Spring Cloud入門:API閘道器服務(Spring Cloud Gateway)
阿新 • • 發佈:2018-12-16
文章例項使用的Spring Cloud版本為Finchley.SR1,Spring Boot版本為2.0.4。
1 Spring Cloud Gateway
在微服務架構中,閘道器作為服務的一個統一入口,所有的外部客戶端訪問都需要經過它來排程和過濾,可以實現的功能包括動態路由、負載均衡、授權認證、限流等。
Spring Cloud Gateway是Spring官方基於Spring 5.0,Spring Boot 2.0和Project Reactor等技術開發的閘道器,旨在為微服務架構提供一種簡單而有效的統一的API路由管理方式,併為他們提供橫切關注點,例如:安全,監控/指標和彈性。
本篇將示例搭建一個簡單的閘道器服務。
2 構建閘道器
2.1 新建Spring Boot專案,引入相關依賴
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.4.RELEASE</version> <relativePath/> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-hystrix</artifactId> </dependency> </dependencies> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Finchley.SR1</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
2.2 application.properties配置
spring.application.name=api-gateway server.port=8888 #註冊中心 eureka.client.serviceUrl.defaultZone=http://localhost:1002/eureka/,http://localhost:1003/eureka/ #例項預設通過使用域名形式註冊到註冊中心:false eureka.instance.prefer-ip-address=true #例項名 eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port} #是否與服務註冊於發現元件進行結合,通過 serviceId 轉發到具體的服務例項 #預設為false,設為true便開啟通過服務中心的自動根據 serviceId 建立路由的功能 #其中微服務應用名預設大寫訪問 spring.cloud.gateway.discovery.locator.enabled=true
2.3 新增Filter,實現簡單的授權認證
@Configuration
public class TokenFilter implements GlobalFilter, Ordered {
@Override
public int getOrder() {
return -100;
}
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
String token = exchange.getRequest().getQueryParams().getFirst("token");
//url不含token引數時返回401狀態碼
if (token == null || token.isEmpty()) {
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
}
2.4 入口程式新增@SpringCloudApplication註解並啟動
@SpringCloudApplication
public class ApiGatewayApplication {
public static void main(String[] args) {
SpringApplication.run(ApiGatewayApplication.class, args);
}
}
啟動應用,訪問 localhost:8888/EUREKA-CLIENT/hello ,可以看到頁面401狀態碼,而攜帶了token引數再次請求後,則可以看到正常返回了結果(注意服務名為大寫)。