parent
07e7e978dc
commit
03aa1d6f03
@ -0,0 +1,210 @@
|
||||
package org.example.conf;
|
||||
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinition;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPathPredicateItem;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPredicateItem;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.common.api.GatewayApiDefinitionManager;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayRuleManager;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.sc.SentinelGatewayFilter;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.GatewayCallbackManager;
|
||||
import com.alibaba.csp.sentinel.adapter.gateway.sc.exception.SentinelGatewayBlockExceptionHandler;
|
||||
import com.alibaba.csp.sentinel.slots.block.RuleConstant;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.beans.factory.ObjectProvider;
|
||||
import org.springframework.cloud.gateway.filter.GlobalFilter;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.annotation.Order;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.codec.ServerCodecConfigurer;
|
||||
import org.springframework.web.reactive.function.BodyInserters;
|
||||
import org.springframework.web.reactive.function.server.ServerResponse;
|
||||
import org.springframework.web.reactive.result.view.ViewResolver;
|
||||
import org.springframework.web.server.ServerWebExchange;
|
||||
import reactor.core.publisher.Mono;
|
||||
|
||||
import javax.annotation.PostConstruct;
|
||||
import java.util.*;
|
||||
|
||||
/**
|
||||
* <h1>Gateway 集成 Sentinel 实现限流</h1>
|
||||
*
|
||||
* 样本代码, 工程中使用直接进行拷贝即可
|
||||
* */
|
||||
@Slf4j
|
||||
@Configuration
|
||||
public class SentinelGatewayConfiguration {
|
||||
|
||||
/** 视图解析器 */
|
||||
private final List<ViewResolver> viewResolvers;
|
||||
/** HTTP 请求和响应数据的编解码配置 */
|
||||
private final ServerCodecConfigurer serverCodecConfigurer;
|
||||
|
||||
/**
|
||||
* <h2>构造方法</h2>
|
||||
* */
|
||||
public SentinelGatewayConfiguration(
|
||||
ObjectProvider<List<ViewResolver>> viewResolversProvider,
|
||||
ServerCodecConfigurer serverCodecConfigurer
|
||||
) {
|
||||
this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
|
||||
this.serverCodecConfigurer = serverCodecConfigurer;
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>限流异常处理器, 限流异常出现时, 执行到这个 handler</h2>
|
||||
* */
|
||||
@Bean
|
||||
@Order(Ordered.HIGHEST_PRECEDENCE)
|
||||
public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
|
||||
// 默认会返回错误 message, code 429
|
||||
return new SentinelGatewayBlockExceptionHandler(
|
||||
this.viewResolvers,
|
||||
this.serverCodecConfigurer
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>限流过滤器, 是 Gateway 全局过滤器, 优先级定义为最高</h2>
|
||||
* */
|
||||
@Bean
|
||||
@Order(Ordered.HIGHEST_PRECEDENCE)
|
||||
public GlobalFilter sentinelGatewayFilter() {
|
||||
return new SentinelGatewayFilter();
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>初始化限流规则</h2>
|
||||
* */
|
||||
// @PostConstruct //fixme 注释掉这个, 就可以取消硬编码模式
|
||||
public void doInit() {
|
||||
|
||||
log.info("---------------------------------------------------");
|
||||
|
||||
// 1. 加载网关限流规则
|
||||
log.info("load sentinel gateway rules (code define)");
|
||||
initGatewayRules();
|
||||
|
||||
// 2. 加载自定义限流异常处理器
|
||||
initBlockHandler();
|
||||
|
||||
log.info("---------------------------------------------------");
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>硬编码网关限流规则</h2>
|
||||
* */
|
||||
private void initGatewayRules() {
|
||||
|
||||
Set<GatewayFlowRule> rules = new HashSet<>();
|
||||
|
||||
GatewayFlowRule rule = new GatewayFlowRule();
|
||||
// 指定限流模式, 根据 route_id 做限流, 默认的模式
|
||||
rule.setResourceMode(SentinelGatewayConstants.RESOURCE_MODE_ROUTE_ID);
|
||||
// 指定 route_id -> service id, 指定要限流的服务
|
||||
rule.setResource("dev-protocol-springcloud-nacos");
|
||||
// 按照 QPS 限流
|
||||
rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
|
||||
// 统计窗口和限流阈值 60s内3个请求通过
|
||||
rule.setIntervalSec(60);
|
||||
rule.setCount(3);
|
||||
|
||||
// 1. 硬编码模式
|
||||
// rules.add(rule);
|
||||
|
||||
// 3. 限流分组, Sentinel 先去找规则定义, 再去找规则中定义的分组
|
||||
rules.add(
|
||||
new GatewayFlowRule("nacos-client-api-1")
|
||||
.setCount(3).setIntervalSec(60)
|
||||
);
|
||||
rules.add(
|
||||
new GatewayFlowRule("nacos-client-api-2")
|
||||
.setCount(1).setIntervalSec(60)
|
||||
);
|
||||
|
||||
// 加载到网关中
|
||||
GatewayRuleManager.loadRules(rules);
|
||||
|
||||
// 3. 加载限流分组
|
||||
initCustomizedApis();
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>自定义限流异常处理器</h2>
|
||||
* */
|
||||
private void initBlockHandler() {
|
||||
|
||||
// 自定义 BlockRequestHandler
|
||||
BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
|
||||
@Override
|
||||
public Mono<ServerResponse> handleRequest(ServerWebExchange serverWebExchange,
|
||||
Throwable throwable) {
|
||||
|
||||
log.error("------------- trigger gateway sentinel rule -------------");
|
||||
|
||||
Map<String, String> result = new HashMap<>();
|
||||
result.put("code", String.valueOf(HttpStatus.TOO_MANY_REQUESTS.value()));
|
||||
result.put("message", HttpStatus.TOO_MANY_REQUESTS.getReasonPhrase());
|
||||
result.put("route", "dev-protocol-springcloud-nacos");
|
||||
|
||||
return ServerResponse
|
||||
.status(HttpStatus.TOO_MANY_REQUESTS)
|
||||
.contentType(MediaType.APPLICATION_JSON)
|
||||
.body(BodyInserters.fromValue(result));
|
||||
}
|
||||
};
|
||||
|
||||
// 设置自定义限流异常处理器
|
||||
GatewayCallbackManager.setBlockHandler(blockRequestHandler);
|
||||
}
|
||||
|
||||
/**
|
||||
* <h2>硬编码网关限流分组</h2>
|
||||
* 1. 最大限制 - 演示
|
||||
* 2. 具体的分组
|
||||
* */
|
||||
private void initCustomizedApis() {
|
||||
|
||||
Set<ApiDefinition> definitions = new HashSet<>();
|
||||
|
||||
// stream-client-api 组, 最大的限制, 只是用作演示, 一种模糊的定义
|
||||
ApiDefinition api = new ApiDefinition("nacos-client-api")
|
||||
// {{}} 可以直接用作给集合初始化
|
||||
.setPredicateItems(new HashSet<ApiPredicateItem>() {{
|
||||
// 模糊匹配 /dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos/ 及其子路径的所有请求
|
||||
add(new ApiPathPredicateItem()
|
||||
.setPattern("/dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos/**")
|
||||
// 根据前缀匹配
|
||||
.setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
|
||||
}});
|
||||
|
||||
// nacos-client-api-1 分组
|
||||
ApiDefinition api1 = new ApiDefinition("nacos-client-api-1")
|
||||
.setPredicateItems(new HashSet<ApiPredicateItem>() {{
|
||||
add(new ApiPathPredicateItem()
|
||||
// 精确匹配 /dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos/nacos-client/service-instance
|
||||
.setPattern("/dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos" +
|
||||
"/nacos-client/service-instance"));
|
||||
}});
|
||||
|
||||
// nacos-client-api-2 分组
|
||||
ApiDefinition api2 = new ApiDefinition("nacos-client-api-2")
|
||||
.setPredicateItems(new HashSet<ApiPredicateItem>() {{
|
||||
add(new ApiPathPredicateItem()
|
||||
// 精确匹配 /dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos/nacos-client/project-config
|
||||
.setPattern("/dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos" +
|
||||
"/nacos-client/project-config"));
|
||||
}});
|
||||
|
||||
definitions.add(api1);
|
||||
definitions.add(api2);
|
||||
|
||||
// 加载限流分组
|
||||
GatewayApiDefinitionManager.loadApiDefinitions(definitions);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,14 @@
|
||||
[
|
||||
{
|
||||
"apiName": "nacos-client-api",
|
||||
"predicateItems": [
|
||||
{
|
||||
"pattern": "/dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos/nacos-client/project-config"
|
||||
},
|
||||
{
|
||||
"pattern": "/dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos/**",
|
||||
"matchStrategy": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@ -0,0 +1,14 @@
|
||||
[
|
||||
{
|
||||
"resource": "dev-protocol-springcloud-nacos",
|
||||
"resourceMode": 0,
|
||||
"count": 3,
|
||||
"intervalSec": 60
|
||||
},
|
||||
{
|
||||
"resource": "nacos-client-api",
|
||||
"resourceMode": 1,
|
||||
"count": 1,
|
||||
"intervalSec": 60
|
||||
}
|
||||
]
|
||||
@ -1,5 +1,6 @@
|
||||
### 查询服务 - (测试gateway)
|
||||
GET http://127.0.0.1:9001/dev-protocol-springcloud-gateway/ecommerce-nacos-client/nacos-client/service-instance?serviceId=e-commerce-gateway
|
||||
# 测试之前的 token 可以重新获取生成
|
||||
GET http://127.0.0.1:9001/dev-protocol-springcloud-gateway/dev-protocol-springcloud-nacos/nacos-client/service-instance?serviceId=e-commerce-gateway
|
||||
Accept: application/json
|
||||
e-commerce-user: eyJhbGciOiJSUzI1NiJ9.eyJlLWNvbW1lcmNlLXVzZXIiOiJ7XCJpZFwiOjE3LFwidXNlcm5hbWVcIjpcIkltb29jUWlueWlAaW1vb2MuY29tXCJ9IiwianRpIjoiMGIxNzQyYWItMWU3OC00OTZjLWIyNTAtMjNkZGQ1ZGEyZTU1IiwiZXhwIjoxNjI0MjA0ODAwfQ.QKGHzohSHdYDHzUVHpe9gNPUgzfkPwrSbB-WiMWYjLlt2tr9BufzZM8bSt-whb_bd0hKoC6rkYYO0WUVR67uSML-2yaTL1xMIn8GH9Flyig3rpO4vefL3Hp2TXIpwHHa7WlKsLzcUpNk9lxWs2B5k0ICdYCH_jD5Tx6N7CzfSUG9u4fOnVeM9UFE2nX_DURupUh_DKCc2oOoMeyCSR7Ma8-Ab4WQU3r-U0YivR8G1A0kmKOIoTeRhM3LcPuxUPh3rCbrjzMg--fexRGw0O38Qsby6pz-ku2IlTyFXY6_jNOG1BZR34-jBOnaIciP1TExw9bFumeuC2GcowTHJVH1Nw
|
||||
token: imooc
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
[
|
||||
{
|
||||
"apiName": "nacos-client-api",
|
||||
"predicateItems": [
|
||||
{
|
||||
"pattern": "/imooc/ecommerce-nacos-client/nacos-client/project-config"
|
||||
},
|
||||
{
|
||||
"pattern": "/imooc/ecommerce-nacos-client/**",
|
||||
"matchStrategy": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
@ -0,0 +1,14 @@
|
||||
[
|
||||
{
|
||||
"resource": "e-commerce-nacos-client",
|
||||
"resourceMode": 0,
|
||||
"count": 3,
|
||||
"intervalSec": 60
|
||||
},
|
||||
{
|
||||
"resource": "nacos-client-api",
|
||||
"resourceMode": 1,
|
||||
"count": 1,
|
||||
"intervalSec": 60
|
||||
}
|
||||
]
|
||||
Loading…
Reference in New Issue