服务发现

  1. docker run -d --name nacos -e MODE=standalone -p 8848:8848  nacos/nacos-server:1.4.1

本地开发环境地址：http://127.0.0.1:8848/nacos/#/login
用户名和密码默认是nacos

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>org.example</groupId>
  8.     <artifactId>hello-spring-cloud-dubbo</artifactId>
  9.     <packaging>pom</packaging>
  10.     <version>1.0-SNAPSHOT</version>
  11.     <modules>
  12.         <module>dubbo-provider-sample</module>
  13.         <module>dubbo-consumer-sample</module>
  14.         <module>dubbo-sample-api</module>
  15.     </modules>
  17.     <properties>
  18.         <maven.compiler.source>1.8</maven.compiler.source>
  19.         <maven.compiler.target>1.8</maven.compiler.target>
  20.         <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
  21.         <spring-cloud-alibaba.version>2.2.2.RELEASE</spring-cloud-alibaba.version>
  22.     </properties>
  24.     <dependencyManagement>
  25.         <dependencies>
  26.             <dependency>
  27.                 <groupId>org.springframework.boot</groupId>
  28.                 <artifactId>spring-boot-dependencies</artifactId>
  29.                 <version>${spring-boot.version}</version>
  30.                 <type>pom</type>
  31.                 <scope>import</scope>
  32.             </dependency>
  33.             <dependency>
  34.                 <groupId>com.alibaba.cloud</groupId>
  35.                 <artifactId>spring-cloud-alibaba-dependencies</artifactId>
  36.                 <version>${spring-cloud-alibaba.version}</version>
  37.                 <type>pom</type>
  38.                 <scope>import</scope>
  39.             </dependency>
  40.         </dependencies>
  41.     </dependencyManagement>
  43. </project>

创建服务接口

按照传统的 Dubbo 开发模式，在构建服务提供者之前，第一个步骤是为服务提供者和服务消费者定义 Dubbo 服务接口。
为了确保契约的一致性，推荐的做法是将 Dubbo 服务接口打包在第二方或者第三方的 artifact（jar）中，该 artifact 甚至无需添加任何依赖。
对于服务提供方而言，不仅通过依赖 artifact 的形式引入 Dubbo 服务接口，而且需要将其实现。对应的服务消费端，同样地需要依赖该 artifact，并以接口调用的方式执行远程方法。接下来的步骤则是创建 artifact。

创建 api 工程 - dubbo-sample-api

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>hello-spring-cloud-dubbo</artifactId>
  7.         <groupId>org.example</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>dubbo-sample-api</artifactId>
  14.     <properties>
  15.         <maven.compiler.source>1.8</maven.compiler.source>
  16.         <maven.compiler.target>1.8</maven.compiler.target>
  17.     </properties>
  19. </project>

命令执行后，名为“dubbo-sample-api” 的项目目录生成，切换至该目录，内部结构如下：

  1. ├── pom.xml
  2. └── src
  3.     ├── main
  4.     │   ├── java
  5.     │   │   └── com
  6.     │   │       └── example
  7.     │   │           └── dubbo
  8.     │   │               └── api
  9.     │   │                   └── EchoService.java
  10.     │   └── resources
  11.     └── test
  12.         └── java

定义 Dubbo 服务接口

Dubbo 服务接口是服务提供方与消费方的远程通讯契约，通常由普通的 Java 接口（interface）来声明，如EchoService接口

  1. package com.example.dubbo.api;
  4. public interface EchoService {
  5.     String echo(String message);
  6. }

该接口非常简单，仅有一个方法，接下来将 dubbo-sample-api 部署到本地 Maven 仓库。

部署 api 工程 - dubbo-sample-api

利用 Maven 命令， 将 dubbo-sample-api 部署到本地 Maven 仓库：

  1.  mvn clean install

服务端开发

前面的准备工作，已经创建了服务端工程，本节主要完成了针对服务接口的实现工作

  1. ├── pom.xml
  2. └── src
  3.     ├── main
  4.     │   ├── java
  5.     │   │   └── com
  6.     │   │       └── example
  7.     │   │           └── dubbo
  8.     │   │               └── provider
  9.     │   │                   ├── DubboProviderApplication.java
  10.     │   │                   └── service
  11.     │   │                       └── EchoServiceImpl.java
  12.     │   └── resources
  13.     │       └── application.yaml
  14.     └── test
  15.         └── java

