服务网关Zuul

什么是路由网关

网关是系统的唯一对外的入口,介于客户端和服务器端之间的中间层,处理非业务功能 提供路由请求、鉴权、监控、缓存、限流等功能。它将"1对N"问题转换成了"1对1”问题。
通过服务路由的功能,可以在对外提供服务时,只暴露 网关中配置的调用地址,而调用方就不需要了解后端具体的微服务主机。

为什么要使用微服务网关

不同的微服务一般会有不同的网络地址,而客户端可能需要调用多个服务接口才能完成一个业务需求,若让客户端直接与各个微服务通信,会有以下问题:
(1)客户端会多次请求不同微服务,增加了客户端复杂性
(2)存在跨域请求,处理相对复杂
(3)认证复杂,每个服务都需要独立认证
(4)难以重构,多个服务可能将会合并成一个或拆分成多个


编写网关服务入门案例

添加依赖

     org.springframework.cloud
     spring-cloud-starter-zuul
 
配置application配置文件,注册zuul服务到eureka注册中心
spring.application.name=zuul-gateway
server.port=9020
eureka.client.serviceUrl.defaultZone=http://user:123456@eureka1:8761/eureka/,http://user:123456@eureka2:8761/eureka/
修改启动类,添加@EnableZuulProxy注解
@SpringBootApplication
@EnableZuulProxy
public class ZuulApplication {
    public static void main(String[] args) {
        SpringApplication.run(ZuulApplication.class, args);
    }
}
通过网关请求服务

http://网关服务地址:网关服务端口/访问的服务的名称/访问的服务中的接口的地址

例如此时要访问e-book-product-provider服务下的product/findAll接口
请求地址就是:http://192.168.1.9:9020/e-book-product-provider/product/findAll
以上就是一个简单的Zuul的入门案例

Zuul的四种路由规则方法

采用 URL 指定路由方式

配置方法:

