四、gateway网关基本使用,接入Nacos1.4.1
1.pom引入
父类pom引入:
<properties>
<java.version>1.8</java.version>
<spring-boot.version>2.3.2.RELEASE</spring-boot.version>
<spring-cloud.version>Hoxton.SR8</spring-cloud.version>
<nacos.version>2.2.5.RELEASE</nacos.version>
</properties>
<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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring-boot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>${nacos.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
模块项目引入:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!-- 服务注册 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
</exclusion>
</exclusions>
</dependency>
2.启动类配置
package com.gateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
@SpringBootApplication
//开启服务注册发现功能
@EnableDiscoveryClient
public class NacosGateWayApplication {
public static void main(String[] args) {
SpringApplication.run(NacosGateWayApplication.class);
}
}
3.三大核心概念
Route(路由)
路由是构建网关的基本模块,它由ID,目标URI,一些列的断言和或氯气组成,如果断言为true则匹配该路由。
Predicate(断言)
参考的是Java8的java.util.function.Predicate,开发人员和一匹配HTTP请求中的所有内容(例如请求头或请求参数),**如果请求与断言相匹配则进行路由 (判断条件)。
Filter(过滤)
指的是Spring框架中的GatewayFilter的实例,使用过滤器,可以再请求路由前或者之后对请求进行修改(对请求做一些更改,或者逻辑业务)。
4.网关配置两种配置方式选择一种
例:对消费者进行路由,匹配url为/hello/开头的。
也有对进行请求的方式,参数,cookies等做匹配的配置,东西太多在此省略。
方式一
server:
port: 80
spring:
application:
name: nacos-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
group: DEFAULT_GROUP
namespace: 8ce9ab74-4c3b-41d0-a956-1d435b17b11f
gateway:
# 路由规则
routes:
- id: nacos-consumer # 路由 ID,唯一
uri: http://localhost:9528/ # 目标URI,路由到微服务的地址
predicates: # 断言(判断条件)
- Path=/hello/** # 匹配对应 URL 的请求,将匹配到的请求追加在目标 URI 之后
方式二
package com.gateway.config;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class RouteConfig {
/**
* 配置了一个id为route-name的路由规则,
* 当访问地址为以下时,会自动转发地址
*
* @param routeLocatorBuilder
* @return
*/
@Bean
public RouteLocator routes(RouteLocatorBuilder routeLocatorBuilder) {
//路由器
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("nacos-consumer", r -> r.path("/hello/**").uri("http://localhost:9528/")).build();
return routes.build();
}
}
服务注册和发现的功能(省略每一个服务配置路由)
参数spring.cloud.gateway.discovery.locator.enabled为true,表明Gateway开启服务注册和发现的功能,并且Spring Cloud Gateway自动根据服务发现为每一个服务创建了一个router,这个router将以服务名开头的请求路径转发到对应的服务。
server:
port: 80
spring:
application:
name: nacos-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
group: DEFAULT_GROUP
namespace: 8ce9ab74-4c3b-41d0-a956-1d435b17b11f
gateway:
discovery:
locator:
enabled: true
lower-case-service-id: true
切记这种方式请求路径开头为服务名
5.全局过滤器
package com.gateway.config;
import com.alibaba.nacos.common.utils.StringUtils;
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.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Component
@Slf4j
public class GateWayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
String path = exchange.getRequest().getURI().getPath();
String test = exchange.getRequest().getQueryParams().getFirst("test");
log.info("[ConsumerTestController]-[testHello]-[{}:begin]-[request:{}]", path, test);
if (StringUtils.isEmpty(test)) {
log.info("非法请求");
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}
两次请求第一次被拦截,第二次请求成功