Trong bài viết trước, mình đã giới thiệu với các bạn Maven Plugin https://github.com/xolstice/protobuf-maven-plugin để có thể generate Java code cho service contract trong gRPC. Hiện tại thì plugin này đã archive. Một plugin khác thay thế, cùng tên và được recommend bởi Maven plugin trên là https://github.com/ascopes/protobuf-maven-plugin. Trong bài viết này, mình sẽ hướng dẫn các bạn cách sử dụng Ascopes Protocol Buffers Maven Plugin để có thể generate Java code cho service contract trong gRPC các bạn nhé!
Mình cũng tạo mới một Maven project để làm ví dụ:
Ascopes Protocol Buffers Maven Plugin cũng sử dụng Protocol Buffer Compiler và plugin gRPC Java Codegen cho Protocol Buffer Compiler để generate các message và các service được định nghĩa trong tập tin .proto, tương tự như plugin https://github.com/xolstice/protobuf-maven-plugin đó các bạn! Chỉ có cách khai báo thì khác mà thôi!
Cụ thể thì mình có thể khai báo plugin này 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 |
<plugin> <groupId>io.github.ascopes</groupId> <artifactId>protobuf-maven-plugin</artifactId> <version>3.6.0</version> <configuration> <protocVersion>${protobuf-java.version}</protocVersion> <binaryMavenPlugins> <binaryMavenPlugin> <groupId>io.grpc</groupId> <artifactId>protoc-gen-grpc-java</artifactId> <version>${grpc.version}</version> <options>@generated=omit</options> </binaryMavenPlugin> </binaryMavenPlugins> </configuration> <executions> <execution> <id>generate</id> <goals> <goal>generate</goal> </goals> </execution> </executions> </plugin> |
Như các bạn thấy, trong phần cấu hình của Ascopes Protocol Buffers Maven Plugin, chúng ta sẽ khai báo phiên bản Protocol Buffer Compiler mà plugin này sẽ sử dụng, sử dụng thẻ <protocVersion>.
Thẻ <binaryMavenPlugin> thì dùng để khai báo sử dụng plugin gRPC Java Codegen. Ở đây, như các bạn thấy, mình đã khai báo một option là “@generated=omit”. Option này dùng để disable việc sử dụng annotation @Generated của dependency javax.annotation-api đó các bạn! Plugin gRPC Java Codegen sẽ sử dụng annotation @com.google.protobuf.Generated của thư viện protobuf-java để thay thế!
Ascopes Protocol Buffers Maven Plugin định nghĩa goal generate để thực hiện việc generate code đó các bạn!
Các bạn cũng cần phải khai báo một số dependency sau để code có thể compile được:
|
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 |
<dependencyManagement> <dependencies> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-bom</artifactId> <version>${grpc.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-protobuf</artifactId> </dependency> <dependency> <groupId>io.grpc</groupId> <artifactId>grpc-stub</artifactId> </dependency> <dependency> <groupId>com.google.protobuf</groupId> <artifactId>protobuf-java</artifactId> <version>${protobuf-java.version}</version> </dependency> </dependencies> |
với grpc.version và protobuf-java.version có giá trị như sau:
|
1 2 3 4 5 6 |
<properties> ... <protobuf-java.version>4.31.1</protobuf-java.version> <grpc.version>1.73.0</grpc.version> </properties> |
Mặc định thì Ascopes Protocol Buffers Maven Plugin sẽ scan các tập tin .proto nằm trong thư mục /src/main/protobuf hoặc /src/main/proto để generate Java code cho service contract cho gRPC server. Để làm ví dụ cho bài viết này, mình cũng sẽ tạo một tập tin helloworld.proto nằm trong thư mục src/main/protobuf với nội dung đơ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.grpc; message HelloRequest { string name = 1; } message HelloResponse { string message = 1; } service HelloService { rpc hello(HelloRequest) returns (HelloResponse); } |
Bây giờ, nếu các bạn chạy Maven Compile “mvn compile”, các bạn sẽ thấy Ascopes Protocol Buffers Maven Plugin generate các tập tin Java ở thư mục /target/generated-sources/protobuf như sau:
Như vậy chúng ta đã hoàn thành việc sử dụng Ascopes Protocol Buffers Maven Plugin để generate Java code cho service contract trong gRPC rồi đó các bạn!
