在最近服务器网站的搭建过程中,使用的springcloud框架,主要使用nacos作为服务注册和发现,同时使用nacos作为项目的配置中心,管理项目的所有配置,使用热部署,让配置文件在更新的时候,可以不重启服务
Nacos概念(Concepts)
命名空间(Namespace)
不同命名空间可以作为生产和开发环境的隔离。
配置(Configuration)
系统中一些配置信息可以注册到Nacos进行管理;
利用Nacos进行配置的动态发布。
配置管理(Configuration Management)
系统配置的编辑、存储、分发、变更管理、历史版本管理、变更审计等所有与配置相关的活动。
配置ID和配置分组(Data ID & Group)
配置ID作为配置的唯一标识;
配置分组内可以有多个配置ID,形成一个配置集。
服务名(Service)
注册服务的唯一标识。
服务注册中心(Service Registry)
存储服务实例和服务负载均衡策略的数据库。
服务发现(Service Discovery)
在计算机网络上,(通常使用服务名)对服务下的实例的地址和元数据进行探测,并以预先定义的接口提供给客户端进行查询。
服务分组(Service Group)
不同的服务可以归类到同一分组。
虚拟集群(Virtual Cluster)
同一个服务下的所有服务实例组成一个默认集群, 集群可以被进一步按需求划分,划分的单位可以是虚拟集群。
实例(Instance)
提供一个或多个服务的具有可访问网络地址(IP:Port)的进程。
权重(Weight)
实例级别的配置。权重为浮点数。权重越大,分配给该实例的流量越大。
健康检查(Health Check)
通过TCP/HTTP的方式检查服务下某实例的健康度,从而确定该实例是否能够提供服务,对于不健康的实例服务端则不会返回。
健康保护阈值(Protect Threshold)
为了防止因过多实例 (Instance) 不健康导致流量全部流向健康实例 (Instance) ,继而造成流量压力把健康 健康实例 (Instance) 压垮并形成雪崩效应,应将健康保护阈值定义为一个 0 到 1 之间的浮点数。当域名健康实例 (Instance) 占总服务实例 (Instance) 的比例小于该值时,无论实例 (Instance) 是否健康,都会将这个实例 (Instance) 返回给客户端。这样做虽然损失了一部分流量,但是保证了集群的剩余健康实例 (Instance) 能正常工作。
Nacos部署
Nacos获取
通过源码或者发行包获取。
从 Github 上下载源码方式
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
Nacos部署
nacos只支持mysql数据库
安装步骤如下:
安装数据库,版本要求:5.6.5+
初始化mysql数据库,数据库初始化文件:nacos-mysql.sql
修改conf/application.properties文件,添加mysql数据源的url、用户名和密码。
spring.datasource.platform=mysql
db.num=1
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=user_name
db.password=pwd
Nacos启动
sh startup.sh -m standalone
Nacos访问
http://10.142.73.201:8080/nacos/index.html
默认用户名:nacos
默认密码:nacos
Open API
这里仅列举项目中用到的一些API,更丰富的API详情可参考官方文档
获取配置列表
请求类型
GET
请求URL
/nacos/v1/cs/configs?search=accurate
请求参数
获取配置详情
请求类型
GET
请求URL
/nacos/v1/cs/configs?show=all
请求参数
名称 类型 描述
dataId string 配置ID
group string 配置分组
获取配置历史列表
请求类型
GET
请求URL
/nacos/v1/cs/history?search=accurate
请求参数
名称 类型 描述
dataId string 配置ID
group string 配置分组
pageNo int 页码
pageSize int 页数量
获取配置历史详情
请求类型
GET
请求URL
/nacos/v1/cs/history
请求参数
名称 类型 描述
dataId string 配置ID
group string 配置分组
nid int 配置主键
删除配置
请求类型
DELETE
请求URL
/nacos/v1/cs/configs
请求参数
名称 类型 描述
dataId string 配置ID
group string 配置分组
添加修改回滚配置
请求类型
POST
请求URL
/nacos/v1/cs/configs
请求参数
名称 类型 描述
dataId string 配置ID
group string 配置分组
content string 配置内容
desc string 配置描述
type string 配置类型
获取服务列表
请求类型
GET
请求URL
/nacos/v1/ns/catalog/serviceList
请求参数
名称 类型 描述
pageNo int 页码
pageSize int 页数量
keyword string 服务名称
删除服务
请求类型
DELETE
请求URL
/nacos/v1/ns/service
请求参数
名称 类型 描述
serviceName string 服务名称
获取服务详情
请求类型
GET
请求URL
/nacos/v1/ns/
请求参数
名称 类型 描述
serviceName string 服务名称
获取实例列表
请求类型
GET
请求URL
/nacos/v1/ns/instance/list
请求参数
名称 类型 描述
serviceName string 服务名称
修改实例
请求类型
PUT
请求URL
/nacos/v1/ns/instance
请求参数
名称 类型 描述
serviceName string 服务名称
ip string IP地址
port int 端口号
clusterName string 集群名称
weight double 权重
enable bool 是否上线
Nacos Spring Cloud
官网Demo:nacos-spring-cloud-config-example
启用配置管理
添加Maven依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>${latest.version}</version>
</dependency>
配置文件
在bootstrap.yml中配置Nacos服务地址和应用名称
spring:
cloud:
nacos:
config:
file-extension: yaml
server-addr:
10.142.73.201:8080
application:
name: nacos-manager
profiles:
active: online
说明:之所以需要配置 spring.application.name ,是因为它是构成 Nacos 配置管理 dataId字段的一部分。
在 Nacos Spring Cloud 中,dataId 的完整格式如下:
${prefix}-${spring.profile.active}.${file-extension}
1. prefix默认为spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
2. spring.profile.active即为当前环境对应的 profile,详情可以参考 Spring Boot文档。注意:当 spring.profile.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成 ${prefix}.${file-extension}。
3. file-exetension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持properties和yaml类型。
启用注解
通过Spring Cloud 原生注解 @RefreshScope 实现配置自动更新:
@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {
@Value("${useLocalCache:false}")
private boolean useLocalCache;
@RequestMapping("/get")
public boolean get() {
return useLocalCache;
}
}
Nacos平台发布配置
运行项目
Nacos平台更新配置
读取项目中最新配置
启动服务发现
官网Demo:nacos-spring-cloud-discovery-example
添加Maven依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>${latest.version}</version>
</dependency>
配置服务提供者
i. 在bootstrap.yml中配置Nacos服务地址和应用名称
spring:
cloud:
nacos:
discovery:
server-addr: 10.142.73.201:8080
cluster-name: nacos-provider
application:
name: nacos-provider
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;
}
}
}
配置服务消费者
i. 在bootstrap.yml中配置Nacos服务地址和应用名称
spring:
cloud:
nacos:
discovery:
server-addr: 10.142.73.201:8080
cluster-name: nacos-consumer
application:
name: nacos-consumer
ii. 通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能。
@SpringBootApplication
@EnableDiscoveryClient
public class NacosConsumerApplication {
@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://nacos-provider/echo/" + str, String.class);
}
}
}
启动服务
分别启动NacosProviderApplication和NacosConsumerApplication服务