{"id":1742,"date":"2023-03-26T21:17:32","date_gmt":"2023-03-26T13:17:32","guid":{"rendered":"https:\/\/www.appblog.cn\/?p=1742"},"modified":"2023-04-23T21:29:45","modified_gmt":"2023-04-23T13:29:45","slug":"nacos-implements-dynamic-routing-for-spring-cloud-gateway","status":"publish","type":"post","link":"https:\/\/www.appblog.cn\/index.php\/2023\/03\/26\/nacos-implements-dynamic-routing-for-spring-cloud-gateway\/","title":{"rendered":"Nacos\u5b9e\u73b0Spring Cloud Gateway\u7684\u52a8\u6001\u8def\u7531"},"content":{"rendered":"<h2>\u524d\u8a00<\/h2>\n<p>\u65b9\u6848\u53c2\u8003\uff1a<a target=\"_blank\" rel=\"noopener\" href=\"https:\/\/www.cnblogs.com\/zlt2000\/p\/11712943.html\">https:\/\/www.cnblogs.com\/zlt2000\/p\/11712943.html<\/a><\/p>\n<p>\u7f51\u5173\u7684\u6838\u5fc3\u6982\u5ff5\u5c31\u662f\u8def\u7531\u914d\u7f6e\u548c\u8def\u7531\u89c4\u5219\uff0c\u800c\u4f5c\u4e3a\u6240\u6709\u8bf7\u6c42\u6d41\u91cf\u7684\u5165\u53e3\uff0c\u5728\u5b9e\u9645\u751f\u4ea7\u73af\u5883\u4e2d\u4e3a\u4e86\u4fdd\u8bc1\u9ad8\u53ef\u9760\u548c\u9ad8\u53ef\u7528\uff0c\u662f\u5c3d\u91cf\u8981\u907f\u514d\u91cd\u542f\u7684\uff0c\u6240\u4ee5\u5b9e\u73b0\u52a8\u6001\u8def\u7531\u662f\u975e\u5e38\u6709\u5fc5\u8981\u7684\uff1b\u672c\u6587\u4e3b\u8981\u4ecb\u7ecd<code>Spring Cloud Gateway<\/code>\u5b9e\u73b0\u7684\u601d\u8def\uff0c\u5e76\u4e14\u4ee5<code>Nacos<\/code>\u4e3a\u6570\u636e\u6e90\u6765\u8bb2\u89e3<\/p>\n<p><!-- more --><\/p>\n<h2>\u5b9e\u73b0\u8981\u70b9<\/h2>\n<p>\u8981\u5b9e\u73b0\u52a8\u6001\u8def\u7531\u53ea\u9700\u5173\u6ce8\u4e0b\u97624\u4e2a\u70b9<\/p>\n<ol>\n<li>\u7f51\u5173\u542f\u52a8\u65f6\uff0c<code>\u52a8\u6001\u8def\u7531<\/code>\u7684\u6570\u636e\u600e\u6837\u52a0\u8f7d\u8fdb\u6765<\/li>\n<li><code>\u9759\u6001\u8def\u7531<\/code>\u4e0e<code>\u52a8\u6001\u8def\u7531<\/code>\u4ee5\u54ea\u4e2a\u4e3a\u51c6\uff0cps\uff1a<code>\u9759\u6001\u8def\u7531<\/code>\u6307\u7684\u662f\u914d\u7f6e\u6587\u4ef6\u91cc\u5199\u6b7b\u7684\u8def\u7531\u914d\u7f6e<\/li>\n<li>\u76d1\u542c<code>\u52a8\u6001\u8def\u7531<\/code>\u7684\u6570\u636e\u6e90\u53d8\u5316<\/li>\n<li>\u6570\u636e\u6709\u53d8\u5316\u65f6\u600e\u6837<code>\u901a\u77e5gateway<\/code>\u5237\u65b0\u8def\u7531<\/li>\n<\/ol>\n<h2>\u5177\u4f53\u5b9e\u73b0<\/h2>\n<p><code>Spring Cloud Gateway<\/code>\u4e2d\u52a0\u8f7d\u8def\u7531\u4fe1\u606f\u5206\u522b\u7531\u4ee5\u4e0b\u51e0\u4e2a\u7c7b\u8d1f\u8d23<\/p>\n<ul>\n<li><code>PropertiesRouteDefinitionLocator<\/code>\uff1a\u4ece\u914d\u7f6e\u6587\u4ef6\u4e2d\u8bfb\u53d6\u8def\u7531\u4fe1\u606f(\u5982YML\u3001Properties\u7b49)<\/li>\n<li><code>RouteDefinitionRepository<\/code>\uff1a\u4ece\u5b58\u50a8\u5668\u4e2d\u8bfb\u53d6\u8def\u7531\u4fe1\u606f(\u5982\u5185\u5b58\u3001\u914d\u7f6e\u4e2d\u5fc3\u3001Redis\u3001MySQL\u7b49)<\/li>\n<li><code>DiscoveryClientRouteDefinitionLocator<\/code>\uff1a\u4ece\u6ce8\u518c\u4e2d\u5fc3\u4e2d\u8bfb\u53d6\u8def\u7531\u4fe1\u606f(\u5982Nacos\u3001Eurka\u3001Zookeeper\u7b49)<\/li>\n<\/ul>\n<p>\u6211\u4eec\u53ef\u4ee5\u901a\u8fc7\u81ea\u5b9a\u4e49<code>RouteDefinitionRepository<\/code>\u7684\u5b9e\u73b0\u7c7b\u6765\u5b9e\u73b0\u52a8\u6001\u8def\u7531\u7684\u76ee\u7684<\/p>\n<h3>\u6dfb\u52a0\u4f9d\u8d56<\/h3>\n<pre><code class=\"language-xml\">&lt;dependency&gt;\n    &lt;groupId&gt;org.springframework.cloud&lt;\/groupId&gt;\n    &lt;artifactId&gt;spring-cloud-starter-gateway&lt;\/artifactId&gt;\n&lt;\/dependency&gt;\n&lt;dependency&gt;\n    &lt;groupId&gt;com.alibaba.cloud&lt;\/groupId&gt;\n    &lt;artifactId&gt;spring-cloud-starter-alibaba-nacos-discovery&lt;\/artifactId&gt;\n&lt;\/dependency&gt;\n&lt;dependency&gt;\n    &lt;groupId&gt;org.springframework.boot&lt;\/groupId&gt;\n    &lt;artifactId&gt;spring-boot-starter-webflux&lt;\/artifactId&gt;\n&lt;\/dependency&gt;\n&lt;dependency&gt;\n    &lt;groupId&gt;org.springframework.cloud&lt;\/groupId&gt;\n    &lt;artifactId&gt;spring-cloud-starter-openfeign&lt;\/artifactId&gt;\n&lt;\/dependency&gt;\n&lt;dependency&gt;\n    &lt;groupId&gt;org.springframework.boot&lt;\/groupId&gt;\n    &lt;artifactId&gt;spring-boot-starter-actuator&lt;\/artifactId&gt;\n&lt;\/dependency&gt;\n&lt;dependency&gt;\n    &lt;groupId&gt;org.springframework.boot&lt;\/groupId&gt;\n    &lt;artifactId&gt;spring-boot-configuration-processor&lt;\/artifactId&gt;\n    &lt;optional&gt;true&lt;\/optional&gt;\n&lt;\/dependency&gt;<\/code><\/pre>\n<h3>\u9759\u6001\u8def\u7531\u793a\u4f8b<\/h3>\n<pre><code class=\"language-yml\">spring:\n  cloud:\n    gateway:\n      discovery:\n        locator:\n          lowerCaseServiceId: true\n          enabled: true\n      routes:\n        - id: auth\n          uri: lb:\/\/uaa-server\n          predicates:\n            - Path=\/api-uaa\/**\n          filters:\n            - StripPrefix=1\n            - PreserveHostHeader<\/code><\/pre>\n<h3>\u5b9e\u73b0\u52a8\u6001\u8def\u7531\u7684\u6570\u636e\u52a0\u8f7d<\/h3>\n<p>\u521b\u5efa\u4e00\u4e2a<code>Nacos<\/code>\u7684<code>RouteDefinitionRepository<\/code>\u5b9e\u73b0\u7c7b<\/p>\n<ul>\n<li>\u91cd\u5199<code>getRouteDefinitions<\/code>\u65b9\u6cd5\u5b9e\u73b0\u8def\u7531\u4fe1\u606f\u7684\u8bfb\u53d6<\/li>\n<li>\u914d\u7f6e<code>Nacos<\/code>\u76d1\u542c\u5668\uff0c\u76d1\u542c\u8def\u7531\u914d\u7f6e\u4fe1\u606f\u7684\u53d8\u5316<\/li>\n<li>\u8def\u7531\u53d8\u5316\u53ea\u9700\u8981\u5f80<code>ApplicationEventPublisher<\/code>\u63a8\u9001\u4e00\u4e2a<code>RefreshRoutesEvent<\/code>\u4e8b\u4ef6\u5373\u523b\uff0c<code>Gateway<\/code>\u4f1a\u81ea\u52a8\u76d1\u542c\u8be5\u4e8b\u4ef6\u5e76\u8c03\u7528<code>getRouteDefinitions<\/code>\u65b9\u6cd5\u66f4\u65b0\u8def\u7531\u4fe1\u606f<\/li>\n<\/ul>\n<pre><code class=\"language-java\">import cn.hutool.core.collection.CollUtil;\nimport cn.hutool.core.util.StrUtil;\nimport com.alibaba.cloud.nacos.NacosConfigProperties;\nimport com.alibaba.fastjson.JSONObject;\nimport com.alibaba.nacos.api.config.listener.Listener;\nimport com.alibaba.nacos.api.exception.NacosException;\nimport lombok.extern.slf4j.Slf4j;\nimport org.springframework.cloud.gateway.event.RefreshRoutesEvent;\nimport org.springframework.cloud.gateway.route.RouteDefinition;\nimport org.springframework.cloud.gateway.route.RouteDefinitionRepository;\nimport org.springframework.context.ApplicationEventPublisher;\nimport reactor.core.publisher.Flux;\nimport reactor.core.publisher.Mono;\n\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.concurrent.Executor;\n\n\/**\n * nacos\u8def\u7531\u6570\u636e\u6e90\n *\/\n@Slf4j\npublic class NacosRouteDefinitionRepository implements RouteDefinitionRepository {\n    private static final String SCG_DATA_ID = &quot;scg-routes&quot;;\n    private static final String SCG_GROUP_ID = &quot;SCG_GATEWAY&quot;;\n\n    private ApplicationEventPublisher publisher;\n\n    private NacosConfigProperties nacosConfigProperties;\n\n    public NacosRouteDefinitionRepository(ApplicationEventPublisher publisher, NacosConfigProperties nacosConfigProperties) {\n        this.publisher = publisher;\n        this.nacosConfigProperties = nacosConfigProperties;\n        addListener();\n    }\n\n    @Override\n    public Flux&lt;RouteDefinition&gt; getRouteDefinitions() {\n        try {\n            String content = nacosConfigProperties.configServiceInstance().getConfig(SCG_DATA_ID, SCG_GROUP_ID,5000);\n            List&lt;RouteDefinition&gt; routeDefinitions = getListByStr(content);\n            return Flux.fromIterable(routeDefinitions);\n        } catch (NacosException e) {\n            log.error(&quot;getRouteDefinitions by nacos error&quot;, e);\n        }\n        return Flux.fromIterable(CollUtil.newArrayList());\n    }\n\n    \/**\n     * \u6dfb\u52a0Nacos\u76d1\u542c\n     *\/\n    private void addListener() {\n        try {\n            nacosConfigProperties.configServiceInstance().addListener(SCG_DATA_ID, SCG_GROUP_ID, new Listener() {\n                @Override\n                public Executor getExecutor() {\n                    return null;\n                }\n\n                @Override\n                public void receiveConfigInfo(String configInfo) {\n                    publisher.publishEvent(new RefreshRoutesEvent(this));\n                }\n            });\n        } catch (NacosException e) {\n            log.error(&quot;nacos-addListener-error&quot;, e);\n        }\n    }\n\n    @Override\n    public Mono&lt;Void&gt; save(Mono&lt;RouteDefinition&gt; route) {\n        return null;\n    }\n\n    @Override\n    public Mono&lt;Void&gt; delete(Mono&lt;String&gt; routeId) {\n        return null;\n    }\n\n    private List&lt;RouteDefinition&gt; getListByStr(String content) {\n        if (StrUtil.isNotEmpty(content)) {\n            return JSONObject.parseArray(content, RouteDefinition.class);\n        }\n        return new ArrayList&lt;&gt;(0);\n    }\n}<\/code><\/pre>\n<h3>\u521b\u5efa\u914d\u7f6e\u7c7b<\/h3>\n<p>\u521b\u5efa\u914d\u7f6e\u7c7b<code>DynamicRouteConfig<\/code><\/p>\n<pre><code class=\"language-java\">import com.alibaba.cloud.nacos.NacosConfigProperties;\nimport com.central.gateway.route.NacosRouteDefinitionRepository;\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;\nimport org.springframework.context.ApplicationEventPublisher;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\n\n\/**\n * \u52a8\u6001\u8def\u7531\u914d\u7f6e\n *\/\n@Configuration\n@ConditionalOnProperty(prefix = &quot;appblog.gateway.dynamicRoute&quot;, name = &quot;enabled&quot;, havingValue = &quot;true&quot;)\npublic class DynamicRouteConfig {\n    @Autowired\n    private ApplicationEventPublisher publisher;\n\n    \/**\n     * Nacos\u5b9e\u73b0\u65b9\u5f0f\n     *\/\n    @Configuration\n    @ConditionalOnProperty(prefix = &quot;appblog.gateway.dynamicRoute&quot;, name = &quot;dataType&quot;, havingValue = &quot;nacos&quot;, matchIfMissing = true)\n    public class NacosDynRoute {\n        @Autowired\n        private NacosConfigProperties nacosConfigProperties;\n\n        @Bean\n        public NacosRouteDefinitionRepository nacosRouteDefinitionRepository() {\n            return new NacosRouteDefinitionRepository(publisher, nacosConfigProperties);\n        }\n    }\n}<\/code><\/pre>\n<h3>\u6dfb\u52a0Nacos\u8def\u7531\u914d\u7f6e<\/h3>\n<p>\u65b0\u589e\u914d\u7f6e\u9879\uff1a<\/p>\n<ul>\n<li><code>Data Id<\/code>\uff1a<code>scg-routes<\/code><\/li>\n<li><code>Group<\/code>\uff1a<code>SCG_GATEWAY<\/code><\/li>\n<\/ul>\n<p>\u6dfb\u52a0\u4e24\u6761\u8def\u7531\u6570\u636e\uff0c\u914d\u7f6e\u5185\u5bb9\uff1a<\/p>\n<pre><code class=\"language-json\">[\n    {\n        &quot;id&quot;: &quot;appblog&quot;,\n        &quot;predicates&quot;: [{\n            &quot;name&quot;: &quot;Path&quot;,\n            &quot;args&quot;: {\n                &quot;pattern&quot;: &quot;\/appblog\/**&quot;\n            }\n        }],\n        &quot;uri&quot;: &quot;http:\/\/www.appblog.cn\/&quot;,\n        &quot;filters&quot;: []\n    },\n    {\n        &quot;id&quot;: &quot;github&quot;,\n        &quot;predicates&quot;: [{\n            &quot;name&quot;: &quot;Path&quot;,\n            &quot;args&quot;: {\n                &quot;pattern&quot;: &quot;\/github\/**&quot;\n            }\n        }],\n        &quot;uri&quot;: &quot;https:\/\/github.com\/&quot;,\n        &quot;filters&quot;: []\n    }\n]<\/code><\/pre>\n<h2>\u6d4b\u8bd5<\/h2>\n<p>\u542f\u52a8\u7f51\u5173\u901a\u8fc7<code>\/actuator\/gateway\/routes<\/code>\u7aef\u70b9\u67e5\u770b\u5f53\u524d\u8def\u7531\u4fe1\u606f<\/p>\n<p>\u53ef\u4ee5\u770b\u5230<code>Nacos<\/code>\u91cc\u914d\u7f6e\u7684\u4e24\u6761\u8def\u7531\u4fe1\u606f<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u524d\u8a00 \u65b9\u6848\u53c2\u8003\uff1ahttps:\/\/www.cnblogs.com\/zlt2000\/p\/11712943.html [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[42],"tags":[440,439],"class_list":["post-1742","post","type-post","status-publish","format-standard","hentry","category-spring-cloud","tag-nacos","tag-spring-cloud-gateway"],"_links":{"self":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/posts\/1742","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/comments?post=1742"}],"version-history":[{"count":0,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/posts\/1742\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/media?parent=1742"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/categories?post=1742"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/tags?post=1742"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}