添加 api 依赖 - dubbo-sample-api

打开 dubbo-provider-sample 的 文件；
将 artifact dubbo-sample-api 依赖信息添加到应用 dubbo-provider-sample 中的 pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>hello-spring-cloud-dubbo</artifactId>
  7.         <groupId>org.example</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>dubbo-provider-sample</artifactId>
  14.     <properties>
  15.         <java.version>1.8</java.version>
  16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  17.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  18.     </properties>
  20.     <dependencies>
  21.         <dependency>
  22.             <groupId>org.springframework.boot</groupId>
  23.             <artifactId>spring-boot-starter-web</artifactId>
  24.         </dependency>
  25.         <dependency>
  26.             <groupId>com.alibaba.cloud</groupId>
  27.             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>com.alibaba.cloud</groupId>
  31.             <artifactId>spring-cloud-starter-dubbo</artifactId>
  32.         </dependency>
  34.         <!-- Dubbo 服务 artifact -->
  35.         <dependency>
  36.             <groupId>org.example</groupId>
  37.             <artifactId>dubbo-sample-api</artifactId>
  38.             <version>1.0-SNAPSHOT</version>
  39.         </dependency>
  41.     </dependencies>
  45.     <build>
  46.         <plugins>
  47.             <plugin>
  48.                 <groupId>org.apache.maven.plugins</groupId>
  49.                 <artifactId>maven-compiler-plugin</artifactId>
  50.                 <version>3.8.1</version>
  51.                 <configuration>
  52.                     <source>1.8</source>
  53.                     <target>1.8</target>
  54.                     <encoding>UTF-8</encoding>
  55.                 </configuration>
  56.             </plugin>
  57.             <plugin>
  58.                 <groupId>org.springframework.boot</groupId>
  59.                 <artifactId>spring-boot-maven-plugin</artifactId>
  60.                 <version>2.3.7.RELEASE</version>
  61.                 <executions>
  62.                     <execution>
  63.                         <id>repackage</id>
  64.                         <goals>
  65.                             <goal>repackage</goal>
  66.                         </goals>
  67.                     </execution>
  68.                 </executions>
  69.             </plugin>
  70.         </plugins>
  71.     </build>
  73. </project>

依赖增加之后，下一步实现 Dubbo 服务 -EchoService

实现 Dubbo 服务

在应用 dubbo-provider-sample 中的 com.example.dubbo.provider.service 包下创建实现类

  1. package com.example.dubbo.provider.service;
  4. import com.example.dubbo.api.EchoService;
  5. import org.apache.dubbo.config.annotation.DubboService;
  7. @DubboService
  8. public class EchoServiceImpl implements EchoService {
  10.     @Override
  11.     public String echo(String s) {
  12.         return  s;
  13.     }
  14. }

其中，@org.apache.dubbo.config.annotation.Service是 Dubbo 服务注解，仅声明该 Java 服务（本地）实现为 Dubbo 服务。 因此，下一步需要将其配置 Dubbo 服务（远程）。

配置 Dubbo 服务提供方

  1. server:
  2.   port: 8081
  4. spring:
  5.   application:
  6.     name: dubbo-provider-sample
  7.   cloud:
  8.     nacos:
  9.       discovery:
  10.         server-addr: 127.0.0.1:8848
  11.         namespace: public
  12. dubbo:
  13.   scan:
  14.     base-packages: com.example.dubbo.provider.service
  15.   protocol:
  16.     name: dubbo
  17.     port: -1
  18.   cloud:
  19.     subscribed-services: ""

在暴露 Dubbo 服务方面，推荐开发人员外部化配置的方式，即指定 Java 服务实现类的扫描基准包。
Dubbo Spring Cloud 继承了 Dubbo Spring Boot 的外部化配置特性，也可以通过标注 @DubboComponentScan 来实现基准包扫描。
application.properties 的配置项说明：

  • dubbo.scan.base-packages: 指定 Dubbo 服务实现类的扫描基准包
  • dubbo.protocol: Dubbo 服务暴露的协议配置，其中子属性name为协议名称，port为协议端口（ -1 表示自增端口，从 20880 开始）
  • spring.application.name: Spring 应用名称，用于 Spring Cloud 服务注册和发现。

