1.Nacos配置管理

Nacos 除了可以做注册中心,同样可以做配置管理来使用。

1.1.统一配置管理

当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。
image.png
Nacos 一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。

1.1.1.在nacos中添加配置文件

如何在 Nacos 中管理配置呢?
image.png
然后在弹出的表单中,填写配置信息:
image.png

注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

1.1.2.从微服务拉取配置

微服务要拉取 Nacos 中管理的配置,并且与本地的 application.yml 配置合并,才能完成项目启动。但如果尚未读取 application.yml,又如何得知 Nacos 地址呢?

因此 Spring 引入了一种新的配置文件:bootstrap.yaml 文件,会在 application.yml 之前被读取,流程如下:
image.png
1)引入 nacos-config 依赖
首先,在 user-service 服务中,引入 nacos-config 的客户端依赖:

  1. <!--nacos配置管理依赖-->
  2. <dependency>
  3. <groupId>com.alibaba.cloud</groupId>
  4. <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
  5. </dependency>

2)添加 bootstrap.yaml
然后,在 user-service 中添加一个 bootstrap.yaml 文件,内容如下:

  1. spring:
  2. application:
  3. name: userservice # 服务名称
  4. profiles:
  5. active: dev #开发环境,这里是dev
  6. cloud:
  7. nacos:
  8. server-addr: localhost:8848 # Nacos地址
  9. config:
  10. file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取 Nacos 地址,再根据${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。

本例中,就是去读取userservice-dev.yaml
image.png
3)读取 Nacos 配置
在 user-service 中的UserController中添加业务逻辑,读取pattern.dateformat配置:
image.png
完整代码:

  1. @Slf4j
  2. @RestController
  3. @RequestMapping("/user")
  4. public class UserController {
  5. @Autowired
  6. private UserService userService;
  7. @Value("${pattern.dateformat}")
  8. private String dateformat;
  9. @GetMapping("now")
  10. public String now(){
  11. return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
  12. }
  13. // ...略
  14. }

在页面访问,可以看到效果:
image.png

1.2.配置热更新

我们最终的目的,是修改 Nacos 中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。要实现配置热更新,可以使用两种方式:

1.2.1.方式一

@Value注入的变量所在类上添加注解@RefreshScope
image.png

1.2.2.方式二

使用@ConfigurationProperties注解代替@Value注解。
在 user-service 服务中,添加一个类,读取patterrn.dateformat属性:

  1. @Component
  2. @Data
  3. @ConfigurationProperties(prefix = "pattern")
  4. public class PatternProperties {
  5. private String dateformat;
  6. }

UserController中使用这个类代替@Value
image.png
完整代码:

  1. @Slf4j
  2. @RestController
  3. @RequestMapping("/user")
  4. public class UserController {
  5. @Autowired
  6. private UserService userService;
  7. @Autowired
  8. private PatternProperties patternProperties;
  9. @GetMapping("now")
  10. public String now(){
  11. return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
  12. }
  13. // 略
  14. }

1.3.配置共享

其实微服务启动时,会去 Nacos 读取多个配置文件,例如:

  • [spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml
  • [spring.application.name].yaml,例如:userservice.yaml

[spring.application.name].yaml不包含环境,因此可以被多个环境共享。下面我们通过案例来测试配置共享

1)添加一个环境共享配置

我们在 Nacos 中添加一个 userservice.yaml 文件:
image.png

2)在user-service中读取共享配置

在 user-service 服务中,修改PatternProperties类,读取新添加的属性:
image.png
在 user-service 服务中,修改UserController,添加一个方法:
image.png

3)运行两个UserApplication,使用不同的profile

修改UserApplication2这个启动项,改变其 profile 值:
image.png
image.png
这样,UserApplication(8081)使用的 profile 是 dev,UserApplication2(8082)使用的 profile 是 test。
启动UserApplicationUserApplication2,访问http://localhost:8081/user/prop,结果:
image.png
访问http://localhost:8082/user/prop,结果:
image.png
可以看出来,不管是 dev,还是 test 环境,都读取到了envSharedValue这个属性的值。

