IDL 方式使用 Triple

这篇教程会通过从零构建一个简单的工程来演示如何基于 IDL 方式使用 Dubbo Triple

前置条件

创建工程

1. 创建一个空的 maven 工程

  1. $ mvn archetype:generate                                \
  2.     -DgroupId=org.apache.dubbo                          \
  3.     -DartifactId=tri-stub-demo                          \
  4.     -DarchetypeArtifactId=maven-archetype-quickstart    \
  5.     -DarchetypeVersion=1.4                              \
  6.     -DarchetypeGroupId=org.apache.maven.archetypes      \
  7.     -Dversion=1.0-SNAPSHOT

2. 切换到工程目录

  1.    $ cd tri-stub-demo

3. 添加 Dubbo 依赖和插件

在 pom.xml 中设置 JDK 版本

  1.     <properties>
  2.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  3.         <maven.compiler.source>1.8</maven.compiler.source>
  4.         <maven.compiler.target>1.8</maven.compiler.target>
  5.     </properties>
  7.     <dependencies>
  8.        <dependency>
  9.            <groupId>junit</groupId>
  10.            <artifactId>junit</artifactId>
  11.            <version>4.13</version>
  12.            <scope>test</scope>
  13.        </dependency>
  14.        <dependency>
  15.            <groupId>org.apache.dubbo</groupId>
  16.            <artifactId>dubbo</artifactId>
  17.            <version>3.0.8</version>
  18.        </dependency>
  19.        <dependency>
  20.         <groupId>org.apache.dubbo</groupId>
  21.         <artifactId>dubbo-dependencies-zookeeper-curator5</artifactId>
  22.         <type>pom</type>
  23.         <version>3.0.8</version>
  24.        </dependency>
  25.         <dependency>
  26.             <groupId>com.google.protobuf</groupId>
  27.             <artifactId>protobuf-java</artifactId>
  28.             <version>3.19.4</version>
  29.         </dependency>
  30.     </dependencies>
  32.     <build>
  33.         <extensions>
  34.             <extension>
  35.                 <groupId>kr.motd.maven</groupId>
  36.                 <artifactId>os-maven-plugin</artifactId>
  37.                 <version>1.6.1</version>
  38.             </extension>
  39.         </extensions>
  40.         <plugins>
  41.             <plugin>
  42.                 <groupId>org.xolstice.maven.plugins</groupId>
  43.                 <artifactId>protobuf-maven-plugin</artifactId>
  44.                 <version>0.6.1</version>
  45.                 <configuration>
  46.                     <protocArtifact>com.google.protobuf:protoc:3.19.4:exe:${os.detected.classifier}</protocArtifact>
  47.                     <protocPlugins>
  48.                         <protocPlugin>
  49.                             <id>dubbo</id>
  50.                             <groupId>org.apache.dubbo</groupId>
  51.                             <artifactId>dubbo-compiler</artifactId>
  52.                             <version>0.0.4.1-SNAPSHOT</version>
  53.                             <mainClass>org.apache.dubbo.gen.tri.Dubbo3TripleGenerator</mainClass>
  54.                         </protocPlugin>
  55.                     </protocPlugins>
  56.                 </configuration>
  57.                 <executions>
  58.                     <execution>
  59.                         <goals>
  60.                             <goal>compile</goal>
  61.                         </goals>
  62.                     </execution>
  63.                 </executions>
  64.             </plugin>
  65.         </plugins>
  66.     </build>

4. 添加接口定义文件

src/main/proto/hello.proto，Dubbo 使用 Protobuf 作为 IDL

  1.     syntax = "proto3";
  3.     option java_multiple_files = true;
  4.     option java_package = "org.apache.dubbo.hello";
  5.     option java_outer_classname = "HelloWorldProto";
  6.     option objc_class_prefix = "HLW";
  8.     package helloworld;
  10.     message HelloRequest {
  11.         string name = 1;
  12.     }
  14.     message HelloReply {
  15.         string message = 1;
  16.     }
  17.     service Greeter{
  18.         rpc greet(HelloRequest) returns (HelloReply);
  19.     }

5. 编译 IDL

  1.     $ mvn clean install

编译成功后，可以看到target/generated-sources/protobuf/java 目录下生成了代码文件

  1.    $ ls org/apache/dubbo/hello/
  2.     DubboGreeterTriple.java    HelloReply.java            HelloRequest.java          HelloWorldProto.java
  3.     Greeter.java               HelloReplyOrBuilder.java   HelloRequestOrBuilder.java

