SpringCloud——服务网关

SpringCloud——服务网关

1、背景

上篇博客《SpringCloud——Eureka服务注册和发现》中介绍了注册中心Eureka、服务提供者和服务消费者。这篇博客我们将介绍服务网关。

图（1） 未使用服务网关的做法

图（2） 服务网关的做法

服务网关，英文Service GateWay，他是微服务框架中唯一的入口。有些类似外观模式，对外只提供一个访问的入口。这样做的好处有很多，减少了客户端多次调用微服务，也可以在“入口”处进行负载或权限的处理。

在SpringCloud Netflix中，Zuul就是这样一个角色。

2、实例

1）、Zuul环境搭建

引入jar包

       <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>

在Application中开启Zuul

@EnableZuulProxy
@SpringCloudApplication  //整合了@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker，主要目的还是简化配置
public class ZuulApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(ZuulApplication.class).web(true).run(args);
    }
    }

Zuul环境搭建完毕之后，我们就可以来看他的主要功能了，包括服务路由和服务过滤。

2）、路由配置

方法一：url配置
在application.properties中，进行如下配置。

zuul.routes.api-a-url.path=/api-a-url/**
zuul.routes.api-a-url.url=http://localhost:2222/

之后，我们就可以通过”/api-a-url”来代替”http://localhost:2222/“进行访问，类似修改本地hosts文件来设置域名。这种方式屏蔽了ip和端口。

缺点： url路由粒度过粗。需要知道所有服务地址才能完成映射。

方法二：服务映射（serviceId）
既然eureka中已经有我们的配置信息，那我们可以借助他来完成地址映射。

zuul.routes.api-a.path=/api-a/**
zuul.routes.api-a.serviceId=compute-service
eureka.client.serviceUrl.defaultZone=http://localhost:8761/eureka/

3）、服务过滤

定义过滤

public class AccessFilter extends ZuulFilter {

    /*filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
    pre：可以在请求被路由之前调用
    routing：在路由请求时候被调用
    post：在routing和error过滤器之后被调用
    error：处理请求时发生错误时被调用
    filterOrder：通过int值来定义过滤器的执行顺序
    shouldFilter：返回一个boolean类型来判断该过滤器是否要执行，所以通过此函数可实现过滤器的开关。在上例中，我们直接返回true，所以该过滤器总是生效。
    run：过滤器的具体逻辑。需要注意，这里我们通过ctx.setSendZuulResponse(false)令zuul过滤该请求，不对其进行路由，然后通过ctx.setResponseStatusCode(401)设置了其返回的错误码，当然我们也可以进一步优化我们的返回，比如，通过ctx.setResponseBody(body)对返回body内容进行编辑等。
    */
    @Override
    public Object run() {
         RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
            Object accessToken = request.getParameter("accessToken");  //定义规则：访问url中必须带有accessToken参数
            if(accessToken == null) {
                ctx.setSendZuulResponse(false);
                ctx.setResponseStatusCode(401);
                return null;
            }
            return null;

    }
    ……
}

实例化

    //实例化过滤器
    @Bean
    public AccessFilter accessFilter() {
        return new AccessFilter();
    }

启动项目，如果访问的url中不含有accessToken参数则会报错，只有包含该参数的请求url才会被放行。

3、小结

Zuul的主要功能：负载均衡、服务路由、服务过滤等，并不是新鲜的东西。api gateway类似外观模式，提供统一的入口。负载均衡和路由和Nginx的功能很像，过滤和权限管理类似shiro的权限配置。

万变不离其宗，目的都是在于把这些与服务本身关系不大的东西剥离出来，而且是越早剥离越好，能在Controller处理的绝不放在Service，能在转发前处理的就不要留到转发后。类似大家说的服务的无状态性，over！