SpringCloud学习之NACOS实现服务的注册与发现

Posted java构架师

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringCloud学习之NACOS实现服务的注册与发现相关的知识，希望对你有一定的参考价值。

nacos基本架构及概念

  • 服务 (Service)

    服务是指一个或一组软件功能（例如特定信息的检索或一组操作的执行），其目的是不同的客户端可以为不同的目的重用（例如通过跨进程的网络调用）。Nacos 支持主流的服务生态，如 Kubernetes Service、gRPC|Dubbo RPC Service 或者 Spring Cloud RESTful Service.

  • 服务注册中心 (Service Registry)

    服务注册中心，它是服务，其实例及元数据的数据库。服务实例在启动时注册到服务注册表，并在关闭时注销。服务和路由器的客户端查询服务注册表以查找服务的可用实例。服务注册中心可能会调用服务实例的健康检查 API 来验证它是否能够处理请求。

  • 服务元数据 (Service Metadata)

    服务元数据是指包括服务端点(endpoints)、服务标签、服务版本号、服务实例权重、路由规则、安全策略等描述服务的数据

  • 服务提供方 (Service Provider)

    是指提供可复用和可调用服务的应用方

  • 服务消费方 (Service Consumer)

    是指会发起对某个服务调用的应用方

  • 配置 (Configuration)

    在系统开发过程中通常会将一些需要变更的参数、变量等从代码中分离出来独立管理，以独立的配置文件的形式存在。目的是让静态的系统工件或者交付物（如 WAR，JAR 包等）更好地和实际的物理运行环境进行适配。配置管理一般包含在系统部署的过程中，由系统管理员或者运维人员完成这个步骤。配置变更是调整系统运行时的行为的有效手段之一。

  • 配置管理 (Configuration Management)

    在数据中心中，系统中所有配置的编辑、存储、分发、变更管理、历史版本管理、变更审计等所有与配置相关的活动统称为配置管理。

  • 名字服务 (Naming Service)

    提供分布式系统中所有对象(Object)、实体(Entity)的“名字”到关联的元数据之间的映射管理服务，例如 ServiceName -> Endpoints Info, Distributed Lock Name -> Lock Owner/Status Info, DNS Domain Name -> IP List, 服务发现和 DNS 就是名字服务的2大场景。

  • 配置服务 (Configuration Service)

    在服务或者应用运行过程中，提供动态配置或者元数据以及配置管理的服务提供者。

以上引自nacos官方文档

前提准备

安装

使用Nacos作为应用的服务注册中心之前，需要下载的Nacos并启动Nacos Server。

这一点与Eureka的使用有所的区别。因为SpringCloud原生支持Eureka，Eureka Server 采用的是Peer to Peer（点对点） 对等通信，是一种去中心化的架构。所以Euraka只需通过@EnableEurekaServer注解，就能把一个服务实例启用为服务注册中心

启动
  • Linux/Unix/Mac：sh startup.sh -m standalone
  • Windows：cmd startup.cmd -m standalone
  1. nacos可以以单机和集群两种模式启动，分别对应-m standalone和-m cluster
  2. startup.sh或startup.cmd脚本位于Nacos解压后的bin目录下，启动之后访问http://127.0.0.1:8848/nacos/，可看到Nacos的服务管理界面如下

应用注册

一旦nacos启动成功，意味着我们已经有了一个服务注册中心了，接下来我们将来分别创建服务提供者·alibaba-nacos-discovery-server和服务消费者alibaba-nacos-discovery-client-common，分别演示服务的注册与发现

服务提供方

目录结构如下：

pom.xml依赖配置如以下：

 <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.2</version>
        <optional>true</optional>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.SR1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>0.2.2.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

启动类增加@EnableDiscoveryClient注解，开启Spring Cloud的服务注册与发现

@EnableDiscoveryClient
@SpringBootApplication
public class AlibabaNacosDiscoveryServerApplication {

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

}

提供接口服务TestController：

@RestController
public class TestController {

    private static Logger log = LoggerFactory.getLogger(TestController.class);

    @GetMapping("/hello")
    public String hello(@RequestParam String name) {
        log.info("invoked name = " + name);
        return "hello " + name;
    }
}

新增配置：

