SpringCloud 基于 Nacos 的注册中心

共 7587字，需浏览 16分钟

· 2021-05-05

所谓注册中心，其实是分布式架构演进过程中的产物，在系统中充当一个协调者的角色。

Nacos 结合 Spring

0x01：添加 maven 依赖

<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-spring-context</artifactId>
    <version>0.2.2-RC1</version>
</dependency>

0x02：开启服务发现功能

使用 @EnableNacosDiscovery 开启 Nacos Spring 的服务发现功能

@Configuration
@EnableNacosDiscovery(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
public class NacosDiscovery {

}

使用 @NacosInjected 注入 Nacos 的NamingService实例，通过 NamingService的 registerInstance() 向 Nacos Server 注册一个名称为 applicationName 的服务，当然也可以通过 Nacos Open API 方式注册：

curl -X PUT 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=XXX&ip=XXX&port=XXX'

这里介绍使用代码的方式

@Configuration
@EnableNacosDiscovery(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
public class NacosDiscovery {

    @NacosInjected
    private NamingService namingService;

    @Value("${server.port}")
    private int serverPort;

    @Value("${spring.application.name}")
    private String applicationName;

    @PostConstruct
    public void registerInstance() throws NacosException {
        namingService.registerInstance(applicationName, "127.0.0.1", serverPort);
    }
}

0x03：编写Controller

编写一个 Controller 来验证服务是否再 Nacos Server 上注册了，代码如下：

@RestController
@RequestMapping(value = "discovery")
public class NacosDiscoveryController {

    @NacosInjected
    private NamingService namingService;

    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public List<Instance> getInstance(@RequestParam String serviceName) throws NacosException {
        return namingService.getAllInstances(serviceName);
    }
}

启动 Nacos Server，安装及启动方式可以参考【 Nacos源码编译】

然后启动 Tomcat，我们先来看看 Nacos 控制台有什么变化

在控制台上，可以看到名为 nacos-spring-discovery 服务实例，点击详情按钮查看实例的详细信息：

在浏览器上访问

http://127.0.0.1:8080/discovery/get?serviceName=nacos-spring-discovery

返回结果如下

[{
    "instanceId": "127.0.0.1#8080#{\"defaultCheckPort\":80,\"defaultPort\":80,\"healthChecker\":{\"type\":\"TCP\"},\"metadata\":{},\"name\":\"\",\"useIPPort4Check\":true}#nacos-spring-discovery",
    "ip": "127.0.0.1",
    "port": 8080,
    "weight": 1.0,
    "healthy": true,
    "cluster": {
        "serviceName": null,
        "name": "",
        "healthChecker": {
            "type": "TCP"
        },
        "defaultPort": 80,
        "defaultCheckPort": 80,
        "useIPPort4Check": true,
        "metadata": {}
    },
    "service": null,
    "metadata": {}
}]

和刚才在控制台看到的数据是一致的。以上就是 Nacos 结合 Spring 的实现方式，那么 Nacos 结合 Spring Boot 呢？其实没什么太大区别。

Nacos 结合 Spring Boot

0x01：添加 Starter 依赖

<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>nacos-discovery-spring-boot-starter</artifactId>
    <version>0.2.1</version>
</dependency>

注意，版本 0.2.x.RELEASE 对应的是 Spring Boot 2.x 版本，版本 0.1.x.RELEASE 对应的是 Spring Boot 1.x 版本。

0x02：在 application.properties 中添加如下配置信息

server.port=8080
spring.application.name=nacos-springboot-discovery
nacos.discovery.server-addr=127.0.0.1:8848

0x03：添加 NacosDiscoveryApplication 启动类

使用 @NacosInjected 注入 Nacos 的 NamingService 实例，通过 NamingService 的registerInstance() 向 Nacos Server 注册一个名称为 applicationName 的服务

@SpringBootApplication
public class NacosDiscoveryApplication {

    @NacosInjected
    private NamingService namingService;

    @Value("${server.port}")
    private int serverPort;

    @Value("${spring.application.name}")
    private String applicationName;

    @PostConstruct
    public void registerInstance() throws NacosException {
        namingService.registerInstance(applicationName, "127.0.0.1", serverPort);
    }

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

}

添加 NacosDiscoveryController 类

@RestController
@RequestMapping(value = "discovery")
public class NacosDiscoveryController {

    @NacosInjected
    private NamingService namingService;

    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public List<Instance> getInstance(@RequestParam String serviceName) throws NacosException {
        return namingService.getAllInstances(serviceName);
    }
}

启动 NacosDiscoveryApplication，观察 Nacos 控制台

在浏览器上访问

http://127.0.0.1:8080/discovery/get?serviceName=nacos-springboot-discovery

返回结果如下

[{
    "instanceId": "127.0.0.1#8080#{\"defaultCheckPort\":80,\"defaultPort\":80,\"healthChecker\":{\"type\":\"TCP\"},\"metadata\":{},\"name\":\"\",\"useIPPort4Check\":true}#nacos-springboot-discovery",
    "ip": "127.0.0.1",
    "port": 8080,
    "weight": 1.0,
    "healthy": true,
    "cluster": {
        "serviceName": null,
        "name": "",
        "healthChecker": {
            "type": "TCP"
        },
        "defaultPort": 80,
        "defaultCheckPort": 80,
        "useIPPort4Check": true,
        "metadata": {}
    },
    "service": null,
    "metadata": {}
}]