前言

在这篇文章介绍并记录关于Spring Cloud Gateway 网关的简单应用。

什么是服务网关

分布式架构的基础是微服务，所有的功能模块都会被抽成一个独立的微服务，而服务网关就是让所有的外部调用都要先经过一个总的入口，这个总的入口就相当于一道墙，把外部与内部的所有服务接口隔开，所有外部调用都要先经过这个总入口，由这个总的入口来决定，要调用哪个服务，这个总的入口就是路由网关，然后路由网关决定你需要调用哪些服务，内部的服务之间也是可以相互调用，如果有必要很多的服务会集群部署，包括总入口路由网关。下面为某学习网的课程截图

image.png

官网上的Spring Cloud GateWay

Spring Cloud GateWay是Spring官方基于Spring 5.0，Spring Boot 2.0和Project Reactor等技术开发的网关，Spring Cloud Gateway旨在为微服务架构提供一种简单而有效的统一的API路由管理方式。Spring Cloud Gateway作为Spring Cloud生态系中的网关，目标是替代Netflix ZUUL，其不仅提供统一的路由方式，并且基于Filter链的方式提供了网关基本的功能，例如：安全，监控/埋点，和限流等。

官网上网关的工作流程

image.png

一、 Zuul的服务过滤

在服务网关中定义过滤器只需要继承 ZuulFilter 抽象类并实现其定义的 四个抽象方法 就可以对请求进行拦截和过滤。

1.1 服务网关的自定义过滤器四个方法实现

自定义过滤器只需要继承 com.netflix.zuul.ZuulFilter 抽象类，实现里面的四个方法

方法                                        作用
public String filterType()  //定义过滤器的类型
public int filterOrder()    //定义过滤器的执行优先级
public boolean shouldFilter()   //是否启用当前过滤器
public Object run() //过滤器真正执行的内容（做的事情）

1.2 Zuul 支持以下四种过滤器

//过滤器类型 说明
pre（前置过滤器）  //在请求被路由之前调用。Zuul请求微服务之前。比如请求身份验证，选择微服务实例，记录调试信息等。
post（后置过滤器） //目标服务被调用被将响应发回调用者后被调用（在route和error过滤器之后被调用）。//通常用于记录从目标服务返回的响应、处理错误或审核敏感信息。
route（路由过滤器）    //负责转发请求到微服务，在目标服务被调用之前拦截调用。通常用来做动态路由。
error（错误过滤器）    //在产生错误是调用，用于对错误进行统一处理。

二、网关转发访问

再接下来的就是在原项目上使用网关转发和自定义过滤器的案例

2.1 添加pom依赖包

添加 Eureka客户端和网关依赖包

 <!--服务发现-->
   <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- 服务网关 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>

2.2 配置routes网关项目的yml

在项目上会配置关于user-server服务和appoint服务。
前提，在通过Zuul网关转发的时候cookie将会丢失，为此先配上

server:
  port: 9000
spring:
  application:
    name: mi-gateway
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8000/eureka/

# 网关转发
zuul:
  prefix: /gateway  #访问前缀
  routes:   #支付单个微服务的转发
    appoint:
      path: /mi-appoint/**   #需要转发微服务的工程path
      serviceId: appoint   #application:name
      strip-prefix: false  #不做前缀配置
#      sensitive-headers:  单独服务
  sensitive-headers: #全部服务忽略敏感头(全部服务都可以传递cookie)

    user:
      path: /mi-user/**
      serviceId: user
      strip-prefix: false

2.3 application的启动类添加注解

@EnableZuulProxy
@SpringCloudApplication
public class ZuulGatewayApplication {

        public static void main(String args[]){
            SpringApplication.run(ZuulGatewayApplication.class,args);
        }
    }

注意:访问同一注册中心的时候，默认加上注册中心上的名字

例如 appoint/地址
网关访问地址就要 localhost：9000/appoint/地址/

2.4 案例效果

运行所有的单个服务，访问appoint

image.png

三、使用自定义过滤器

一般在使用前后端开发的情况下，需要创建一个config类来进行跨域

3.1 在config包下创建跨域过滤

@Configuration
public class CorsConfig {

    @Bean
    public CorsFilter corsFilter() {
        final UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        final CorsConfiguration config = new CorsConfiguration();

        //配置项Cookies跨域
        config.setAllowCredentials(true);
        //配置被跨域的域名
        config.setAllowedOrigins(Arrays.asList("*"));
        config.setAllowedHeaders(Arrays.asList("*"));
        config.setAllowedMethods(Arrays.asList("*"));
        config.setMaxAge(300L);
        source.registerCorsConfiguration("/**", config);
        return new CorsFilter(source);
    }

3.2 使用Pre来进行模拟一个登陆

登陆拦截 openid

@Component
public class AuthIndexFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return PRE_TYPE;
    }

    @Override
    public int filterOrder() {
        return PRE_DECORATION_FILTER_ORDER -1;
    }

    @Override
    public boolean shouldFilter() {

        /*判断是否相同，相同就拦截*/
        RequestContext requestContext = RequestContext.getCurrentContext();
        HttpServletRequest request =  requestContext.getRequest();
        if ("/gateway/mi-appoint/index".equals(request.getRequestURI())){
            return  true;
        }
        return false;
    }

    @Override
    public Object run() throws ZuulException {

        RequestContext requestContext = RequestContext.getCurrentContext();
        HttpServletRequest request =  requestContext.getRequest();
        //mi-appoint/index 只能拥有openid访问
        Cookie cookie = CookieUtil.get(request,"openid");
        if (cookie ==null || StringUtils.isEmpty(cookie.getValue())){
            requestContext.setSendZuulResponse(false);
            requestContext.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        return null;
    }
}

3.3 接着在user服务创建Controller进行访问拦截

先访问一遍， 是否匹配

image.png

再输入跟数据匹配的openid =abc

image.png

3.3 使用Post后置过滤

当网站访问经过Pre校验过滤后就使用Post后置过滤
在这只演示简单的获取Post过滤的响应头过滤
@Component
public class addResponseHeaderFilter extends ZuulFilter {

//POST_TYPE 过滤
@Override
public String filterType() {
    return POST_TYPE;
}
/**
 * 优先级在它之前
 * @return
 */
@Override
public int filterOrder() {
    return SEND_RESPONSE_FILTER_ORDER -1;
}
@Override
public boolean shouldFilter() {
    return true;
}

/**
 * 拿到结果
 * @return
 * @throws ZuulException
 */
@Override
public Object run() throws ZuulException {
    RequestContext requestContext = RequestContext.getCurrentContext();
    HttpServletResponse response =  requestContext.getResponse();
    response.setHeader("X-Foo", UUID.randomUUID().toString());
    return null;
}

}
在一次访问上面的地址就会得到

image.png

对于本次章节是对网关服务的简单应用，接下来会记录学习
Fegin+Feign+hystrix断路器模式
github项目地址：https://github.com/mi499938150/SpringCloud-Example.git