SpringCloud Gateway使用redis實現動態路由的方法
1. 將 actuator 端點暴露出來
management:
endpoints:
web:
exposure:
include: “*”
2. redis 配置
https://www.jb51.net/article/203766.htm
3. 將原內存路由持久化到 redis
@Component
public class RedisRouteDefinitionRepository implements RouteDefinitionRepository {
/**
* hash存儲的key
*/
public static final String GATEWAY_ROUTES = "gateway_dynamic_route";
@Resource
private StringRedisTemplate redisTemplate;
/**
* 獲取路由信息
* @return
*/
@Override
public Flux<RouteDefinition> getRouteDefinitions() {
List<RouteDefinition> routeDefinitions = new ArrayList<>();
redisTemplate.opsForHash().values(GATEWAY_ROUTES).stream()
.forEach(routeDefinition -> routeDefinitions.add(JSON.parseObject(routeDefinition.toString(), RouteDefinition.class)));
return Flux.fromIterable(routeDefinitions);
}
@Override
public Mono<Void> save(Mono<RouteDefinition> route) {
return route.flatMap(routeDefinition -> {
redisTemplate.opsForHash().put(GATEWAY_ROUTES, routeDefinition.getId(), JSONObject.toJSONString(routeDefinition));
return Mono.empty();
});
}
@Override
public Mono<Void> delete(Mono<String> routeId) {
return routeId.flatMap(id -> {
if (redisTemplate.opsForHash().hasKey(GATEWAY_ROUTES, id)) {
redisTemplate.opsForHash().delete(GATEWAY_ROUTES, id);
return Mono.empty();
}
return Mono.defer(() -> Mono.error(new NotFoundException("route definition is not found, routeId:" + routeId)));
});
}
}
4. 重寫動態路由服務
@Service
public class GatewayDynamicRouteService implements ApplicationEventPublisherAware {
@Resource
private RedisRouteDefinitionRepository redisRouteDefinitionRepository;
private ApplicationEventPublisher applicationEventPublisher;
/**
* 增加路由
* @param routeDefinition
* @return
*/
public int add(RouteDefinition routeDefinition) {
redisRouteDefinitionRepository.save(Mono.just(routeDefinition)).subscribe();
applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this));
return 1;
}
/**
* 更新
* @param routeDefinition
* @return
*/
public int update(RouteDefinition routeDefinition) {
redisRouteDefinitionRepository.delete(Mono.just(routeDefinition.getId()));
redisRouteDefinitionRepository.save(Mono.just(routeDefinition)).subscribe();
applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this));
return 1;
}
/**
* 刪除
* @param id
* @return
*/
public Mono<ResponseEntity<Object>> delete(String id) {
return redisRouteDefinitionRepository.delete(Mono.just(id)).then(Mono.defer(() -> Mono.just(ResponseEntity.ok().build())))
.onErrorResume(t -> t instanceof NotFoundException, t -> Mono.just(ResponseEntity.notFound().build()));
}
@Override
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
this.applicationEventPublisher = applicationEventPublisher;
}
}
5. 對外暴露接口
@RestController
@RequestMapping("/gateway")
public class GatewayDynamicRouteController {
@Resource
private GatewayDynamicRouteService gatewayDynamicRouteService;
@PostMapping("/add")
public String create(@RequestBody RouteDefinition entity) {
int result = gatewayDynamicRouteService.add(entity);
return String.valueOf(result);
}
@PostMapping("/update")
public String update(@RequestBody RouteDefinition entity) {
int result = gatewayDynamicRouteService.update(entity);
return String.valueOf(result);
}
@DeleteMapping("/delete/{id}")
public Mono<ResponseEntity<Object>> delete(@PathVariable String id) {
return gatewayDynamicRouteService.delete(id);
}
}
測試
測試前刪除我們配置的靜態路由，因為靜態路由和 redis 動態路由同時存在時取並集。
訪問 http://localhost:2000/actuator/gateway/routes , 可以看到隻有默認路由。
[
{
"route_id": "CompositeDiscoveryClient_consul",
"route_definition": {
"id": "CompositeDiscoveryClient_consul",
"predicates": [
{
"name": "Path",
"args": {
"pattern": "/consul/**"
}
}
],
"filters": [
{
"name": "RewritePath",
"args": {
"regexp": "/consul/(?<remaining>.*)",
"replacement": "/${remaining}"
}
}
],
"uri": "lb://consul",
"order": 0
},
"order": 0
},
{
"route_id": "CompositeDiscoveryClient_idc-gateway",
"route_definition": {
"id": "CompositeDiscoveryClient_idc-gateway",
"predicates": [
{
"name": "Path",
"args": {
"pattern": "/idc-gateway/**"
}
}
],
"filters": [
{
"name": "RewritePath",
"args": {
"regexp": "/idc-gateway/(?<remaining>.*)",
"replacement": "/${remaining}"
}
}
],
"uri": "lb://idc-gateway",
"order": 0
},
"order": 0
},
{
"route_id": "CompositeDiscoveryClient_idc-provider1",
"route_definition": {
"id": "CompositeDiscoveryClient_idc-provider1",
"predicates": [
{
"name": "Path",
"args": {
"pattern": "/idc-provider1/**"
}
}
],
"filters": [
{
"name": "RewritePath",
"args": {
"regexp": "/idc-provider1/(?<remaining>.*)",
"replacement": "/${remaining}"
}
}
],
"uri": "lb://idc-provider1",
"order": 0
},
"order": 0
},
{
"route_id": "CompositeDiscoveryClient_idc-provider2",
"route_definition": {
"id": "CompositeDiscoveryClient_idc-provider2",
"predicates": [
{
"name": "Path",
"args": {
"pattern": "/idc-provider2/**"
}
}
],
"filters": [
{
"name": "RewritePath",
"args": {
"regexp": "/idc-provider2/(?<remaining>.*)",
"replacement": "/${remaining}"
}
}
],
"uri": "lb://idc-provider2",
"order": 0
},
"order": 0
}
]
這個時候訪問 http://192.168.124.5:2000/idc-provider1/provider1/1 根據結果可以推測能正確路由到 provider1， 測試結果一致。
創建 provider1 路由，將路徑設置為 /p1/**，測試是否生效。
POST 請求 http://localhost:2000/gateway/add
{
"id":"provider1",
"predicates":[
{
"name":"Path",
"args":{
"_genkey_0":"/p1/**"
}
},
{
"name":"RemoteAddr",
"args":{
"_genkey_0":"192.168.124.5/16"
}
}
],
"filters":[
{
"name":"StripPrefix",
"args":{
"_genkey_0":"1"
}
}
],
"uri":"lb://idc-provider1",
"order":0
}
查看 redis 存儲，或者請求 http://localhost:2000/actuator/gateway/routes , 都可以看到配置成功。
到此這篇關於SpringCloud Gateway使用redis實現動態路由的文章就介紹到這瞭,更多相關SpringCloud Gateway動態路由內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- spring-cloud-gateway動態路由的實現方法
- SpringCloud Gateway 路由配置定位原理分析
- nacos gateway動態路由實戰
- Spring Cloud Gateway動態路由Apollo實現詳解
- SpringCloud超詳細講解微服務網關Gateway