4)配置共享的优先级

当 Nacos、服务本地同时出现相同属性时,优先级有高低之分:
image.png

2.Feign远程调用

先来看我们以前利用RestTemplate发起远程调用的代码:
image.png
存在下面的问题:

  • 代码可读性差,编程体验不统一
  • 参数复杂URL难以维护

Feign 是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign,其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
image.png

2.1.Feign替代RestTemplate

Fegin 的使用步骤如下:

1)引入依赖

我们在 order-service 服务的pom文件中引入 Fegin 的依赖:

  1. <dependency>
  2. <groupId>org.springframework.cloud</groupId>
  3. <artifactId>spring-cloud-starter-openfeign</artifactId>
  4. </dependency>

2)添加注解

在 order-service 的启动类添加注解开启 Feign 的功能:
image.png

3)编写Feign的客户端

在 order-service 中新建一个接口,内容如下:

  1. @FeignClient("userservice")
  2. public interface UserClient {
  3. @GetMapping("/user/{id}")
  4. User findById(@PathVariable("id") Long id);
  5. }

这个客户端主要是基于 Spring MVC 的注解来声明远程调用的信息,比如:

  • 服务名称:userservice
  • 请求方式:GET
  • 请求路径:/user/{id}
  • 请求参数:Long id
  • 返回值类型:User

这样,Feign 就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。

4)测试

修改 order-service 中的OrderService类中的queryOrderById方法,使用 Feign 客户端代替RestTemplate
image.png
是不是看起来优雅多了。

5)总结

使用 Feign 的步骤:

  1. 引入依赖
  2. 添加@EnableFeignClients注解
  3. 编写FeignClient接口
  4. 使用FeignClient中定义的方法代替RestTemplate

    2.2.自定义配置

    Feign 可以支持很多的自定义配置,如下表所示:
类型 作用 说明
feign.Logger.Level 修改日志级别 包含四种不同的级别:NONE、BASIC、HEADERS、FULL
feign.codec.Decoder 响应结果的解析器 http远程调用的结果做解析,例如解析json字符串为java对象
feign.codec.Encoder 请求参数编码 将请求参数编码,便于通过http请求发送
feign. Contract 支持的注解格式 默认是Spring MVC的注解
feign. Retryer 失败重试机制 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试

一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认 Bean 即可。
下面以日志为例来演示如何自定义配置。

2.2.1.配置文件方式

基于配置文件修改 feign 的日志级别可以针对单个服务:

  1. feign:
  2. client:
  3. config:
  4. userservice: # 针对某个微服务的配置
  5. loggerLevel: FULL # 日志级别

也可以针对所有服务:

  1. feign:
  2. client:
  3. config:
  4. default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
  5. loggerLevel: FULL # 日志级别

而日志的级别分为四种:

  • NONE:不记录任何日志信息,这是默认值。
  • BASIC:仅记录请求的方法,URL以及响应状态码和执行时间。
  • HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息。
  • FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。

    2.2.2.Java代码方式

    也可以基于 Java 代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:

    1. public class DefaultFeignConfiguration {
    2. @Bean
    3. public Logger.Level feignLogLevel(){
    4. return Logger.Level.BASIC; // 日志级别为BASIC
    5. }
    6. }

    如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:

    1. @EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

    如果是局部生效,则把它放到对应的@FeignClient这个注解中:

    1. @FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)

    2.3.Feign使用优化

    Feign 底层发起http请求,依赖于其它的框架。其底层客户端实现包括:

  • URLConnection:默认实现,不支持连接池

  • Apache HttpClient :支持连接池
  • OKHttp:支持连接池

因此提高 Feign 的性能主要手段就是使用连接池代替默认的URLConnection。这里我们用 Apache 的HttpClient来演示。

1)引入依赖
在 order-service 的pom文件中引入 Apache 的HttpClient依赖:

  1. <!--httpClient的依赖 -->
  2. <dependency>
  3. <groupId>io.github.openfeign</groupId>
  4. <artifactId>feign-httpclient</artifactId>
  5. </dependency>

