spring cloud gateway+自定義全局/過濾器工廠

說明: spring cloud + gateway + eureka + 網關過濾器

網關項目和模擬請求項目作爲消費者註冊到eureka中,另外起了一個eureka註冊中心項目

新建eureka註冊中心項目:

添加依賴: 注意依賴是eureka-server

<?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>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wm</groupId>
    <artifactId>eureka-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>eureka-server</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Hoxton.RC1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
        </dependencies>
    </dependencyManagement>

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

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
    </repositories>

</project>

在啓動類添加註解: @EnableEurekaServer

package com.wm.eurekaserver;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@SpringBootApplication
@EnableEurekaServer
public class EurekaServerApplication {

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

}

添加配置文件: application.yml

spring:
  application:
    name: eureka-server
server:
  port: 9090
eureka:
  instance:
    #主機名稱
    hostname: eureka-server
  client:
    fetchRegistry: false
    registerWithEureka: false  #是否將eureka自身作爲應用註冊到eureka註冊中心
    serviceUrl:
      ## eureka註冊端口,需要保存一致,和本項目的端口一樣
      defaultZone: http://localhost:9090/eureka/

eureka註冊中心項目就完成了

新建一個controller訪問項目,類似業務項目啥的

添加依賴: 注意依賴是: eureka-client

<?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>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wm</groupId>
    <artifactId>testgateway</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>testgateway</name>
    <description>Demo project for Spring Boot</description>

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

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>


        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>

    </dependencies>

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

</project>

啓動類添加註解: @EnableDiscoveryClient 或者 @EnableEurekaClient 區別是後者僅在使用eureka時使用,前者在consul作爲註冊中心也可以生效

package com.wm.testgateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class TestgatewayApplication {

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

}

添加application.yml:

spring:
  application:
    name: test-gateway
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:9090/eureka/
server:
  port: 8080

新建controller類模擬請求訪問:

package com.wm.testgateway.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/***
 * @ClassName: GatewayController
 * @Description:
 * @Author: wm_yu
 * @Create_time: 10:26 2019-11-7
 */
@RestController
public class GatewayController  {

    @GetMapping("/yu")
    public String test(String name){
        return String.format("hello,%s",name);
    }
}

測試網關(模擬業務項目)完成了

新建網關配置項目:

添加依賴: 注意依賴:eureka-client

<?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>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wm</groupId>
    <artifactId>gateway</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>gateway</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Hoxton.RC1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>


        <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.62</version>
        </dependency>


    </dependencies>



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

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
    </repositories>

</project>

啓動類配置:

package com.wm.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {

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

}

新建全局filter類+過濾工廠類:

MyGlobalFilter.java

全局過濾器,不需要再apllication中任何的配置,直接註冊到spring就可以生效

package com.wm.gateway.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.List;

/***
 * @ClassName: MyGlobalFilter
 * @Description: 自定義gateway全局過濾器,全局過濾器無需配置,對所有的路由都生效
 * @Author: wm_yu
 * @Create_time: 14:30 2019-11-7
 */
@Slf4j
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {

    private static final String TOKEN = "token";


    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        //獲取當前請求的url
        String requestUrl = exchange.getRequest().getURI().toString();
        log.info("請求進入全局過濾器:{}",requestUrl);
        //獲取到請求頭信息,校驗是否含有token
        HttpHeaders headers = exchange.getRequest().getHeaders();
        List<String> tokenList = headers.get(TOKEN);
        if(CollectionUtils.isEmpty(tokenList) || StringUtils.isEmpty(tokenList.get(0))){
            //設置異常狀態值
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            //截斷訪問,直接返回異常信息
            return exchange.getResponse().setComplete();
        }
        log.info("請求token:{}",tokenList.get(0));

        //TODO 校驗token合法性等等,自定義邏輯



        //放行請求
        return chain.filter(exchange);
    }



    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}

MyAuthGatewayFilterFactory.java

package com.wm.gateway.filter.factory;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

/***
 * @ClassName: MyAuthGatewayFilterFactory
 * @Description: 自定義過濾器工廠, 需要以GatewayFilterFactory結尾, 過濾器的名稱是前面部分
 * @Author: wm_yu
 * @Create_time: 15:10 2019-11-7
 */
