Nacos配置管理
统一配置管理
nacos实现配置管理
需要热更新的配置才交给nacos管理，一般不会变更的配置放在微服务本地。
微服务拉取配置
微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。
但是没有读取application.yml，就不知道nacos地址的地址。
因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取，流程如下：
步骤如下：
-
引入spring-cloud-starter-alibaba-nacos-config的nacos配置管理依赖。
-
添加bootstrap.yaml配置文件，此文件优先级高于application.yml。
spring: application: name: userservice #服务名称 profiles: active: dev #环境 cloud: nacos: server-addr: localhost:8848 #nacos地址 config: file-extension: yaml #文件后缀名name + active + file-extension三者组成唯一Data Id： userservice-dev.yaml
配置热更新
方式一：
在@Value注入的变量所在类上添加注解@RefreshScope。
方式二：
使用@ConfigurationProperties注解代替@Value注解：
@Data
@Component
@ConfigurationProperties(prefix = "pattern") //前缀名
public class PatternProperties {
private String dataformat;
}
多环境配置共享
微服务启动时，会去nacos读取多个配置文件，例如：
[spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml[spring.application.name].yaml
[spring.application.name].yaml不包含环境，因此可以被多个环境共享。
配置共享优先级：
Nacos集群搭建
集群结构图：
以单点的数据库为例：
-
创建数据库，导入nacos官网的sql文件。
-
下载解压nacos，进入nacos的conf目录，修改配置文件cluster.conf.example，重命名为cluster.conf，并添加内容：
127.0.0.1:8845 127.0.0.1.8846 127.0.0.1.8847 -
修改application.properties文件，添加数据库配置：
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&useUnicode=true&useSSL=false&serverTimezone=UTC db.user.0=root db.password.0=123 -
将nacos文件夹复制三份，分别命名为：nacos1、nacos2、nacos3，然后分别修改三个文件夹中的application.properties的端口号。
-
启动三个nacos节点：startup.cmd
-
修改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; } }
Feign远程调用
基本使用
-
引入spring-cloud-starter-openfeign的依赖。
-
在启动类上添加注解
@EnableFeignClients -
编写Feign客户端：
@FeignClient("userservice") public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }- 服务名称：userservice
- 请求方式：GET
- 请求路径：/user/{id}
- 请求参数：Long id
- 返回值类型：User
-
调用UserClient接口代替RestTemplate。
Feign集成了ribbon,因此自带负载均衡。
踩的坑
配置文件必须要有bootstrap.properties或者bootstrap.yml，里面要有nacos的服务地址，如果只有application.properties或者application.yml可能会导致加载不到配置中的nacos服务地址。
自定义配置
| 类型 | 作用 | 说明 |
|---|---|---|
| feign.Logger.Level | 修改日志级别 | 包含四种不同的级别：NONE、BASIC、HEADERS、FULL |
| feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析，例如解析json字符串为java对象 |
| feign.codec.Encoder | 请求参数编码 | 将请求参数编码，便于通过http请求发送 |
| feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
| feign. Retryer | 失败重试机制 | 请求失败的重试机制，默认是没有，不过会使用Ribbon的重试 |
方式一：配置文件
针对单个服务：
feign:
client:
config:
userservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别
针对所有服务：
feign:
client:
config:
default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
日志等级分为4种：
- NONE：不记录任何日志信息，这是默认值。
- BASIC：仅记录请求的方法，URL以及响应状态码和执行时间。
- HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息。
- FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。
日志级别尽量别用HEADERS和FULL，会影响性能。
方式二：Java代码
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC; // 日志级别为BASIC
}
}
全局生效：放到启动类的@EnableFeignClients注解中：
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
局部生效：放到对应类的@FeignClient注解中：
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
Feign使用优化
Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：
- URLConnection：默认实现，不支持连接池.
- Apache HttpClient ：支持连接池。
- OKHttp：支持连接池。
因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。
这里以Apache的HttpClient来演示：
-
引入feign-httpclient的依赖。
-
配置连接池：
feign: httpclient: enabled: true #支持HttpClient的开关 max-connections: 200 #最大连接数 max-connections-per-route: 50 #单个路径的最大连接数
最佳实践
继承方式
Feign的客户端与服务提供者的controller代码非常相似，因此可以通过继承来共享代码：
- 定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。
- Feign客户端继承该接口，Controller则实现该接口。
优点：简单，实现了代码的共享。
缺点：
- 服务提供方和服务消费方紧耦合。
- 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解。
抽取方式
将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。
例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。
这样子的话耦合度低，但可能会有多余代码，比较臃肿。
步骤如下：
- 创建一个module，命名为feign-api，引入spring-cloud-starter-openfeign依赖，把UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中。
- 在order-service中引入feign-api的依赖。
因为feign-api里面定义的bean不在启动类的扫描包范围（都是别的项目了），所以启动服务会报错。
解决：
方式一：指定Feign应该扫描的包：
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
方式二：指定需要加载的Client接口：
@EnableFeignClients(clients = {UserClient.class})
Gateway服务网关
网关作用
- 权限控制：对用户请求做身份认证，权限校验。
- 路由和负载均衡：将用户请求路由到微服务，并实现负载均衡。
- 限流：对用户请求进行限流。
在SpringCloud中网关的实现包括两种：
- gateway：具有更好的性能。
- zuul
gateway基本使用
-
创建项目，引入网关依赖（spring-cloud-starter-gateway）和nacos服务发现注册依赖（spring-cloud-starter-alibaba-nacos-discovery）。
-
编写配置文件：
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://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称 predicates: # 路由断言，也就是判断请求是否符合路由规则的条件 - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求将符合
Path规则的一切请求，都代理到uri参数指定的地址。也就是
/user/**开头的请求，都会被代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。
流程图如下：
踩到的坑
子工程里面没有继承到父工程的依赖，不知道是idea还是maven的原因，在子工程里面的依赖加上版本刷新后再删掉就能解决了。
断言工厂
在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory（断言工厂）读取并处理，转变为路由判断的条件。
断言工厂在SpringCloudGateway有十多个:
| 名称 | 说明 | 示例 |
|---|---|---|
| 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/** |
| Query | 请求参数必须包含指定参数 | - Query=name, Jack或者- Query=name |
| RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
| Weight | 权重处理 |
会Path就行。
过滤器工厂
GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：
有31种不同的路由过滤器工厂。例如：
| 名称 | 说明 |
|---|---|
| AddRequestHeader | 给当前请求添加一个请求头 |
| RemoveRequestHeader | 移除请求中的一个请求头 |
| AddResponseHeader | 给响应结果中添加一个响应头 |
| RemoveResponseHeader | 从响应结果中移除有一个响应头 |
| RequestRateLimiter | 限制请求的流量 |
请求头过滤器
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
filters: # 过滤器
- AddRequestHeader=Truth,1+1=1 # 添加请求头
当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。
默认过滤器
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
default-filters: # 默认过滤项
- AddRequestHeader=Truth,1+1=1
将过滤器工厂写到default下，则对所有的路由都生效。
全局过滤器
与默认过滤器的区别：网关提供的31种过滤器工厂作用是固定的，无法完成自己的实际业务需求。
定义方式是实现GlobalFilter接口，以拦截请求判断参数中的authorization是否为admin为例：
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//1.获取请求参数
ServerHttpRequest request = exchange.getRequest();
MultiValueMap<String, String> params = request.getQueryParams();
//2.获取参数中的 authorization 参数
String auth = params.getFirst("authorization");
//3.判断参数值是否等于 admin
if ("admin".equals(auth)){
//4.相等，放行
return chain.filter(exchange);
}
//5.不相等，拦截
//5.1.设置状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
//5.2拦截请求
return exchange.getResponse().setComplete();
}
}
@Order代表执行优先级，也可以通过实现Ordered接口完成，order值越小，优先级越高。
过滤器执行顺序
请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器。
排序规则：
- 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
- GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定。
- 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增，二者是分开递增的。
- 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
跨域问题
跨域：协议、主机、端口号、域名有一个不同就是跨域。
跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题。
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 # 这次跨域检测的有效期