2)配置连接池
在 order-service 的 application.yml 中添加配置:

  1. feign:
  2. client:
  3. config:
  4. default: # default全局的配置
  5. loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  6. httpclient:
  7. enabled: true # 开启feign对HttpClient的支持
  8. max-connections: 200 # 最大的连接数
  9. max-connections-per-route: 50 # 每个路径的最大连接数

接下来,在FeignClientFactoryBean中的loadBalance方法中打断点:
image.png
Debug 方式启动 order-service 服务,可以看到这里的client,底层就是Apache HttpClient
image.png
总结,Feign 的优化:

  1. 日志级别尽量用basic
  2. 使用HttpClientOKHttp代替URLConnection
    1. 引入 feign-httpClient 依赖
    2. 配置文件开启httpClient功能,设置连接池参数

      2.4.最佳实践

      所谓最近实践,就是使用过程中总结的经验,最好的一种使用方式。观察可以发现,Feign 的客户端与服务提供者的 Controller 代码非常相似:

Feign 客户端:
image.png
UserController
image.png
有没有一种办法简化这种重复的代码编写呢?

2.4.1.继承方式

一样的代码可以通过继承来共享:

  1. 定义一个API接口,利用定义方法,并基于 Spring MVC 注解做声明。
  2. Feign 客户端和 Controller 都集成改接口。

image.png

优点:

  • 简单
  • 实现了代码共享

缺点:

  • 服务提供方、服务消费方紧耦合 。
  • 参数列表中的注解映射并不会继承,因此 Controller 中必须再次声明方法、参数列表、注解。

    2.4.2.抽取方式

    将 Feign 的 Client 抽取为独立模块,并且把接口有关的POJO、默认的 Feign 配置都放到这个模块中,提供给所有消费者使用。

例如,将UserClientUserFeign的默认配置都抽取到一个 feign-api 包中,所有微服务引用该依赖包,即可直接使用。
image.png

2.4.3.实现基于抽取的最佳实践

1)抽取

首先创建一个 module,命名为 feign-api:
image.png
项目结构:
image.png
在 feign-api 中然后引入 Feign 的 starter 依赖:

  1. <dependency>
  2. <groupId>org.springframework.cloud</groupId>
  3. <artifactId>spring-cloud-starter-openfeign</artifactId>
  4. </dependency>

然后,order-service 中编写的UserClientUserDefaultFeignConfiguration都复制到 feign-api 项目中:
image.png

2)在order-service中使用feign-api

首先,删除 order-service 中的UserClientUserDefaultFeignConfiguration等类或接口。
在 order-service 的pom文件中中引入 feign-api 的依赖:

  1. <dependency>
  2. <groupId>cn.itcast.demo</groupId>
  3. <artifactId>feign-api</artifactId>
  4. <version>1.0</version>
  5. </dependency>

修改 order-service 中的所有与上述三个组件有关的导包部分,改成导入 feign-api 中的包。

3)重启测试

重启后,发现服务报错了:
image.png
这是因为UserClient现在在cn.itcast.feign.clients包下,而 order-service 的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient

4)解决扫描包问题

方式一:
指定 Feign 应该扫描的包:

  1. @EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二:
指定需要加载的 Client 接口:

  1. @EnableFeignClients(clients = {UserClient.class})

3.Gateway服务网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

3.1.为什么需要网关

Gateway 网关是我们服务的守门神,所有微服务的统一入口。

网关的核心功能特性

  • 请求路由
  • 权限控制
  • 限流

架构图:
image.png

权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。

路由和负载均衡:一切请求都必须先经过 Gateway ,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。

限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。

在 Spring Cloud 中网关的实现包括两种:

  • gateway
  • zuul

Zuul 是基于 Servlet 的实现,属于阻塞式编程。而 Spring Cloud Gateway 则是基于 Spring5 中提供的 WebFlux,属于响应式编程的实现,具备更好的性能。

3.2.gateway快速入门

