Обзор
вотSpringCloud GatewayПервая часть практики в основном рассказывает о реализации фильтров. Spring-Cloud-GatewayWebFluxОснованный на адаптивной архитектуре, он является асинхронным и неблокирующим и может в полной мере использовать аппаратные ресурсы многоядерных процессоров для обработки большого количества одновременных запросов.
Эта статья будет основана наВведение в spring-cloud-gatewayБазовая среда изменена.
Принцип работы
Spring-Cloud-Gateway реализован на основе фильтров, аналогичных zuul, сpreа такжеpostДва способа фильтрации, разбираться отдельнодологикаа такжепост логика.客户端的请求先经过preтипа фильтра, затем перенаправить запрос в конкретную бизнес-службу, а после получения ответа от бизнес-службы пройти черезpostТип обработки фильтра и, наконец, возврат ответа клиенту.
Процесс выполнения фильтра выглядит следующим образом:Чем больше заказ, тем ниже приоритет
Далее проверимfilterисполнительный порядок.
Здесь создаются три фильтра, каждый с разными приоритетами
@Slf4j
public class AFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("AFilter前置逻辑");
return chain.filter(exchange).then(Mono.fromRunnable(() -> {
log.info("AFilter后置逻辑");
}));
}
}
@Slf4j
public class BFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("BFilter前置逻辑");
return chain.filter(exchange).then(Mono.fromRunnable(() -> {
log.info("BFilter后置逻辑");
}));
}
}
@Slf4j
public class CFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("CFilter前置逻辑");
return chain.filter(exchange).then(Mono.fromRunnable(() -> {
log.info("CFilter后置逻辑");
}));
}
}
@Configuration
public class FilterConfig {
@Bean
@Order(-1)
public GlobalFilter a() {
return new AFilter();
}
@Bean
@Order(0)
public GlobalFilter b() {
return new BFilter();
}
@Bean
@Order(1)
public GlobalFilter c() {
return new CFilter();
}
}
curl -X POST -H "Content-Type:application/json" -d '{"name": "admin"}' http://192.168.124.5:2000/p/provider1
curl -X GET -G -d "username=admin" http://192.168.124.5:2000/p/provider1/1
Просмотр выходного журнала шлюза
2020-03-29 16:23:22.832 INFO 59326 --- [ctor-http-nio-6] cn.idea360.gateway.filter1.AFilter : AFilter前置逻辑
2020-03-29 16:23:22.832 INFO 59326 --- [ctor-http-nio-6] cn.idea360.gateway.filter1.BFilter : BFilter前置逻辑
2020-03-29 16:23:22.832 INFO 59326 --- [ctor-http-nio-6] cn.idea360.gateway.filter1.CFilter : CFilter前置逻辑
2020-03-29 16:23:22.836 INFO 59326 --- [ctor-http-nio-6] cn.idea360.gateway.filter1.CFilter : CFilter后置逻辑
2020-03-29 16:23:22.836 INFO 59326 --- [ctor-http-nio-6] cn.idea360.gateway.filter1.BFilter : BFilter后置逻辑
2020-03-29 16:23:22.836 INFO 59326 --- [ctor-http-nio-6] cn.idea360.gateway.filter1.AFilter : AFilter后置逻辑
пользовательский фильтр
Теперь предположим, что мы хотим посчитать время отклика службы, мы можем сделать это в коде
long beginTime = System.currentTimeMillis();
// do something...
long elapsed = System.currentTimeMillis() - beginTime;
log.info("elapsed: {}ms", elapsed);
Надоело каждый раз это писать? Spring говорит нам, что есть нечто, называемое АОП. Но мы микросервисы, и писать в каждом сервисе надоедает. Вот когда фильтр шлюза вступает в игру.
Пользовательские фильтры должны быть реализованыGatewayFilterа такжеOrdered. вGatewayFilterЭтот метод используется для реализации вашей пользовательской логики.
Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
а такжеOrderedсерединаint getOrder()Метод заключается в установке уровня приоритета для фильтра, чем больше значение, тем ниже приоритет.
Хорошо, давайте перейдем к коду.
/**
* 此过滤器功能为计算请求完成时间
*/
public class ElapsedFilter implements GatewayFilter, Ordered {
private static final String ELAPSED_TIME_BEGIN = "elapsedTimeBegin";
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
exchange.getAttributes().put(ELAPSED_TIME_BEGIN, System.currentTimeMillis());
return chain.filter(exchange).then(
Mono.fromRunnable(() -> {
Long startTime = exchange.getAttribute(ELAPSED_TIME_BEGIN);
if (startTime != null) {
System.out.println(exchange.getRequest().getURI().getRawPath() + ": " + (System.currentTimeMillis() - startTime) + "ms");
}
})
);
}
/*
*过滤器存在优先级，order越大，优先级越低
*/
@Override
public int getOrder() {
return Ordered.LOWEST_PRECEDENCE;
}
}
Когда запрос только что поступил, мы идем вServerWebExchangeпоместить атрибут вelapsedTimeBegin, значением атрибута является отметка времени в миллисекундах в это время. Затем, после выполнения запроса, временная метка, которую мы ввели ранее, удаляется, и разница с текущим временем составляет время выполнения запроса. Поскольку это некоммерческий журнал, он будетOrderedустановить какInteger.MAX_VALUEчтобы понизить приоритет.
Теперь давайте посмотрим на наш предыдущий вопрос: как отличить «до» от «после»? На самом деле этоchain.filter(exchange)Тот, что до этого, является «предварительной» частью, а тот, что после этого,thenВнутри находится раздел «Пост».
После создания фильтра мы добавляем его в нашу цепочку фильтров.
@Configuration
public class FilterConfig {
/**
* http://localhost:8100/filter/provider
* @param builder
* @return
*/
@Bean
public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
// @formatter:off
// 可以对比application.yml中关于路由转发的配置
return builder.routes()
.route(r -> r.path("/filter/**")
.filters(f -> f.stripPrefix(1)
.filter(new ElapsedFilter()))
.uri("lb://idc-cloud-provider")
.order(0)
.id("filter")
)
.build();
// @formatter:on
}
}
Реализовать функцию аудита на основе глобального фильтра
// AdaptCachedBodyGlobalFilter
@Component
public class LogFilter implements GlobalFilter, Ordered {
private Logger log = LoggerFactory.getLogger(LogFilter.class);
private final ObjectMapper objectMapper = new ObjectMapper();
private static final String START_TIME = "startTime";
private static final List<HttpMessageReader<?>> messageReaders = HandlerStrategies.withDefaults().messageReaders();
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
ServerHttpRequest request = exchange.getRequest();
// 请求路径
String path = request.getPath().pathWithinApplication().value();
// 请求schema: http/https
String scheme = request.getURI().getScheme();
// 请求方法
HttpMethod method = request.getMethod();
// 路由服务地址
URI targetUri = exchange.getAttribute(ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR);
// 请求头
HttpHeaders headers = request.getHeaders();
// 设置startTime
exchange.getAttributes().put(START_TIME, System.currentTimeMillis());
// 获取请求地址
InetSocketAddress remoteAddress = request.getRemoteAddress();
MultiValueMap<String, String> formData = null;
AccessRecord accessRecord = new AccessRecord();
accessRecord.setPath(path);
accessRecord.setSchema(scheme);
accessRecord.setMethod(method.name());
accessRecord.setTargetUri(targetUri.toString());
accessRecord.setRemoteAddress(remoteAddress.toString());
accessRecord.setHeaders(headers);
if (method == HttpMethod.GET) {
formData = request.getQueryParams();
accessRecord.setFormData(formData);
writeAccessRecord(accessRecord);
}
if (method == HttpMethod.POST) {
Mono<Void> voidMono = null;
if (headers.getContentType().equals(MediaType.APPLICATION_JSON)) {
// JSON
voidMono = readBody(exchange, chain, accessRecord);
}
if (headers.getContentType().equals(MediaType.APPLICATION_FORM_URLENCODED)) {
// x-www-form-urlencoded
voidMono = readFormData(exchange, chain, accessRecord);
}
if (voidMono != null) {
return voidMono;
}
}
return chain.filter(exchange);
}
private Mono<Void> readFormData(ServerWebExchange exchange, GatewayFilterChain chain, AccessRecord accessRecord) {
return null;
}
private Mono<Void> readBody(ServerWebExchange exchange, GatewayFilterChain chain, AccessRecord accessRecord) {
return DataBufferUtils.join(exchange.getRequest().getBody()).flatMap(dataBuffer -> {
byte[] bytes = new byte[dataBuffer.readableByteCount()];
dataBuffer.read(bytes);
DataBufferUtils.release(dataBuffer);
Flux<DataBuffer> cachedFlux = Flux.defer(() -> {
DataBuffer buffer = exchange.getResponse().bufferFactory().wrap(bytes);
DataBufferUtils.retain(buffer);
return Mono.just(buffer);
});
// 重写请求体,因为请求体数据只能被消费一次
ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) {
@Override
public Flux<DataBuffer> getBody() {
return cachedFlux;
}
};
ServerWebExchange mutatedExchange = exchange.mutate().request(mutatedRequest).build();
return ServerRequest.create(mutatedExchange, messageReaders)
.bodyToMono(String.class)
.doOnNext(objectValue -> {
accessRecord.setBody(objectValue);
writeAccessRecord(accessRecord);
}).then(chain.filter(mutatedExchange));
});
}
@Override
public int getOrder() {
return Ordered.LOWEST_PRECEDENCE;
}
/**
* TODO 异步日志
* @param accessRecord
*/
private void writeAccessRecord(AccessRecord accessRecord) {
log.info("\n\n start------------------------------------------------- \n " +
"请求路径:{}\n " +
"scheme:{}\n " +
"请求方法:{}\n " +
"目标服务:{}\n " +
"请求头:{}\n " +
"远程IP地址:{}\n " +
"表单参数:{}\n " +
"请求体:{}\n " +
"end------------------------------------------------- \n ",
accessRecord.getPath(), accessRecord.getSchema(), accessRecord.getMethod(), accessRecord.getTargetUri(), accessRecord.getHeaders(), accessRecord.getRemoteAddress(), accessRecord.getFormData(), accessRecord.getBody());
}
}
curl -X POST -H "Content-Type:application/json" -d '{"name": "admin"}' http://192.168.124.5:2000/p/provider1
curl -X GET -G -d "username=admin" http://192.168.124.5:2000/p/provider1/1
выходной результат
start-------------------------------------------------
请求路径:/provider1
scheme:http
请求方法:POST
目标服务:http://192.168.124.5:2001/provider1
请求头:[Content-Type:"application/json", User-Agent:"PostmanRuntime/7.22.0", Accept:"*/*", Cache-Control:"no-cache", Postman-Token:"2a4ce04d-8449-411d-abd8-247d20421dc2", Host:"192.168.124.5:2000", Accept-Encoding:"gzip, deflate, br", Content-Length:"16", Connection:"keep-alive"]
远程IP地址:/192.168.124.5:49969
表单参数:null
请求体:{"name":"admin"}
end-------------------------------------------------
Далее давайте настроим журнал, чтобы облегчить системе журналов извлечение журнала. Журнал SpringBoot по умолчанию — logback.
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property name="LOGS" value="/Users/cuishiying/Documents/spring-cloud-learning/logs" />
<appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>
%black(%d{ISO8601}) %highlight(%-5level) [%blue(%t)] %yellow(%C{1.}): %msg%n%throwable
</Pattern>
</layout>
</appender>
<appender name="RollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOGS}/spring-boot-logger.log</file>
<encoder
class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>%d %p %C{1.} [%t] %m%n</Pattern>
</encoder>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- rollover daily and when the file reaches 10 MegaBytes -->
<fileNamePattern>${LOGS}/archived/spring-boot-logger-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
</appender>
<!-- LOG everything at INFO level -->
<root level="info">
<!--<appender-ref ref="RollingFile" />-->
<appender-ref ref="Console" />
</root>
<!-- LOG "cn.idea360*" at TRACE level additivity:是否向上级loger传递打印信息。默认是true-->
<logger name="cn.idea360.gateway" level="info" additivity="false">
<appender-ref ref="RollingFile" />
<appender-ref ref="Console" />
</logger>
</configuration>
Таким образом, есть журналы в каталогах консоли и журналов.
фабрика фильтров по индивидуальному заказу
Если вы видели конфигурацию статической маршрутизации, у вас должна сложиться впечатление о следующей конфигурации.
filters:
- StripPrefix=1
- AddResponseHeader=X-Response-Default-Foo, Default-Bar
StripPrefix,AddResponseHeaderЭти два фактически являются двумя фабриками фильтров (GatewayFilterFactory), которые более гибко и удобно настраивать таким образом.
мы поставим предыдущийElapsedFilterИзмените его так, чтобы он мог получатьbooleanВведите параметры, чтобы решить, следует ли печатать параметры запроса.
public class ElapsedGatewayFilterFactory extends AbstractGatewayFilterFactory<ElapsedGatewayFilterFactory.Config> {
private static final Log log = LogFactory.getLog(GatewayFilter.class);
private static final String ELAPSED_TIME_BEGIN = "elapsedTimeBegin";
private static final String KEY = "withParams";
public List<String> shortcutFieldOrder() {
return Arrays.asList(KEY);
}
public ElapsedGatewayFilterFactory() {
super(Config.class);
}
public GatewayFilter apply(Config config) {
return (exchange, chain) -> {
exchange.getAttributes().put(ELAPSED_TIME_BEGIN, System.currentTimeMillis());
return chain.filter(exchange).then(
Mono.fromRunnable(() -> {
Long startTime = exchange.getAttribute(ELAPSED_TIME_BEGIN);
if (startTime != null) {
StringBuilder sb = new StringBuilder(exchange.getRequest().getURI().getRawPath())
.append(": ")
.append(System.currentTimeMillis() - startTime)
.append("ms");
if (config.isWithParams()) {
sb.append(" params:").append(exchange.getRequest().getQueryParams());
}
log.info(sb.toString());
}
})
);
};
}
public static class Config {
private boolean withParams;
public boolean isWithParams() {
return withParams;
}
public void setWithParams(boolean withParams) {
this.withParams = withParams;
}
}
}
Интерфейс верхнего уровня фабрики фильтров:GatewayFilterFactory, мы можем напрямую наследовать два его абстрактных класса, чтобы упростить разработкуAbstractGatewayFilterFactoryа такжеAbstractNameValueGatewayFilterFactory, разница между этими двумя абстрактными классами заключается в том, что первый принимает параметр (например,StripPrefixи тот, который мы создали), который принимает два параметра (например,AddResponseHeader).
GatewayFilter apply(Config config)Метод фактически создаетGatewayFilterАнонимный класс , конкретная реализация почти такая же, как и у предыдущего, поэтому объяснять не буду.
статический внутренний классConfigпросто чтобы получить этоbooleanТип сервиса параметра, имя переменной в нем можно написать по желанию, но его нужно переписатьList shortcutFieldOrder()Сюда.
Обратите внимание, что вы должны вызвать конструктор родительского класса, чтобыConfigТип передается в прошлом, иначе будет сообщеноClassCastException
public ElapsedGatewayFilterFactory() {
super(Config.class);
}
У нас есть фабричный класс, и мы регистрируем его в Spring.
@Bean
public ElapsedGatewayFilterFactory elapsedGatewayFilterFactory() {
return new ElapsedGatewayFilterFactory();
}
Затем добавьте конфигурацию (основные изменения вdefault-filtersконфигурация)
server:
port: 2000
spring:
application:
name: idc-gateway
redis:
host: localhost
port: 6379
timeout: 6000ms # 连接超时时长（毫秒）
jedis:
pool:
max-active: 1000 # 连接池最大连接数（使用负值表示没有限制）
max-wait: -1ms # 连接池最大阻塞等待时间（使用负值表示没有限制）
max-idle: 10 # 连接池中的最大空闲连接
min-idle: 5 # 连接池中的最小空闲连接
cloud:
consul:
host: localhost
port: 8500
gateway:
discovery:
locator:
enabled: true
# 修改在这里。gateway可以通过开启以下配置来打开根据服务的serviceId来匹配路由,默认是大写
default-filters:
- Elapsed=true
routes:
- id: provider # 路由 ID，保持唯一
uri: lb://idc-provider1 # uri指目标服务地址，lb代表从注册中心获取服务
predicates: # 路由条件。Predicate 接受一个输入参数，返回一个布尔值结果。该接口包含多种默认方法来将 Predicate 组合成其他复杂的逻辑（比如：与，或，非）
- Path=/p/**
filters:
- StripPrefix=1 # 过滤器StripPrefix，作用是去掉请求路径的最前面n个部分截取掉。StripPrefix=1就代表截取路径的个数为1，比如前端过来请求/test/good/1/view，匹配成功后，路由到后端的请求路径就会变成http://localhost:8888/good/1/view
Эпилог
На этом статья заканчивается. оWebfluxЯ только начал учиться, я чувствую, чтоRxjavaпо тому путиonNextполучить асинхронные данные вpostЭто не влияет на получение тела. Проверено, чтобы знатьgetBodyПолученный вывод данных нулевой, а сам прошелFlux.createСозданные данные доступны в подписчиках. Здесь предстоит еще много исследований, и я надеюсь, что дам вам несколько советов. В то же время я надеюсь, что все обратят внимание на паблик [Когда я встретил тебя].