Gateway网关是我们服务的守门神,所有微服务的统一入口。
网关功能:
身份认证和权限校验:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
服务路由、负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
请求限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
在SpringCloud中网关的实现包括两种:
Gateway
Zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
引入SpringCloudGateway的依赖和nacos的服务发现依赖:
1 <!--网关gateway依赖-->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>
1 @SpringBootApplication 2 public class GatewayApplication { 3 public static void main(String[] args) { 4 SpringApplication.run(GatewayApplication.class, args); 5 } 6 }
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(loadBalance)就是负载均衡,后面跟服务名称 14 predicates: # 路由断言,也就是判断请求是否符合路由规则的条件 15 - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件。
例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的。
像这样的断言工厂在SpringCloudGateway还有十几个:
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
路由过滤器的种类
Spring提供了31种不同的路由过滤器工厂。例如:
需求:给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!
在gateway中修改application.yml文件,给userservice的路由添加过滤器。只对当前路由的请求生效:
spring:cloud:gateway:routes:- id: user-service uri: lb://userservice predicates: - Path=/user/** filters: # 过滤器- AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:
spring:application:name: gateway # 服务名称cloud:nacos:server-addr: localhost:8848 # nacos地址gateway:routes: # 网关路由配置- id: user-service uri: lb://userservice predicates: - Path=/user/** - id: order-serviceuri: lb://orderservicepredicates:- Path=/order/** default-filters: # 默认过滤器,会对所有的路由请求都生效- AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头
全局过滤器 GlobalFilter
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与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 }
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
1.参数中是否有authorization;
2.authorization参数值是否为admin。
如果同时满足则放行,否则拦截。
步骤:
1.实现GlobalFilter接口
2.编写处理逻辑
3.添加@Order注解或实现Ordered接口
实现:
在gateway中定义一个过滤器:
1 @Order(-1) 2 @Component3 public class AuthorizeFilter implements GlobalFilter {4 @Override5 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 }
@Order 注解是顺序注解,设置过滤器执行顺序。数值越小优先级越高。
除添加@Order注解外还可以实现Ordered接口:
public class AuthorizeFilter implements GlobalFilter, Ordered {
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
1、每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
2、GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定。
3、路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
4、当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
可以参考下面几个类的源码来查看:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链。
跨域:域名不一致就是跨域,主要包括:
域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com。
域名相同,端口不同:localhost:8080和localhost:8081。
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题。
解决方案:CORS,Cross-origin resource sharing 跨域资源共享
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 # 是否允许携带cookiemaxAge: 360000 # 这次跨域检测的有效期