GitHub 오픈소스 탐험

스칼라(Scala) 개발자라면, 프로토콜 버퍼(Protocol Buffers)를 사용하여 데이터 구조를 직렬화하는 방법에 대해 고민해본 적이 있을 것입니다. 특히 자바와의 호환성을 유지하면서도 스칼라의 장점을 살리고 싶은 개발자들에게 ScalaPB는 매력적인 선택이 될 수 있습니다. ScalaPB는 스칼라용 프로토콜 버퍼 컴파일러 플러그인으로, 스칼라의 케이스 클래스, 파서 및 직렬화 도구를 생성하여 프로토콜 버퍼를 효율적으로 다룰 수 있도록 도와줍니다. 이번 글에서는 ScalaPB의 주요 기능과 설치, 기본 사용법을 소개하고, 실제 사례를 통해 어떻게 활용할 수 있는지 알아보겠습니다.

ScalaPB의 주요 기능

프로토콜 버퍼 지원: ScalaPB는 proto2와 proto3를 모두 지원하며, 기존 자바 프로토콜 버퍼와 함께 사용할 수 있도록 설계되었습니다. 이를 통해 점진적인 마이그레이션이 가능해집니다.
케이스 클래스 생성: ScalaPB는 각 최상위 메시지와 열거형을 별도의 스칼라 파일로 생성합니다. 이는 증분 컴파일의 성능을 크게 향상시킵니다.
JSON 변환 지원: 프로토콜 버퍼와 JSON 간의 변환이 가능하여, 웹 API와의 연동을 쉽게 할 수 있습니다.
GRPC 통합: GRPC와의 통합이 가능하여, 마이크로서비스 아키텍처를 쉽게 구축할 수 있습니다.
Scalafix, Scala.js 지원: 코드 수정을 위한 Scalafix와 JavaScript 기반의 웹 애플리케이션 개발을 위한 Scala.js와의 호환성을 제공합니다.

설치 방법

ScalaPB를 설치하기 위해서는 sbt(Scala Build Tool)를 사용합니다. 프로젝트의 project/protoc.sbt 파일에 다음 줄을 추가하세요:

addSbtPlugin("com.thesamet" % "sbt-protoc" % "1.0.6")

그리고 build.sbt 파일에 다음 줄을 추가합니다:

libraryDependencies += "com.thesamet.scalapb" %% "compilerplugin" % "0.11.3"

Compile / PB.targets := Seq(
  scalapb.gen() -> (Compile / sourceManaged).value / "scalapb"
)

이제 ScalaPB를 사용할 준비가 완료되었습니다!

기본 사용법

이제 간단한 프로토콜 버퍼 메시지를 정의하고, ScalaPB를 통해 스칼라 케이스 클래스를 생성해보겠습니다.

1단계: 프로토콜 정의

src/main/protobuf/sample.proto 파일을 생성하고, 다음과 같이 메시지를 정의합니다.

syntax = "proto3";

package sample;

message Person {
  string name = 1;
  int32 age = 2;
}

2단계: 케이스 클래스 생성

sbt compile 명령어를 실행하여 스칼라 케이스 클래스를 생성합니다. 생성된 클래스는 target/scala-2.13/scalapb 디렉터리에서 확인할 수 있습니다.

3단계: 사용 예제

이제 생성된 케이스 클래스를 사용하는 예제를 작성해보겠습니다.

import scalapb.GeneratedMessageCompanion
import sample.Person

object ExampleApp extends App {
  // Person 객체 생성
  val person = Person(name = "홍길동", age = 30)

  // Person 객체를 직렬화
  val bytes = person.toByteArray

  // 직렬화된 데이터를 역직렬화
  val deserializedPerson = Person.parseFrom(bytes)

  println(s"이름: ${deserializedPerson.name}, 나이: ${deserializedPerson.age}")
}

위의 코드를 실행하면, 홍길동이라는 이름과 30이라는 나이를 갖는 Person 객체가 생성되고, 직렬화 및 역직렬화 과정도 확인할 수 있습니다.

실무에서의 활용 시나리오

ScalaPB는 대규모 데이터 처리 또는 마이크로서비스 아키텍처를 사용하는 프로젝트에 매우 유용합니다. 예를 들어, 여러 서비스 간에 데이터를 주고받을 때 프로토콜 버퍼를 사용하여 효율적으로 데이터를 직렬화하고 전송할 수 있습니다. 또한, 스칼라의 타입 시스템을 활용하여 안전한 데이터 처리를 구현할 수 있습니다.

다른 도구와의 비교

ScalaPB 외에도 Avro, Thrift와 같은 데이터 직렬화 도구가 존재합니다. 그러나 ScalaPB는 스칼라와의 통합이 우수하며, 자바 코드와의 호환성을 유지하면서도 스칼라의 기능을 최대한 활용할 수 있는 장점이 있습니다. 특히, 프로토콜 버퍼의 직렬화 성능은 일반적으로 다른 도구들보다 우수하여, 높은 성능을 요구하는 시스템에서 더욱 빛을 발합니다.

마무리

ScalaPB는 스칼라 개발자들이 프로토콜 버퍼를 손쉽게 다룰 수 있도록 도와주는 강력한 도구입니다. 프로토콜 버퍼를 사용하여 데이터를 직렬화하고, 다양한 환경에서 활용할 수 있는 가능성을 제공합니다. 스칼라에서 프로토콜 버퍼를 사용하고자 하는 모든 개발자에게 추천하는 프로젝트입니다. 자세한 내용은 ScalaPB GitHub 페이지에서 확인해보세요.

ScalaPB, 스칼라에서 프로토콜 버퍼를 쉽게 다루는 법은?