Nacos 除了可以做注册中心,同样可以做配置管理来使用。
当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。
Nacos 一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。
在配置管理页面,点击右上角的加号即可添加配置
然后在弹出的表单中,填写配置信息:
注意:项目的核心配置,需要热更新的配置才有放到 nacos 管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。
微服务要拉取 nacos 中管理的配置,并且与本地的 application.yml 配置合并,才能完成项目启动。但如果尚未读取 application.yml,又如何得知 nacos 地址呢?
因此 Spring 中引入了一种新的配置文件:bootstrap.yml 文件,它会在 application.yml 之前被读取,流程如下:
1)在 user-service 服务中,引入 nacos-config 的客户端依赖:
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
dependency>
2)在 user-service 中添加 bootstrap.yml 文件(它的启动优先级高于 application.yml),内容如下:
spring:
application:
name: user-service # 服务名称
profiles:
active: dev # 开发环境,这里是dev
cloud:
nacos:
server-addr: localhost:8848 # Nacos地址
config:
file-extension: yaml # 文件后缀名
这里会根据 spring.cloud.nacos.server-addr
获取 nacos 地址,而获取文件 ID 的规则具体参考官网:
本例中,就是去读取user-service-dev.yaml
:
3)在 UserController 代码的中间添加业务逻辑,读取 pattern.dateformat 配置,代码如下:
@Value("${pattern.dateformat}")
private String dateFormat;
@GetMapping("/now")
public String now(){
return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateFormat));
}
我们最终的目的,是修改 nacos 中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。要实现配置热更新,可以使用两种方式:
在 @Value 注入的变量所在类上添加注解@RefreshScope
:
使用 @ConfigurationProperties 注解代替 @Value 注解。在 user-service 服务中,添加一个类,读取 patterrn.dateformat 属性:
package cn.itcast.user.config;
@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
private String dateformat;
}
在 UserController 中使用这个类代替 @Value 注解,中间代码如下:
@Autowired
private PatternProperties patternProperties;
@GetMapping("/now")
public String now() {
return LocalDateTime.now().format(
DateTimeFormatter.ofPattern(patternProperties.getDateformat())
);
}
其实微服务启动时,会去 nacos 读取多个配置文件,例如:
[spring.application.name]-[spring.profiles.active].yaml
,例如:user-service-dev.yaml
[spring.application.name].yaml
,例如:user-service.yaml
而无论 profile 如何变化,[spring.application.name].yaml
这个文件一定会加载,因此多环境共享配置可以写入这个文件,被多个环境共享。
下面我们通过案例来测试配置共享
我们在 nacos 中添加一个 user-service.yaml 文件,用于共享配置:
在 user-service 服务中,修改 PatternProperties 类,读取新添加的属性:
@Data
@Component
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
private String dateformat;
private String envSharedValue;
}
在 user-service 服务中,修改 UserController,添加一个方法:
@GetMapping("/prop")
public PatternProperties prop() {
return patternProperties;
}
修改 UserApplication2 这个启动项,改变其 profile 值:
这样,UserApplication(8081) 使用的 profile 是 dev,UserApplication2(8082) 使用的 profile 是 test。然后一起启动
1)访问页面:http://localhost:8081/user/prop
2)访问页面:http://localhost:8082/user/prop
可以看出来,不管是 dev,还是 test 环境,都读取到了 envSharedValue 这个属性的值。
当 nacos、服务本地同时出现相同属性时,优先级有高低之分,如图:
不同微服务之间可以共享配置文件,通过下面的两种方式来指定:
方式一:shared-configs
spring:
application:
name: user-service # 服务名称
profiles:
active: dev # 开发环境,这里是dev
cloud:
nacos:
server-addr: localhost:8848 # Nacos地址
config:
file-extension: yaml # 文件后缀名
shared-configs: # 多微服务间共享的配置列表
- dataId: common.yaml # 要共享的配置文件id
方式二:extension-configs
spring:
application:
name: user-service # 服务名称
profiles:
active: dev # 开发环境,这里是dev
cloud:
nacos:
server-addr: localhost:8848 # Nacos地址
config:
file-extension: yaml # 文件后缀名
extension-configs: # 多微服务间共享的配置列表
- dataId: extend.yaml # 要共享的配置文件id
Nacos 生产环境下一定要部署为集群状态,部署后整体架构如下:
三个 nacos 节点的地址:
节点 | IP地址 | 端口号 |
---|---|---|
nacos1 | 127.0.0.1 | 8845 |
nacos2 | 127.0.0.1 | 8846 |
nacos3 | 127.0.0.1 | 8847 |
Nacos 默认数据存储在内嵌数据库 Derby 中,不属于生产可用的数据库。官方推荐的是使用带有主从的高可用数据库集群。但是这里我们先用单点的数据库为例来讲解。
1)将之前的 nacos-1.4.1 的 zip 包,进行解压
2)创建 nacos 数据库,导入 SQL 文件,文件在 conf/nacos-mysql.sql
,数据库名也可以用官方推荐
1)进入 conf 目录,复制 cluster.conf.example 配置文件,重命名为 cluster.conf,删除里面的内容,配置成我们自己的,如下:
127.0.0.1:8845
127.0.0.1:8846
127.0.0.1:8847
2)修改 application.properties 文件,添加数据库配置:
# 28行,配置IP地址,避免电脑内多网卡冲突
nacos.inetutils.ip-address=127.0.0.1
# 33行,表示使用 mysql 数据库作为外部存储
spring.datasource.platform=mysql
# 36行,表示使用一个数据库
db.num=1
# 39 40 41 行,配置基本参数
db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=10000&socketTimeout=30000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=root
db.password.0=123456
1)因为是在 windows 上模拟的,我们可以将之前的 nacos 进行复制三份,分别为 nacos1、nacos2、naocs3
2)分别修改三个文件夹中的 application.properties,配置不同的端口号,在 21 行:
nacos1:server.port=8845
nacos2:server.port=8846
nacos3:server.port=8847
3)然后分别双击启动三个 nacos 节点:
startup.cmd
找到资料提供的 nginx 安装包,或者自己下载一个:http://nginx.org/en/download.html,版本为 1.18.0
解压 nginx 到任意非中文目录下:
修改 conf/nginx.conf 文件,配置如下:
upstream nacos-cluster {
server 127.0.0.1:8845;
server 127.0.0.1:8846;
server 127.0.0.1:8847;
}
server {
listen 80;
server_name localhost;
location /nacos {
proxy_pass http://nacos-cluster;
}
}
然后双击 nginx.exe 启动,然后在浏览器访问测试:http://localhost/nacos
注意:如果代码中使用,需要修改 application.yml 文件如下:
spring:
cloud:
nacos:
server-addr: localhost:80 # Nacos地址
注意点:
先来看我们以前利用 RestTemplate 发起远程调用的代码:
存在下面的问题:
Feign 是一个声明式的 http 客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现 http 请求的发送,解决上面提到的问题。
Fegin 的使用步骤如下:
我们在 order-service 服务的 pom 文件中引入 feign 的依赖:
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-openfeignartifactId>
dependency>
在 order-service 的启动类添加@EnableFeignClients
注解开启 Feign 的功能:
在 order-service 中新建一个接口,内容如下:
package cn.itcast.order.client;
@FeignClient("user-service")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
这个客户端主要是基于 SpringMVC 的注解来声明远程调用的信息,比如:
有了这些信息,Feign 就可以帮助我们发送 http 请求,无需自己使用 RestTemplate 来发送了。
修改 order-service 中的 OrderService 类中的 queryOrderById 方法,使用 Feign 客户端代替 RestTemplate,然后启动进行进行测试。
Feign 可以支持很多的自定义配置,如下表所示:
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http 远程调用的结果做解析,例如解析 JSON 字符串为对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过 http 请求发送 |
feign.Contract | 支持的注解格式 | 默认是 SpringMVC 的注解 |
feign.Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用 Ribbon 的重试 |
一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的 @Bean 覆盖默认 Bean 即可。
下面以日志为例来演示如何自定义配置。
基于配置文件修改 feign 的日志级别,可以针对单个服务,也可以针对所有服务:
feign:
client:
config:
default: # 用default代表全局配置,如果是写服务名称如(user-service),就是针对某个微服务的配置
loggerLevel: FULL # 日志级别
而日志的级别分为四种:
也可以基于 Java 代码来修改日志级别,先声明一个类,然后声明一个 Logger.Level 的对象:
package cn.itcast.order.config;
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel() {
return Logger.Level.FULL;
}
}
如果要全局生效,将其放到启动类的 @EnableFeignClients 这个注解中:
@EnableFeignClients(defaultConfiguration = {DefaultFeignConfiguration.class})
如果是局部生效,则把它放到对应的 @FeignClient 这个注解中:
@FeignClient(value = "user-service", configuration = {DefaultFeignConfiguration.class})
Feign 底层发起 http 请求,依赖于其它的框架。其底层客户端实现包括:
客户端 | 介绍 |
---|---|
URLConnection | 默认实现,不支持连接池 |
Apache HttpClient | 支持连接池 |
OKHttp | 支持连接池 |
因此优化 Feign 的性能主要包括:
这里我们用 Apache 的 HttpClient 来演示。
1)引入依赖:在 order-service 的 pom 文件中引入 Apache 的 HttpClient 依赖
<dependency>
<groupId>io.github.openfeigngroupId>
<artifactId>feign-httpclientartifactId>
dependency>
2)配置连接池:在 order-service 的 application.yml 中添加配置,设置连接池参数
feign:
client:
config:
default: # 用default就是全局配置,如果是写服务名称如(user-service),就是针对某个微服务的配置
loggerLevel: BASIC # 日志级别
httpclient:
enabled: true # 开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50 # 每个路径的最大连接数
3)测试:在 FeignClientFactoryBean 中的 loadBalance 方法中打断点:
Debug 方式启动 order-service 服务,可以看到这里的 client,底层就是 Apache HttpClient:
所谓最佳实践,就是使用过程中总结的经验,最好的一种使用方式。仔细观察可以发现,Feign 的客户端与服务提供者的 controller 代码非常相似:
有没有一种办法简化这种重复的代码编写呢?
一样的代码可以通过继承来共享,如图:
1)定义一个 API 接口,利用定义方法,并基于 SpringMVC 注解做声明。
2)Feign 客户端和 Controller 都集成改接口
优点:
缺点:
服务提供方、服务消费方紧耦合
参数列表中的注解映射并不会继承,因此 Controller 中必须再次声明方法、参数列表、注解
将 FeignClient 抽取为独立模块,并且把接口有关的 POJO、默认的 Feign 配置都放到这个模块中。
例如,将 UserClient、User、Feign 的默认配置都抽取到一个 feign-api 包中,所有微服务引用该依赖包,即可直接使用:
在父项目下创建一个子模块,名为:feign-api,然后在 pom 文件中引入 feign 的 starter 依赖
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-openfeignartifactId>
dependency>
把 order-service 中编写的 UserClient、User、DefaultFeignConfiguration 都复制到 feign-api 项目中
首先,删除 order-service 中的 UserClient、User、DefaultFeignConfiguration 等类或接口。然后在 order-service 的 pom 文件中引入 feign-api 的依赖:
<dependency>
<groupId>com.xqhgroupId>
<artifactId>feign-apiartifactId>
<version>1.0.0version>
dependency>
然后修改 order-service 中的所有与上述三个组件有关的导包部分,改成导入 feign-api 中的包
重启后,发现服务报错了:
这是因为 UserClient 现在在 cn.itcast.feign.client
包下,而 order-service 的@EnableFeignClients
注解是在 cn.itcast.order
包下,不在同一个包,无法扫描到 UserClient
方式一:指定 Feign 应该扫描的包
@EnableFeignClients(basePackages = {"cn.itcast.feign.client"})
方式二:指定需要加载的 Client 接口
@EnableFeignClients(clients = {UserClient.class})
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
Gateway 网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性:
身份认证和权限校验
服务路由、负载均衡
请求限流
在 SpringCloud 中网关的实现包括两种:
下面,我们就演示下网关的基本路由功能。基本步骤如下:
1)在父项目下创建子模块,名为:getewary
2)在 pom 文件中引入依赖:
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-gatewayartifactId>
dependency>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>
dependencies>
package cn.itcast.gateway;
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
创建 application.yml 文件,在里面进行基础配置和路由规则,内容如下:
server:
port: 10010 # 网关端口
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由ID,自定义但要保证唯一
# uri: http://127.0.0.1:8081 # 路由的目标地址 http 就是固定地址
uri: lb://user-service # 路由的目标地址 lb表示负载均衡,后面跟服务名称
predicates: # 路由断言,其实就是判断请求是否符合路由规则
- Path=/user/** # 表示按照路径匹配,只要以/user/开头就符合要求
我们将符合Path
规则的一切请求,都代理到 uri
参数指定的地址。
本例中,我们将 /user/**
开头的请求,代理到lb://userservice
,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
重启网关,访问:http://localhost:10010/user/1,因为符合/user/**
规则,请求会被转发到 uri:http://user-service/user/1,所以我们就可以获取到结果:
接下来,重点来学习路由断言和路由过滤器的详细知识
我们在配置文件中写的断言规则只是字符串,这些字符串会被 Predicate Factory 读取并处理,转变为路由判断的条件,例如Path=/user/**
是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory
这个类来处理的,像这样的断言工厂在 SpringCloudGateway 还有十几个:
详细参考官网:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories
名称 | 说明 | 示例 |
---|---|---|
After | 某个时间点之后的请求 | - After=2037-01-20T17:42:47.789-07:00[America/Denver] |
Before | 某个时间点之前的请求 | - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] |
Between | 两个时间点之间的请求 | - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver] |
Cookie | 请求必须包含某些cookie | - Cookie=chocolate, ch.p |
Header | 请求必须包含某些header | - Header=X-Request-Id, \d+ |
Host | 请求必须是访问某个host(域名) | - Host=**.somehost.org,**.anotherhost.org |
Method | 请求方式必须是指定方式 | - Method=GET,POST |
Path | 请求路径必须符合指定规则 | - Path=/red/{segment},/blue/{segment} |
Query | 请求参数必须包含指定参数 | - Query=red, gree. |
RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
Weight | 权重处理 | - Weight=group1, 2 |
我们只需要掌握 Path 这种路由工程就可以了。
GatewayFilter 是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
Spring 提供了 31 种不同的路由过滤器工厂:下面列出常见的几个
详细参考官网:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories
名称 | 说明 |
---|---|
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除有一个响应头 |
RequestRateLimiter | 限制请求的流量 |
下面我们以 AddRequestHeader 为例来讲解。
需求:给所有进入 user-service 的请求添加一个请求头:Truth=itcast is freaking awesome!
只需要修改gateway服务的application.yml文件,添加路由过滤即可:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
filters: # 过滤器
- AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
当前过滤器写在 user-service 路由下,因此仅仅对访问 user-service 的请求有效。
如果要对所有的路由都生效,则可以将过滤器工厂写到 geteway 的 default-filters 下。格式如下:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
default-filters: # 默认过滤项
- AddRequestHeader=Truth, Itcast is freaking awesome!
上一节学习的过滤器,网关提供了 31 种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。此时就需要全局过滤器了
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与 GatewayFilter 的作用一样。区别在 GatewayFilter 通过配置定义,处理逻辑是固定的,而 GlobalFilter 的逻辑需要自己写代码实现。
定义全局过滤器方式,就是实现 GlobalFilter 接口,重写方法
public interface GlobalFilter {
/**
* 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
*
* @param exchange 请求上下文,里面可以获取Request、Response等信息
* @param chain 用来把请求委托给下一个过滤器
* @return {@code Mono} 返回标示当前过滤器业务结束
*/
Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
在 filter 中编写自定义逻辑,可以实现下列功能:
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:如果同时满足则放行,否则拦截
参数中是否有 authorization,
authorization 参数值是否为 admin
在 gateway 中定义一个过滤器,实现代码如下:
package cn.itcast.gateway.filter;
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.获取所有的请求参数
MultiValueMap<String, String> queryParams = exchange.getRequest().getQueryParams();
// 2.获取 authorization 参数
String auth = queryParams.getFirst("authorization");
// 3.校验
if ("admin".equals(auth)) {
// 放行
return chain.filter(exchange);
}
// 4.拦截
// 4.1 禁止访问,设置状态码
exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
// 4.2.结束处理
return exchange.getResponse().setComplete();
}
}
重启 gateway,然后访问网址进行测试:http://localhost:10010/user/1?authorization=admin
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和 DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
排序的规则是什么呢?
详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()
方法是先加载 defaultFilters,然后再加载某个 route 的 filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()
方法会加载全局过滤器,与前面的过滤器合并后根据 order 排序,组织过滤器链
跨域:域名不一致就是跨域,主要包括:
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
解决方案:CORS,不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html
将下面的页面文件放入 tomcat 或者 nginx 这样的 web 服务器中,进行访问:
DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Documenttitle>
head>
<body>
<pre>
spring:
cloud:
gateway:
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
- "http://www.leyou.com"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期
pre>
body>
<script src="https://unpkg.com/axios">script>
<script>
axios.get("http://localhost:10010/user/1?authorization=admin")
.then(resp => console.log(resp.data))
.catch(err => console.log(err))
script>
html>
会发现浏览器控制台报错如下:
从 localhost:8090 访问 localhost:10010,端口不同,显然是跨域的请求。
在 gateway 服务的 application.yml 文件中,添加下面的配置:
spring:
cloud:
gateway:
# 省略中间配置
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期
限流:对应用服务器的请求做限制,避免因过多请求而导致服务器过载甚至宕机。限流算法常见的包括:
固定窗口计数器算法概念如下:
漏桶算法说明:
令牌桶算法说明: