10、Nacos Spring Cloud

本文主要面向 Spring Cloud 的使用者,通过两个示例来介绍如何使用 Nacos 来实现分布式环境下的配置管理和服务注册发现。

关于Nacos Spring Cloud 的详细文档请参看:Nacos ConfigNacos Discovery

  • 通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-config 实现配置的动态变更。
  • 通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-discovery 实现服务的注册与发现。

前提条件

您需要先下载 Nacos 并启动 Nacos server。操作步骤参见 Nacos 快速入门

启动配置管理

启动了Nacos server 后,您就可以参考以下示例代码,为您的 Spring Cloud 应用启动 Nacos 配置管理服务了。完整示例代码请参考:nacos-spring-cloud-config-example

1、 添加依赖:

<dependency> 
    <groupId>com.alibaba.cloud</groupId> 
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> 
    <version>${latest.version}</version> 
</dependency> 

注意:版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本,版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。

更多版本对应关系参考:版本说明 Wiki

1、bootstrap.properties中配置Nacosserver的地址和应用名;

spring.cloud.nacos.config.server-addr=127.0.0.1:8848 

spring.application.name=example 

说明:之所以需要配置 spring.application.name ,是因为它是构成 Nacos 配置管理 dataId字段的一部分。

在Nacos Spring Cloud 中,dataId 的完整格式如下:

${prefix}-${spring.profile.active}.${file-extension} 
  • prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
  • spring.profile.active 即为当前环境对应的 profile,详情可以参考 Spring Boot文档注意:当 spring.profile.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成 ${prefix}.${file-extension}
  • file-exetension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

1、 通过SpringCloud原生注解@RefreshScope实现配置自动更新:

@RestController 
@RequestMapping("/config") 
@RefreshScope 
public class ConfigController { 

    @Value("${useLocalCache:false}") 
    private boolean useLocalCache; 

    @RequestMapping("/get") 
    public boolean get() { 
        return useLocalCache; 
    } 
} 

1、 首先通过调用NacosOpenAPI向NacosServer发布配置:dataId为example.properties,内容为useLocalCache=true

curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=true" 

1、 运行NacosConfigApplication,调用curlhttp://localhost:8080/config/get,返回内容是true
2、 再次调用NacosOpenAPI向Nacosserver发布配置:dataId为example.properties,内容为useLocalCache=false

curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=false" 

1、 再次访问http://localhost:8080/config/get,此时返回内容为false,说明程序中的useLocalCache值已经被动态更新了;

启动服务发现

本节通过实现一个简单的 echo service 演示如何在您的 Spring Cloud 项目中启用 Nacos 的服务发现功能,如下图示:

 

完整示例代码请参考:nacos-spring-cloud-discovery-example

1、 添加依赖:

<dependency> 
    <groupId>com.alibaba.cloud</groupId> 
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> 
    <version>${latest.version}</version> 
</dependency> 

注意:版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本,版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。

更多版本对应关系参考:版本说明 Wiki

1、 配置服务提供者,从而服务提供者可以通过Nacos的服务注册发现功能将其服务注册到Nacosserver上;

i.在 application.properties 中配置 Nacos server 的地址:

server.port=8070 
spring.application.name=service-provider 

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 

ii.通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能:

@SpringBootApplication 
@EnableDiscoveryClient 
public class NacosProviderApplication { 

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

    @RestController 
    class EchoController { 
        @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET) 
        public String echo(@PathVariable String string) { 
            return "Hello Nacos Discovery " + string; 
        } 
    } 
} 

1、 配置服务消费者,从而服务消费者可以通过Nacos的服务注册发现功能从Nacosserver上获取到它要调用的服务;

i.在 application.properties 中配置 Nacos server 的地址:

server.port=8080 
spring.application.name=service-consumer 

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 

ii.通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能。给 RestTemplate 实例添加 @LoadBalanced 注解,开启 @LoadBalancedRibbon 的集成:

@SpringBootApplication 
@EnableDiscoveryClient 
public class NacosConsumerApplication { 

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

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

    @RestController 
    public class TestController { 

        private final RestTemplate restTemplate; 

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

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

1、 启动ProviderApplicationConsumerApplication,调用http://localhost:8080/echo/2018,返回内容为HelloNacosDiscovery2018

相关项目

版权声明:「DDKK.COM 弟弟快看,程序员编程资料站」本站文章,版权归原作者所有