微服务网关 Soul搭建和集成SpringCloud+Nacos案例(二)

前情回顾

在微服务网关 Soul搭建和集成SpringCloud Nacos案例（一）中，主要讲解了Soul的搭建工作，在接下来的内容中，将要讲解关于Soul接入SpringCloud + Nacos项目示例。

Soul接入Spring Cloud + Nacos应用

一、接入架构图

二、搭建 Spring Cloud + Nacos 示例项目

1、使用IDEA快速搭建一个 Spring Cloud 示例

先使用IDEA快速搭建一个 Spring Cloud 示例项目，暂未接入 Soul 网关。如下图所示

2、接入Nacos服务注册中心

添加Nacos注册中心Maven依赖，如下：

		<dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

添加Nacos注册中心配置下：

spring:
  application:
    name: sping-soul-nacos
  cloud:
    nacos:
      # Nacos 服务发现与注册配置，其中子属性 server-addr 指定 Nacos 服务器主机和端口
      discovery:
        server-addr: 127.0.0.1:8848
      config:
        enabled: false #禁用nacos-config自动配置功能
        # 设置配置中心服务端地址
        server-addr: ${spring.cloud.nacos.discovery.server-addr}

启动类上添加服务注册注解：

@EnableDiscoveryClient
@SpringBootApplication
public class SpringSoulNacosApplication {

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

}

3、接入Soul

首先添加Soul的客户端依赖，依赖如下：

 <!-- 引入 Soul 针对 Spring Cloud 的集成的依赖 -->
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>soul-client-springcloud</artifactId>
            <version>2.1.2-RELEASE</version>
        </dependency>

添加Soul客户端配置信息

soul:
  # Soul 针对 SpringMVC 的配置项，对应 SoulSpringCloudConfig 配置类
  springcloud:
    admin-url: http://127.0.0.1:8082 # Soul Admin 地址
    context-path: /sc-user-service-api # 设置在 Soul 网关的路由前缀，例如说 /order、/product 等等。
    # 后续，网关会根据该 context-path 来进行路由
    app-name: ${spring.application.name} # 应用名。未配置情况下，默认使用 `spring.application.name` 配置项

需要在 Controller 的 HTTP API 方法上，添加 @SoulClient 注解，用于设置每个 API 方法对应的请求路径。这里，我们修改 UserController 类，添加该注解。代码如下：

@RestController
@RequestMapping("/user")
public class UserController {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping("/getUserInfo")
    @SoulClient(path = "/user/getUserInfo", desc = "获得用户信息")
    public String getUserInfo(@RequestParam("id") Integer id) {
        return "获得用户信息 ID:" + id;
    }

    @PostMapping("/addUser")
    @SoulClient(path = "/user/addUser", desc = "新增用户信息")
    public Integer addUser(@RequestBody UserCreateDTO createDTO) {
        logger.info("[addUser][username({}) password({})]", createDTO.getNickName(), createDTO.getGender());
        return 1;
    }

}

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class UserCreateDTO implements Serializable {
    private static final long serialVersionUID = 1L;

    private String nickName;

    private String gender;
}

@SoulClient 注解一共有三个属性：

• path：映射的 HTTP 接口的请求路径。
• desc：接口的描述，便于知道其用途。
• enable：是否开启，默认为 true 开启。

后续，在 Spring Cloud 应用启动时，Soul Client 会自动解析 @SoulClient 注解的 API 方法，写入方法的元数据到 Soul Admin 控制台，最终通知到 Soul Bootstrap 服务网关上。
示例Gitee地址：https://gitee.com/hepu_gitee/spring-soul-nacos.git

4、启动Spring Cloud示例项目

• ① 执行 SpringSoulNacosApplication启动 Spring Boot 应用。在 IDEA 控制台可以看到如下日志，看到写入 HTTP API 方法的元数据到 Soul Admin 控制台，启动后日志：

-05-29 10:29:01.147  WARN 6728 --- [           main] c.n.c.sources.URLConfigurationSource     : No URLs will be polled as dynamic configuration sources.
2020-05-29 10:29:01.147  INFO 6728 --- [           main] c.n.c.sources.URLConfigurationSource     : To enable URLs as dynamic configuration sources, define System property archaius.configurationSource.additionalUrls or make config.properties available on classpath.
2020-05-29 10:29:01.151  WARN 6728 --- [           main] c.n.c.sources.URLConfigurationSource     : No URLs will be polled as dynamic configuration sources.
2020-05-29 10:29:01.151  INFO 6728 --- [           main] c.n.c.sources.URLConfigurationSource     : To enable URLs as dynamic configuration sources, define System property archaius.configurationSource.additionalUrls or make config.properties available on classpath.
2020-05-29 10:29:01.274  INFO 6728 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2020-05-29 10:29:01.358  INFO 6728 --- [pool-1-thread-1] s.SoulSpringCloudClientBeanPostProcessor : springCloud client register success :{} {"appName":"sping-soul-nacos","path":"/sc-user-service-api/user/getUserInfo","pathDesc":"获得用户信息","rpcType":"springCloud","serviceName":"UserController","methodName":"getUserInfo","parameterTypes":"java.lang.Integer","rpcExt":"","enabled":true}
2020-05-29 10:29:01.375  INFO 6728 --- [pool-1-thread-1] s.SoulSpringCloudClientBeanPostProcessor : springCloud client register success :{} {"appName":"sping-soul-nacos","path":"/sc-user-service-api/user/addUser","pathDesc":"新增用户信息","rpcType":"springCloud","serviceName":"UserController","methodName":"addUser","parameterTypes":"com.hepu.springsoulnacos.controller.dto.UserCreateDTO","rpcExt":"","enabled":true}
2020-05-29 10:29:01.819  INFO 6728 --- [           main] o.s.s.c.ThreadPoolTaskScheduler          : Initializing ExecutorService
2020-05-29 10:29:02.597  INFO 6728 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8083 (http) with context path ''
2020-05-29 10:29:02.675  INFO 6728 --- [           main] c.a.c.n.registry.NacosServiceRegistry    : nacos registry, DEFAULT_GROUP sping-soul-nacos 10.0.23.129:8083 register finished
2020-05-29 10:29:02.999  INFO 6728 --- [           main] c.h.s.SpringSoulNacosApplication         : Started SpringSoulNacosApplication in 5.61 seconds (JVM running for 6.452)

• ② 使用浏览器，访问 http://127.0.0.1:8082/#/system/metadata 地址，进入「系统管理 -> 元数据」菜单，可以看到上述注册的元数据。如下图所示：