zuul.routes.e-book-product-provider.path=/product/**
zuul.routes.e-book-product-provider.url=http://127.0.0.1:9001/
`其中e-book-product-provider为自定义的键名,一个path和url为一组
此时通过网关网关的/product/**,表示访问的http://127.0.0.1:9001/product/**

采用服务名指定路由方式

zuul.routes.e-book-product-provider.path=/suibian/**
zuul.routes.e-book-product-provider.serviceId=e-book-product-provider
`其中e-book-product-provider为自定义的键名,一个path和serviceId为一组
此时通过网关网关的/suibian/**,表示访问的http://127.0.0.1:9001/suibian/**
采用服务名指定路由方式还有简化写法:
zuul.routes.e-book-product-provider.path=/suibian/**
此时的e-book-product-provider不能随便写了,此时的e-book-product-provider必须和eureka中注册服务名一致,此时效果与上方配置一样

路由排除:排除某个或多个服务

例如

zuul.ignored-services=e-book-product-provider

此时通过路由访问e-book-product-provider/**时,将无法访问

路由排除:排除所有服务

由于服务太多,不可能手工一个个加,故路由排除所有服务,然后针对要路由的服务进行手工加

zuul.ignored-services=*
zuul.routes.e-book-order-provider.path=/e-book-order-provider/**

此时通过路由,只能访问/e-book-order-provider/**其他服务将为不能访问

路由排除:排除指定关键字的路径

例如:排除路径中含有findAll的

zuul.ignored-patterns=/**/findAll/**

此时通过路由访问,所有路径中包含/findAll/都不能访问。

路由的添加前缀

zuul.prefix=/api

此时访问所有服务都需要在服务前加上/api/的前缀

网关过滤器

每个客户端用户请求微服务应用提供的接口时,它们的访问权限往往都需要有一定的限制,系统并不会将所有的微服务接口都对它们开放。

为了在 API 网关中实现对客户端请求的校验,我们将需要使用到 Spring Cloud Zuul 的另外一个核心功能:过滤器。

Zuul 允许开发者在 API 网关上通过定义过滤器来实现对请求的拦截与过滤,实现的方法非常简单。

如何定义过滤器

编写java类,继承抽象ZuulFilter实现抽象类中的方法,记得在类上使用@Component注解
方法介绍

@Component
public class LogFilter extends ZuulFilter {
    private static final Logger logger = LoggerFactory.getLogger(LogFilter.class);

    /**
     * 过滤内容:逻辑处理、一般2个用途
     *1、请求前拦截,对请求进行判断,如果请求无效就直接断路,如果有效可再加工处理
     *2、请求结果后处理,即对结果做一些处理
     */
    @Override
    public Object run() {
        //获取请求上下文
        RequestContext rc = RequestContext.getCurrentContext();
        HttpServletRequest request = rc.getRequest();
        logger.info("LogFilter.....请求方式={},请求url={}",request.getMethod(),request.getRequestURL().toString());
        return null;
    }

    /**
     * 过滤器类型:类型决定了过滤器执行的时机
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 多个过滤器时,当前过滤器执行顺序,数字越优先级越高
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     *是否开启过滤,默认是false
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }
}

filterType过滤器的类型:分别是 “PRE”、“ROUTING”、“POST” 和“ERROR”,
四个类型的生命周期不同,过滤器运行的时机也不同。生命周期下图来表示

PRE:这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
ROUTING:这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求,并使用 Apache HttpClient 或 Netfilx Ribbon 请求微服务。
POST:这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的 HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
ERROR:在其他阶段发生错误时执行该过滤器。 除了默认的过滤器类型,Zuul 还允许我们创建自定义的过滤器类型。例如,我们可以定制一种 STATIC 类型的过滤器,直接在 Zuul 中生成响应,而不将请求转发到后端的微服务。

模拟不同类型执行时机和顺序

首先创建多个过滤器



AccessFilter主要代码

    @Override
    public Object run() {
        logger.info("~~~~~~~~~~~~~~~~~~~pre1~~~~~~~~~~~~~~~~~~~~~~~");
        return null;
    }
    
    @Override
    public String filterType() {return "pre";}

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

AccessFilter2主要代码,我们在AccessFilter2中抛出了一个异常用于查看error的执行时机

    @Override
    public Object run() {
        logger.info("~~~~~~~~~~~~~~~~~~~~~pre2~~~~~~~~~~~~~~~~~~~~~");
        throw new RuntimeException();
    }

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

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

ErrorFilter主要代码

    @Override
    public Object run() {
        logger.info("~~~~~~~~~~~~~~~~~~~~~error~~~~~~~~~~~~~~~~~~~~~");
        return null;
    }

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

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

PostFilter主要代码

    @Override
    public Object run() {
        logger.info("~~~~~~~~~~~~~~~~~~~~~post~~~~~~~~~~~~~~~~~~~~~");
        return null;
    }

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

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

运行后控制台打印输入信息,可以看出各个类型的的声明周期运行时机

模拟采用网关过滤器实现权限验证

/**
 * 模拟登陆验证
 */
@Component
public class AccessFilter extends ZuulFilter {
    private static final Logger logger = LoggerFactory.getLogger(AccessFilter.class);

    @Override
    public Object run() {
        RequestContext rc = RequestContext.getCurrentContext();
        HttpServletRequest request = rc.getRequest();
        logger.info("~~~~~~~~~~~~~~~~~~~pre1~~~~~~~~~~~~~~~~~~~~~~~");
        //模拟当前请求是否含有token,此处模拟从表单中获取token
        String token = request.getParameter("token");
        //对 token 做判断
        if(token==null||"".equals(token)){
            logger.warn("token is null............");
            rc.setSendZuulResponse(false);//代表请求结束。不在继续向下请求
            rc.setResponseStatusCode(401);//添加一个响应码
            rc.setResponseBody("{\"result\":\"token is null\"}");//添加响应内容
            rc.getResponse().setContentType("text/html;charset=utf-8");//响应类型
        }else{
            //验证通过
            logger.info("token is ok");
        }
        return null;
    }

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

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

    @Override
    public boolean shouldFilter() {
        return true;
    }
}
通过代理访问不含token,此时返回是我们自定义的信息
控制台输入打印
通过代理访问含token,此时返回的是通过product服务获取到的信息
控制台输入打印

网关的处理异常响应的控制器

创建java类实现 ErrorController接口重写 getErrorPath方法

@RestController
public class ExceptionHandler implements ErrorController {
    @Override
    public String getErrorPath() {
        return "/error";
    }

    @RequestMapping(value="/error")
    public String error(){
        return "{result:500 error!!!!}";
    }
}

测试:通过网关随便访问一个不存在的地址

创建异常处理器之前

你可能感兴趣的:(服务网关Zuul)