@Component
@Slf4j
public class MyAuthGatewayFilterFactory extends AbstractGatewayFilterFactory<MyAuthGatewayFilterFactory.Config> {

    public MyAuthGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        log.info("加載配置類:{}", JSON.toJSONString(config));
        return (exchange, chain) -> {
            ServerHttpRequest request = exchange.getRequest();
            String requestUrl = request.getURI().toString();
            log.info("訪問請求進入了自定義的過濾工廠:{}",requestUrl);
            //讀取是否不校驗name的參數放行,自定義的參數,true表示需要校驗,false爲不校驗
            if (!config.getEnable()) {
                return chain.filter(exchange);
            }
            ServerHttpResponse response = exchange.getResponse();
            if(StringUtils.isEmpty(config.getName())){
                response.setStatusCode(HttpStatus.UNAUTHORIZED);
                return response.setComplete();
            }
            return chain.filter(exchange);
        };
    }

    public static class Config {
        private Boolean isEnable;
        private String name;

        public Boolean getEnable() {
            return isEnable;
        }

        public void setEnable(Boolean enable) {
            isEnable = enable;
        }

        public void setName(String name) {
            this.name = name;
        }
        public String getName() {
            return name;
        }
    }

}

這個命名是有規定的, 需要以GatewayFilterFactory結尾,前面部分的就是過濾器的名稱,也就是在application.yml的配置名稱

需要在appplication.yml進行配置,在filters下進行一些自定義的配置,注意過濾器的名稱

完整的配置如下:

server:
  port: 9000


yu:
  uri: lb://test-gateway

spring:
  application:
    name: my_gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true  # 開啓通過服務中心的自動根據 serviceId 創建路由的功能
      routes:
      # This route rule used to forward request to activity server
      - id: gateway-route
        uri: ${yu.uri} # uri以lb://開頭（lb代表從註冊中心獲取服務），後面接的就是你需要轉發到的服務名稱 ,注意服務名稱是服務:項目配置的 spring.application.name
        predicates:
        - Path=/yu/**   # 表示以/yu/**的url會被轉發到test-gateway服務去
        filters:
          - name: MyAuth   #定義的過濾器名稱   + GatewayFilterFactory就是類名稱了
            args:
              name: wm_yu
              enable: false
### 解釋:   訪問本服務地址: http://localhost:9000/user    轉發到服務 test-gateway  地址: http://localhost:8080/user

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:9090/eureka/
  instance:
    prefer-ip-address: true

下面啓動項目,先啓動eureka-server項目:

可以看到eureka註冊中心項目: 註冊了兩個服務

查看eureka管理ui界面: http://localhost:9090

可以看到網關配置項目:

下面測試:

使用網關項目的端口號: 9000,如下,首先不攜帶token請求

什麼信息都沒有,查看控制檯日誌:

可以看到兩個Filter都進入了,且全局過濾器後訪問

攜帶token訪問:

成功訪問到了,test-gateway項目

查看控制檯:

這是直接使用appilication.yml配置的過濾器,還有一種方法是使用代碼寫入,不推薦,造成硬編碼

如果你的配置是 Key、Value 這種形式的，那麼可以不用自己定義配置類，直接繼承 AbstractNameValueGatewayFilterFactory 類即可。

AbstractNameValueGatewayFilterFactory 類繼承了 AbstractGatewayFilterFactory，定義了一個 NameValueConfig 配置類，NameValueConfig 中有 name 和 value 兩個字段。

我們可以直接使用，AddRequestHeaderGatewayFilterFactory、AddRequestParameterGatewayFilterFactory 等都是直接繼承的 AbstractNameValueGatewayFilterFactory。

參見博客: http://c.biancheng.net/view/5440.html

spring cloud gateway+自定義全局/過濾器工廠

nacos動態網關gateway+docker部署

java反射獲取到接口和類的方法對應的參數名稱(非參數類型)

spring cloud gateway+自定義全局/過濾器工廠

linux中安裝consul

spring cloud gateway網關處理跨域

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結