Binary Data를 Swift 구조체로 변환하기 (feat. ByteBuffer, swift-nio)

목차

💌 Binary Data로 서버와 통신 (feat. 소켓 통신)

🌟 Byte Buffer란?

🍎 Swift에서 ByteBuffer를 사용해서 데이터 읽기 (기본 자료형)

🍏 ByteBuffer를 사용해서 Swift 구조체(Struct)로 변환하기

---

💌 Binary Data로 서버와 통신 (feat. 소켓 통신)

최근에 채팅 기능을 개발하면서, 소켓(Socket) 통신을 구현하게 되었다.

(소켓 통신에 대해서는 채팅 기능 개발이 끝난 후 포스팅하도록 하겠다.)

이번에 소켓 통신을 구현하면서, 특이점은 서버와 통신할때 주고받는 데이터 형식이 Binary Data였다는 점이다.

 

물론, 소켓 통신도 json 형태로 데이터를 주고받아도 된다.

하지만, 소켓 통신의 경우 Binary Data로 데이터를 주고받는게 더 적합하다고 한다.

 

이유는 여러가지가 있겠지만 두가지만 적겠다.

1. 효율적인 데이터 크기

- 우선 json은 문자열이다. json 문자열을 실제로 서버에 전송될때는 바이트로 인코딩 된다. 그렇다면 실제 data만 byte로 보내는것 보다, key값을 포함한 모든 data 문자열을 byte로 인코딩하면 용량이 더 클 수 밖에 없다.

2. 더 빠른 속도와 성능

- Binary data는 컴퓨터가 직접 읽고 쓸 수 있는 원시 형태이므로, 데이터를 처리하는 데 더 빠를 수 있다.

- 그에 반해, JSON 데이터는 문자열로 표현되기 때문에, 전송하기 전에 문자열로 변환하거나, 수신 후 문자열을 파싱해야 한다. 이 과정은 추가적인 CPU와 메모리 자원을 소모하며, 전송 속도를 저하시킬 수 있다.

---

🌟 Byte Buffer란?

Byte

바이트(Byte)는 디지털 정보의 단위 중 하나로, 8비트로 구성된다. 컴퓨터와 정보 통신 분야에서 널리 사용되는 기본적인 데이터 단위로, 문자, 숫자, 이미지, 사운드 등의 다양한 종류의 데이터를 표현하는 데 사용된다.

 

Buffer

버퍼(Buffer)는 데이터를 임시로 저장하는 메모리 공간을 의미한다. 버퍼는 주로 서로 다른 속도로 작동하는 시스템 구성 요소 간의 데이터 전송을 조정하고, 데이터를 임시 저장하거나 처리하는 데 사용된다.

 

ByteBuffer

ByteBuffer는 Java에서 제공하는 특정 클래스이지만, "바이트 버퍼"라는 개념 자체는 Java에만 국한되지 않고, 다양한 프로그래밍 언어와 시스템에서 사용되는 일반적인 개념이다. 바이트 버퍼는 바이트 단위의 데이터를 임시로 저장하고 처리하는 데 사용되는 메모리 공간을 의미한다.

 

---

🍎 Swift에서 ByteBuffer를 사용해서 데이터 읽기 (기본 자료형)

우선, ByteBuffer 클래스를 사용하기 위해 Swift-nio 라는 패키지를 설치해줘야한다.

(cocoapods를 지원 안하니, spm으로 설치해야한다.)

https://github.com/apple/swift-nio

GitHub - apple/swift-nio: Event-driven network application framework for high performance protocol servers & clients, non-blocki

 

swift-nio는 정말 방대한 라이브러리이다. 정말 많은걸 지원하지만, ByteBuffer를 읽고 쓸 수 있는 기능만 사용하였다.

 

import NIO

// MARK: - 서버에서 응답 받은 데이터
// WebSocket으로 data를 receive할때 데이터 타입은 Data 타입으로 들어온다.
let data: Data 

// MARK: - Data to byteBuffer
// ByteBuffer는 SwiftNIO 패키지에서 제공해주는 객체이다.
var byteBuffer: ByteBuffer = ByteBuffer(data: data)

// MARK - 바이트 버퍼 읽기
// 바이트 버퍼를 앞에서부터 읽게 된다.
// 바이트 버퍼의 첫 데이터로 Integer가 들어온다고 가정하고, 우선 Integer를 읽어보자.

// MARK: - byteBuffer to INT32 - Mid-Little
let int32 = byteBuffer.readInteger(endianness: .little, as: Int32.self)
// Int로 바꾸기
let int = Int(int32!)

// MARK: - 다음 바이트 버퍼 읽기
// 바이트 버퍼를 또 읽게 되면 앞에 읽은 Integer 다음 부분부터 읽게 된다.
// 다음 데이터는 String이 들어온다고 가정하고, String을 읽어보자.

// MARK: - String을 읽으려면 우선 String의 길이인 Integer부터 읽어야한다.
let strLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)
// MARK: - byteBuffer to Ascii
let str = byteBuffer.readString(length: Int(strLength!), encoding: .ascii) 
// MARK: - 한글도 읽을거면 utf8로 인코딩하기
let str = byteBuffer.readString(length: Int(strLength!), encoding: .utf8)

 

 

