前提
- Windows 11 Pro 22H2 22621.1848
- Docker Desktop version 4.20.1 (110738)
- 使用する Docker イメージ:
eclipse-temurin:17
Maven プロジェクト作成
spring initializr で、 Mavem + Java17 + Lombok のプロジェクトを作成し、展開する
開発用コンテナ起動
共通ボリュームとして maven_data
を利用しているので、あらかじめボリュームを作成しておいてください。
docker volume create maven_dataそのうえで、 docker compose
コマンドで開発用コンテナを立ち上げます。
docker compose up -d開発用コンテナへ接続
以下コマンドで app
コンテナへ接続し、その中で開発を行ってください。
docker compose exec app bashProtocol Buffers に必要なパッケージのインストール
apt update
apt install -y protobuf-compilerProtocol
Buffers のコンパイルに必要なライブラリを pom.xml
に追加
protobuf-java: 生成する Java ソースコードをコンパイルするためのライブラリprotobuf-java-util: Protocol Buffers 用便利 API を使うためのライブラリ
<dependency>
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
<version>3.23.0</version>
</dependency>
<dependency>
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java-util</artifactId>
<version>3.23.0</version>
</dependency>.proto の作成
通信フォーマットを定義する .proto
ファイルを作成する。
今回は、 ${PROJECT_ROOT}/proto/MemberInfo.proto
に以下内容でファイルを作成。
syntax = "proto3";
option java_multiple_files = false;
option java_package="dev.mikoto2000.javastudy.protocolbuffers.firststep.model";
message CommonInfo {
string timestamp = 1;
}
message TeacherProps {
string teacher_id = 1;
}
message StudentProps {
string student_id = 1;
}
message Member {
string type = 1;
string name = 2;
oneof properties {
TeacherProps teacher_props = 3;
StudentProps student_props = 4;
}
}
message MemberInfo {
CommonInfo common_info = 1;
repeated Member member = 2;
}.proto から Java
コードを生成
以下コマンドで、 Protocol Buffers のメッセージ作成に必要な Java コードを生成する。
protoc -I=./proto --java_out=./src/main/java/ ./proto/MemberInfo.proto${PROJECT_ROOT}/src/main/dev/mikoto2000/javastudy/protocolbuffers/firststep/model/MemberInfoOuterClass.java
にコードが生成される。
Protocol Buffers のエンコード・デコードを実装
簡単のために Spring Boot の CommandLineRunner
を利用して処理を実装する。
package dev.mikoto2000.javastudy.protocolbuffers.firststep;
import org.springframework.boot.CommandLineRunner;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;
import com.google.protobuf.InvalidProtocolBufferException;
import dev.mikoto2000.javastudy.protocolbuffers.firststep.model.MemberInfoOuterClass.CommonInfo;
import dev.mikoto2000.javastudy.protocolbuffers.firststep.model.MemberInfoOuterClass.Member;
import dev.mikoto2000.javastudy.protocolbuffers.firststep.model.MemberInfoOuterClass.MemberInfo;
import dev.mikoto2000.javastudy.protocolbuffers.firststep.model.MemberInfoOuterClass.StudentProps;
import dev.mikoto2000.javastudy.protocolbuffers.firststep.model.MemberInfoOuterClass.TeacherProps;
/**
* CliEntrypoint
*/
@Component
@Profile("!test")
public class CliEntrypoint implements CommandLineRunner {
@Override
public void run(String... args) throws InvalidProtocolBufferException {
// MemberInfo の組み立て
MemberInfo.Builder builder = MemberInfo.newBuilder();
MemberInfo memberInfo = builder
.setCommonInfo(CommonInfo.newBuilder().setTimestamp("1234567890").build())
.addMember(Member.newBuilder()
.setType("student")
.setStudentProps(StudentProps.newBuilder()
.setStudentId("mikoto2000")
.build())
.build())
.addMember(Member.newBuilder()
.setType("teacher")
.setTeacherProps(TeacherProps.newBuilder()
.setTeacherId("makoto2000")
.build())
.build())
.build();
System.out.printf("memberInfo: %s\n", memberInfo);
// エンコード
byte[] memberInfoBytes = memberInfo.toByteArray();
// デコード
MemberInfo memberInfoFromByteArray = MemberInfo.parseFrom(memberInfoBytes);
System.out.printf("memberInfoFromByteArray: %s\n", memberInfoFromByteArray);
// エンコード前後の結果比較
System.out.printf("memberInfo.toString().equals(memberInfoFromByteArray.toString()): %s\n", memberInfo.toString().equals(memberInfoFromByteArray.toString()));
}
}動作確認
./mvnw spring-boot:run以下のような出力になる。(Maven の出力や、 Spring Boot のロゴは省略)
memberInfo: common_info {
timestamp: "1234567890"
}
member {
type: "student"
student_props {
student_id: "mikoto2000"
}
}
member {
type: "teacher"
teacher_props {
teacher_id: "makoto2000"
}
}
memberInfoFromByteArray: common_info {
timestamp: "1234567890"
}
member {
type: "student"
student_props {
student_id: "mikoto2000"
}
}
member {
type: "teacher"
teacher_props {
teacher_id: "makoto2000"
}
}
memberInfo.toString().equals(memberInfoFromByteArray.toString()): trueうん、できている気がする。
以上。