手把手教你Spring Cloud Alibaba（一） 集成 Nacos 、Dubbo构建项目

一、背景与项目说明

用Dubbo构建项目的微服务好处就是底层的服务可以集中在一块，上层代码消费者（Consumer）直接像使用本地代码一样使用服务。

我们用Nacos作为服务的注册与发现, 方便管理与调用。我们用最简单的项目来说明这个问题，项目有三个子模块：

• api

  提供服务，与领域实体。 在真正的项目中，做好领域数据的集中管理与划分是衡量一个架构师的其中一个方面

• provider

  真正服务的实现者，通过注解 @DubboService 提供对外的微服务组件的提供者（provider）

• consumer

  服务的使用者，通过注解 @DubboReference ，就要调用本地服务一样方便。

本项目我们采用的技术栈如下：

• JDK >= 17
• Spring Boot 3.X
• 相应的 Spring Cloud Alibaba
• Nacos 服务 2.X 版本，其默认端口是 8848。（注：Nacos 3.X已经发表，但端口与其他使用上略有些不同）

借助 AI 的提示词：

JDK版本17，Spring Cloud Alibaba 集成 Nacos 、构建一个最简单的Dubbo 服务项目，共有三个字模块：api、provider consumer。 

二、模块与代码构成

1. 父模块，取名为dubbo-demo(实际开发中其实就是你的正式项目)，统一管理版本控制与常用依赖。 其 pom.xml:

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
   
       <groupId>com.example</groupId>
       <artifactId>dubbo-demo</artifactId>
       <version>1.0-SNAPSHOT</version>
       <modules>
           <module>api</module>
           <module>provider</module>
           <module>consumer</module>
       </modules>
       <packaging>pom</packaging>
   
       <!-- 版本管理 -->
       <properties>
           <spring.boot.version>2.7.18</spring.boot.version>
           <spring.cloud.alibaba.version>2021.0.5.0</spring.cloud.alibaba.version>
           <lombok.version>1.18.28</lombok.version>
       </properties>
   
       <!-- 依赖管理 -->
       <dependencyManagement>
           <dependencies>
               <!-- Spring Boot 依赖管理 -->
               <dependency>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-dependencies</artifactId>
                   <version>${spring.boot.version}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
   
               <!-- Spring Cloud Alibaba 依赖管理 -->
               <dependency>
                   <groupId>com.alibaba.cloud</groupId>
                   <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                   <version>${spring.cloud.alibaba.version}</version>
                   <type>pom</type>
                   <scope>import</scope>
               </dependency>
   
   
               <!-- Lombok -->
               <dependency>
                   <groupId>org.projectlombok</groupId>
                   <artifactId>lombok</artifactId>
                   <version>${lombok.version}</version>
                   <optional>true</optional>
               </dependency>
           </dependencies>
       </dependencyManagement>
   
       <!-- 公共依赖 -->
       <dependencies>
           <!-- Lombok（编译时注解） -->
           <dependency>
               <groupId>org.projectlombok</groupId>
               <artifactId>lombok</artifactId>
               <optional>true</optional>
           </dependency>
   
       </dependencies>
   
       <build>
           <plugins>
               <plugin>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-maven-plugin</artifactId>
                   <version>${spring.boot.version}</version>
               </plugin>
           </plugins>
       </build>
   
   </project>
   

   api 模块

   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <parent>
           <artifactId>dubbo-demo</artifactId>
           <groupId>com.example</groupId>
           <version>1.0-SNAPSHOT</version>
       </parent>
       <modelVersion>4.0.0</modelVersion>
       <artifactId>api</artifactId>
   </project>
   

   服务接口类：

   package com.example.service;
   
   public interface HelloService {
       String sayHello(String name);
   }
   