下面,我们就演示下网关的基本路由功能。基本步骤如下:

  1. 创建 Spring Boot 工程 Gateway,引入网关依赖
  2. 编写启动类
  3. 编写基础配置和路由规则
  4. 启动网关服务进行测试

    1)创建gateway服务,引入依赖

    创建服务:
    image.png
    引入依赖:
    1. <!--网关-->
    2. <dependency>
    3. <groupId>org.springframework.cloud</groupId>
    4. <artifactId>spring-cloud-starter-gateway</artifactId>
    5. </dependency>
    6. <!--nacos服务发现依赖-->
    7. <dependency>
    8. <groupId>com.alibaba.cloud</groupId>
    9. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    10. </dependency>

    2)编写启动类

    1. @SpringBootApplication
    2. public class GatewayApplication {
    3. public static void main(String[] args) {
    4. SpringApplication.run(GatewayApplication.class, args);
    5. }
    6. }

    3)编写基础配置和路由规则

    创建 application.yml 文件,内容如下:
    1. server:
    2. port: 10010 # 网关端口
    3. spring:
    4. application:
    5. name: gateway # 服务名称
    6. cloud:
    7. nacos:
    8. server-addr: localhost:8848 # nacos地址
    9. gateway:
    10. routes: # 网关路由配置
    11. - id: user-service # 路由id,自定义,只要唯一即可
    12. # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
    13. uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
    14. predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
    15. - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
    我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。

本例中,我们将 /user/**开头的请求,代理到lb://userservice,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。

4)重启测试

重启网关,访问http://localhost:10010/user/1时,符合/user/**规则,请求转发到uri:http://userservice/user/1,得到了结果:
image.png

5)网关路由的流程图

整个访问的流程如下:
image.png

总结:
网关搭建步骤:

  1. 创建项目,引入 Nacos 服务发现和 Gateway 依赖
  2. 配置 application.yml,包括服务基本信息、Nacos 地址、路由

路由配置包括:

  1. 路由id:路由的唯一标示
  2. 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
  3. 路由断言(predicates):判断路由的规则,
  4. 路由过滤器(filters):对请求或响应做处理

接下来,就重点来学习路由断言和路由过滤器的详细知识

3.3.断言工厂

我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件,例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的,像这样的断言工厂在 Spring Cloud Gateway还有十几个:

名称 说明 示例
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 这种路由工程就可以了。

3.4.过滤器工厂

Gateway Filter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
image.png

3.4.1.路由过滤器的种类

Spring 提供了31种不同的路由过滤器工厂。例如:

名称 说明
AddRequestHeader 给当前请求添加一个请求头
RemoveRequestHeader 移除请求中的一个请求头
AddResponseHeader 给响应结果中添加一个响应头
RemoveResponseHeader 从响应结果中移除有一个响应头
RequestRateLimiter 限制请求的流量

3.4.2.请求头过滤器

下面我们以AddRequestHeader为例来讲解。

需求:给所有进入 userservice 的请求添加一个请求头:Truth=itcast is freaking awesome!

只需要修改 Gateway 服务的 application.yml 文件,添加路由过滤即可:

  1. spring:
  2. cloud:
  3. gateway:
  4. routes:
  5. - id: user-service
  6. uri: lb://userservice
  7. predicates:
  8. - Path=/user/**
  9. filters: # 过滤器
  10. - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

当前过滤器写在 userservice 路由下,因此仅仅对访问 userservice 的请求有效。

3.4.3.默认过滤器

如果要对所有的路由都生效,则可以将过滤器工厂写到 default 下。格式如下:

  1. spring:
  2. cloud:
  3. gateway:
  4. routes:
  5. - id: user-service
  6. uri: lb://userservice
  7. predicates:
  8. - Path=/user/**
  9. default-filters: # 默认过滤项
  10. - AddRequestHeader=Truth, Itcast is freaking awesome!

3.4.4.总结

过滤器的作用是什么?

  • 对路由的请求或响应做加工处理,比如添加请求头
  • 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么?

  • 对所有路由都生效的过滤器

    3.5.全局过滤器

    上一节学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。

    3.5.1.全局过滤器作用

    全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

  1. public interface GlobalFilter {
  2. /**
  3. * 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
  4. *
  5. * @param exchange 请求上下文,里面可以获取Request、Response等信息
  6. * @param chain 用来把请求委托给下一个过滤器
  7. * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
  8. */
  9. Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
  10. }

