安装服务端地址
- https://nacos.io/zh-cn/docs/quick-start.html
- 参照官网下载源码来打包、安装
启动服务
- sh startup.sh -m standalone – 单机模式
- 集群模式省略
- 默认账号/密码 nacos/nacos
控制台地址
- http://localhost:8848/nacos/#
- 可以查看源码即可知道路径 同样可以修改端口等
- 界面介绍忽略 参照官网 https://nacos.io/zh-cn/docs/console-guide.html
使用Nacos搭建工程
- 项目结构
- 此处引入版本 0.2.1.RELEASE
<!-- 0.2.0.RELEASE存在bug https://github.com/alibaba/nacos/issues/930 -->
<!-- 错误描述 java.lang.IllegalStateException: failed to req API:/nacos/v1/ns/instance after all servers([127.0.0.1:8848]) -->
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>0.2.1.RELEASE</version>
- pom.xml配置请看码云地址 https://gitee.com/weigang200820/nacos-spring-boot
1、 provider模块
- [ ] 服务注册启动类 NacosProviderApplication
package com.zbj.nacos.provider;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
/**
* com.com.zbj.nacos.provider.NacosProviderApplication
*
* @author weigang
* @create 2019-07-25
**/
@SpringBootApplication
@EnableDiscoveryClient
public class NacosProviderApplication {
public static void main(String[] args) {
SpringApplication.run(NacosProviderApplication.class, args);
}
}
- 提供者对外暴露服务
package com.zbj.nacos.provider;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
/**
* EchoController
*
* @author weigang
* @create 2019-07-25
**/
@RestController
@RequestMapping("/echo")
public class EchoController {
@RequestMapping(value = "/{echo}", method = RequestMethod.GET)
public String echo(@PathVariable String echo) {
return "Hello Nacos discovery-> " + echo;
}
}
- 配置文件bootstrap.yml 注意这里不要配置在application.yml/properties中 有加载顺序原因
spring:
application:
name: nacos-provider
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
server:
port: 18080
2、 consumer模块
- 消费者启动类 NacosConsumerApplication
package com.zbj.nacos.consumer;
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.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
/**
* NacosConsumerApplication
*
* @EnableDiscoveryClient 能够让注册中心能够发现,扫描到该服务 第一版没有配置,导致 http://nacos-provider/echo/ 调不通
*
* @author weigang
* @create 2019-07-25
**/
@SpringBootApplication
@EnableDiscoveryClient
public class NacosConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(NacosConsumerApplication.class);
}
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate();
}
}
- 消费者对外服务 TestController
package com.zbj.nacos.consumer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
/**
* TestController
*
* @author weigang
* @create 2019-07-25
**/
@RestController
@RequestMapping("/echo")
public class TestController {
private RestTemplate restTemplate;
@Autowired
public TestController(RestTemplate restTemplate) {
this.restTemplate = restTemplate;
}
@RequestMapping(value = "/{str}", method = RequestMethod.GET)
public String echo(@PathVariable String str) {
return restTemplate.getForObject("http://nacos-provider/echo/" + str, String.class);
}
}
- 配置文件bootstrap.yml 注意这里不要配置在application.yml/properties中 有加载顺序原因
spring:
application:
name: nacos-conusmer
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
server:
port: 18081
3、 启动Provider和Consumer
-
提供者启动后 在控制台即可看到
-
提供者是集群 点击详情即可看到
-
消费者启动后 控制台展示
-
启动多个提供者或消费者(单机省事) 修改对应端口后 服务配置 -> Edit Configurations 如图 然后启动*(1)即可
-
订阅者列表
需要先访问 http://localhost:18081/echo/echo http://localhost:18082/echo/echo 后才能在控制台订阅者列表看到 注意 服务名称必须输入后 点击查询才能看到订阅者列表(这样设计也能理解)
4、 config模块
- 配置启动类 NacosConfigApplication
package com.zbj.nacos.config;
import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySources;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* NacosConfigApplication
* Document: https://nacos.io/zh-cn/docs/quick-start-spring-boot.html
* <p>
* Nacos 控制台添加配置:
* <p>
* Data ID:example
* <p>
* Group:DEFAULT_GROUP
* <p>
* 配置内容:useLocalCache=true
*
* @author weigang
* @create 2019-07-27
**/
@SpringBootApplication
@NacosPropertySources({
@NacosPropertySource(dataId = "example", autoRefreshed = true),
@NacosPropertySource(dataId = "zbj.demo", autoRefreshed = true)
})
public class NacosConfigApplication {
public static void main(String[] args) {
SpringApplication.run(NacosConfigApplication.class, args);
}
}
- 对外暴露服务 ConfigController
package com.zbj.nacos.config;
import com.alibaba.nacos.api.config.annotation.NacosConfigListener;
import com.alibaba.nacos.api.config.annotation.NacosValue;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* ConfigController
*
* @author weigang
* @create 2019-07-27
**/
@RestController
@RequestMapping("/config")
public class ConfigController {
@NacosValue(value = "${useLocalCache:false}", autoRefreshed = true)
private boolean useLocalCache;
@NacosValue(value = "${zbj.demo:1}", autoRefreshed = true)
private String zbjDemo;
@GetMapping("/get")
public boolean get() {
return useLocalCache;
}
@GetMapping("/demo")
public String demo() {
return zbjDemo;
}
@NacosConfigListener(dataId = "zbj.demo")
public void zbjDemo(String message){
System.out.println(message);
zbjDemo = message;
}
}
- 配置文件 application.yml
nacos:
config:
server-addr: 127.0.0.1:8848
- 启动 NacosConfigApplication
- 访问浏览器 返回false
http://localhost:8080/config/get
- 控制台编辑example配置项
- 再刷新刚才链接
- 再增加一个dataId zbj.demo
NacosConfigApplication 增加 @NacosPropertySource配置
ConfigController 增加属性配置,此处需要对zbj.demo赋初始值 否则启动异常
- 经测试 直接配置属性zbjDemo + autoRefreshed=true,再加上zbjDemo属性的getter和setter方法。修改控制台配置项后 值没有发生变化
- 增加Nacos配置监听器(@NacosConfigListener)
- 这样启动后,监听器检测到dataId(zbj.demo)值发生变化 则触发zbjDemo方法
注意 这里是客户端拉模式 客户端定时轮询,当配置的dataId发生变化 则触发事件
入口 NacosConfigService(Properties properties)
启动一个线程,每隔10ms检测是否有更新
- 设置默认值后 再通过将控制台的内容拉取到本地,并设置zbjDemo变量值,当启动时,调用这个配置的相关业务过大时,则读取到的配置都是默认值,应该放在应用启动时做这些个操作。也有可能姿势不对吧
- 应用启动成功后 十几秒才进入 zbjDemo方法
zbjDemo方法不能是private 这样不会触发监听事件
5、配置多个环境
- 多环境对应Namespace
- 将命名空间ID配置在application.yml中即可
nacos:
config:
namespace: 8eae6387-9199-4e14-8b0a-3d75156352fb
常见问题
- 由于刚开始搭建项目时,是单模块。后来通过new-> Module后(原代码没有删除) 导致provider模块依赖的包始终拉起不到
- 通过 Project Structure -> Project Setting -> Modules 如图所示
- 官方常见问题 https://nacos.io/zh-cn/docs/faq.html
源码地址 https://gitee.com/weigang200820/nacos-spring-boot
参考地址 https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-cloud-example
- 命名空间配置 https://www.alibabacloud.com/help/zh/doc-detail/59962.htm?spm=a2c63.p38356.b99.21.4c7ec123laCLaU
- https://mp.weixin.qq.com/s?__biz=MzA3MTQ2MDgyOQ==&mid=2247484167&idx=1&sn=a0b50779d871428ea09f956da0c07d82&chksm=9f2c71b5a85bf8a357c8aaa4feb306eede48af295d20aa3ad2597c0f37c705d36010166e3b2d&scene=38#wechat_redirect