{"id":1743,"date":"2023-03-26T21:19:06","date_gmt":"2023-03-26T13:19:06","guid":{"rendered":"https:\/\/www.appblog.cn\/?p=1743"},"modified":"2023-04-23T21:29:25","modified_gmt":"2023-04-23T13:29:25","slug":"implementing-dynamic-routing-in-spring-cloud-gateway-based-on-nacos","status":"publish","type":"post","link":"https:\/\/www.appblog.cn\/index.php\/2023\/03\/26\/implementing-dynamic-routing-in-spring-cloud-gateway-based-on-nacos\/","title":{"rendered":"\u57fa\u4e8eNacos\u5b9e\u73b0Spring Cloud Gateway\u5b9e\u73b0\u52a8\u6001\u8def\u7531\u7684\u65b9\u6cd5"},"content":{"rendered":"<h2>\u7b80\u4ecb<\/h2>\n<p>\u4e3b\u8981\u4ecb\u7ecd\u4ee5Nacos\u4e3a\u914d\u7f6e\u4e2d\u5fc3\uff0c\u5b9e\u73b0Spring Cloud GateWay \u5b9e\u73b0\u52a8\u6001\u8def\u7531\u7684\u529f\u80fd\u3002Spring Cloud Gateway\u542f\u52a8\u65f6\u5019\uff0c\u5c31\u5c06\u8def\u7531\u914d\u7f6e\u548c\u89c4\u5219\u52a0\u8f7d\u5230\u5185\u5b58\u91cc\uff0c\u65e0\u6cd5\u505a\u5230\u4e0d\u91cd\u542f\u7f51\u5173\u5c31\u53ef\u4ee5\u52a8\u6001\u7684\u5bf9\u5e94\u8def\u7531\u7684\u914d\u7f6e\u548c\u89c4\u5219\u8fdb\u884c\u589e\u52a0\uff0c\u4fee\u6539\u548c\u5220\u9664\u3002\u901a\u8fc7Nacos\u7684\u914d\u7f6e\u4e0b\u53d1\u529f\u80fd\u53ef\u4ee5\u5b9e\u73b0\u5728\u4e0d\u91cd\u542f\u7f51\u5173\u7684\u60c5\u51b5\u4e0b\uff0c\u5b9e\u73b0\u52a8\u6001\u8def\u7531\u3002<\/p>\n<p><!-- more --><\/p>\n<h2>\u96c6\u6210<\/h2>\n<h3>Spring Cloud GateWay\u96c6\u6210<\/h3>\n<ul>\n<li><code>spring-cloud-starter-gateway<\/code>\uff1a\u8def\u7531\u8f6c\u53d1\u3001\u8bf7\u6c42\u8fc7\u6ee4\uff08\u6743\u9650\u6821\u9a8c\u3001\u9650\u6d41\u4ee5\u53ca\u76d1\u63a7\u7b49\uff09<\/li>\n<li><code>spring-boot-starter-webflux<\/code>\uff1a\u53cd\u5e94\u5f0fWeb\u6846\u67b6<\/li>\n<li><code>spring-boot-starter-actuator<\/code>\uff1a\u76d1\u63a7\u7cfb\u7edf\u5065\u5eb7<\/li>\n<\/ul>\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;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.boot&lt;\/groupId&gt;\n  &lt;artifactId&gt;spring-boot-starter-actuator&lt;\/artifactId&gt;\n&lt;\/dependency&gt;<\/code><\/pre>\n<h3>Nacos\u96c6\u6210<\/h3>\n<p><code>nacos-client<\/code>\uff1aNacos\u5ba2\u6237\u7aef<\/p>\n<pre><code class=\"language-xml\">&lt;dependency&gt;\n  &lt;groupId&gt;com.alibaba.nacos&lt;\/groupId&gt;\n  &lt;artifactId&gt;nacos-client&lt;\/artifactId&gt;\n&lt;\/dependency&gt;<\/code><\/pre>\n<h3>\u52a8\u6001\u8def\u7531<\/h3>\n<p>DynamicRouteServiceImpl:\u63d0\u4f9b\u52a8\u6001\u8def\u7531\u7684\u57fa\u7840\u65b9\u6cd5\uff0c\u53ef\u901a\u8fc7\u83b7\u53d6bean\u64cd\u4f5c\u8be5\u7c7b\u7684\u65b9\u6cd5\u3002\u8be5\u7c7b\u63d0\u4f9b\u65b0\u589e\u8def\u7531\u3001\u66f4\u65b0\u8def\u7531\u3001\u5220\u9664\u8def\u7531\uff0c\u7136\u540e\u5b9e\u73b0\u53d1\u5e03\u7684\u529f\u80fd\u3002<\/p>\n<pre><code class=\"language-java\">@Service\npublic class DynamicRouteServiceImpl implements ApplicationEventPublisherAware {\n\n  @Autowired\n  private RouteDefinitionWriter routeDefinitionWriter;\n\n  private ApplicationEventPublisher publisher;\n\n  \/**\n   * \u589e\u52a0\u8def\u7531\n   * @param definition\n   * @return\n   *\/\n  public String add(RouteDefinition definition) {\n    routeDefinitionWriter.save(Mono.just(definition)).subscribe();\n    this.publisher.publishEvent(new RefreshRoutesEvent(this));\n    return &quot;success&quot;;\n  }\n\n  \/**\n   * \u66f4\u65b0\u8def\u7531\n   * @param definition\n   * @return\n   *\/\n  public String update(RouteDefinition definition) {\n    try {\n      this.routeDefinitionWriter.delete(Mono.just(definition.getId()));\n    } catch (Exception e) {\n      return &quot;update fail,not find route routeId: &quot;+definition.getId();\n    }\n    try {\n      routeDefinitionWriter.save(Mono.just(definition)).subscribe();\n      this.publisher.publishEvent(new RefreshRoutesEvent(this));\n      return &quot;success&quot;;\n    } catch (Exception e) {\n      return &quot;update route fail&quot;;\n    }\n  }\n\n  \/**\n   * \u5220\u9664\u8def\u7531\n   * @param id\n   * @return\n   *\/\n  public String delete(String id) {\n    try {\n      this.routeDefinitionWriter.delete(Mono.just(id)).subscribe();\n      return &quot;delete success&quot;;\n    } catch (Exception e) {\n      e.printStackTrace();\n      return &quot;delete fail&quot;;\n    }\n  }\n\n  @Override\n  public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {\n    this.publisher = applicationEventPublisher;\n  }\n\n}<\/code><\/pre>\n<p>RouteDefinition\uff1a\u63d0\u4f9b\u8def\u7531\u5b9e\u4f53\u7c7b\uff0c\u4e3b\u8981\u6709predicates\u5339\u914d\u6765\u81ea\u7528\u6237\u7684\u8bf7\u6c42\uff0cfilters\u670d\u52a1\u8def\u7531<\/p>\n<pre><code class=\"language-java\">@Validated\npublic class RouteDefinition {\n    @NotEmpty\n    private String id = UUID.randomUUID().toString();\n\n    @NotEmpty\n    @Valid\n    private List&lt;PredicateDefinition&gt; predicates = new ArrayList&lt;&gt;();\n\n    @Valid\n    private List&lt;FilterDefinition&gt; filters = new ArrayList&lt;&gt;();\n\n    @NotNull\n    private URI uri;\n\n    private int order = 0;\n\n    public RouteDefinition() {}\n\n    public RouteDefinition(String text) {\n        int eqIdx = text.indexOf(&quot;=&quot;);\n        if (eqIdx &lt;= 0) {\n            throw new ValidationException(&quot;Unable to parse RouteDefinition text &#039;&quot; + text + &quot;&#039;&quot; +\n                    &quot;, must be of the form name=value&quot;);\n        }\n\n        setId(text.substring(0, eqIdx));\n\n        String[] args = tokenizeToStringArray(text.substring(eqIdx+1), &quot;,&quot;);\n\n        setUri(URI.create(args[0]));\n\n        for (int i=1; i &lt; args.length; i++) {\n            this.predicates.add(new PredicateDefinition(args[i]));\n        }\n    }\n\n    public String getId() {\n        return id;\n    }\n\n    public void setId(String id) {\n        this.id = id;\n    }\n\n    public List&lt;PredicateDefinition&gt; getPredicates() {\n        return predicates;\n    }\n\n    public void setPredicates(List&lt;PredicateDefinition&gt; predicates) {\n        this.predicates = predicates;\n    }\n\n    public List&lt;FilterDefinition&gt; getFilters() {\n        return filters;\n    }\n\n    public void setFilters(List&lt;FilterDefinition&gt; filters) {\n        this.filters = filters;\n    }\n\n    public URI getUri() {\n        return uri;\n    }\n\n    public void setUri(URI uri) {\n        this.uri = uri;\n    }\n\n    public int getOrder() {\n        return order;\n    }\n\n    public void setOrder(int order) {\n        this.order = order;\n    }\n\n    @Override\n    public boolean equals(Object o) {\n        if (this == o) return true;\n        if (o == null || getClass() != o.getClass()) return false;\n        RouteDefinition routeDefinition = (RouteDefinition) o;\n        return Objects.equals(id, routeDefinition.id) &amp;&amp;\n                Objects.equals(predicates, routeDefinition.predicates) &amp;&amp;\n                Objects.equals(order, routeDefinition.order) &amp;&amp;\n                Objects.equals(uri, routeDefinition.uri);\n    }\n\n    @Override\n    public int hashCode() {\n        return Objects.hash(id, predicates, uri);\n    }\n\n    @Override\n    public String toString() {\n        return &quot;RouteDefinition{&quot; +\n                &quot;id=&#039;&quot; + id + &#039;\\&#039;&#039; +\n                &quot;, predicates=&quot; + predicates +\n                &quot;, filters=&quot; + filters +\n                &quot;, uri=&quot; + uri +\n                &quot;, order=&quot; + order +\n                &#039;}&#039;;\n    }\n}<\/code><\/pre>\n<p>NacosGatewayProperties\uff1a\u81ea\u5b9a\u4e49\u5c5e\u6027\u7ed1\u5b9a\u503c\uff0c\u53ef\u901a\u8fc7\u914d\u7f6e\u6587\u4ef6\u914d\u7f6e\u5c5e\u6027<\/p>\n<pre><code class=\"language-java\">@ConfigurationProperties(prefix=&quot;nacos&quot;, ignoreUnknownFields = true)\n@Configuration\npublic class NacosGatewayProperties {\n\n    private String address;\n\n    private String dataId;\n\n    private String groupId;\n\n    private Long timeout;\n\n    public String getAddress() {\n        return address;\n    }\n\n    public void setAddress(String address) {\n        this.address = address;\n    }\n\n    public String getDataId() {\n        return dataId;\n    }\n\n    public void setDataId(String dataId) {\n        this.dataId = dataId;\n    }\n\n    public String getGroupId() {\n        return groupId;\n    }\n\n    public void setGroupId(String groupId) {\n        this.groupId = groupId;\n    }\n\n    public Long getTimeout() {\n        return timeout;\n    }\n\n    public void setTimeout(Long timeout) {\n        this.timeout = timeout;\n    }    \n}<\/code><\/pre>\n<p>DynamicRouteServiceImplByNacos\uff1a\u5b9e\u73b0runner\uff0c\u901a\u8fc7nacos\u4e0b\u53d1\u52a8\u6001\u8def\u7531\u914d\u7f6e<\/p>\n<pre><code class=\"language-java\">@Slf4j\n@Component\npublic class DynamicRouteServiceImplByNacos implements CommandLineRunner {\n\n    @Autowired\n    private DynamicRouteServiceImpl dynamicRouteService;\n\n    @Autowired\n    private NacosGatewayProperties nacosGatewayProperties;\n\n    \/**\n     * \u76d1\u542cNacos Server\u4e0b\u53d1\u7684\u52a8\u6001\u8def\u7531\u914d\u7f6e\n     * @param dataId\n     * @param group\n     *\/\n    public void dynamicRouteByNacosListener() {\n        try {\n            ConfigService configService = NacosFactory.createConfigService(nacosGatewayProperties.getAddress());\n            String content = configService.getConfig(nacosGatewayProperties.getDataId(), nacosGatewayProperties.getGroupId(), nacosGatewayProperties.getTimeout());\n            log.info(content);\n            configService.addListener(nacosGatewayProperties.getDataId(), nacosGatewayProperties.getGroupId(), new Listener() {\n                @Override\n                public void receiveConfigInfo(String configInfo) {\n                    List&lt;RouteDefinition&gt; list = JsonUtils.toList(configInfo, RouteDefinition.class);\n                    list.forEach(definition -&gt; {\n                        dynamicRouteService.update(definition);\n                    });\n                }\n\n                @Override\n                public Executor getExecutor() {\n                    return null;\n                }\n            });\n        } catch (NacosException e) {\n            e.printStackTrace();\n        }\n    }\n\n    @Override\n    public void run(String... args) throws Exception {\n        dynamicRouteByNacosListener();\n    }\n}<\/code><\/pre>\n<h2>Nacos\u914d\u7f6e\u4e0b\u53d1<\/h2>\n<h3>Nacos\u914d\u7f6e<\/h3>\n<pre><code>nacos:\n  address: 127.0.0.1:8848\n  data-id: ok-cloud-gateway-route\n  group-id: dev\n  timeout: 5000<\/code><\/pre>\n<h3>Nacos\u5c5e\u6027\u6587\u4ef6\u5b9a\u4e49<\/h3>\n<p>\u65b0\u5efadataID\u4e3a<code>ok-cloud-gateway-route<\/code>\uff0cgroupID\u4e3adev\u7684\u914d\u7f6e<\/p>\n<pre><code class=\"language-json\">[\n  {\n    &quot;filters&quot;: [],\n    &quot;id&quot;: &quot;blog&quot;,\n    &quot;order&quot;: 0,\n    &quot;predicates&quot;: [{\n      &quot;args&quot;: {\n        &quot;pattern&quot;: &quot;\/about&quot;\n      },\n      &quot;name&quot;: &quot;Path&quot;\n    }],\n    &quot;uri&quot;: &quot;https:\/\/www.appblog.cn&quot;\n  },\n  {\n    &quot;filters&quot;: [],\n    &quot;id&quot;: &quot;user-service&quot;,\n    &quot;order&quot;: 0,\n    &quot;predicates&quot;: [{\n      &quot;args&quot;: {\n        &quot;pattern&quot;: &quot;\/user\/**&quot;\n      },\n      &quot;name&quot;: &quot;Path&quot;\n    }],\n    &quot;uri&quot;: &quot;lb:\/\/ok-cloud-user-service&quot;\n  }\n]<\/code><\/pre>\n<p>\u67e5\u770b\u8def\u7531\u4fe1\u606f\uff1a<a target=\"_blank\" rel=\"noopener\" href=\"http:\/\/127.0.0.1:9000\/actuator\/gateway\/routes\">http:\/\/127.0.0.1:9000\/actuator\/gateway\/routes<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u7b80\u4ecb \u4e3b\u8981\u4ecb\u7ecd\u4ee5Nacos\u4e3a\u914d\u7f6e\u4e2d\u5fc3\uff0c\u5b9e\u73b0Spring Cloud GateWay \u5b9e\u73b0\u52a8\u6001\u8def\u7531\u7684\u529f\u80fd\u3002Spr [&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-1743","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\/1743","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=1743"}],"version-history":[{"count":0,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/posts\/1743\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/media?parent=1743"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/categories?post=1743"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/tags?post=1743"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}