在 filter 中编写自定义逻辑,可以实现下列功能:

  • 登录状态判断
  • 权限校验
  • 请求限流等

    3.5.2.自定义全局过滤器

    需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:

  • 参数中是否有 authorization

  • authorization 参数值是否为 admin

如果同时满足则放行,否则拦截。

实现:
在 Gateway 中定义一个过滤器:

  1. @Order(-1)
  2. @Component
  3. public class AuthorizeFilter implements GlobalFilter {
  4. @Override
  5. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  6. // 1.获取请求参数
  7. MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
  8. // 2.获取authorization参数
  9. String auth = params.getFirst("authorization");
  10. // 3.校验
  11. if ("admin".equals(auth)) {
  12. // 放行
  13. return chain.filter(exchange);
  14. }
  15. // 4.拦截
  16. // 4.1.禁止访问,设置状态码
  17. exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
  18. // 4.2.结束处理
  19. return exchange.getResponse().setComplete();
  20. }
  21. }

3.5.3.过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器DefaultFilterGlobalFilter
请求路由后,会将当前路由过滤器DefaultFilterGlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
image.png

排序的规则是什么呢?

  • 每一个过滤器都必须指定一个int类型的order值,**order**值越小,优先级越高,执行顺序越靠前
  • GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
  • 路由过滤器和defaultFilterorder由 Spring 指定,默认是按照声明顺序从1递增。
  • 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器> GlobalFilter的顺序执行。

详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个 route 的 filters,然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链。

3.6.跨域问题

3.6.1.什么是跨域问题

跨域:域名不一致就是跨域,主要包括:

  • 域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
  • 域名相同,端口不同:localhost:8080和localhost:8081

跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题。

解决方案:CORS,这个以前应该学习过,这里不再赘述了。不知道的小伙伴可以查看:https://www.ruanyifeng.com/blog/2016/04/cors.html

3.6.2.模拟跨域问题

可以在浏览器控制台看到下面的错误:
image.png
从 localhost:8090 访问 localhost:10010,端口不同,显然是跨域的请求。

3.6.3.解决跨域问题

在 Gateway 服务的 application.yml 文件中,添加下面的配置:

  1. spring:
  2. cloud:
  3. gateway:
  4. # 。。。
  5. globalcors: # 全局的跨域处理
  6. add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
  7. corsConfigurations:
  8. '[/**]':
  9. allowedOrigins: # 允许哪些网站的跨域请求
  10. - "http://localhost:8090"
  11. allowedMethods: # 允许的跨域ajax的请求方式
  12. - "GET"
  13. - "POST"
  14. - "DELETE"
  15. - "PUT"
  16. - "OPTIONS"
  17. allowedHeaders: "*" # 允许在请求中携带的头信息
  18. allowCredentials: true # 是否允许携带cookie
  19. maxAge: 360000 # 这次跨域检测的有效期

3.7 权限管理

服务网关的一大作用就是可以对外部的请求进行集中权限认证,这样每个具体的服务就不用操心权限管理的问题了,可以专心于业务的实现。基本的思路是外部客户端首先需要获取一个由系统中独立的认证中心负责签发的accessToken,然后每次请求服务时在http header中携带该Token,服务网关负责校验accessToken的有效性以及是否具备访问该服务的权限,具体的思路和我之前介绍单系统权限管理的思路比较类似,可以查看 Spring Boot整合Shiro和JWT的无状态权限管理方案 这篇文章。

