SpringCloud Gateway动态路由

说明
动态路由配置免去了每新增路由跳转都需要重启网关的工作,如下则是保存到MongoDB的步骤
相关pom.xml文件配置

<dependencies>
        <!--GateWay ⽹关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--引⼊webflux-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-mongodb</artifactId>
        </dependency>
    </dependencies>

application.yml配置

spring:
  application:
    name: api-gateway
  data:
    mongodb:
      uri: mongodb://username:password@192.168.8.11:27017/databaseName

mongo相关类

#定义路由实体
@Getter
@Setter
public class Router {

    /** 路由ID */
    @Id
    private String id;
    /** 路由谓词 */
    private List<PredicateDefinition> predicates = new ArrayList<>();
    /** 过滤器 */
    private List<FilterDefinition> filters = new ArrayList<>();
    /** 跳转地址uri */
    private String uri;
    /** 路由顺序 */
    private int order;
}
#定义service
public interface RouterService {

    List<Router> listAll();

    void add(Router router);

    void modifyById(Router router);

    void removeById(String id);
}
@Service
public class RouterServiceImpl implements RouterService {

    @Autowired
    private MongoTemplate mongoTemplate;

    @Override
    public List<Router> listAll() {
        return mongoTemplate.findAll(Router.class);
    }

    @Override
    public void add(Router router) {
        mongoTemplate.save(router);
    }

    @Override
    public void modifyById(Router router) {
        mongoTemplate.save(router);
    }

    @Override
    public void removeById(String id) {
        Query query = Query.query(Criteria.where("id").is(id));
        mongoTemplate.remove(query,Router.class);
    }
}

实现路由保存接口 RouteDefinitionRepository

@Service
public class MongoRouteDefinitionRepository implements RouteDefinitionRepository {

    @Autowired
    private RouterService routerService;

    @Override
    public Flux<RouteDefinition> getRouteDefinitions() {
        List<Router> routers = routerService.listAll();
        List<RouteDefinition> routeDefinitions = new ArrayList<>();
        for (Router router : routers) {
            RouteDefinition routeDefinition = new RouteDefinition();
            routeDefinition.setId(router.getId());
            routeDefinition.setFilters(router.getFilters());
            routeDefinition.setPredicates(router.getPredicates());
            routeDefinition.setUri(URI.create(router.getUri()));
            routeDefinition.setOrder(router.getOrder());
            routeDefinitions.add(routeDefinition);
        }
        return Flux.fromIterable(routeDefinitions);
    }

    @Override
    public Mono<Void> save(Mono<RouteDefinition> route) {
        return route.flatMap(routeDefinition -> {
            Router router = new Router();
            router.setId(routeDefinition.getId());
            router.setFilters(routeDefinition.getFilters());
            router.setPredicates(routeDefinition.getPredicates());
            router.setUri(routeDefinition.getUri().toString());
            router.setOrder(routeDefinition.getOrder());
            routerService.add(router);
            return Mono.empty();
        });
    }

    @Override
    public Mono<Void> delete(Mono<String> routeId) {
        return routeId.flatMap(id -> {
            routerService.removeById(id);
            return Mono.empty();
        });
    }
}

实现网关路由接口 ApplicationEventPublisherAware

@Service
public class GatewayDynamicRouteService implements ApplicationEventPublisherAware {

    @Autowired
    private MongoRouteDefinitionRepository mongoRouteDefinitionRepository;
    private ApplicationEventPublisher applicationEventPublisher;

    private void notifyChanged() {
        applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this));
    }


    /**
     * 增加路由
     *
     * @param routeDefinition
     * @return
     */
    public int add(RouteDefinition routeDefinition) {
        mongoRouteDefinitionRepository.save(Mono.just(routeDefinition)).subscribe();
        notifyChanged();
        return 1;
    }

    /**
     * 更新
     *
     * @param routeDefinition
     * @return
     */
    public int update(RouteDefinition routeDefinition) {
        mongoRouteDefinitionRepository.delete(Mono.just(routeDefinition.getId()));
        mongoRouteDefinitionRepository.save(Mono.just(routeDefinition)).subscribe();
        notifyChanged();
        return 1;
    }

    /**
     * 删除路由
     */
    public int delete(String id) {
        mongoRouteDefinitionRepository.delete(Mono.just(id)).subscribe();
        notifyChanged();
        return 1;
    }

    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.applicationEventPublisher = applicationEventPublisher;
    }
}

控制类编写

@RestController
@RequestMapping("/gateway/route")
public class GatewayDynamicRouteController {

    @Resource
    private GatewayDynamicRouteService gatewayDynamicRouteService;

    @PostMapping("/add")
    public ResponseMessage create(@RequestBody RouteDefinition entity) {
        int result = gatewayDynamicRouteService.add(entity);
        return ResponseMessage.success(new HashMap<String, Object>(){{
            put("result", result);
        }});
    }

    @PostMapping("/update")
    public ResponseMessage update(@RequestBody RouteDefinition entity) {
        int result = gatewayDynamicRouteService.update(entity);
        return ResponseMessage.success(new HashMap<String, Object>(){{
            put("result", result);
        }});
    }

    @GetMapping("/delete/{id}")
    public ResponseMessage delete(@PathVariable String id) {
        int result = gatewayDynamicRouteService.delete(id);
        return ResponseMessage.success(new HashMap<String, Object>(){{
            put("result", result);
        }});
    }
}
  • 注意需要把yml中定义的路由配置删除掉
    测试接口 具体配置规则,需要看官方文档
#postman调用
{
    "id":"blog",
    "predicates":[
        {
            "name": "Path",
            "args":{
                "pattern" : "/user/**"
            }
        }
    ],
    "filters" : [ 
        {
            "name" : "StripPrefix",
            "args" : {
                "_genkey_0" : "1"
            }
        }
    ],
    "uri": "https://blog.csdn.net",
    "order": 0
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容