Spring Cloud Alibaba(1) 实现服务注册与发现 Nacos Discovery

程序员文章站 2022-07-15 10:16:41

...

文章目录

1. 什么是 Nacos？

Nacos 的关键特性

2. 安装 Nacos
3. 接入Nacos注册中心

项目构建
服务提供者
服务消费者

文章所有参考代码都已上传GitHub：https://github.com/Djnsakn/spring-cloud-alibaba-learning
本系列环境：Intellij IDEA 2019.1.1、JDK 1.8、Spring Boot 2.1.8.RELEASE、Spring Cloud Greenwich.SR3

1. 什么是 Nacos？

Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。

Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。 Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。

使用 Nacos 简化服务发现、配置管理、服务治理及管理的解决方案，让微服务的发现、管理、共享、组合更加容易。

Nacos 的关键特性

服务发现和服务健康监测
动态配置服务
动态 DNS 服务
服务及其元数据管理

2. 安装 Nacos

使用之前请先查看版本说明。
下载地址：https://github.com/alibaba/nacos/releases
本文版本：1.2.1
下载完成后，解压，然后启动服务器，startup.sh脚本位于Nacos解压后的bin目录下：
Linux/Unix/Mac
启动命令(standalone代表着单机模式运行，非集群模式):
sh startup.sh -m standalone
如果您使用的是ubuntu系统，或者运行脚本报错提示[[符号找不到，可尝试如下运行：
bash startup.sh -m standalone
Windows
启动命令：
cmd startup.cmd
或者双击startup.cmd运行文件。
启动完成之后，访问：http://127.0.0.1:8848/nacos/，可以进入Nacos的服务管理页面，如下：
Spring Cloud Alibaba(1) 实现服务注册与发现 Nacos Discovery

3. 接入Nacos注册中心

项目构建

本文的项目结构如下：
Spring Cloud Alibaba(1) 实现服务注册与发现 Nacos Discovery
依次创建maven父子项目，具体代码可参考
https://github.com/Djnsakn/spring-cloud-alibaba-learning

服务提供者

第一步：创建module，命名为：nacos-spring-cloud-provider-example 。
第二步：添加依赖，本文的 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">
    <parent>
        <artifactId>nacos-spring-cloud-discovery-example</artifactId>
        <groupId>com.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>nacos-spring-cloud-provider-example</artifactId>

    <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>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>5.1.0.Final</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

第三步：创建应用主类：

package com.alibaba.nacos.example.spring.cloud;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@SpringBootApplication
@EnableDiscoveryClient  // 通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能
public class NacosProviderApplication {

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

	@Value("${server.port}")
	String port;

	@RestController
	class EchoController {
		@RequestMapping("/echo")
		public String echo(String name) {
			return "Hello Nacos Discovery " + name + " port:" + port;
		}
	}
}

第四步：配置服务名称和Nacos地址

#server.port=8070
spring.application.name=service-provider
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

第五步：启动上面创建的应用。启动 --server.port=8070和 --server.port=8071 两个实例。
Spring Cloud Alibaba(1) 实现服务注册与发现 Nacos Discovery

在启动都ok之后，我们可以访问Nacos的管理页面http://127.0.0.1:8848/nacos/来查看服务列表，此时可以看到如下内容：

服务消费者

第一步：创建module，命名为：nacos-spring-cloud-consumer-example 。
第二步：添加依赖，本文的 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">
    <parent>
        <artifactId>nacos-spring-cloud-discovery-example</artifactId>
        <groupId>com.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>nacos-spring-cloud-consumer-example</artifactId>

    <properties>
        <spring-cloud-openfeign.version>2.0.0.RELEASE</spring-cloud-openfeign.version>
        <spring-cloud-netflix.version>2.0.0.RELEASE</spring-cloud-netflix.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
            <version>${spring-cloud-netflix.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
            <version>${spring-cloud-openfeign.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>com.alibaba.nacos</groupId>
                    <artifactId>nacos-client</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

第三步：应用主类为：

package com.alibaba.nacos.example.spring.cloud;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.context.annotation.Bean;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
@EnableFeignClients  // 使用Feign
@EnableDiscoveryClient  // 通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能
public class NacosConsumerApplication {

    @LoadBalanced  // 给 RestTemplate 实例添加 @LoadBalanced 注解，开启 @LoadBalanced 与 Ribbon 的集成
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

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

    // 使用过RestTemplate来向服务的某个具体实例发起HTTP请求
    @RestController
    public class TestController {

        private final RestTemplate restTemplate;

        @Autowired
        public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}

        @RequestMapping(value = "/echo", method = RequestMethod.GET)
        public String echo(String name) {
            return restTemplate.getForObject("http://service-provider/echo?name=" + name, String.class);
        }
    }


    // 使用Feign
    @RestController
    static class TestControllerFeign {

        @Autowired
        Client client;

        @GetMapping("/test")
        public String test(String name) {
            return client.hello(name);
        }
    }


    @FeignClient("service-provider")
    interface Client {

        @RequestMapping(value = "/echo", method = RequestMethod.GET)
        String hello(@RequestParam(name = "name") String name);

    }
}

第四步：配置服务名称和Nacos地址，让服务消费者可以发现上面已经注册到Nacos的服务。

server.port=8080
spring.application.name=service-consumer
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

第五步：启动服务消费者，然后通过curl或者postman等工具发起访问，或者直接在浏览器输入，下面以curl为例：
Spring Cloud Alibaba(1) 实现服务注册与发现 Nacos Discovery
可以看到，两次不同请求的时候，真正实际调用的服务提供者实例是不同的，也就是说，通过LoadBalancerClient接口在获取服务实例的时候，已经实现了对服务提供方实例的负载均衡。
具体代码可参考
https://github.com/Djnsakn/spring-cloud-alibaba-learning