目录
一、为什么需要网关
二、网关技术的实现
在SpringCloud中网关的实现包括两种:
-
Gateway:SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
-
Zuul:基于Servlet的实现,属于阻塞式编程。
三、搭建网关服务
1、创建新module,引入依赖
//gateway
implementation 'org.springframework.cloud:spring-cloud-starter-gateway'
//nacos-discovery
implementation 'com.alibaba.cloud:spring-cloud-starter-alibaba-nacos-discovery'
2、编写路由配置及nacos地址
server:
port: 10010
spring:
main:
web-application-type: reactive
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:80
discovery:
# 命名空间ID
namespace: 44480e91-8290-43e4-9129-2d2d42ecd30a
# 配置集群名称,也就是机房位置,如:HZ,杭州
cluster-name: HZ
# nacos登录
username: nacos
password: nacos
# 是否是临时实例
ephemeral: true
gateway:
routes: # 网关路由配置
- id: user-service # 路由id,自定义,只要唯一即可
# uri: http://127.0.0.1:8081 # 路由的目标固定地址
uri: lb://user-service # 路由的目标地址,lb就是负载均衡
predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
- Path=/user/** # 这个就是按照路径匹配,只要以/user/开头就符合要求
四、路由断言工厂
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件。例如Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理。
1、网关路由可以配置的内容包括:
路由id:路由唯一标识
uri:路由目的地,支持lb和http两种
predicates:路由断言,判断请求是否符合要求,符合则转发到路由目的地
filters:路由过滤器,处理请求或响应
2、Spring提供了11种基本的Predicate工厂:
spring:
cloud:
gateway:
routes: # 网关路由配置
- id: user-service # 路由id,自定义,只要唯一即可
# uri: http://127.0.0.1:8081 # 路由的目标固定地址
uri: lb://user-service # 路由的目标地址,lb就是负载均衡
predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
# 这个就是按照路径匹配,只要以/user/开头就
- Path=/user/**
# 接收某个时间点之后的请求
- After=2037-01-20T17:42:47.789-07:00[America/Denver]
# 接收某个时间点之前的请求
- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
# 接收两个时间点之间的请求
- Between=2037-01-20T17:42:47.789-07:00[America/Denver],2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
# 请求必须包含某些cookie
- Cookie=chocolate,ch.p
# 请求必须包含某些header
- Header=X-Request-Id,\d+
# 请求必须是访问某个host(域名)
- Host=**.somehost.org,**.anotherhost.org
# 请求方式必须是指定方式
- Method=GET,POST
# 请求路径必须符合指定规则
- Path=/red/{segment},/blue/**
# 请求参数必须包含指定参数
- Query=name,Jack
- Query=name
# 请求者的IP必须是指定范围
- RemoteAddr=192.168.1.1/24
# 权重处理
- Weight=1
五、路由过滤器GatewayFilter
1、GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
2、过滤器工程GatewayFilterFactory,Spring提供了31种不同的路由过滤器工厂。例如:
AddRequestHeader:给当前请求添加一个请求头
RemoveRequestHeader:移除请求中的一个请求头
AddResponseHeader:给响应结果中添加一个响应头
RemoveResponseHeader:从响应结果中移除有一个响应头
RequestRateLimiter:限制请求的流量
3、使用示例
spring:
cloud:
gateway:
routes: # 网关路由配置
- id: user-service # 路由id,自定义,只要唯一即可
# uri: http://127.0.0.1:8081 # 路由的目标固定地址
uri: lb://user-service # 路由的目标地址,lb就是负载均衡
predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
# 这个就是按照路径匹配,只要以/user/开头就
- Path=/user/**
filters: # 过滤器
# 给user-service的请求添加一个请求头
- AddRequestHeader=Truth,Itcast is freaking awesome
default-filters: # 默认过滤器,会对所有的路由请求都生效
- AddRequestHeader=Truth,Itcast is freaking awesome
@RequestMapping("/user")
@RestController
public class UserController {
/**
* truth:获取filters设置的请求头
*/
@GetMapping("/{userId}")
public User getUserById(@PathVariable Long userId, @RequestHeader(value = "Truth", required = false) String truth) {
@Autowired
private UserService userService;
QueryWrapper<User> userWrapper = new QueryWrapper<>();
userWrapper.eq("user_id", userId);
System.out.println("truth:" + truth);
return userService.getOne(userWrapper);
}
}
六、全局过滤器 GlobalFilter
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。
区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。
1、定义方式:实现GlobalFilter接口
public interface GlobalFilter {
/**
* 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
* @param exchange 请求上下文,里面可以获取Request、Response等信息
* @param chain 用来把请求委托给下一个过滤器
* @return {@code Mono<Void>} 返回标示当前过滤器业务结束
*/
Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
2、示例:定义全局过滤器,拦截请求并判断用户身份
/**
* 参数中是否有authorization
* authorization参数值是否为admin
* 如果满足条件则放行,否则拦截
*/
//@Order(-1) //指定过滤器顺序
@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.是,放行
return chain.filter(exchange);
}
//否,拦截
//设置状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
//拦截请求
return exchange.getResponse().setComplete();
}
@Override
public int getOrder() {
return -1;
}
}
3、指定过滤器顺序
-
添加@Order(-1)注解
-
实现Ordered接口
七、过滤器执行顺序
-
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter。
-
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器。
-
过滤器执行顺序
GlobalFilter通过添加@Order(-1)注解或实现Ordered接口来指定order值。
每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
当过滤器的order值一样时,会按照defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
可以参考下面几个类的源码来查看:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters方法是先加载defaultFilter,然后再加载某个route的filter,然后合并。
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
-
网关处理跨域采用的同样是CORS方案,并且只需要简单配置即可实现:
spring:
cloud:
gateway:
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
cors-configurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
- "http://www.leyou.com"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期