# 应用名
spring.application.name=alibaba-nacos-discovery-server
# 端口
server.port=8001
# Nacos服务注册中心地址
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

启动：

INFO 25148 --- [           main] o.s.c.a.n.registry.NacosServiceRegistry  : nacos registry, alibaba-nacos-discovery-server 192.168.10.211:8001 register finished

访问nacos管理页面：

服务消费方

目录结构如下：

pom.xml依赖配置如以下：

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Finchley.SR1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>0.2.2.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.2</version>
        <optional>true</optional>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-webflux</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

启动类增加@EnableDiscoveryClient注解，开启Spring Cloud的服务注册与发现，添加@EnableFeignClients注解，用于controller里多种调用方式演示

@EnableDiscoveryClient
@SpringBootApplication
public class AlibabaNacosDiscoveryServerApplication {

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

}

提供接口服务TestController，提供多种服务调用方式，分别为Feign、RestTemplate、WebClient：

@RestController
public class TestController {

    @Autowired
    private LoadBalancerClient loadBalancerClient;

    @Autowired
    private RestTemplate restTemplate;

    @Autowired
    private WebClient.Builder webClientBuilder;

    @Autowired
    private TestFeignClient client;
    
    /* original */
    @GetMapping("/test")
    public String test() {
        // 通过spring cloud common中的负载均衡接口选取服务提供节点实现接口调用
        ServiceInstance serviceInstance = loadBalancerClient.choose("alibaba-nacos-discovery-server");
        String url = serviceInstance.getUri() + "/hello?name=" + "gaohb";
        RestTemplate restTemplate = new RestTemplate();
        String result = restTemplate.getForObject(url, String.class);
        return "Invoke : " + url + ", return : " + result;
    }

    /* feign */
    @GetMapping("/testFeign")
    public String testFeign() {
        String result = client.hello("gaohb");
        return "Return : " + result;
    }

    /* RestTemplate */
    @GetMapping("/testRestTemplate")
    public String testRestTemplate() {
        String result = restTemplate.getForObject("http://alibaba-nacos-discovery-server/hello?name=gaohb", String.class);
        return "Return : " + result;
    }
    
    /* webClient */
    @GetMapping("/testWebClient")
    public Mono<String> testWebClient() {
        Mono<String> result = webClientBuilder.build()
                .get()
                .uri("http://alibaba-nacos-discovery-server/hello?name=gaohb")
                .retrieve()
                .bodyToMono(String.class);
        return result;
    }
    
}

新增feign客户端TestFeignClient，用于声明式调用服务演示：

@FeignClient("alibaba-nacos-discovery-server")
public interface TestFeignClient {

    @GetMapping("/hello")
    String hello(@RequestParam(name = "name") String name);
}

另外是RestTemplate 和 WebClient.Builder注册到Spring容器，用于RestTemplate和WebClient.Builder两种服务调用方式演示

@Configuration
public class TestConfig {

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

    @Bean
    @LoadBalanced
    public WebClient.Builder loadBalancedWebClientBuilder() {
        return WebClient.builder();
    }

}

新增配置：

# 应用名
spring.application.name=alibaba-nacos-discovery-client-common
# 端口
server.port=9000
# Nacos服务注册中心地址
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

启动：

INFO 25148 --- [           main] o.s.c.a.n.registry.NacosServiceRegistry  : nacos registry, alibaba-nacos-discovery-common 192.168.10.211:9000 register finished

访问nacos管理页面，服务也正常注册：

访问

http://localhost:9000/test
http://localhost:9000/testFeign
http://localhost:9000/testRestTemplate
http://localhost:9000/testWebClient

可以看到服务正常调用，结果分别如下：

Invoke : http://your_ip:8001/hello?name=AceLin_H, return : hello AceLin_H
Return : hello AceLin_H
Return : hello AceLin_H
hello AceLin_H

以上是关于SpringCloud学习之NACOS实现服务的注册与发现的主要内容，如果未能解决你的问题，请参考以下文章

SpringCloud学习之整合eureka

SpringCloud学习之Hystrix请求熔断与服务降级

SpringCloud学习之六：使用Spring Cloud Bus自动刷新配置

SpringCloud学习之Config—动态更新配置

SpringCloud学习之服务注册中心

SpringCloud学习之SpringCloudStream&集成kafka