Hiện chưa có một official starter hỗ trợ cho gRPC trong Spring Boot nhưng các bạn cũng có thể sử dụng các starter do cộng đồng phát triển ở GitHub repository https://github.com/grpc-ecosystem/grpc-spring. Trong bài viết này, mình sẽ hướng dẫn các bạn cách xây dựng một gRPC server với Spring Boot sử dụng grpc-server-spring-boot-starter trong GitHub repository này các bạn nhé!
Đầu tiên, mình sẽ tạo mới một Spring Boot project để làm ví dụ:
Chúng ta sẽ khai báo grpc-server-spring-boot-starter như sau:
|
1 2 3 4 5 6 7 8 9 10 11 |
<dependency> <groupId>net.devh</groupId> <artifactId>grpc-server-spring-boot-starter</artifactId> <version>3.1.0.RELEASE</version> </dependency> <dependency> <groupId>javax.annotation</groupId> <artifactId>javax.annotation-api</artifactId> <version>1.3.2</version> </dependency> |
Ở đây, mình sẽ sử dụng Protocol Buffers Maven Plugin để generate Java code cho service contract của gRPC nên như các bạn thấy, mình cũng khai báo luôn dependency javax.annotation-api để khỏi bị lỗi compile sau khi generate source code.
Tập tin .proto trong thư mục src/main/proto định nghĩa service contract, mình sẽ định nghĩa đơn giản như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
syntax = "proto3"; option java_multiple_files = true; package com.huongdanjava.springboot.grpc; message HelloRequest { string name = 1; } message HelloResponse { string message = 1; } service HelloService { rpc hello(HelloRequest) returns (HelloResponse); } |
Protocol Buffers Maven Plugin mình khai báo như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
<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.25.4:exe:${os.detected.classifier}</protocArtifact> <pluginId>grpc-java</pluginId> <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.66.0:exe:${os.detected.classifier}</pluginArtifact> </configuration> <executions> <execution> <goals> <goal>compile</goal> <goal>compile-custom</goal> </goals> </execution> </executions> </plugin> </plugins> </build> |
Các bạn có thể đọc thêm bài viết Generate Java code cho service contract trong gRPC sử dụng Protocol Buffers Maven Plugin để hiểu rõ về cách sử dụng Protocol Buffers Maven Plugin để generate Java code cho service contract các bạn nhé!
Chạy Maven Compile, các bạn sẽ thấy kết quả như sau:
Để hiện thực HelloService với grpc-server-spring-boot-starter, các bạn chỉ cần thêm một class mới extends class HelloServiceGrpc.HelloServiceImplBase và annotate class này với annotation @GrpcService như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
package com.huongdanjava.springboot.grpc; import io.grpc.stub.StreamObserver; import net.devh.boot.grpc.server.service.GrpcService; @GrpcService public class HelloController extends HelloServiceGrpc.HelloServiceImplBase { @Override public void hello(HelloRequest request, StreamObserver<HelloResponse> responseObserver) { String greeting = "Hello " + request.getName() + " from Huong Dan Java"; HelloResponse response = HelloResponse.newBuilder() .setMessage(greeting) .build(); responseObserver.onNext(response); responseObserver.onCompleted(); } } |
Nội dung implement của phương thức hello() mình làm tương tự như trong bài viết trước đó các bạn!
grpc-server-spring-boot-starter với cơ chế auto-configuration của Spring Boot, sẽ tự động start một gRPC server với các default configuration, thêm implementation của HelloService để expose ra bên ngoài.
Mặc định thì grpc-server-spring-boot-starter sẽ chạy gRPC server ở port 9090, các bạn có thể thay đổi port mặc định này bằng cách khai báo property grpc.server.port với giá trị mà các bạn muốn nhé! Trong ví dụ này, mình sẽ để port mặc định.
Nếu giờ mình chạy ứng dụng ví dụ này rồi sử dụng Postman để request tới operation hello, mình sẽ thấy kết quả như sau:
Rất nhanh và đơn giản phải không các bạn?
