type
status
date
Jul 25, 2024 04:06 AM
slug
summary
category
tags
password
icon
Nacos配置管理统一配置管理Nacos配置管理实践在nacos中添加配置文件从微服务拉取配置配置热更新方式一方式二（推荐）配置共享添加一个环境共享配置在user-service中读取共享配置运行两个UserApplication，使用不同的profile配置共享的优先级搭建Nacos集群集群结构图搭建集群优化Feign远程调用Feign替代RestTemplate引入依赖添加注解编写Feign的客户端测试自定义配置配置文件方式Java代码方式Feign性能优化引入依赖配置连接池最佳实践继承方式抽取方式实现基于抽取的最佳实践Gateway服务网关为什么需要网关gateway快速入门创建gateway服务，引入依赖编写启动类编写基础配置和路由规则重启测试网关路由的流程图断言工厂过滤器工厂路由过滤器的种类请求头过滤器默认过滤器全局过滤器全局过滤器作用自定义全局过滤器过滤器执行顺序跨域问题什么是跨域问题Gateway解决跨域问题
Nacos配置管理
统一配置管理
- 当微服务部署的实例越来越多，达到数十、数百时，逐个修改微服务配置就会让人抓狂，而且很容易出错。我们需要一种统一配置管理方案，可以集中管理所有实例的配置。
- Nacos一方面可以将配置集中管理，另一方可以在配置变更时，及时通知微服务，实现配置的热更新。
Nacos配置管理实践
在nacos中添加配置文件
注意：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。
从微服务拉取配置
- 微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。但如果尚未读取application.yml，又如何得知nacos地址呢？
- 因此spring引入了一种新的配置文件：
bootstrap.yaml文件，会在application.yml之前被读取，流程如下：
- 引入nacos-config依赖
首先，在user-service服务中，引入nacos-config的客户端依赖：
- 添加bootstrap.yaml
然后，在user-service中添加一个
bootstrap.yml文件【这里后缀名可以是yml或者yaml，但是前缀一定要是bootstrap】，内容如下：- 这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据
${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id，来读取配置。本例中，就是去读取userservice-dev.yaml - 如果报错：Error creating bean with name ‘userController’: Injection of autowired dependencies failed; nested exception is java.lang.IllegalArgumentException: Could not resolve placeholder ‘pattern.dateformat’ in value “${pattern.dateformat}”
- 先去查看Nacos配置列表：发现该配置文件不在public命名空间下，而是在dev命名空间下，需要配置
namespace - 在bootstrap.yml中增加配置namespace，注明命名空间
bug解决：
- 读取nacos配置
在user-service中的UserController中添加业务逻辑，读取pattern.dateformat配置：
- 浏览器访问：http://localhost:8081/user/now，可以看到效果：
配置热更新
我们最终的目的，是修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是配置热更新。要实现配置热更新，可以使用两种方式。
方式一
- 在
@Value注入的变量所在类上添加注解@RefreshScope
方式二（推荐）
- 使用
@ConfigurationProperties注解代替@Value注解。
在user-service服务中，添加一个类，读取patterrn.dateformat属性：
在UserController中使用这个类代替@Value：
配置共享
其实微服务启动时，会去nacos读取多个配置文件，例如：
[spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml
[spring.application.name].yaml，例如：userservice.yaml
而
[spring.application.name].yaml不包含环境，因此可以被多个环境共享。添加一个环境共享配置
我们在nacos中添加一个userservice.yaml文件：
在user-service中读取共享配置
在user-service服务中，修改PatternProperties类，读取新添加的属性：
在user-service服务中，修改UserController，添加一个方法：
运行两个UserApplication，使用不同的profile
修改UserApplication2这个启动项，改变其profile值：
这样，UserApplication(8081)使用的profile是dev，UserApplication2(8082)使用的profile是test。启动UserApplication和UserApplication2。
可以看出来，不管是dev，还是test环境，都读取到了envSharedValue这个共享属性的值。
配置共享的优先级
当nacos、服务本地同时出现相同属性时，优先级有高低之分：
搭建Nacos集群
集群结构图
官方给出的Nacos集群图：
其中包含3个nacos节点，然后一个负载均衡器代理3个Nacos。这里负载均衡器可以使用nginx。
我们计划的集群结构：
三个nacos节点的地址：
节点 | ip | port |
nacos1 | 192.168.150.1 | 8845 |
nacos2 | 192.168.150.1 | 8846 |
nacos3 | 192.168.150.1 | 8847 |
搭建集群
搭建集群的基本步骤：
- 搭建数据库，初始化数据库表结构
- Nacos默认数据存储在内嵌数据库Derby中，不属于生产可用的数据库。
- 这里我们以单点的数据库为例来讲解。
- 首先新建一个数据库，命名为nacos，而后导入下面的SQL：
- 下载，配置并启动nacos
- 下载地址：https://github.com/alibaba/nacos/tags
- 进入nacos的conf目录，修改配置文件
cluster.conf.example，重命名为cluster.conf，然后添加内容 - 然后修改application.properties文件，添加数据库配置
- 将nacos文件夹复制三份，分别命名为：nacos1、nacos2、nacos3，然后分别修改三个文件夹中的application.properties
- 启动nacos集群：
startup.cmd（以集群模式启动）
- nginx反向代理
而后在浏览器访问：http://localhost/nacos即可。
代码中application.yml文件配置如下：
优化
- 实际部署时，需要给做反向代理的nginx服务器设置一个域名，这样后续如果有服务器迁移nacos的客户端也无需更改配置.
- Nacos的各个节点应该部署到多个不同服务器，做好容灾和隔离。
Feign远程调用
先来看我们以前利用RestTemplate发起远程调用的代码：
- 存在下面的问题：
- 代码可读性差，编程体验不统一
- 参数复杂URL难以维护
Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign，其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。
Feign替代RestTemplate
引入依赖
我们在order-service服务的pom文件中引入feign的依赖：
添加注解
在order-service的启动类添加注解开启Feign的功能：
编写Feign的客户端
在order-service中新建一个接口，内容如下：
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：
- 服务名称：userservice
- 请求方式：GET
- 请求路径：/user/{id}
- 请求参数：Long id
- 返回值类型：User
这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。
测试
修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate，优雅太多了。
自定义配置
Feign可以支持很多的自定义配置，如下表所示：
类型 | 作用 | 说明 |
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别：NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析，例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码，便于通过http请求发送 |
feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign. Retryer | 失败重试机制 | 请求失败的重试机制，默认是没有，不过会使用Ribbon的重试 |
一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。
配置文件方式
基于配置文件修改feign的日志级别可以针对单个服务：
也可以针对所有服务：
而日志的级别分为四种：
NONE：不记录任何日志信息，这是默认值。
BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。
Java代码方式
也可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：
如果要全局生效，将其放到启动类的
@EnableFeignClients这个注解中：如果是局部生效，则把它放到对应的
@FeignClient这个注解中：Feign性能优化
Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：
URLConnection：默认实现，不支持连接池
Apache HttpClient：支持连接池
OKHttp：支持连接池
因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。这里我们用Apache的HttpClient来演示。
引入依赖
在order-service的pom文件中引入Apache的HttpClient依赖：
配置连接池
在order-service的application.yml中添加配置：
Feign的性能优化：
- 日志级别尽量用basic或者none
- 使用HttpClient或OKHttp代替URLConnection
① 引入feign-httpClient依赖
② 配置文件开启httpClient功能，设置连接池参数
最佳实践
仔细观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：
feign客户端：
UserController：
有没有一种办法简化这种重复的代码编写呢？
继承方式
- 一样的代码可以通过继承来共享：
- 定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。
- Feign客户端和Controller都集成改接口
- 优点：
- 简单
- 实现了代码共享
- 缺点：
- 服务提供方、服务消费方紧耦合
- 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解
抽取方式
将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。
实现基于抽取的最佳实践
- 抽取
- 首先创建一个module，命名为feign-api，在feign-api中然后引入feign的starter依赖
- 然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中。
- 在order-service中使用feign-api
- 首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。在order-service的pom文件中中引入feign-api的依赖：
- 修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包
- 重启测试
解决bug：重启后，发现服务报错了：这是因为UserClient现在在cn.itcast.feign.clients包下，而order-service的@EnableFeignClients注解是在cn.itcast.order包下，不在同一个包，无法扫描到UserClient。
- 解决扫描包问题
- 方式一：指定Feign应该扫描的包：
- 方式二：指定需要加载的Client接口：
Gateway服务网关
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
为什么需要网关
Gateway网关是我们服务的守门神，所有微服务的统一入口。
- 网关的核心功能特性：
- 请求路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。
- 权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。
- 限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。
- 架构图：
- 在SpringCloud中网关的实现包括两种：
- gateway：SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。
- zuul：基于Servlet的实现，属于阻塞式编程。
gateway快速入门
创建gateway服务，引入依赖
创建新的Module，引入依赖：
编写启动类
编写基础配置和路由规则
创建
application.yml文件，内容如下：我们将符合
Path 规则的一切请求，都代理到 uri参数指定的地址。本例中，我们将 /user/**开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。重启测试
网关路由的流程图
整个访问的流程如下：
断言工厂
- 我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件。
- 例如
Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的，像这样的断言工厂在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 | 权重处理 | ㅤ |
过滤器工厂
GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：
路由过滤器的种类
Spring提供了31种不同的路由过滤器工厂，官网地址：https://docs.spring.io/spring-cloud-gateway/reference/spring-cloud-gateway/gatewayfilter-factories.html。例如：
名称 | 说明 |
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除有一个响应头 |
RequestRateLimiter | 限制请求的流量 |
请求头过滤器
下面我们以AddRequestHeader 为例来讲解。
需求：给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!
只需要修改gateway服务的application.yml文件，添加路由过滤即可：
当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。
默认过滤器
如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：
全局过滤器
全局过滤器作用
- 全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。
- 定义方式是实现GlobalFilter接口。
在filter中编写自定义逻辑，可以实现下列功能：
- 登录状态判断
- 权限校验
- 请求限流等
自定义全局过滤器
- 需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：
- 参数中是否有authorization，
- authorization参数值是否为admin
- 如果同时满足则放行，否则拦截
- 实现：在gateway中定义一个过滤器：
过滤器执行顺序
请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器：
排序的规则是什么呢？
- 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
- GlobalFilter通过实现Ordered接口，或者添加
@Order注解来指定order值，由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
- 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
跨域问题
什么是跨域问题
跨域：域名不一致就是跨域，主要包括：
- 访问协议不同：http与https
- 访问ip/域名不同：baidu.com与taobao.com
- 访问端口不同：8081与8082
跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题
Gateway解决跨域问题
在gateway服务的application.yml文件中，添加下面的配置：
- 作者:Frank
- 链接:https://blog.franksteven.me//article/nacos-feign-gateway
- 声明:本文采用 CC BY-NC-SA 4.0 许可协议，转载请注明出处。