在昨天的作业中我们将黑马商城拆分为5个微服务用户服务商品服务购物车服务交易服务支付服务由于每个微服务都有不同的地址或端口入口不同相信大家在与前端联调的时候发现了一些问题请求不同数据时要访问不同的入口需要维护多个入口地址麻烦前端无法调用nacos无法实时更新服务列表不要着急这些问题都可以在今天的学习中找到答案我们会通过网关技术解决上述问题。今天的内容会分为3章第一章网关路由解决前端请求入口的问题。第二章网关鉴权解决统一登录校验和用户信息获取的问题。第三章统一配置管理解决微服务的配置文件重复和配置热更新问题。通过今天的学习你将掌握下列能力会利用微服务网关做请求路由会利用微服务网关做登录身份校验会利用Nacos实现统一配置管理会利用Nacos实现配置热更新好了接下来我们就一起进入今天的学习吧。1.网关路由1.1.认识网关什么是网关顾明思议网关就是网络的关口。数据在网络间传输从一个网络传输到另一网络时就需要经过网关来做数据的路由和转发以及数据安全的校验。更通俗的来讲网关就像是以前园区传达室的大爷。外面的人要想进入园区必须经过大爷的认可如果你是不怀好意的人肯定被直接拦截。外面的人要传话或送信要找大爷。大爷帮你带给目标人。现在微服务网关就起到同样的作用。前端请求不能直接访问微服务而是要请求网关网关可以做安全控制也就是登录身份校验校验通过才放行通过认证后网关再根据请求判断应该访问哪个微服务将请求转发过去在SpringCloud当中提供了两种网关实现方案Netflix Zuul早期实现目前已经淘汰SpringCloudGateway基于Spring的WebFlux技术完全支持响应式编程吞吐能力更强课堂中我们以SpringCloudGateway为例来讲解官方网站Spring Cloud Gateway1.2.快速入门接下来我们先看下如何利用网关实现请求路由。由于网关本身也是一个独立的微服务因此也需要创建一个模块开发功能。大概步骤如下创建网关微服务引入SpringCloudGateway、NacosDiscovery依赖编写启动类配置网关路由1.2.1.创建项目首先我们要在hmall下创建一个新的module命名为hm-gateway作为网关微服务1.2.2.引入依赖在hm-gateway模块的pom.xml文件中引入依赖?xml version1.0 encodingUTF-8? project xmlnshttp://maven.apache.org/POM/4.0.0 xmlns:xsihttp://www.w3.org/2001/XMLSchema-instance xsi:schemaLocationhttp://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd parent artifactIdhmall/artifactId groupIdcom.heima/groupId version1.0.0/version /parent modelVersion4.0.0/modelVersion artifactIdhm-gateway/artifactId properties maven.compiler.source11/maven.compiler.source maven.compiler.target11/maven.compiler.target /properties dependencies !--common-- dependency groupIdcom.heima/groupId artifactIdhm-common/artifactId version1.0.0/version /dependency !--网关-- dependency groupIdorg.springframework.cloud/groupId artifactIdspring-cloud-starter-gateway/artifactId /dependency !--nacos discovery-- dependency groupIdcom.alibaba.cloud/groupId artifactIdspring-cloud-starter-alibaba-nacos-discovery/artifactId /dependency !--负载均衡-- dependency groupIdorg.springframework.cloud/groupId artifactIdspring-cloud-starter-loadbalancer/artifactId /dependency /dependencies build finalName${project.artifactId}/finalName plugins plugin groupIdorg.springframework.boot/groupId artifactIdspring-boot-maven-plugin/artifactId /plugin /plugins /build /project1.2.3.启动类在hm-gateway模块的com.hmall.gateway包下新建一个启动类代码如下package com.hmall.gateway; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; SpringBootApplication public class GatewayApplication { public static void main(String[] args) { SpringApplication.run(GatewayApplication.class, args); } }1.2.4.配置路由接下来在hm-gateway模块的resources目录新建一个application.yaml文件内容如下server: port: 8080 spring: application: name: gateway cloud: nacos: server-addr: 192.168.150.101:8848 gateway: routes: - id: item # 路由规则id自定义唯一 uri: lb://item-service # 路由的目标服务lb代表负载均衡会从注册中心拉取服务列表 predicates: # 路由断言判断当前请求是否符合当前规则符合则路由到目标服务 - Path/items/**,/search/** # 这里是以请求路径作为判断规则 - id: cart uri: lb://cart-service predicates: - Path/carts/** - id: user uri: lb://user-service predicates: - Path/users/**,/addresses/** - id: trade uri: lb://trade-service predicates: - Path/orders/** - id: pay uri: lb://pay-service predicates: - Path/pay-orders/**1.2.5.测试启动GatewayApplication以 http://localhost:8080 拼接微服务接口路径来测试。例如http://localhost:8080/items/page?pageNo1pageSize1此时启动UserApplication、CartApplication然后打开前端页面发现相关功能都可以正常访问了1.3.路由过滤-属性路由规则的定义语法如下spring: cloud: gateway: routes: - id: item uri: lb://item-service predicates: - Path/items/**,/search/**其中routes对应的类型如下是一个集合也就是说可以定义很多路由规则。集合中的RouteDefinition就是具体的路由规则定义其中常见的属性如下四个属性含义如下id路由的唯一标示uri路由目标地址lb://代表负载均衡从注册中心获取目标微服务的实例列表并且负载均衡选择一个访问。predicates路由断言其实就是匹配条件filters路由过滤条件后面讲这里我们重点关注predicates也就是路由断言。SpringCloudGateway中支持的断言类型有很多名称说明示例After是某个时间点后的请求- After2037-01-20T17:42:47.789-07:00[America/Denver]Before是某个时间点之前的请求- Before2031-04-13T15:14:47.43308:00[Asia/Shanghai]Between是某两个时间点之前的请求- Between2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]Cookie请求必须包含某些cookie- Cookiechocolate, ch.pHeader请求必须包含某些header- HeaderX-Request-Id, \dHost请求必须是访问某个host域名- Host**.somehost.org,**.anotherhost.orgMethod请求方式必须是指定方式- MethodGET,POSTPath请求路径必须符合指定规则- Path/red/{segment},/blue/**Query请求参数必须包含指定参数- Queryname, Jack或者- QuerynameRemoteAddr请求者的ip必须是指定范围- RemoteAddr192.168.1.1/24weight权重处理官网地址Route Predicate Factories :: Spring Cloud Gateway路由过滤器网关中提供了33种路由过滤器每种过滤器都有独特的作用。名称说明示例AddRequestHeader给当前请求添加一个请求头AddrequestHeaderheaderName,headerValueRemoveRequestHeader移除请求中的一个请求头RemoveRequestHeaderheaderNameAddResponseHeader给响应结果中添加一个响应头AddResponseHeaderheaderName,headerValueRemoveResponseHeader从响应结果中移除有一个响应头RemoveResponseHeaderheaderNameRewritePath请求路径重写RewritePath/red/?(?segment.*), /$\{segment}StripPrefix去除请求路径中的N段前缀StripPrefix1,则路径/a/b转发时只保留/bserver: port: 8080 spring: application: name: gateway cloud: nacos: server-addr: 192.168.100.128:8848 gateway: routes: - id: item-service uri: lb://item-service predicates: - Path/items/**,/search/** filters: - AddRequestHeaderX-Request-red, blue # 添加请求头 - id: user-service uri: lb://user-service predicates: - Path/addresses/**,/users/** default-filters: - AddRequestHeaderX-Request-red, blue # 默认添加请求头2.网关登录校验单体架构时我们只需要完成一次用户登录、身份校验就可以在所有业务中获取到用户信息。而微服务拆分后每个微服务都独立部署不再共享数据。也就意味着每个微服务都需要做登录校验这显然不可取。2.1.鉴权思路分析我们的登录是基于JWT来实现的校验JWT的算法复杂而且需要用到秘钥。如果每个微服务都去做登录校验这就存在着两大问题每个微服务都需要知道JWT的秘钥不安全每个微服务重复编写登录校验代码、权限校验代码麻烦既然网关是所有微服务的入口一切请求都需要先经过网关。我们完全可以把登录校验的工作放到网关去做这样之前说的问题就解决了只需要在网关和用户服务保存秘钥只需要在网关开发登录校验功能此时登录校验的流程如图不过这里存在几个问题网关路由是配置的请求转发是Gateway内部代码我们如何在转发之前做登录校验网关校验JWT之后如何将用户信息传递给微服务微服务之间也会相互调用这种调用不经过网关又该如何传递用户信息这些问题将在接下来几节一一解决。2.2.网关过滤器登录校验必须在请求转发到微服务之前做否则就失去了意义。而网关的请求转发是Gateway内部代码实现的要想在请求转发之前做登录校验就必须了解Gateway内部工作的基本原理。如图所示客户端请求进入网关后由HandlerMapping对请求做判断找到与当前请求匹配的路由规则Route然后将请求交给WebHandler去处理。WebHandler则会加载当前路由下需要执行的过滤器链Filter chain然后按照顺序逐一执行过滤器后面称为Filter。图中Filter被虚线分为左右两部分是因为Filter内部的逻辑分为pre和post两部分分别会在请求路由到微服务之前和之后被执行。只有所有Filter的pre逻辑都依次顺序执行通过后请求才会被路由到微服务。微服务返回结果后再倒序执行Filter的post逻辑。最终把响应结果返回如图中所示最终请求转发是有一个名为NettyRoutingFilter的过滤器来执行的而且这个过滤器是整个过滤器链中顺序最靠后的一个。如果我们能够定义一个过滤器在其中实现登录校验逻辑并且将过滤器执行顺序定义到NettyRoutingFilter之前这就符合我们的需求了那么该如何实现一个网关过滤器呢网关过滤器链中的过滤器有两种GatewayFilter路由过滤器作用范围比较灵活可以是任意指定的路由Route.GlobalFilter全局过滤器作用范围是所有路由不可配置。!注意过滤器链之外还有一种过滤器HttpHeadersFilter用来处理传递到下游微服务的请求头。例如org.springframework.cloud.gateway.filter.headers.XForwardedHeadersFilter可以传递代理请求原本的host头到下游微服务。其实GatewayFilter和GlobalFilter这两种过滤器的方法签名完全一致/** * 处理请求并将其传递给下一个过滤器 * param exchange 当前请求的上下文其中包含request、response等各种数据 * param chain 过滤器链基于它向下传递请求 * return 根据返回值标记当前请求是否被完成或拦截chain.filter(exchange)就放行了。 */ MonoVoid filter(ServerWebExchange exchange, GatewayFilterChain chain);FilteringWebHandler在处理请求时会将GlobalFilter装饰为GatewayFilter然后放到同一个过滤器链中排序以后依次执行。Gateway中内置了很多的GatewayFilter详情可以参考官方文档Spring Cloud GatewayGateway内置的GatewayFilter过滤器使用起来非常简单无需编码只要在yaml文件中简单配置即可。而且其作用范围也很灵活配置在哪个Route下就作用于哪个Route.例如有一个过滤器叫做AddRequestHeaderGatewayFilterFacotry顾明思议就是添加请求头的过滤器可以给请求添加一个请求头并传递到下游微服务。使用的使用只需要在application.yaml中这样配置spring: cloud: gateway: routes: - id: test_route uri: lb://test-service predicates: -Path/test/** filters: - AddRequestHeaderkey, value # 逗号之前是请求头的key逗号之后是value如果想要让过滤器作用于所有的路由则可以这样配置spring: cloud: gateway: default-filters: # default-filters下的过滤器可以作用于所有路由 - AddRequestHeaderkey, value routes: - id: test_route uri: lb://test-service predicates: -Path/test/**2.3.自定义过滤器无论是GatewayFilter还是GlobalFilter都支持自定义只不过编码方式、使用方式略有差别。2.3.1.自定义GatewayFilter自定义GatewayFilter不是直接实现GatewayFilter而是实现AbstractGatewayFilterFactory。最简单的方式是这样的Component public class PrintAnyGatewayFilterFactory extends AbstractGatewayFilterFactoryObject { Override public GatewayFilter apply(Object config) { return new GatewayFilter() { Override public MonoVoid filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 获取请求 ServerHttpRequest request exchange.getRequest(); // 编写过滤器逻辑 System.out.println(过滤器执行了); // 放行 return chain.filter(exchange); } }; } }!注意该类的名称一定要以GatewayFilterFactory为后缀然后在yaml配置中这样使用spring: cloud: gateway: default-filters: - PrintAny # 此处直接以自定义的GatewayFilterFactory类名称前缀类声明过滤器另外这种过滤器还可以支持动态配置参数不过实现起来比较复杂示例Component public class PrintAnyGatewayFilterFactory // 父类泛型是内部类的Config类型 extends AbstractGatewayFilterFactoryPrintAnyGatewayFilterFactory.Config { Override public GatewayFilter apply(Config config) { // OrderedGatewayFilter是GatewayFilter的子类包含两个参数 // - GatewayFilter过滤器 // - int order值值越小过滤器执行优先级越高 return new OrderedGatewayFilter(new GatewayFilter() { Override public MonoVoid filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 获取config值 String a config.getA(); String b config.getB(); String c config.getC(); // 编写过滤器逻辑 System.out.println(a a); System.out.println(b b); System.out.println(c c); // 放行 return chain.filter(exchange); } }, 100); } // 自定义配置属性成员变量名称很重要下面会用到 Data static class Config{ private String a; private String b; private String c; } // 将变量名称依次返回顺序很重要将来读取参数时需要按顺序获取 Override public ListString shortcutFieldOrder() { return List.of(a, b, c); } // 返回当前配置类的类型也就是内部的Config Override public ClassConfig getConfigClass() { return Config.class; } }然后在yaml文件中使用spring: cloud: gateway: default-filters: - PrintAny1,2,3 # 注意这里多个参数以,隔开将来会按照shortcutFieldOrder()方法返回的参数顺序依次复制上面这种配置方式参数必须严格按照shortcutFieldOrder()方法的返回参数名顺序来赋值。还有一种用法无需按照这个顺序就是手动指定参数名spring: cloud: gateway: default-filters: - name: PrintAny args: # 手动指定参数名无需按照参数顺序 a: 1 b: 2 c: 32.3.2.自定义GlobalFilter自定义GlobalFilter则简单很多直接实现GlobalFilter即可而且也无法设置动态参数Component public class PrintAnyGlobalFilter implements GlobalFilter, Ordered { Override public MonoVoid filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 编写过滤器逻辑 System.out.println(未登录无法访问); // 放行 // return chain.filter(exchange); // 拦截 ServerHttpResponse response exchange.getResponse(); response.setRawStatusCode(401); return response.setComplete(); } Override public int getOrder() { // 过滤器执行顺序值越小优先级越高 return 0; } }2.4.登录校验接下来我们就利用自定义GlobalFilter来完成登录校验。2.4.1.JWT工具登录校验需要用到JWT而且JWT的加密需要秘钥和加密工具。这些在hm-service中已经有了我们直接拷贝过来具体作用如下AuthProperties配置登录校验需要拦截的路径因为不是所有的路径都需要登录才能访问JwtProperties定义与JWT工具有关的属性比如秘钥文件位置SecurityConfig工具的自动装配JwtToolJWT工具其中包含了校验和解析token的功能hmall.jks秘钥文件其中AuthProperties和JwtProperties所需的属性要在application.yaml中配置hm: jwt: location: classpath:hmall.jks # 秘钥地址 alias: hmall # 秘钥别名 password: hmall123 # 秘钥文件密码 tokenTTL: 30m # 登录有效期 auth: excludePaths: # 无需登录校验的路径 - /search/** - /users/login - /items/**2.4.2.登录校验过滤器接下来我们定义一个登录校验的过滤器代码如下package com.hmall.gateway.filter; import com.hmall.common.exception.UnauthorizedException; import com.hmall.common.utils.CollUtils; import com.hmall.gateway.config.AuthProperties; import com.hmall.gateway.util.JwtTool; import lombok.RequiredArgsConstructor; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.Ordered; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.http.server.reactive.ServerHttpResponse; import org.springframework.stereotype.Component; import org.springframework.util.AntPathMatcher; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; import java.util.List; Component RequiredArgsConstructor EnableConfigurationProperties(AuthProperties.class) public class AuthGlobalFilter implements GlobalFilter, Ordered { private final JwtTool jwtTool; private final AuthProperties authProperties; private final AntPathMatcher antPathMatcher new AntPathMatcher(); Override public MonoVoid filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 1.获取Request ServerHttpRequest request exchange.getRequest(); // 2.判断是否不需要拦截 if(isExclude(request.getPath().toString())){ // 无需拦截直接放行 return chain.filter(exchange); } // 3.获取请求头中的token String token null; ListString headers request.getHeaders().get(authorization); if (!CollUtils.isEmpty(headers)) { token headers.get(0); } // 4.校验并解析token Long userId null; try { userId jwtTool.parseToken(token); } catch (UnauthorizedException e) { // 如果无效拦截 ServerHttpResponse response exchange.getResponse(); response.setRawStatusCode(401); return response.setComplete(); } // TODO 5.如果有效传递用户信息 System.out.println(userId userId); // 6.放行 return chain.filter(exchange); } private boolean isExclude(String antPath) { for (String pathPattern : authProperties.getExcludePaths()) { if(antPathMatcher.match(pathPattern, antPath)){ return true; } } return false; } Override public int getOrder() { return 0; } }重启测试会发现访问/items开头的路径未登录状态下不会被拦截访问其他路径则未登录状态下请求会被拦截并且返回401状态码2.5.微服务获取用户现在网关已经可以完成登录校验并获取登录用户身份信息。但是当网关将请求转发到微服务时微服务又该如何获取用户身份呢由于网关发送请求到微服务依然采用的是Http请求因此我们可以将用户信息以请求头的方式传递到下游微服务。然后微服务可以从请求头中获取登录用户信息。考虑到微服务内部可能很多地方都需要用到登录用户信息因此我们可以利用SpringMVC的拦截器来实现登录用户信息获取并存入ThreadLocal方便后续使用。据图流程图如下因此接下来我们要做的事情有改造网关过滤器在获取用户信息后保存到请求头转发到下游微服务编写微服务拦截器拦截请求获取用户信息保存到ThreadLocal后放行2.5.1.保存用户到请求头首先我们修改登录校验拦截器的处理逻辑保存用户信息到请求头中2.5.2.拦截器获取用户在hm-common中已经有一个用于保存登录用户的ThreadLocal工具其中已经提供了保存和获取用户的方法接下来我们只需要编写拦截器获取用户信息并保存到UserContext然后放行即可。由于每个微服务都有获取登录用户的需求因此拦截器我们直接写在hm-common中并写好自动装配。这样微服务只需要引入hm-common就可以直接具备拦截器功能无需重复编写。我们在hm-common模块下定义一个拦截器具体代码如下package com.hmall.common.interceptor; import cn.hutool.core.util.StrUtil; import com.hmall.common.utils.UserContext; import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class UserInfoInterceptor implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 1.获取请求头中的用户信息 String userInfo request.getHeader(user-info); // 2.判断是否为空 if (StrUtil.isNotBlank(userInfo)) { // 不为空保存到ThreadLocal UserContext.setUser(Long.valueOf(userInfo)); } // 3.放行 return true; } Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 移除用户 UserContext.removeUser(); } }接着在hm-common模块下编写SpringMVC的配置类配置登录拦截器具体代码如下package com.hmall.common.config; import com.hmall.common.interceptors.UserInfoInterceptor; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.DispatcherServlet; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; Configuration ConditionalOnClass(DispatcherServlet.class) public class MvcConfig implements WebMvcConfigurer { Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new UserInfoInterceptor()); } }不过需要注意的是这个配置类默认是不会生效的因为它所在的包是com.hmall.common.config与其它微服务的扫描包不一致无法被扫描到因此无法生效。基于SpringBoot的自动装配原理我们要将其添加到resources目录下的META-INF/spring.factories文件中内容如下org.springframework.boot.autoconfigure.EnableAutoConfiguration\ com.hmall.common.config.MyBatisConfig,\ com.hmall.common.config.MvcConfig2.5.3.恢复购物车代码之前我们无法获取登录用户所以把购物车服务的登录用户写死了现在需要恢复到原来的样子。找到cart-service模块的com.hmall.cart.service.impl.CartServiceImpl修改其中的queryMyCarts方法2.6.OpenFeign传递用户前端发起的请求都会经过网关再到微服务由于我们之前编写的过滤器和拦截器功能微服务可以轻松获取登录用户信息。但有些业务是比较复杂的请求到达微服务后还需要调用其它多个微服务。比如下单业务流程如下下单的过程中需要调用商品服务扣减库存调用购物车服务清理用户购物车。而清理购物车时必须知道当前登录的用户身份。但是订单服务调用购物车时并没有传递用户信息购物车服务无法知道当前用户是谁由于微服务获取用户信息是通过拦截器在请求头中读取因此要想实现微服务之间的用户信息传递就必须在微服务发起调用时把用户信息存入请求头。微服务之间调用是基于OpenFeign来实现的并不是我们自己发送的请求。我们如何才能让每一个由OpenFeign发起的请求自动携带登录用户信息呢这里要借助Feign中提供的一个拦截器接口feign.RequestInterceptorpublic interface RequestInterceptor { /** * Called for every request. * Add data using methods on the supplied {link RequestTemplate}. */ void apply(RequestTemplate template); }我们只需要实现这个接口然后实现apply方法利用RequestTemplate类来添加请求头将用户信息保存到请求头中。这样以来每次OpenFeign发起请求的时候都会调用该方法传递用户信息。由于FeignClient全部都是在hm-api模块因此我们在hm-api模块的com.hmall.api.config.DefaultFeignConfig中编写这个拦截器在com.hmall.api.config.DefaultFeignConfig中添加一个BeanBean public RequestInterceptor userInfoRequestInterceptor(){ return new RequestInterceptor() { Override public void apply(RequestTemplate template) { // 获取登录用户 Long userId UserContext.getUser(); if(userId null) { // 如果为空则直接跳过 return; } // 如果不为空则放入请求头中传递给下游微服务 template.header(user-info, userId.toString()); } }; }好了现在微服务之间通过OpenFeign调用时也会传递登录用户信息了。3.配置管理
