springcloud微服务实战 学习笔记六 服务网关

服务网关简介

服务网关是微服务架构中一个不可或缺的部分。通过服务网关统一向外系统提供REST API的过程中，除了具备服务路由、均衡负载功能之外，它还具备了权限控制等功能。Spring Cloud Netflix中的Zuul就担任了这样的一个角色，为微服务架构提供了前门保护的作用，同时将权限控制这些较重的非业务逻辑内容迁移到服务路由层面，使得服务集群主体能够具备更高的可复用性和可测试性。

依赖

    org.springframework.cloud
    spring-cloud-starter-zuul


    org.springframework.cloud
    spring-cloud-starter-eureka

配置

spring.application.name=api-gateway
server.port=5555
#通过url的方式做服务转发（不推荐）
#zuul.routes.api-a-url.path=/api-a-url/**
#zuul.routes.api-a-url.url=http://localhost:2222/
#通过serviceId的方式
#api-a api-b只是自定义的名称
zuul.routes.api-a.path=/api-a/**
zuul.routes.api-a.serviceId=compute-service-a
zuul.routes.api-b.path=/api-b/**
zuul.routes.api-b.serviceId=compute-service-b
#注册为服务
eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

所有的/api-a/**路径的访问转发到compute-service-a服务
所有的/api-b/**路径的访问转发到compute-service-b服务
服务网关实现转发有两种方式，一种是通过url的方式转发，另一种是通过serviceId的方式转发。通过url转发的方式，则不需要eureka依赖。
推荐使用serviceId的映射方式，除了对Zuul维护上更加友好之外，serviceId映射方式还支持了断路器，对于服务故障的情况下，可以有效的防止故障蔓延到服务网关上而影响整个系统的对外服务

Application.java

@EnableZuulProxy
@SpringCloudApplication
public class Application {
    public static void main(String[] args) {
        new SpringApplicationBuilder(Application.class).web(true).run(args);
    }

    @Bean
    public AccessFilter accessFilter(){
        return new AccessFilter();
    }
}

自定义过滤器AccessFilter.java

public class AccessFilter extends ZuulFilter{

    private static Logger log = LoggerFactory.getLogger(AccessFilter.class);

    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        log.info(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));
        String accessToken = request.getParameter("accessToken");
        if(accessToken==null){
            log.warn("access token is empty");
            currentContext.setSendZuulResponse(false);
            currentContext.setResponseStatusCode(401);
            currentContext.setResponseBody("accessToken is null");
            return null;
        }
        log.info("access token ok");
        return null;
    }
}

自定义过滤器的实现，需要继承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内容进行编辑等。

将服务网关注册为服务，将权限系统做成另外一个服务，在网关里面调用这个服务，来实现权限控制。