该值在 Dubbo Spring Cloud 加持下被视作dubbo.application.name，因此，无需再显示地配置dubbo.application.name

  • spring.cloud.nacos.discovery: Nacos 服务发现与注册配置，其中子属性 server-addr 指定 Nacos 服务器主机和端口

完成以上步骤后，还需编写一个 Dubbo Spring Cloud 引导类。

引导 Dubbo Spring Cloud 服务提供方应用

  1. package com.example.dubbo.provider;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
  7. @EnableDiscoveryClient
  8. @SpringBootApplication
  9. public class DubboProviderApplication {
  11.     public static void main(String[] args) {
  12.         SpringApplication.run(DubboProviderApplication.class, args);
  13.     }
  15. }

客户端开发

增加 api 依赖 - dubbo-sample-api

与服务提供方 Maven 工程类似，将 artifact dubbo-sample-api 依赖信息添加到应用 dubbo-consumer-sample 中的 pom.xml 

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>hello-spring-cloud-dubbo</artifactId>
  7.         <groupId>org.example</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>dubbo-consumer-sample</artifactId>
  14.     <properties>
  15.         <java.version>1.8</java.version>
  16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  17.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  18.     </properties>
  20.     <dependencies>
  21.         <dependency>
  22.             <groupId>org.springframework.boot</groupId>
  23.             <artifactId>spring-boot-starter-web</artifactId>
  24.         </dependency>
  25.         <dependency>
  26.             <groupId>com.alibaba.cloud</groupId>
  27.             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>com.alibaba.cloud</groupId>
  31.             <artifactId>spring-cloud-starter-dubbo</artifactId>
  32.         </dependency>
  34.         <!-- Dubbo 服务 artifact -->
  35.         <dependency>
  36.             <groupId>org.example</groupId>
  37.             <artifactId>dubbo-sample-api</artifactId>
  38.             <version>1.0-SNAPSHOT</version>
  39.         </dependency>
  40.     </dependencies>
  42.     <build>
  43.         <plugins>
  44.             <plugin>
  45.                 <groupId>org.apache.maven.plugins</groupId>
  46.                 <artifactId>maven-compiler-plugin</artifactId>
  47.                 <version>3.8.1</version>
  48.                 <configuration>
  49.                     <source>1.8</source>
  50.                     <target>1.8</target>
  51.                     <encoding>UTF-8</encoding>
  52.                 </configuration>
  53.             </plugin>
  54.             <plugin>
  55.                 <groupId>org.springframework.boot</groupId>
  56.                 <artifactId>spring-boot-maven-plugin</artifactId>
  57.                 <version>2.3.7.RELEASE</version>
  58.                 <executions>
  59.                     <execution>
  60.                         <id>repackage</id>
  61.                         <goals>
  62.                             <goal>repackage</goal>
  63.                         </goals>
  64.                     </execution>
  65.                 </executions>
  66.             </plugin>
  67.         </plugins>
  68.     </build>
  70. </project>

目录结构

  1. ├── pom.xml
  2. └── src
  3.     ├── main
  4.     │   ├── java
  5.     │   │   └── com
  6.     │   │       └── example
  7.     │   │           └── dubbo
  8.     │   │               └── consumer
  9.     │   │                   ├── DubboConsumerApplication.java
  10.     │   │                   └── controller
  11.     │   │                       └── EchoController.java
  12.     │   └── resources
  13.     │       └── application.yaml
  14.     └── test
  15.         └── java

restful

  1. package com.example.dubbo.consumer.controller;
  5. import org.apache.dubbo.config.annotation.DubboReference;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.RequestParam;
  8. import org.springframework.web.bind.annotation.RestController;
  9. import com.example.dubbo.api.EchoService;
  12. @RestController
  13. public class EchoController {
  15.     @DubboReference
  16.     private EchoService echoService;
  18.     // http://127.0.0.1:8080/echo?msg=hello
  19.     @GetMapping("/echo")
  20.     public String echo(@RequestParam(name = "msg", defaultValue = "hello world") String msg) {
  21.         return echoService.echo(msg);
  22.     }
  23. }

入口程序

  1. package com.example.dubbo.consumer;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
  7. @EnableDiscoveryClient
  8. @SpringBootApplication
  9. public class DubboConsumerApplication {
  11.     public static void main(String[] args) {
  12.         SpringApplication.run(DubboConsumerApplication.class, args);
  13.     }
  15. }