gRPCをSpring Bootで利用する【株式会社ライトコード】

※弊社エンジニアの記事になります。

はじめに

業務でSpringBootでREST APIの開発を行っていたのですが、マイクロサービス化するに当たりgRPCを利用して開発することになりました。そこで個人勉強として簡単なサービスを作ったので記録します。

SpringBootでgRPCを実装して、gRPCの4つの通信方式まで実際にやってみます。この記事の内容を上から行うとspring boot+gRPCで動く環境が作れます。

プロジェクトの作成

https://start.spring.io/ でプロジェクトを作成します。依存関係の追加は不要です。ProjectはMavenを選択してください。

ダウンロード＆解凍を行い、pom.xml を修正します。

pom.xmlの修正

ダウンロードして解凍したプロジェクトにある、pom.xml を修正してgRPCとSpringBootを利用できるようにしていきます。

最初はgRPC対応です。dependencyを追加してライブライのダウンロードを行います。

<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-netty-shaded</artifactId>
  <version>1.57.0</version>
  <scope>runtime</scope>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.57.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.57.0</version>
</dependency>
<dependency> <!-- necessary for Java 9+ -->
  <groupId>org.apache.tomcat</groupId>
  <artifactId>annotations-api</artifactId>
  <version>6.0.53</version>
  <scope>provided</scope>
</dependency><dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-netty-shaded</artifactId>
  <version>1.57.0</version>
  <scope>runtime</scope>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.57.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.57.0</version>
</dependency>
<dependency> <!-- necessary for Java 9+ -->
  <groupId>org.apache.tomcat</groupId>
  <artifactId>annotations-api</artifactId>
  <version>6.0.53</version>
  <scope>provided</scope>
</dependency>

pluginの追加

<build>
  <extensions>
    <extension>
      <groupId>kr.motd.maven</groupId>
      <artifactId>os-maven-plugin</artifactId>
      <version>1.7.1</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.6.1</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.23.4:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.57.0:exe:${os.detected.classifier}</pluginArtifact>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>
<build>
  <extensions>
    <extension>
      <groupId>kr.motd.maven</groupId>
      <artifactId>os-maven-plugin</artifactId>
      <version>1.7.1</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.6.1</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.23.4:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.57.0:exe:${os.detected.classifier}</pluginArtifact>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

これでjavaでgPRCが使えるようになりました。次にspring bootで利用できるようにします。

<dependency>
 <groupId>io.github.lognet</groupId>
 <artifactId>grpc-spring-boot-starter</artifactId>
 <version>5.1.3</version>
</dependency>
<dependency>
 <groupId>io.github.lognet</groupId>
 <artifactId>grpc-spring-boot-starter</artifactId>
 <version>5.1.3</version>
</dependency>

これでpom.xmlは準備完了です。

protoファイルの作成

src/main配下にprotoフォルダを作成し、Greeter.protoファイルを作成して下記の内容を記述。

syntax = "proto3";
 
package com.example;
 
service Greeter {
  // Unary RPC (単一リクエスト, 単一レスポンス)
  rpc SayHelloUnary (GreeterRequest) returns (GreeterReply) {}
  // Server streaming RPC (単一リクエスト, 複数レスポンス)
  rpc SayHelloServerStreaming (GreeterRequest) returns (stream GreeterReply) {}
  // Client streaming RPC (複数リクエスト, 単一レスポンス)
  rpc SayHelloClientStreaming (stream GreeterRequest) returns (GreeterReply) {}
  // Bidirectional streaming RPC (複数リクエスト, 複数レスポンス)
  rpc SayHelloBidirectionalStreaming (stream GreeterRequest) returns (stream GreeterReply) {}
}
 
// ユーザ名を含むリクエスト
message GreeterRequest {
  string name = 1;
}
 
// Hello,を含むレスポンス
message GreeterReply {
  string message = 1;
}
syntax = "proto3";
 
package com.example;
 
service Greeter {
  // Unary RPC (単一リクエスト, 単一レスポンス)
  rpc SayHelloUnary (GreeterRequest) returns (GreeterReply) {}
  // Server streaming RPC (単一リクエスト, 複数レスポンス)
  rpc SayHelloServerStreaming (GreeterRequest) returns (stream GreeterReply) {}
  // Client streaming RPC (複数リクエスト, 単一レスポンス)
  rpc SayHelloClientStreaming (stream GreeterRequest) returns (GreeterReply) {}
  // Bidirectional streaming RPC (複数リクエスト, 複数レスポンス)
  rpc SayHelloBidirectionalStreaming (stream GreeterRequest) returns (stream GreeterReply) {}
}
 
// ユーザ名を含むリクエスト
message GreeterRequest {
  string name = 1;
}
 
// Hello,を含むレスポンス
message GreeterReply {
  string message = 1;
}