2. provider 模块

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
            http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <parent>
           <artifactId>dubbo-demo</artifactId>
           <groupId>com.example</groupId>
           <version>1.0-SNAPSHOT</version>
       </parent>
       <modelVersion>4.0.0</modelVersion>
   
       <artifactId>provider</artifactId>
   
       <dependencies>
           <!-- 服务接口模块 -->
           <dependency>
               <groupId>com.example</groupId>
               <artifactId>api</artifactId>
               <version>1.0-SNAPSHOT</version>
           </dependency>
   
           <!-- Spring Boot Web -->
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-web</artifactId>
           </dependency>
   
           <!-- Spring Cloud Alibaba Nacos 服务发现 -->
           <dependency>
               <groupId>com.alibaba.cloud</groupId>
               <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
           </dependency>
   
           <!-- Spring Cloud Dubbo -->
           <dependency>
               <groupId>org.apache.dubbo</groupId>
               <artifactId>dubbo-spring-boot-starter</artifactId>
               <version>3.2.11</version>
           </dependency>
   
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-actuator</artifactId>
           </dependency>
   
       </dependencies>
   </project>
   

   Spring配置

   server:
     port: 8081
   
   spring:
     application:
       name: dubbo-provider
     cloud:
       nacos:
         discovery:
           server-addr: 127.0.0.1:8848
   
   dubbo:
     scan:
       base-packages: com.example.service.impl  # 服务实现类包路径
     protocol:
       name: dubbo
       port: -1  # 随机端口
     registry:
       address: nacos://127.0.0.1:8848
   

   服务实现类，注意注解 @DubboService：

   package com.example.service.impl;
   
   import com.example.service.HelloService;
   import org.apache.dubbo.config.annotation.DubboService;
   
   @DubboService  // Dubbo 服务暴露
   public class HelloServiceImpl implements HelloService {
       @Override
       public String sayHello(String name) {
           return "Hello, " + name + "! 来自 Dubbo 服务提供者";
       }
   }
   

   启动类：

   package com.example.service.impl.com.example;
   
   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   
   @SpringBootApplication
   public class ProviderApplication {
       public static void main(String[] args) {
           SpringApplication.run(ProviderApplication.class, args);
       }
   }
   

3. consumer 模块

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <parent>
           <artifactId>dubbo-demo</artifactId>
           <groupId>com.example</groupId>
           <version>1.0-SNAPSHOT</version>
       </parent>
       <modelVersion>4.0.0</modelVersion>
   
       <artifactId>consumer</artifactId>
   
       <dependencies>
           <!-- API模块依赖 -->
           <dependency>
               <groupId>com.example</groupId>
               <artifactId>api</artifactId>
               <version>1.0-SNAPSHOT</version>
           </dependency>
   
           <!-- Spring Boot Web -->
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-web</artifactId>
           </dependency>
   
           <!-- Spring Cloud Alibaba Nacos 服务注册发现 -->
           <dependency>
               <groupId>com.alibaba.cloud</groupId>
               <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
           </dependency>
   
           <dependency>
               <groupId>org.apache.dubbo</groupId>
               <artifactId>dubbo-spring-boot-starter</artifactId>
               <version>3.2.11</version>
           </dependency>
       </dependencies>
   </project>
   

   server:
     port: 8082
   
   spring:
     application:
       name: dubbo-consumer
     cloud:
       nacos:
         discovery:
           server-addr: 127.0.0.1:8848
   
   dubbo:
     registry:
       address: nacos://127.0.0.1:8848
     cloud:
       subscribed-services: dubbo-provider  # 要调用的服务名（provider的application.name）
   

   服务使用者类：HelloController

package com.example.controller;

import com.example.service.HelloService;
import org.apache.dubbo.config.annotation.DubboReference;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @DubboReference  // 远程注入Dubbo服务
    private HelloService helloService;

    @GetMapping("/hello/{name}")
    public String hello(@PathVariable String name) {
        return helloService.sayHello(name);
    }
}

启动类：

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }
}

三、Nacos服务的准备

①. 去 Nacos的官网下载页面 :

https://nacos.io/download/nacos-server/

选择 2.x 的压缩包进行下载，如图：

②. 解压缩后，在nacos\bin的目录使用命令行启动 :

startup.cmd -m standalone

③. 登录 Nacos 页面 : http://localhost:8848/nacos 。 如图登录成功

四、代码的功能验证

启动顺序：

启动 Nacos（localhost:8848）

启动 dubbo-provider

启动 dubbo-consumer

浏览器访问：

http://localhost:8082/hello/world

返回：

Hello, world! 来自 Dubbo 服务提供者