6. 添加服务端接口实现

src/main/java/org/apache/dubbo/GreeterImpl.java

  1.    package org.apache.dubbo;
  3.    import org.apache.dubbo.hello.DubboGreeterTriple;
  4.    import org.apache.dubbo.hello.HelloReply;
  5.    import org.apache.dubbo.hello.HelloRequest;
  7.    public class GreeterImpl extends DubboGreeterTriple.GreeterImplBase {
  8.       @Override
  9.       public HelloReply greet(HelloRequest request) {
  10.          return HelloReply.newBuilder()
  11.          .setMessage("Hello," + request.getName() + "!")
  12.          .build();
  13.       }
  14.    }

7. 添加服务端启动类

src/main/java/org/apache/dubbo/MyDubboServer.java

  1.    package org.apache.dubbo;
  3.    import org.apache.dubbo.common.constants.CommonConstants;
  4.    import org.apache.dubbo.config.ApplicationConfig;
  5.    import org.apache.dubbo.config.ProtocolConfig;
  6.    import org.apache.dubbo.config.RegistryConfig;
  7.    import org.apache.dubbo.config.ServiceConfig;
  8.    import org.apache.dubbo.config.bootstrap.DubboBootstrap;
  9.    import org.apache.dubbo.hello.Greeter;
  11.    import java.io.IOException;
  13.    public class MyDubboServer {
  15.        public static void main(String[] args) throws IOException {
  16.            ServiceConfig<Greeter> service = new ServiceConfig<>();
  17.            service.setInterface(Greeter.class);
  18.            service.setRef(new GreeterImpl());
  20.            DubboBootstrap bootstrap = DubboBootstrap.getInstance();
  21.            bootstrap.application(new ApplicationConfig("tri-stub-server"))
  22.                    .registry(new RegistryConfig("zookeeper://127.0.0.1:2181"))
  23.                    .protocol(new ProtocolConfig(CommonConstants.TRIPLE, 50051))
  24.                    .service(service)
  25.                    .start();
  26.            System.out.println("Dubbo triple stub server started");
  27.            System.in.read();
  28.        }
  29.    }

8. 添加客户端启动类

src/main/java/org/apache/dubbo/MyDubboClient.java

  1.    package org.apache.dubbo;
  3.    import org.apache.dubbo.common.constants.CommonConstants;
  4.    import org.apache.dubbo.config.ApplicationConfig;
  5.    import org.apache.dubbo.config.ReferenceConfig;
  6.    import org.apache.dubbo.config.RegistryConfig;
  7.    import org.apache.dubbo.config.bootstrap.DubboBootstrap;
  8.    import org.apache.dubbo.hello.Greeter;
  9.    import org.apache.dubbo.hello.HelloReply;
  10.    import org.apache.dubbo.hello.HelloRequest;
  12.    public class MyDubboClient {
  13.       public static void main(String[] args) {
  14.          DubboBootstrap bootstrap = DubboBootstrap.getInstance();
  15.          ReferenceConfig<Greeter> ref = new ReferenceConfig<>();
  16.          ref.setInterface(Greeter.class);
  17.          ref.setProtocol(CommonConstants.TRIPLE);
  18.          ref.setProxy(CommonConstants.NATIVE_STUB);
  19.          ref.setTimeout(3000);
  20.          bootstrap.application(new ApplicationConfig("tri-stub-client"))
  21.             .registry(new RegistryConfig("zookeeper://127.0.0.1:2181"))
  22.             .reference(ref)
  23.             .start();
  25.          Greeter greeter = ref.get();
  26.          HelloRequest request = HelloRequest.newBuilder().setName("Demo").build();
  27.          HelloReply reply = greeter.greet(request);
  28.          System.out.println("Received reply:" + reply);
  29.        }
  30.    }

9. 编译代码

  1. $ mvn clean install

10. 启动服务端

  1. $ mvn org.codehaus.mojo:exec-maven-plugin:3.0.0:java -Dexec.mainClass="org.apache.dubbo.MyDubboServer"
  2. Dubbo triple stub server started

11. 打开新的终端，启动客户端

  1. $ mvn org.codehaus.mojo:exec-maven-plugin:3.0.0:java -Dexec.mainClass="org.apache.dubbo.MyDubboClient"
  2. Received reply:message: "Hello,Demo!"

最后修改 December 16, 2022: Fix check (#1736) (97972c1)