zuul网关

目标

1、Zuul路由网关简介及基本使用
2、Zuul路由映射配置
3、Zuul请求过滤配置
Zuul路由网关简介及基本使用
简介

Zuul API路由网关服务简介

请看上图，这里的API 路由网关服务 由Zuul实现，主要就是对外提供服务接口的时候，起到了请求的路由和过滤作用，也因此能够隐藏内部服务的接口细节，从来有利于保护系统的安全性；

路由配置
Zuul 路由配置

我们新建一个module microservice-zuul-3001
这里我们的zuul也注册到eureka服务里，端口3001；
我们修改下Hosts，专门为zuul搞个本地域名映射
hosts文件路径 C:\Windows\System32\drivers\etc\hosts
hosts文件 加下：

127.0.0.1  zuul.javaxl.com

然后pom.xml要加上

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

完整pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.liuyujian</groupId>
        <artifactId>Liuyujian6microservice</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>microservice-zuul-3001</artifactId>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.javaxl</groupId>
            <artifactId>microservice-common</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <!-- actuator监控 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- hystrix容错 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <!--zuul网关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>

        <!--ribbon相关依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-ribbon</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>

        <!--引入Feign依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-feign</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

搞一个 application.yml

server:
  port: 3001
  context-path: /
spring:
  application:
    name: microservice-zuul
eureka:
  instance:
    instance-id: microservice-zuul:3001
    prefer-ip-address: true
  client:
    service-url:
      defaultZone: http://eureka2001.lyj.com:2001/eureka/,http://eureka2002.lyj.com:2002/eureka/,http://eureka2003.lyj.com:2003/eureka/
info:
  groupId: com.lyj.testSpringcloud
  artifactId: microservice-zuul-3001
  version: 1.0-SNAPSHOT
  userName: http://lyj.com
  phone: 123456

建一个主启动类：ZuulApplication_3001
加下@EnableZuulProxy注解

package com.liuyujian.microservicezuul3001;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
@EnableZuulProxy
public class MicroserviceZuul3001Application {

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

}

我们测试下：
启动一个eureka 然后再启动下一个1006服务，以及 zuul网关服务；

这里有两个服务；

我们直接请求：http://localhost:1006/student/list 能获取到数据；
我们用 http://zuul.lyj.com:3001/microservice-student/student/list 域名+端口+服务名称+请求地址 也能请求到数据；

说明我们的路由基本配置OK

Zuul路由映射配置
上面是zuul的简单使用，从接口地址很轻易的就暴露了服务提供者的唯一标识名microservice-student；有安全风险，我们需要将其隐藏；

ignored-services的作用是将原来的服务提供者唯一标识名禁用；

Prefix的作用是给服务加前缀

yml文件中添加以下配置：

zuul:
  routes:
    studentServer.serviceId: microservice-student
    studentServer.path: /studentServer/**
  ignored-services: "*"
  prefix: /lyj

配置完毕后可通过以下链接做测试
http://zuul.lyj.com:3001/microservice-student/student/list
http://zuul.lyj.com:3001/studentServer/student/list
http://zuul.lyj.com:3001/lyj/microservice-student/student/list
http://zuul.lyj.com:3001/lyj/studentServer/student/list

对应的配置会出现上面的错误页面，这是正常现象。
解决页面错误
ZuulFallbackProvider

package com.liuyujian.microservicezuul3001.fallback;

import org.springframework.cloud.netflix.zuul.filters.route.ZuulFallbackProvider;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.stereotype.Component;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

@Component
public class ZuulFallBack implements ZuulFallbackProvider {

    @Override
    public String getRoute() {
        return "*";
    }

    /**
     * 在给zuul整合回退功能时，只要类实现ZuulFallbackProvider接口，并且注册bean即可。
     *
     * 不过需要注意的时，这个回退只有服务掉线或者超时的情况下才会触发（Camden.SR4版本测试是这样），
     * 如果服务程序出现异常，此回退程序是不能处理的，异常会直接返回给调用者，比如页面。
     *
     * @return
     */
    @Override
    public ClientHttpResponse fallbackResponse() {
        return new ClientHttpResponse() {
            @Override
            public HttpHeaders getHeaders() {
                HttpHeaders headers = new HttpHeaders();
                headers.setContentType(MediaType.APPLICATION_JSON_UTF8);//application/json;charset=UTF-8
                return headers;
            }

            @Override
            public InputStream getBody() throws IOException {
                String msg = "服务繁忙，请稍后.....";
                //new ByteArrayInputStream("{\"code\":-1,\"msg\":\"服务暂不可用\"}".getBytes(StandardCharsets.UTF_8))
                return new ByteArrayInputStream(msg.getBytes());
            }

            @Override
            public String getStatusText() throws IOException {
                return HttpStatus.BAD_REQUEST.getReasonPhrase();//400
            }

            @Override
            public HttpStatus getStatusCode() throws IOException {
                return HttpStatus.BAD_REQUEST;
            }

            @Override
            public int getRawStatusCode() throws IOException {
                return HttpStatus.BAD_REQUEST.value();//"Bad Request"
            }

            @Override
            public void close() {

            }
        };
    }
}

设置时间限制
yml文件里面加

feign:
  hystrix:
    enabled: true

hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 1500
ribbon:
  ReadTimeout: 6000
  ConnectTimeout: 6000
  MaxAutoRetries: 0
  MaxAutoRetriesNextServer: 1
  eureka:
    enabled: true

Zuul请求过滤配置
比如我们登录某个系统 需要身份验证，用户名密码啥的；

我们请求服务，也可以来设置身份验证，也就是过滤非法请求；Zuul通过ZuulFilter过滤器实现；
一般具体实现的话 每次经过Zuul服务网关 我们都对带来的token进行有效性验证；

我们先定义一个 AccessFilter类：

package com.liuyujian.microservicezuul3001.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.apache.log4j.Logger;

import javax.servlet.http.HttpServletRequest;

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 * @company
 * @create  2019-04-30 16:05
 */
public class AccessFilter extends ZuulFilter {

    Logger logger=Logger.getLogger(AccessFilter.class);

    /**
     * 判断该过滤器是否要被执行
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 过滤器的具体执行逻辑
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        String parameter = request.getParameter("accessToken");
        logger.info(request.getRequestURL().toString()+" 请求访问");
        if(parameter==null){
            logger.error("accessToken为空！");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            ctx.setResponseBody("{\"result\":\"accessToken is empty!\"}");
            return null;
        }
        //  token判断逻辑
        logger.info(request.getRequestURL().toString()+" 请求成功");
        return null;
    }

    /**
     * 过滤器的类型 这里用pre，代表会再请求被路由之前执行
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 过滤器的执行顺序
     */
    @Override
    public int filterOrder() {
        return 0;
    }

}

然后再开启下 Filter配置：

package com.liuyujian.microservicezuul3001.config;

import com.liuyujian.microservicezuul3001.filter.AccessFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class ZuulConfig {

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

浏览器输入地址进行测试
http://zuul.lyj.com:3001/lyj/studentServer/student/list
http://zuul.lyj.com:3001/lyj/studentServer/student/list?accessToken=xiaoliu
http://zuul.lyj.com:3001/lyj/studentServer/student/hystrix
http://zuul.lyj.com:3001/lyj/studentServer/student/hystrix?accessToken=xiaoliu
测试结果如下