简单的介绍了SpringCloud中的Gateway。
为什么需要网关?
原理示意:网关集中承接外部流量,把认证、权限校验、限流与路由等入口职责组织起来。本文的 /user/** 匹配用户服务,lb://userservice 表示通过服务发现与负载均衡选择实例;这些策略需要相应配置或实现,不会仅因引入网关依赖便全部自动生效。
网关的技术实现
在SpringCloud中网关的实现包括两种:
- gateway
- Zuul
- Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
网关的作用
- 对用户请求做身份认证、权限校验
- 将用户请求路由到微服务,并实现负载均衡
- 对用户请求做限流
搭建网关的步骤
- 创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现依赖:
<!--nacos服务注册发现依赖--><dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!--网关gateway依赖--><dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId></dependency>- 编写路由配置及nacos地址
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/开头就符合要求路由配置
网关路由可以配置的内容包括
- 路由id:路由唯一标示
- uri:路由目的地,支持lb和http两种
- predicates:路由断言,判断请求是否符合要求,符合则转发到路由目的地
- filters:路由过滤器,处理请求或响应
路由断言工厂Route Predicate Factory
| 名称 | 说明 | 示例 |
|---|---|---|
| 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-ld,\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
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理,共计三十一中,具体配置官网查看
路由过滤器配置在某条路由的 filters 下,只处理匹配该路由的请求。理解时分清三个步骤:predicates 判断请求是否匹配,uri 指定转发目标,filters 在转发前后处理请求或响应。例如统一添加请求头、调整路径或补充响应头,属于过滤器职责而不是新的业务接口。配置语法与可用工厂以当前 Gateway 版本为准,不把过滤器数量当作固定常量。
当多条路由需要相同的过滤规则时,可以把公共规则放到 spring.cloud.gateway.default-filters,避免在每条路由中重复声明。它表示默认应用的路由过滤器配置,并不是替请求选择目标的“默认路由器”。单条路由仍可声明自己的 filters;需要自定义通用逻辑时,再考虑下面介绍的 GlobalFilter,并检查公共规则与局部规则是否产生重复处理。
全局过滤器
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。定义方式是实现GlobalFilter接口。
举例如下:
需求:
定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
- 参数中是否有authorization
- authorization参数值是否为admin
如果同时满足则放行,否则拦截
//@Order(-1) //过滤器顺序,越小越优先@Componentpublic class AuthorizeFilter implements GlobalFilter, Ordered { @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(); }
@Override public int getOrder() { return -1; }}过滤器链执行顺序
原理示意:正常放行时,前置处理按 order 从小到大进入过滤器链,响应的后置处理沿已建立的嵌套顺序返回。直接结束响应会短路后续处理;同一 order 下的类型顺序需结合版本和实际注册方式核对,不能仅依赖类型名称判断。
过滤器执行顺序
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
跨域问题处理
跨域:域名不一致就是跨域,主要包括:
- 域名不同:www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
- 域名相同,端口不同:localhost:8080和localhost8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
解决方案:CORS
spring: cloud: gateway: #。。。 globalcors: # 全局的跨域处理 add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 corsConfigurations: '[/**]': allowed0rigins: # 允许哪些网站的跨域请求 - "http://localhost:8090" - "http://www.leyou.com" allowedMethods: # 允许的跨域ajax的请求方式 - "GET" - "POST" - "DELETE" - "PUT" - "OPTIONS" allowedHeaders: "*” # 允许在请求中携带的头信息 allowCredentials: true # 是否允许携带 cookiemaxAge: 360000 # 这次跨域检测的有效期