1 为什么需要网关
网关功能:
- 身份认证和权限校验
- 服务路由,负载均衡
- 请求限流
网关的技术实现
在SpringCloud中网关的实现包括两种:
- gateway
- zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
2 搭建网关服务
搭建网关服务的步骤:
- 创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现依赖,编写启动类:
<!--网关gateway依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class,args);
}
}
- 编写路由配置及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: order-service
uri: lb://userservice
predicates:
- Path=/order/**
3 网关处理请求的流程
4 路由断言工厂Route Predicate Factory
网关路由可以配置的内容包括:
-
路由id:路由唯一标示
-
uri:路由目的地,支持lb和http两种
-
predicates:路由断言,判断请求是否符合要求,符合则转发到路由目的地
-
filters:路由过滤器,处理请求或响应
-
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
-
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的 -
像这样的断言工厂在SpringCloudGateway还有十几个
Spring提供了11种基本的Predicate工厂:
spring官方文档给出了相应的使用方式:
5 路由过滤器GatewayFilter
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
Spring提供了31种不同的路由过滤器工厂。例如:
spring官网也给了相关的使用方法:
案例:给所有进入userservice的请求添加一个请求头
给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!
实现方式:
- 在gateway中修改application.yml文件,给userservice的路由添加过滤器:
filters: # 过滤器 对指定的微服务生效
- AddRequestHeader=Truth,Itcast is freaking aowsome!
- 给UserController类中的请求加一个参数来验证是否添加请求头成功
default-filters: # 过滤器 全局有效,对所有微服务的请求都有效
- AddRequestHeader=Truth,Itcast is freaking aowsome!
6 全局过滤器GlobalFilter
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。
区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。
定义方式是实现GlobalFilter接口。
public interface GlobalFilter {
/**
*处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
*
*@param exchange请求上下文,里面可以获取Request、Response等信息
* @param chain用来把请求委托给下一个过滤器
* @return {@code Mono<Void>}返回标示当前过滤器业务结束
*/
Mono<Void> filter(ServerWebExchange exchange,GatewayFilterChain chain);
}
案例:定义全局过滤器,拦截并判断用户身份
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
- 参数中是否有authorization
- authorization参数值是否为admin
如果同时满足则放行,否则拦截
// @Order(-1) 过滤器的优先级 也可用实现Orderd接口实现
@Component
public 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.是 放行
chain.filter(exchange);
}
// 5.否 拦截
// 5.1 设置状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
// 5.2 拦截请求
return exchange.getResponse().setComplete();
}
@Override
public int getOrder() {
return -1;
}
}
7 过滤器执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高执行顺序越靠前。
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
当过滤器的order值一样时,会按照defaultFilter >路由过滤器 >GlobalFilter的顺序执行。
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator //getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWlebHandler //handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链
8 跨域问题处理
跨域:域名不一致就是跨域,主要包括:
- 域名不同: www.taobao.com和www.taobao.org 和 www.jd.com和miaosha.jd.com
- 域名相同,端口不同: localhost:8080和localhost8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
解决方案:CORS
网关处理跨域采用的同样是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 # 这次跨域检测的有效期