📌 여기서 잠깐! readInteger() 에 endianness와 as 속성은 뭘까?

이거.. 중요한거다!

왜냐하면 이 속성을 어떻게 설정하는지에 따라 다른 데이터가 출력된다...

Endianness - 바이트 순서

엔디안 속성은 메모리 내에서 데이터의 바이트가 어떻게 배열되는지를 정의한다.
1. 빅 엔디안 (Big-endian):
가장 중요한 바이트(가장 높은 바이트)가 메모리의 낮은 주소에 저장된다. 즉, 데이터의 첫 번째 바이트가 가장 먼저 저장된다.
2. 리틀 엔디안 (Little-endian):
가장 중요한 바이트가 메모리의 높은 주소에 저장된다. 즉, 데이터의 마지막 바이트가 가장 먼저 저장된다.

As - 형변환

As 속성은 readInteger() 메서드가 읽은 데이터를 특정 형식으로 변환할 때 사용된다. 데이터가 읽힐 때, 어떻게 해석될지를 결정할 수 있는 옵션이다.

 

 

내가 응답받은 데이터를 어떤 속성으로 변환해야될지 모른다면, (나는 알려주는 사람이 없어서 몰랐다...)

응답 받은 데이터를 콘솔에서 찍어보고, 찍힌 데이터를 컨버터에서 돌려보고 맞는 속성을 찾는다!!

https://www.scadacore.com/tools/programming-calculators/online-hex-converter/

Online Hex Converter - Bytes, Ints, Floats, Significance, Endians - SCADACore

내가 사용한 컨버터이다. 

왜 Hex Converter냐고? Hex String은 Binary Data를 사람이 보기 좋게 변환한 것이다.

나는 응답으로 받은 데이터를 콘솔에 찍으면 [01 00 00 00] 이 나왔다.

이건 binary data를 사람이 보기 좋게 변환해놓은 Hex String이었고, 따라서 Hex String Converter 를 사용하였다.

 

나는 변환했을때 값이 1이여야 했다.

1을 찾아보면, Int32 - Little Endian (DCBA) 와 UINT16 - Little Endian (BA) 가 있다.

이중에서 나는 Int32 - Little Endian으로 변환했고, 데이터를 잘 읽어올 수 있었다.

let int32 = byteBuffer.readInteger(endianness: .little, as: Int32.self)

---

🍏 ByteBuffer를 사용해서 Swift 구조체(Struct)로 변환하기

struct BaseResponse<T> {
    var res: Int?
    var code: Int?
    var data: T?
}

struct ChattingRooms {
    var chattingRooms: [ChattingRoom]?
}

struct ChattingRoom {
    var id: String?
    var name: String?
    var groupId: String?
    var channelId: String?
    var imageUrl: String?
    var lastChat: String?
    var lastChatTimeStamp: Int?
    var unreadMessageCount: Int?
}

 

 

응답받은 Binary Data를 Swift로 읽기 편하게 위와 같은 구조체(Struct)로 변환해보자!

let res = byteBuffer.readInteger(endianness: .little, as: Int32.self) 
let code = byteBuffer.readInteger(endianness: .little, as: Int32.self)

// MARK: - data는 object Array로 들어오기 때문에 우선, length부터 구한다.
let objectArrayLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)

var data: [ChattingRoom] = []

// MARK: - 배열 길이만큼 object를 읽는다.
if let objectArrayLength = objectArrayLength {
    for _ in 0..<objectArrayLength {
        if let object = readObject(byteBuffer: byteBuffer) {
            data.append(object)
        }
    }
}

// MARK: - 최종 구조체(Struct)
let response: BaseResponse<ChattingRooms> = BaseResponse(res: Int(res!), code: Int(code!), data: ChattingRooms(chattingRooms: data))

print(response)

// MARK: - object를 읽어 ChattingRoom 구조체로 변환
private func readObject(byteBuffer: ByteBuffer) -> ChattingRoom {
    var byteBuffer = byteBuffer

    let idLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)
    let id = byteBuffer.readString(length: Int(idLength!), encoding: .ascii)

    let nameLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)
    let name = byteBuffer.readString(length: Int(nameLength!), encoding: .utf8)

    let groupIdLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)
    let groupId = byteBuffer.readString(length: Int(groupIdLength!), encoding: .ascii)

    let channelIdLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)
    let channelId = byteBuffer.readString(length: Int(channelIdLength!), encoding: .ascii)

    let imageUrlLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)
    let imageUrl = byteBuffer.readString(length: Int(imageUrlLength!), encoding: .ascii)

    let lastChatLength = byteBuffer.readInteger(endianness: .little, as: Int32.self)
    let lastChat = byteBuffer.readString(length: Int(lastChatLength!), encoding: .utf8)

    let lastChatTimeStamp = byteBuffer.readInteger(endianness: .little, as: Int32.self)

    let unreadMessageCount = byteBuffer.readInteger(endianness: .little, as: Int32.self)

    return ChattingRoom(id: id, name: name, groupId: groupId, channelId: channelId, imageUrl: imageUrl, lastChat: lastChat, lastChatTimeStamp: Int(lastChatTimeStamp!), unreadMessageCount: Int(unreadMessageCount!))
}