網(wǎng)關(guān)介紹

API網(wǎng)關(guān)是一個(gè)更為智能的應(yīng)用服務(wù)器，它的定義類似于面向?qū)ο笤O(shè)計(jì)模式中的Facade模式，它的存在就像是整個(gè)微服務(wù)架構(gòu)系統(tǒng)的門面一樣，所有的外部客戶端訪問都需要經(jīng)過它來進(jìn)行調(diào)度和過濾。它除了要實(shí)現(xiàn)請求路由、 負(fù)載均衡、 校驗(yàn)過濾等功能之外，還需要更多能力，比如與服務(wù)治理框架的結(jié)合、請求轉(zhuǎn)發(fā)時(shí)的熔斷機(jī)制、服務(wù)的聚合等一系列高級功能。

入門例子

創(chuàng)建一個(gè)moudle，命名為eureka-zuul，創(chuàng)建時(shí)選擇一些的組件依賴：

1533108772510.png

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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>eureka-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>eureka-zuul</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

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

配置application.yml

server:
  port: 1100
spring:
  application:
    name: service-zuul

application.yml只是設(shè)置基本信息，結(jié)合之前創(chuàng)建的配置中心，我們把主要把配置的主要信息通過eureka-config-git配置中心獲取。所以添加一個(gè)bootstrap.yml配置文件。

spring:
  cloud:
    config:
      profile: dev #dev開發(fā)環(huán)境配置文件，test測試環(huán)境配置文件，pro正式環(huán)境文件
      label: master #git倉庫對應(yīng)的分支名稱 config-label-test
#      label: config-label-test #git倉庫對應(yīng)的分支名稱 config-label-test
#      uri: http://localhost:7001/ #config-server
      name: service-zuul
      discovery:
        serviceId: config-server-git #基于服務(wù)注冊發(fā)現(xiàn)的方式查找
        enabled: true
eureka:
  client:
      serviceUrl:
        defaultZone: http://peer1:8762/eureka/,http://peer2:8763/eureka/
management: #配置暴露監(jiān)控節(jié)點(diǎn)地址
  endpoints:
    web:
      exposure:
        include: "*"
      cors:
        allowed-origins: "*"
        allowed-methods: "*"
#注冊中心eureka.client.service-url.defaultZone = 一定要放在boostrap文件中，不然啟動(dòng)會(huì)報(bào)錯(cuò)

這里的配置主要就是指向配置中心。

項(xiàng)目的主類添加EnableZuulProxy注解