我们首先需要在服务网关中定义一个GlobalFilter对所有的外部请求进行过滤,代码如下:

  1. @Slf4j
  2. public class AuthGlobalFilter implements GlobalFilter, Ordered {
  3. private AuthService authService;
  4. private AuthConfigProperties authConfig;
  5. public AuthGlobalFilter(AuthConfigProperties authConfig, AuthService authService) {
  6. this.authConfig = authConfig;
  7. this.authService = authService;
  8. }
  9. @Override
  10. public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  11. String reqPath = exchange.getRequest().getURI().getPath();
  12. String token = exchange.getRequest().getHeaders().getFirst(authConfig.getHeaderKeyOfToken());
  13. if (!authService.verifyToken(reqPath, token)) {
  14. log.warn("没有授权的访问,{}", reqPath);
  15. exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
  16. return exchange.getResponse().setComplete();
  17. }
  18. //获取token中存储的用户唯一标识,并放入request header中,供后端业务服务使用
  19. String account = authService.getAccountByToken(token);
  20. ServerHttpRequest request = exchange.getRequest().mutate()
  21. .header(authConfig.getHeaderKeyOfAccount(), account).build();
  22. return chain.filter(exchange.mutate().request(request).build());
  23. }
  24. /**
  25. * 过滤器的优先级,越低越高
  26. */
  27. @Override
  28. public int getOrder() {
  29. return 1;
  30. }
  31. }

功能很简单,就是对请求头部的token进行校验,如果成功就将从token中解析出来的用户账户信息放入转发的请求头中供后端的业务服务使用,否则返回UNAUTHORIZED。这个Filter也需要注册到容器中:

  1. @Bean
  2. public AuthGlobalFilter authGlobalFilter(AuthService authService) {
  3. return new AuthGlobalFilter(authConfig, authService);
  4. }

对token进行校验的核心逻辑在authService.verifyToken方法中,代码如下:

  1. /**
  2. * 验证token的有效性及是否具备对该url的访问权限,
  3. * 判定规则参考了shiro的一些设定
  4. */
  5. public boolean verifyToken(String url, String token) {
  6. if (Strings.isNullOrEmpty(token)) {
  7. return false;
  8. }
  9. //获取每个Url所对应的权限控制符
  10. String urlPermission = getUrlPermission(url);
  11. if ("anno".equals(urlPermission)) {
  12. return true;
  13. } else {
  14. //获取token中包含的用户唯一标识
  15. String account = jwtHelper.getAccount(token);
  16. if (Strings.isNullOrEmpty(account)) {
  17. return false;
  18. }
  19. //获取token的加密密钥
  20. String secret = getUserSecret(account);
  21. //校验accessToken
  22. if (jwtHelper.verify(token, secret) == null) {
  23. return false;
  24. }
  25. // 如果url仅要求验证用户有效性,则直接通过
  26. if (Strings.isNullOrEmpty(urlPermission) ||
  27. "authc".equals(urlPermission)) {
  28. return true;
  29. }
  30. // 进一步判断用户权限
  31. if (urlPermission.startsWith("perms")) {
  32. Set<String> userPerms = this.getUserPermissions(account);
  33. String perms = urlPermission.substring(urlPermission.indexOf("[") + 1, urlPermission.lastIndexOf("]"));
  34. return userPerms.containsAll(Arrays.asList(perms.split(",")));
  35. }
  36. }
  37. return false;
  38. }

服务网关首先需要知道不同的服务地址需要什么样的权限才允许访问,这里采用了类似Shiro配置的格式,类似这样如下的格式,实际环境中可能是从数据库或配置文件中读取:

  1. /**
  2. * 获取所有的接口url与用户权限的映射关系,格式仿造了shiro的权限配置格式
  3. */
  4. public Map<String, String> getAllUrlPermissionsMap() {
  5. Map<String, String> urlPermissionsMap = Maps.newHashMap();
  6. urlPermissionsMap.put("/api/order/orders", "authc");
  7. urlPermissionsMap.put("/api/order/create-order", "perms[order]");
  8. urlPermissionsMap.put("/api/storage/**", "perms[storage]");
  9. return urlPermissionsMap;
  10. }

通过Spring 提供的工具类AntPathMatcher,就可以查询到每个请求url所需要的权限标识符,再根据权限标识符去检查token对应的用户是否具备相应的权限。