SpringCloud之Zuul 自定義filter

實現過濾器很簡單，只需要繼承ZuulFilter,並實現ZuulFilter中的抽象方法。

filterType()：定義過濾器的類型，它有4種類型，分別是pre、post、routing和error
filterOrder()：過濾順序，它是一個Int類型的值，值越小，越早執行該過濾器
shouldFilter()：表示該過濾器是否過濾邏輯，如果為true，則執行run方法，如果為false，則不執行run方法
Object run()：寫具體的過濾邏輯

注意重要說明,有些版本在轉發post時,文件上傳無法轉法。只要升級下版本就可以了。

本示中使用的是 springcloud    Edgware.RELEASE 對應springboot1.5.9

Spring Boot	Spring Cloud
1.2.x	Angel版本
1.3.x	Brixton版本
1.4.xstripes	Camden版本
1.5.x	Dalston版本、Edgware版本
2.0.x	Finchley版本
2.1.x	Greenwich.SR2

 

示例

1.pom中引用

<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.company</groupId>
    <artifactId>zuuldemo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>zuuldemo</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
    <parent>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-parent</artifactId>
        <version>Edgware.RELEASE</version>
        <relativePath></relativePath>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>commons-codec</groupId>
            <artifactId>commons-codec</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.58</version>
        </dependency>
    </dependencies>
</project>

2.springcloud項目

2.1 src/main/resources/application.yml

server:
   port: 80
spring:
   application:
      name: api-geteway
   http:
      multipart:
         enabled: true # 使用http multipart上傳處理
         file-size-threshold: 1MB # 當上傳文件達到1MB的時候進行磁盤寫入
         max-request-size: 10MB # 設置最大的請求文件的大小
         max-file-size: 10MB # 設置單個文件的最大長度
zuul:
   routes:
      weixin:
         path: /mypath/**
         url: https://www.baidu.com

2.2 App.java

package com.company.zuuldemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.context.annotation.Bean;

import com.company.zuuldemo.filter.MyFilter;

/**
 * Hello world!
 *
 */
@EnableZuulProxy
@SpringBootApplication
public class ZuulApp {

    //使用filter
    @Bean
    public MyFilter myFilter() {
        return new MyFilter();
    }

//    @Bean
//    public FirstFilter firstFilter() {
//        return new FirstFilter();
//    }
//
//    @Bean
//    public SecondFilter secondFilter() {
//        return new SecondFilter();
//    }

    public static void main(String[] args) {
        // System.out.println( "Hello World!" );
        SpringApplication.run(ZuulApp.class);
    }
}

2.3 MyFilter.java

 

package com.company.zuuldemo.filter;

import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;

public class MyFilter extends ZuulFilter {

    final static Logger logger = LoggerFactory.getLogger(FirstFilter.class);

    // 這里可以依據url規則判斷是否需要進行過濾 true需要過濾進入run方法 ,false直接忽略
    public boolean shouldFilter() {
        RequestContext ctx = RequestContext.getCurrentContext();
        logger.info(ctx.getRequest().getRequestURI() + " get request path info");
        String url = ctx.getRequest().getRequestURI().toLowerCase();

        // 這里判斷url邏輯
        if (url.startsWith("/login")) {
            return false;
        }

        return true;
    }

    public Object run() {

        RequestContext ctx = RequestContext.getCurrentContext();

        // 通過其它業務生成token
        String access_token = "user_name_token";

        // 使用1 ：向request的header中增加參數access_token
        ctx.addZuulRequestHeader("access_token", access_token);

        // 使用2：向request的url里增加參數,示例增加 access_token
        Map<String, List<String>> requestQueryParams = ctx.getRequestQueryParams();
        if (requestQueryParams == null) {
            requestQueryParams = new HashMap<>();
        }

        requestQueryParams.put("access_token", Arrays.asList(access_token));

        ctx.setRequestQueryParams(requestQueryParams);

        //使用3 ：:判斷是否登錄,如果未登錄直接返回404
        if (access_token == null || access_token.trim().length() == 0) {
            //過濾該請求，不對其進行路由(直接輸入返回）
            ctx.setSendZuulResponse(false);
            //返回錯誤碼
            ctx.setResponseStatusCode(401);
            // 返回錯誤內容
            ctx.setResponseBody("{\"result\":\"access_token is not correct!\"}");
            
            //讓下一個Filter看到上一個Filter的狀態用於過濾器間的協調
            ctx.set("my_filter_is_success", false);
            return null; 
        }

        // 對該請求進行路由(默認就是true)
        //ctx.setSendZuulResponse(true);
        //ctx.setResponseStatusCode(200);
        //讓下一個Filter看到上一個Filter的狀態用於過濾器間的協調
        ctx.set("my_filter_is_success", false);

        return null; //直接返回null即可
    }

    @Override
    public String filterType() {
        // 前置過濾器
        //pre：可以在請求被路由之前調用
        //route：在路由請求時候被調用
        //post：在route和error過濾器之后被調用
        //error：處理請求時發生錯誤時被調用
        return "pre";
    }

    @Override
    public int filterOrder() {
        //優先級為0，數字越大，優先級越低  
        return 0;
    }
}