/*@SpringBootApplication
EnableEurekaClient*/
@EnableZuulProxy//注解@EnableZuulProxy以開啟zuul特性
@SpringCloudApplication //使用@SpringCloudApplication包括，
// Springboot注解，注冊服務(wù)到注冊中心注解，熔斷器注解
// 在SpringCloud看來這是每一微服務(wù)所必須應(yīng)有的三個(gè)注解，所以才推出了@SpringCloudApplication注解
public class EurekaZuulApplication {

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

另外config-repo這個(gè)配置文件中心的項(xiàng)目有個(gè)zuul的配置文件bootstrap.yml主要配置的就是指向了這個(gè)config-repo的配置文件。
service-zuul-dev.yml

zuul:
  ignoredServices: '*' #忽略所有未配置的service,每一個(gè)微服務(wù)的路由配置都需要配置
  host:
    connect-timeout-millis: 20000
    socket-timeout-millis: 20000
  routes:
    ribbon-service: #自定義名稱
      path: /ribbon/**
      serviceId: service-user-ribbon #/ribbon/開頭的路徑轉(zhuǎn)發(fā)至service-user-ribbon微服務(wù)
      sensitiveHeaders: true #springcloud項(xiàng)目中經(jīng)過網(wǎng)關(guān)zuul轉(zhuǎn)發(fā)請求后發(fā)生session失效問題，這是由于zuul默認(rèn)會(huì)丟棄原來的session并生成新的session
      #所以這里對制定的路由開啟自定義敏感頭。除了設(shè)置為true，也可以設(shè)置為空。zuul.sensitiveHeaders= 只是全局設(shè)置的做法。不推薦！破壞了默認(rèn)設(shè)置的用意
hystrix: #hystrix配置
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMilliseconds: 2500
ribbon: #ribbon負(fù)載均衡參數(shù)配置
  ReadTimeout: 5000
  ConnectTimeout: 5000
eureka:
  client:
    serviceUrl:
      defaultZone: http://peer1:8762/eureka/,http://peer2:8763/eureka/

相關(guān)的配置注釋已經(jīng)說得很清楚了
。
接下來我們新建一個(gè)類來測試zuul功能。
創(chuàng)建一個(gè)UserFallbackProvider類實(shí)現(xiàn)FallbackProvider接口

@Component
public class UserFallbackProvider implements FallbackProvider {

    @Override
    public String getRoute() {
        return "service-user-ribbon";
    }

    @Override
    public ClientHttpResponse fallbackResponse(String route, Throwable cause) {
        return new ClientHttpResponse() {
            @Override
            public HttpStatus getStatusCode() throws IOException {
                return HttpStatus.OK;
            }

            @Override
            public int getRawStatusCode() throws IOException {
                return 200;
            }

            @Override
            public String getStatusText() throws IOException {
                return "OK";
            }

            @Override
            public void close() {

            }

            @Override
            public InputStream getBody() throws IOException {
                return new ByteArrayInputStream("fallback".getBytes());
            }

            @Override
            public HttpHeaders getHeaders() {
                HttpHeaders headers = new HttpHeaders();
                headers.setContentType(MediaType.APPLICATION_JSON);
                return headers;
            }
        };
    }
}

1533110129632.png

依次啟動(dòng)服務(wù)注冊中心=>configGit=>serviceUser=>serviceUserRibbon=>zuul

1533110998412.png

1533110900002.png

1533111016759.png

服務(wù)確保正常，我們訪問zuul的服務(wù)地址：http://localhost:1100/ribbon/listUsersByRibbon

1533111048541.png

數(shù)據(jù)正常返回，說明zuul項(xiàng)目配置正常。

過濾器

上面的演示是用zuul實(shí)現(xiàn)一個(gè)基本的接口請映射請求，zuul主要的主要是認(rèn)證和鑒權(quán)這方面的功能。我們下面實(shí)現(xiàn)一個(gè)過濾器的功能；在上面的項(xiàng)目基礎(chǔ)上，我們新建一個(gè)過濾器AccessFilter實(shí)現(xiàn)ZuulFilter接口

@Log
public class AccessFilter extends ZuulFilter {
    @Override
    public String filterType() {
        /**
         * pre 代表請求被路由前執(zhí)行
         */
        return "pre";
    }

    @Override
    public int filterOrder() {
        /**
         * 過濾器執(zhí)行的順序
         */
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        /**
         * 判斷過濾器是否執(zhí)行
         */
        return true;
    }

    /**
     * 具體的過濾邏輯
     *
     * @return
     * @throws ZuulException
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        log.info("send " + request.getMethod() + " Request to " + request.getRequestURL().toString());
        String token = request.getParameter("token");
        if (StringUtils.isBlank(token)) {
            log.warning("access token is empty");
            currentContext.setSendZuulResponse(false);
            currentContext.setResponseStatusCode(401);
            try {
                HttpServletResponse response = currentContext.getResponse();
                response.setCharacterEncoding("utf-8");  //設(shè)置字符集
                response.setContentType("text/html; charset=utf-8"); //設(shè)置相應(yīng)格式
                response.getWriter().write("token 驗(yàn)證失敗");
            } catch (IOException e) {
                log.info("response io異常");
                e.printStackTrace();
            }
            return null;
        }
        return null;
    }
}

這里的過濾器主要的作用是攔截請求，然后從請求體中獲取參數(shù)token。判斷有沒有token這個(gè)參數(shù)，如果有的話，就通過；如果獲取不到token參數(shù)，就直接響應(yīng)一個(gè)401的狀態(tài)。
然后在項(xiàng)目的主類中注入該過濾器：

/**
     * 啟用過濾器功能
     *
     * @return
     */
    @Bean
    public AccessFilter accessFilter() {
        return new AccessFilter();
    }

重啟zuul服務(wù)，重新訪問地址：http://localhost:1100/ribbon/listUsersByRibbon
當(dāng)我們沒有在請求地址中加上token的參數(shù)時(shí)，該接口響應(yīng)token校驗(yàn)失敗了。

1533111845622.png

我們在通過地址http://localhost:1100/ribbon/listUsersByRibbon?token=token
在加上token參數(shù)的情況下，過濾器校驗(yàn)通過就可以正常的響應(yīng)接口了。

1533111890497.png

github 項(xiàng)目源碼