1.什么是gateway
所谓的API网关,就是指系统的统一入口,它封装了应用程序的内部结构,为客户端提供统一服 务,一些与业务本身功能无关的公共逻辑可以在这里实现,诸如认证、鉴权、监控(黑白名单)、路由转发等等。
常见的API网关:
l Ngnix+lua
使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用
lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本
l Kong
基于Nginx+Lua开发,性能高,稳定,有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题:
只支持Http协议;二次开发,自由扩展困难;提供管理API,缺乏更易用的管控、配置方式。
l Zuul 1.0----老的微服务项目
Netflix开源的网关,功能丰富,使用JAVA开发,易于二次开发 问题:缺乏管控,无法动态配
置;依赖组件较多;处理Http请求依赖的是Web容器,性能不如Nginx
Netflix提出理论---Zuul2.0 远远超过1.0---实际的产品没有出来。
l Spring Cloud Gateway
Spring公司为了替换Zuul而开发的网关服务,将在下面具体介绍。
注意:SpringCloud alibaba技术栈中并没有提供自己的网关,我们可以采用Spring Cloud Gateway来做网关
Gateway简介
Spring Cloud Gateway是Spring公司基于Spring 5.0,Spring Boot 2.0 和 Project Reactor 等术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflix Zuul,其不仅提供统一的路由方式,并且基于 Filter 链的方式提供了网关基本的功能,例如:安全,监控和限流。
2.如何使用gateway
2.1项目搭建
1)创建一个maven项目
2)引入相关依赖
<!--相关依赖-->
<dependencies>
<!--如果引入了gateway的依赖,那么不能引用spring-boot-starter-web的依赖
gateway使用的服务netty服务,如果你引入web,而web使用的tomcat服务器,俩个服务会出现-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
</dependencies>
3)创建主启动类
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);
}
}
4)创建配置文件application.yml
# 端口号
server:
port: 81
# 起服务器名称
spring:
application:
name: hmq-gateway #网关服务名称
#gateway路径规则
cloud:
gateway:
routes:
- id: hmq-product # 路由的标识---只要唯一即可,如果没有默认UUID生成一个
uri: http://lovalhost:8001 # 真实要转发的地址
predicates: #断言:当满足断言的条件时,才会真正转发到uri地址
- Path=/product/**
- id: hmq-order
uri: http://localhost:9001
predicates:
- Path=/order/**
5)记得启动nacos
6)启动主启动类
2.2问题发现:
发现uri地址是一个死数据,未来我们可以是集群。
如何解决? --我们也可以把网关交于注册中心来管理,那么网关就可以从注册中心拉取服务信息。
1)在网关中引入nacos依赖
<!--nacos依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
2)修改配置文件
主启动类运行,发现8003的端口也打印了内容
思考: 如果未来我们有1w个微服务,那么就需要在gateway中配置1w微服务的路由。
解决方案: 可以使用gateway自动定位功能
访问时:
原理:
2.3gateway常见的断言
l 基于Datetime类型的断言工厂*
此类型的断言根据时间做判断,主要有三个:
AfterRoutePredicateFactory: 接收一个日期参数,判断请求日期是否晚于指定日期
BeforeRoutePredicateFactory: 接收一个日期参数,判断请求日期是否早于指定日期
BetweenRoutePredicateFactory: 接收两个日期参数,判断请求日期是否在指定时间段内
-After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]
基于远程地址的断言工厂RemoteAddrRoutePredicateFactory
接收一个IP地址段,判断请求主机地址是否在地址段中
-RemoteAddr=192.168.1.1/24
l 基于Cookie的断言工厂
CookieRoutePredicateFactory:接收两个参数,cookie 名字和一个正则表达式。 判断请求
cookie是否具有给定名称且值与正则表达式匹配。
-Cookie=chocolate, ch.
l 基于Header的断言工厂
HeaderRoutePredicateFactory:接收两个参数,标题名称和正则表达式。 判断请求Header是否
具有给定名称且值与正则表达式匹配。 key value
-Header=X-Request-Id, \d+
l *基于**Host**的断言工厂*
HostRoutePredicateFactory:接收一个参数,主机名模式。判断请求的Host是否满足匹配规则。
-Host=**.testhost.org
l 基于Method请求方法的断言工厂
MethodRoutePredicateFactory:接收一个参数,判断请求类型是否跟指定的类型匹配。
-Method=GET
l 基于Path请求路径的断言工厂
PathRoutePredicateFactory:接收一个参数,判断请求的URI部分是否满足路径规则。
-Path=/foo/{segment}基于Query请求参数的断言工厂
QueryRoutePredicateFactory :接收两个参数,请求param和正则表达式, 判断请求参数是否具
有给定名称且值与正则表达式匹配。
-Query=baz, ba.
l 基于路由权重的断言工厂
WeightRoutePredicateFactory:接收一个[组名,权重], 然后对于同一个组内的路由按照权重转发
routes:
-id: weight_route1 uri: host1 predicates:
-Path=/product/**
-Weight=group3, 1
-id: weight_route2 uri: host2 predicates:
-Path=/product/**
-Weight= group3, 9
2.4gateway内置的过滤器
2.5自定义过滤器--全局过滤器
认证判断
权限校验
黑白名单
跨域配置
认证判断
- 当客户端第一次请求服务时,服务端对用户进行信息认证(登录)
- 认证通过,将用户信息进行加密形成token,返回给客户端,作为登录凭证
- 以后每次请求,客户端都携带认证的token
- 服务端对token进行解密,判断是否有效。
如上图,对于验证用户是否已经登录鉴权的过程可以在网关统一检验。
检验的标准就是请求中是否携带token凭证以及token的正确性。
如何定义全局过滤器:
1)创建filter包,LoginFilter
import com.alibaba.fastjson.JSON;
import com.hmq.vo.FilterUrl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
@Component
public class LoginFilter implements GlobalFilter, Ordered {
@Autowired
private FilterUrl filterUrl;
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
ServerHttpRequest request = exchange.getRequest();
ServerHttpResponse response = exchange.getResponse();
//过滤的业务代码
//1.获取请求路径
String path = request.getPath().toString();
//判断该路径是否放行路径
if (filterUrl.getWhitePaths().contains(path)){
return chain.filter(exchange);
}
//获取请求头
String token = request.getHeaders().getFirst("token");
if(StringUtils.hasText(token)&&"admin".equals(token)){
//查看redis中是否存在该token
return chain.filter(exchange);//放行
}
//json数据
Map<String,Object> map = new HashMap<>();
map.put("msg","未登录");
map.put("code",403);
//3.3作JSON转换
byte[] bytes = JSON.toJSONString(map).getBytes(StandardCharsets.UTF_8);
//3.4调用bufferFactory方法,生成DataBuffer对象
DataBuffer buffer = response.bufferFactory().wrap(bytes);
//4.调用Mono中的just方法,返回要写给前端的JSON数据
return response.writeWith(Mono.just(buffer));
}
//Ordered:优先级 值越小 优先级越高
@Override
public int getOrder() {
return 0;
}
}
2)导入json依赖,配合LoginFilter
<!--json依赖-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.83</version>
</dependency>
3)修改配置文件
#过滤器路径
filter:
whitePaths: #白名单路径
- "/product/login"
- "/product/aaa"
- "/product/bbb"
blackPaths:
- "/product/ccc"
4)创建vo包 FilterUrl
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.HashSet;
import java.util.Set;
@Component
@ConfigurationProperties(prefix = "filter")
public class FilterUrl {
private Set<String> whitePaths = new HashSet<>();
private Set<String> blackPaths = new HashSet<>();
public FilterUrl() {
}
//构造函数
public FilterUrl(Set<String> whitePaths, Set<String> blackPaths) {
this.whitePaths = whitePaths;
this.blackPaths = blackPaths;
}
/**
* 获取
* @return whitePaths
*/
public Set<String> getWhitePaths() {
return whitePaths;
}
/**
* 设置
* @param whitePaths
*/
public void setWhitePaths(Set<String> whitePaths) {
this.whitePaths = whitePaths;
}
/**
* 获取
* @return blackPaths
*/
public Set<String> getBlackPaths() {
return blackPaths;
}
/**
* 设置
* @param blackPaths
*/
public void setBlackPaths(Set<String> blackPaths) {
this.blackPaths = blackPaths;
}
public String toString() {
return "FilterUrl{whitePaths = " + whitePaths + ", blackPaths = " + blackPaths + "}";
}
}
解决跨域问题
1)写个跨域配置类
@Configuration
public class CorConfig {
// 当前跨域请求最大有效时长。这里默认1天
private static final long MAX_AGE = 24 * 60 * 60;
@Bean
public CorsFilter corsFilter() {
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
CorsConfiguration corsConfiguration = new CorsConfiguration();
corsConfiguration.addAllowedOrigin("*"); // 1 设置访问源地址
corsConfiguration.addAllowedHeader("*"); // 2 设置访问源请求头
corsConfiguration.addAllowedMethod("*"); // 3 设置访问源请求方法
corsConfiguration.setMaxAge(MAX_AGE);
source.registerCorsConfiguration("/**", corsConfiguration); // 4 对接口配置跨域设置
return new CorsFilter(source);
}
}
2)跨域解决写在配置文件中
spring:
application:
name: gateway #服务名称
cloud:
nacos:
discovery:
server-addr: localhost:8848 #nacos地址
gateway:
globalcors:
add-to-simple-url-handler-mapping: true
cors-configurations:
'[/**]': #拦截的请求
allowedOrigins: #允许跨域的请求
- "http://localhost:8080"
allowedMethods: #运行跨域的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" #允许请求中携带的头信息
allowCredentials: true #是否允许携带cookie
maxAge: 36000 #跨域检测的有效期,单位s
方案任选其一即可