Nacos入门学习

Posted 2022-11-01 wu6660563

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Nacos入门学习相关的知识，希望对你有一定的参考价值。

Nacos

为什么是Nacos？既然有了Eureka、Consule，为什么还有Nacos？

Nacos 是一个更易于帮助构建云原生应用的动态服务发现、配置和服务管理平台，提供注册中心、配置中心和动态 DNS 服务三大功能。能够无缝对接Springcloud、Spring、Dubbo等流行框架

之前看直播中小马哥一直在推进这个项目SpringCloudAlibaba，其中最重要的就是Nacos。

我们需要知道Netflix OSS下的诸多重要组件先后宣布停止新功能开发的大背景，而Spring Cloud Alibaba是一个新生项目，正处于高速迭代中。

备注：此文档基本上学习官网备注

Nacos安装

下载

Nacos入门安装其实可以直接看官网，讲的非常直白和简单，下载最新的包，然后直接运行即可！
https://nacos.io/zh-cn/docs/quick-start.html

下载：

git clone https://github.com/alibaba/nacos.git
cd nacos/
mvn -Prelease-nacos clean install -U  
ls -al distribution/target/

// change the $version to your actual path
cd distribution/target/nacos-server-$version/nacos/bin

安装

Linux/Unix/Mac
启动命令(standalone代表着单机模式运行，非集群模式):

sh startup.sh -m standalone

如果您使用的是ubuntu系统，或者运行脚本报错提示[[符号找不到，可尝试如下运行：

bash startup.sh -m standalone

快速熟悉服务

服务注册

curl -X POST 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=nacos.naming.serviceName&ip=20.18.7.10&port=8080'

服务发现

curl -X GET 'http://127.0.0.1:8848/nacos/v1/ns/instance/list?serviceName=nacos.naming.serviceName'

发布配置

curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test&content=HelloWorld"

获取配置

curl -X GET "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test"

Nacos集成开发

Spring

集成Spring其实有一份很全的文档
https://github.com/nacos-group/nacos-spring-project/wiki/Nacos-Spring-Project-0.3.1-%E6%96%B0%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C

启动配置管理

添加依赖

<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-spring-context</artifactId>
    <version>$latest.version</version>
</dependency>

添加注解

添加 @EnableNacosConfig 注解启用 Nacos Spring 的配置管理服务。以下示例中，我们使用 @NacosPropertySource 加载了 dataId 为 example 的配置源，并开启自动更新

@Configuration
@EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
@NacosPropertySource(dataId = "example", autoRefreshed = true)
public class NacosConfiguration

使用@NacosValue

@Controller
@RequestMapping("config")
public class ConfigController 

    @NacosValue(value = "$useLocalCache:false", autoRefreshed = true)
    private boolean useLocalCache;

    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public boolean get() 
        return useLocalCache;

启动Tomcat
启动 Tomcat，调用 curl http://localhost:8080/config/get尝试获取配置信息。由于此时还未发布过配置，所以返回内容是 false
发布配置
curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example&group=DEFAULT_GROUP&content=useLocalCache=true"

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

启动服务发现

添加注解

<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-spring-context</artifactId>
    <version>$latest.version</version>
</dependency>

通过添加 @EnableNacosDiscovery 注解开启 Nacos Spring 的服务发现功能

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

使用 @NacosInjected 注入 Nacos 的 NamingService 实例

@Controller
@RequestMapping("discovery")
public class DiscoveryController 

    @NacosInjected
    private NamingService namingService;

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

启动 Tomcat
调用 curl http://localhost:8080/discovery/get?serviceName=example，此时返回为空 JSON 数组[]
注册服务
通过调用 Nacos Open API 向 Nacos server 注册一个名称为 example 服务

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

再次访问 curl http://localhost:8080/discovery/get?serviceName=example，此时返回内容为

[
  
    "instanceId": "127.0.0.1#8080#DEFAULT#example",
    "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": 
  
]

SpringBoot

启动配置管理

添加依赖

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

配置地址

nacos.config.server-addr=127.0.0.1:8848

使用 @NacosPropertySource 加载 dataId 为 example 的配置源，并开启自动更新

@SpringBootApplication
@NacosPropertySource(dataId = "example", autoRefreshed = true)
public class NacosConfigApplication 

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

通过 Nacos 的 @NacosValue 注解设置属性值。

@Controller
@RequestMapping("config")
public class ConfigController 

    @NacosValue(value = "$useLocalCache:false", autoRefreshed = true)
    private boolean useLocalCache;

    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public boolean get() 
        return useLocalCache;

启动 NacosConfigApplication，调用 curl http://localhost:8080/config/get，返回内容是 false
启动 NacosConfigApplication，调用 curl http://localhost:8080/config/get，返回内容是 false

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

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

启动服务发现

添加依赖

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

使用 @NacosInjected 注入 Nacos 的 NamingService 实例

@Controller
@RequestMapping("discovery")
public class DiscoveryController 

    @NacosInjected
    private NamingService namingService;

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


@SpringBootApplication
public class NacosDiscoveryApplication 

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

启动 NacosDiscoveryApplication，调用 curl http://localhost:8080/discovery/get?serviceName=example，此时返回为空 JSON 数组[]
注册服务
curl -X PUT 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=example&ip=127.0.0.1&port=8080'
再次访问 curl http://localhost:8080/discovery/get?serviceName=example，此时返回内容为

[
  
    "instanceId": "127.0.0.1-8080-DEFAULT-example",
    "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": 
  
]

SpringCloud

启动配置

添加依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>$latest.version</version>
</dependency>

配置Nacos应用地址和服务名

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

spring.application.name=example

通过 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新

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

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

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

首先通过调用 Nacos Open API 向 Nacos Server 发布配置：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"

运行 NacosConfigApplication，调用 curl http://localhost:8080/config/get，返回内容是 true
再次调用 Nacos Open API 向 Nacos server 发布配置：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"

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

启动服务发现

添加依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>$latest.version</version>
</dependency>

开启服务发现

@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;

配置服务消费者

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

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

集成负载均衡Ribbon

@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);

启动 ProviderApplication 和 ConsumerApplication ，调用 http://localhost:8080/echo/2018，返回内容为 Hello Nacos Discovery 2018

以上是关于Nacos入门学习的主要内容，如果未能解决你的问题，请参考以下文章

nacos入门配置学习

史上最全 SpringCloudAlibaba入门教程，从零开始带你深入♂学习——Nacos组件:环境配置