| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – 参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/</link><description>Recent content in 参考手册 on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>zh-cn</language><atom:link href="https://dubbo.apache.org/zh-cn/docs/references/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Protobuf</title><link>https://dubbo.apache.org/zh-cn/docs/references/protobuf/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/protobuf/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/protocol/triple/idl/">最新版本</a>。</p> |
| </div></description></item><item><title>Docs: Schema 配置参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/xml/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/xml/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/xml/">最新版本</a>。</p> |
| </div> |
| <p>这里以 XML Config <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> 为准，列举所有配置项 <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup>。其它配置方式，请参见相应转换关系：<a href="../../../docsv2.7/user/configuration/properties">属性配置</a>，<a href="../../../docsv2.7/user/configuration/annotation">注解配置</a>，<a href="../../../docsv2.7/user/configuration/api">API 配置</a>。</p> |
| <p>所有配置项分为三大类，参见下表中的&quot;作用&quot; 一列。</p> |
| <ul> |
| <li>服务发现：表示该配置项用于服务的注册与发现，目的是让消费方找到提供方。</li> |
| <li>服务治理：表示该配置项用于治理服务间的关系，或为开发测试提供便利条件。</li> |
| <li>性能调优：表示该配置项用于调优性能，不同的选项对性能会产生影响。</li> |
| <li>所有配置最终都将转换为 URL <sup id="fnref:3"><a href="#fn:3" class="footnote-ref" role="doc-noteref">3</a></sup> 表示，并由服务提供方生成，经注册中心传递给消费方，各属性对应 URL 的参数，参见配置项一览表中的 &ldquo;对应URL参数&rdquo; 列。</li> |
| </ul> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>XML Schema: <a href="http://dubbo.apache.org/schema/dubbo/dubbo.xsd">http://dubbo.apache.org/schema/dubbo/dubbo.xsd</a>&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>注意：只有 group，interface，version 是服务的匹配条件，三者决定是不是同一个服务，其它配置项均为调优和治理参数。&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:3"> |
| <p>URL 格式：<code>protocol://username:password@host:port/path?key=value&amp;key=value</code>&#160;<a href="#fnref:3" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: 配置中心参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/config-center/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/config-center/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config-center/">最新版本</a>。</p> |
| </div> |
| <p>配置中心在 Dubbo 中承担3个职责：</p> |
| <ol> |
| <li>外部化配置：启动配置的集中式存储 （简单理解为 dubbo.properties 的外部化存储）。</li> |
| <li>服务治理：服务治理规则的存储与通知。</li> |
| <li>动态配置：控制动态开关或者动态变更属性值</li> |
| </ol> |
| <p>启用动态配置，以 Zookeeper 为例，可查看 <a href="../../references/xml/dubbo-config-center">配置中心属性详解</a></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:config-center</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>或者</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.config-center.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://127.0.0.1:2181</span> |
| </span></span></code></pre></div><p>或者</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ConfigCenterConfig configCenter <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConfigCenterConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>configCenter<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><blockquote> |
| <p>为了兼容 2.6.x 版本配置，在使用 Zookeeper 作为注册中心，且没有显示配置配置中心的情况下，Dubbo 框架会默认将此 Zookeeper 用作配置中心，但将只作服务治理用途。</p> |
| </blockquote> |
| <h2 id="外部化配置">外部化配置</h2> |
| <p>请参考文档 <a href="../configuration/external-config">外部化配置</a></p> |
| <h2 id="动态配置">动态配置</h2> |
| <p>[TODO 待完善]</p> |
| <h2 id="服务治理">服务治理</h2> |
| <h4 id="zookeeper">Zookeeper</h4> |
| <p>默认节点结构：</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/zk-configcenter-governance.jpg" alt="zk-configcenter-governance"></p> |
| <ul> |
| <li>namespace，用于不同配置的环境隔离。</li> |
| <li>config，Dubbo 约定的固定节点，不可更改，所有配置和服务治理规则都存储在此节点下。</li> |
| <li>dubbo，所有服务治理规则都是全局性的，dubbo 为默认节点</li> |
| <li>configurators/tag-router/condition-router/migration，不同的服务治理规则类型，node value 存储具体规则内容</li> |
| </ul> |
| <h4 id="apollo">Apollo</h4> |
| <p>所有的服务治理规则都是全局性的，默认从公共命名空间 <code>dubbo</code> 读取和订阅：</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/apollo-configcenter-governance.jpg" alt="apollo-configcenter-governance.jpg"></p> |
| <p>不同的规则以不同的 key 后缀区分：</p> |
| <ul> |
| <li>configurators，<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/examples/config-rule/">覆盖规则</a></li> |
| <li>tag-router，<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/examples/routing-rule/">标签路由</a></li> |
| <li>condition-router，<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/examples/routing-rule/#%E6%9D%A1%E4%BB%B6%E8%B7%AF%E7%94%B1">条件路由</a></li> |
| <li>migration，<a href="../../migration/migration-service-discovery">迁移规则</a></li> |
| </ul> |
| <h4 id="nacos">Nacos</h4> |
| <p>所有的服务治理规则都是全局的，默认从 namespace: <code>public</code> 下进行读取， 通过 dataId: <code>interface name</code> 以及 group: <code>dubbo</code> 去读取和订阅：</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/nacos-configcenter-governance.png" alt="nacos-configcenter-governance.jpg"></p> |
| <p>不同的规则以 dataId 的后缀区分：</p> |
| <ul> |
| <li>configurators，<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/examples/config-rule/">覆盖规则</a></li> |
| <li>tag-router，<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/examples/routing-rule/">标签路由</a></li> |
| <li>condition-router，<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/examples/routing-rule/#%E6%9D%A1%E4%BB%B6%E8%B7%AF%E7%94%B1">条件路由</a></li> |
| <li>migration，<a href="../../migration/migration-service-discovery">迁移规则</a></li> |
| </ul></description></item><item><title>Docs: 注册中心参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/registry/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/registry/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/registry/">最新版本</a>。</p> |
| </div> |
| <p>推荐使用 <a href="zookeeper">Zookeeper 注册中心</a></p></description></item><item><title>Docs: SPI 扩展实现</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/">最新版本</a>。</p> |
| </div> |
| <p>SPI 扩展接口仅用于系统集成，或 Contributor 扩展功能插件。</p></description></item><item><title>Docs: Dubbo 配置</title><link>https://dubbo.apache.org/zh-cn/docs/references/configuration/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/configuration/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/">最新版本</a>。</p> |
| </div></description></item><item><title>Docs: 元数据参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/metadata/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/metadata/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/metadata-center/">最新版本</a>。</p> |
| </div> |
| <h2 id="背景">背景</h2> |
| <p>dubbo provider中的服务配置项有接近<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/references/xml/dubbo-provider/">30个配置项</a>。 排除注册中心服务治理需要之外，很大一部分配置项是provider自己使用，不需要透传给消费者。这部分数据不需要进入注册中心，而只需要以key-value形式持久化存储。 |
| dubbo consumer中的配置项也有<a href="https://dubbo.apache.org/zh-cn/docsv2.7/user/references/xml/dubbo-consumer/">20+个配置项</a>。在注册中心之中，服务消费者列表中只需要关注application，version，group，ip，dubbo版本等少量配置，其他配置也可以以key-value形式持久化存储。 |
| 这些数据是以服务为维度注册进入注册中心，导致了数据量的膨胀，进而引发注册中心(如zookeeper)的网络开销增大，性能降低。<br> |
| 除了上述配置项的存储之外，dubbo服务元数据信息也需要被存储下来。元数据信息包括服务接口，及接口的方法信息。这些信息将被用于服务mock，服务测试。</p> |
| <p>以上的元数据都是基于接口级别。在3.0版本中，引入了应用元数据的概念，应用元数据描述的是整个应用的信息概览。并且引入了服务自省映射，用于应用级别的服务发现。</p> |
| <h2 id="目标">目标</h2> |
| <p>需要将注册中心原来的数据信息和元数据信息保存到独立的key-value的存储中，这个key-value可以是DB，redis或者其他持久化存储。核心代码中支持了zookeeper，redis, nacos(推荐)的默认支持。</p> |
| <blockquote> |
| <p>因为是基于key-value存储，key不会改变，最新的value会将原来的value进行覆盖</p> |
| </blockquote> |
| <p>Provider存储内容的格式，参见：org.apache.dubbo.metadata.definition.model.FullServiceDefinition。是该类型gson化之后的存储。 |
| Consumer存储内容，为Map格式。从Consumer端注册到注册中心的URL中的获取参数信息。即通过URL.getParameterMap()获取到的Map，进行gson化之后进行存储。</p> |
| <p>详细的内容，可以参考下面的sample输出。</p> |
| <h2 id="配置">配置</h2> |
| <p>默认的元数据存储，额外支持以下几个特性：</p> |
| <ul> |
| <li>失败重试</li> |
| <li>每天定时重刷</li> |
| </ul> |
| <h4 id="失败重试">失败重试</h4> |
| <p>失败重试可以通过retrytimes （重试次数,默认100），retryperiod（重试周期，默认3000ms）进行设置。</p> |
| <h4 id="定时刷新">定时刷新</h4> |
| <p>默认开启，可以通过设置cycleReport=false进行关闭。</p> |
| <h4 id="完整的配置项">完整的配置项：</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.metadata-report.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://127.0.0.1:2181</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.username<span style="color:#719e07">=</span><span style="color:#2aa198">xxx ##非必须</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.password<span style="color:#719e07">=</span><span style="color:#2aa198">xxx ##非必须</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.retry-times<span style="color:#719e07">=</span><span style="color:#2aa198">30 ##非必须,default值100</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.retry-period<span style="color:#719e07">=</span><span style="color:#2aa198">5000 ##非必须,default值3000</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.cycle-report<span style="color:#719e07">=</span><span style="color:#2aa198">false ##非必须,default值true</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.sync.report<span style="color:#719e07">=</span><span style="color:#2aa198">false ##非必须,default值为false</span> |
| </span></span></code></pre></div><blockquote> |
| <p>如果元数据地址(dubbo.metadata-report.address)也不进行配置，会判断注册中心的协议是否支持元数据中心，如果支持，会使用注册中心的地址来用作元数据中心。</p> |
| </blockquote> |
| <p>接下来看几个sample的配置。无论哪种配置方式，都需要引入maven依赖：</p> |
| <p>zookeeper:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-metadata-report-zookeeper<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>redis:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-metadata-report-redis<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>nacos:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-metadata-report-nacos<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><blockquote> |
| <p><strong>完整的sample，查看<a href="https://github.com/dubbo/dubbo-samples/tree/master">sample-2.7</a></strong></p> |
| </blockquote> |
| <h3 id="方式一在配置中心配置">方式一：在配置中心配置</h3> |
| <p>参考sample：dubbo-samples-metadata-report/dubbo-samples-metadata-report-configcenter 工程。</p> |
| <h5 id="配置中心配置">配置中心配置</h5> |
| <p>配置中心的配置，可以参考configcenter的文档。配置的内容如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.registry.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://127.0.0.1:2181</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">### 注意驼峰式风格</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://127.0.0.1:2181 ###元数据存储的地址</span> |
| </span></span></code></pre></div><p>在sample中，使用了Zookeeper作为配置中心。启动本地zookeeper服务之后，直接运行：org.apache.dubbo.samples.metadatareport.configcenter.ZKTools 就可以完成写入。 |
| 如果配置中心使用了nacos，apollo，这些产品本身支持ops配置。</p> |
| <h5 id="应用配置">应用配置</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75">###dubbo.properties</span> |
| </span></span><span style="display:flex;"><span>dubbo.config-center.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://127.0.0.1:2181</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span></code></pre></div><p>完成上述两步之后，注册中心地址、元数据地址将从配置中心进行获取。现在可以依次运行Provider类和Consumer类，会在console中得到对应的输出或者直接通过zookeeper的cli查看。</p> |
| <h5 id="provider配置">Provider配置</h5> |
| <p>provider端存储的元数据内容如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;parameters&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;side&#34;</span>: <span style="color:#2aa198">&#34;provider&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;dubbo&#34;</span>: <span style="color:#2aa198">&#34;2.0.2&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;threads&#34;</span>: <span style="color:#2aa198">&#34;100&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;interface&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.configcenter.api.AnnotationService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;threadpool&#34;</span>: <span style="color:#2aa198">&#34;fixed&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;version&#34;</span>: <span style="color:#2aa198">&#34;1.1.1&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;generic&#34;</span>: <span style="color:#2aa198">&#34;false&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;revision&#34;</span>: <span style="color:#2aa198">&#34;1.1.1&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;valid&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;application&#34;</span>: <span style="color:#2aa198">&#34;metadatareport-configcenter-provider&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;default.timeout&#34;</span>: <span style="color:#2aa198">&#34;5000&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;group&#34;</span>: <span style="color:#2aa198">&#34;d-test&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;anyhost&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;canonicalName&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.configcenter.api.AnnotationService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;codeSource&#34;</span>: <span style="color:#2aa198">&#34;file:/Users/cvictory/workspace/work-mw/dubbo-samples/dubbo-samples-metadata-report/dubbo-samples-metadata-report-configcenter/target/classes/&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: [{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;name&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;parameterTypes&#34;</span>: [<span style="color:#2aa198">&#34;java.lang.String&#34;</span>], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;returnType&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span> |
| </span></span><span style="display:flex;"><span> }], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;types&#34;</span>: [{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;value&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char[]&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;hash&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> }, { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char&#34;</span> |
| </span></span><span style="display:flex;"><span> }] |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>provider存储的内容包括了provider服务往注册中心填写的全部参数，以及服务的方法信息（方法名，入参出参的格式）。</p> |
| <h5 id="consumer配置">Consumer配置：</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;valid&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;side&#34;</span>: <span style="color:#2aa198">&#34;consumer&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;application&#34;</span>: <span style="color:#2aa198">&#34;metadatareport-configcenter-consumer&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;default.timeout&#34;</span>: <span style="color:#2aa198">&#34;6666&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;dubbo&#34;</span>: <span style="color:#2aa198">&#34;2.0.2&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;interface&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.configcenter.api.AnnotationService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;version&#34;</span>: <span style="color:#2aa198">&#34;1.1.1&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;revision&#34;</span>: <span style="color:#2aa198">&#34;1.1.1&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;group&#34;</span>: <span style="color:#2aa198">&#34;d-test&#34;</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>consumer端存储了consumer往注册中心填写的全部参数。</p> |
| <p>上面的例子，主要是将元数据地址放在配置中心，在元数据区存储下来的provider端服务信息和consumer端服务信息的展示。 |
| 接下来的两个例子，主要讲解在工程中配置：xml方式，annotation方式。</p> |
| <h3 id="方式二配置在项目中-properties方式引入配置">方式二：配置在项目中-properties方式引入配置</h3> |
| <p>参考sample：dubbo-samples-metadata-report/dubbo-samples-metadata-report-local-properties工程。</p> |
| <h5 id="dubboproperties">dubbo.properties</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.metadata-report.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://127.0.0.1:2181</span> |
| </span></span></code></pre></div><p>配置完成这个之后，其余的不用特别关注。也可以直接查看对应的provider和consumer端的服务信息。</p> |
| <h5 id="provider存储的某个服务的内容">provider存储的某个服务的内容：</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;parameters&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;valid&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;async&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;side&#34;</span>: <span style="color:#2aa198">&#34;provider&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;application&#34;</span>: <span style="color:#2aa198">&#34;metadatareport-local-xml-provider&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;dubbo&#34;</span>: <span style="color:#2aa198">&#34;2.0.2&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;interface&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.local.xml.api.DemoService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;generic&#34;</span>: <span style="color:#2aa198">&#34;false&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;anyhost&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;canonicalName&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.local.xml.api.DemoService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;codeSource&#34;</span>: <span style="color:#2aa198">&#34;file:/Users/cvictory/workspace/work-mw/dubbo-samples/dubbo-samples-metadata-report/dubbo-samples-metadata-report-local-xml/target/classes/&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: [{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;name&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;parameterTypes&#34;</span>: [<span style="color:#2aa198">&#34;java.lang.String&#34;</span>], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;returnType&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span> |
| </span></span><span style="display:flex;"><span> }], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;types&#34;</span>: [{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> }, { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char&#34;</span> |
| </span></span><span style="display:flex;"><span> }, { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;value&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char[]&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;hash&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }] |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h5 id="consumer端存储的内容">consumer端存储的内容：</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;valid&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;side&#34;</span>: <span style="color:#2aa198">&#34;consumer&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;application&#34;</span>: <span style="color:#2aa198">&#34;metadatareport-local-xml-consumer&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;dubbo&#34;</span>: <span style="color:#2aa198">&#34;2.0.2&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;interface&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.local.xml.api.DemoService&#34;</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="方式三配置在项目中-annotation方式引入配置">方式三：配置在项目中-annotation方式引入配置</h3> |
| <p>参考sample：dubbo-samples-metadata-report/dubbo-samples-metadata-report-local-annotaion工程。</p> |
| <h5 id="bean-引入bean">@Bean 引入bean</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> MetadataReportConfig <span style="color:#268bd2">metadataReportConfig</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> MetadataReportConfig metadataReportConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> MetadataReportConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> metadataReportConfig<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> metadataReportConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>引入Bean之后，其余的地方也不需要特别配置。直接查看对应的服务信息：</p> |
| <h5 id="provider存储的某个服务的内容-1">provider存储的某个服务的内容：</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;parameters&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;side&#34;</span>: <span style="color:#2aa198">&#34;provider&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;dubbo&#34;</span>: <span style="color:#2aa198">&#34;2.0.2&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;interface&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.local.annotation.api.AnnotationService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;version&#34;</span>: <span style="color:#2aa198">&#34;1.1.8&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;generic&#34;</span>: <span style="color:#2aa198">&#34;false&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;revision&#34;</span>: <span style="color:#2aa198">&#34;1.1.8&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;valid&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;application&#34;</span>: <span style="color:#2aa198">&#34;metadatareport-local-annotaion-provider&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;default.timeout&#34;</span>: <span style="color:#2aa198">&#34;1000&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;group&#34;</span>: <span style="color:#2aa198">&#34;d-test&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;anyhost&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;canonicalName&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.local.annotation.api.AnnotationService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;codeSource&#34;</span>: <span style="color:#2aa198">&#34;file:/Users/cvictory/workspace/work-mw/dubbo-samples/dubbo-samples-metadata-report/dubbo-samples-metadata-report-local-annotaion/target/classes/&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: [{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;name&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;parameterTypes&#34;</span>: [<span style="color:#2aa198">&#34;java.lang.String&#34;</span>], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;returnType&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span> |
| </span></span><span style="display:flex;"><span> }], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;types&#34;</span>: [{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> }, { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;value&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char[]&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;hash&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char&#34;</span> |
| </span></span><span style="display:flex;"><span> }] |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h5 id="consumer端存储的内容-1">consumer端存储的内容：</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;valid&#34;</span>: <span style="color:#2aa198">&#34;true&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;side&#34;</span>: <span style="color:#2aa198">&#34;consumer&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;application&#34;</span>: <span style="color:#2aa198">&#34;metadatareport-local-annotaion-consumer&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;dubbo&#34;</span>: <span style="color:#2aa198">&#34;2.0.2&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;interface&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.samples.metadatareport.local.annotation.api.AnnotationService&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;version&#34;</span>: <span style="color:#2aa198">&#34;1.1.8&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;revision&#34;</span>: <span style="color:#2aa198">&#34;1.1.8&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;group&#34;</span>: <span style="color:#2aa198">&#34;d-test&#34;</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h2 id="扩展">扩展</h2> |
| <h3 id="spi定义">SPI定义</h3> |
| <p>参考：org.apache.dubbo.metadata.store.MetadataReportFactory ， org.apache.dubbo.metadata.store.MetadataReport</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;redis&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">MetadataReportFactory</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</span><span style="color:#719e07">({</span><span style="color:#2aa198">&#34;protocol&#34;</span><span style="color:#719e07">})</span> |
| </span></span><span style="display:flex;"><span> MetadataReport <span style="color:#268bd2">getMetadataReport</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="自定义元数据的存储">自定义元数据的存储</h3> |
| <p>下面以Redis存储为例进行说明。</p> |
| <p>新建一个project，需要支持以下修改：</p> |
| <h4 id="扩展abstractmetadatareport">扩展AbstractMetadataReport</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">RedisMetadataReport</span> <span style="color:#268bd2">extends</span> AbstractMetadataReport <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> <span style="color:#268bd2">static</span> Logger logger <span style="color:#719e07">=</span> LoggerFactory<span style="color:#719e07">.</span>getLogger<span style="color:#719e07">(</span>RedisMetadataReport<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> JedisPool pool<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">RedisMetadataReport</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span><span style="color:#719e07">(</span>url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> pool <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> JedisPool<span style="color:#719e07">(</span><span style="color:#719e07">new</span> JedisPoolConfig<span style="color:#719e07">(),</span> url<span style="color:#719e07">.</span>getHost<span style="color:#719e07">(),</span> url<span style="color:#719e07">.</span>getPort<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">doStoreProviderMetadata</span><span style="color:#719e07">(</span>ProviderMetadataIdentifier providerMetadataIdentifier<span style="color:#719e07">,</span> String serviceDefinitions<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>storeMetadata<span style="color:#719e07">(</span>providerMetadataIdentifier<span style="color:#719e07">,</span> serviceDefinitions<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">doStoreConsumerMetadata</span><span style="color:#719e07">(</span>ConsumerMetadataIdentifier consumerMetadataIdentifier<span style="color:#719e07">,</span> String value<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>storeMetadata<span style="color:#719e07">(</span>consumerMetadataIdentifier<span style="color:#719e07">,</span> value<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">storeMetadata</span><span style="color:#719e07">(</span>MetadataIdentifier metadataIdentifier<span style="color:#719e07">,</span> String v<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">(</span>Jedis jedis <span style="color:#719e07">=</span> pool<span style="color:#719e07">.</span>getResource<span style="color:#719e07">())</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> jedis<span style="color:#719e07">.</span>set<span style="color:#719e07">(</span>metadataIdentifier<span style="color:#719e07">.</span>getIdentifierKey<span style="color:#719e07">()</span> <span style="color:#719e07">+</span> META_DATA_SOTRE_TAG<span style="color:#719e07">,</span> v<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Throwable e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> logger<span style="color:#719e07">.</span>error<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Failed to put &#34;</span> <span style="color:#719e07">+</span> metadataIdentifier <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; to redis &#34;</span> <span style="color:#719e07">+</span> v <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, cause: &#34;</span> <span style="color:#719e07">+</span> e<span style="color:#719e07">.</span>getMessage<span style="color:#719e07">(),</span> e<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> RpcException<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Failed to put &#34;</span> <span style="color:#719e07">+</span> metadataIdentifier <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; to redis &#34;</span> <span style="color:#719e07">+</span> v <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, cause: &#34;</span> <span style="color:#719e07">+</span> e<span style="color:#719e07">.</span>getMessage<span style="color:#719e07">(),</span> e<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h4 id="扩展-abstractmetadatareportfactory">扩展 AbstractMetadataReportFactory</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">RedisMetadataReportFactory</span> <span style="color:#268bd2">extends</span> AbstractMetadataReportFactory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> MetadataReport <span style="color:#268bd2">createMetadataReport</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> RedisMetadataReport<span style="color:#719e07">(</span>url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h4 id="增加-metadatareportfactory">增加 MetadataReportFactory</h4> |
| <blockquote> |
| <p>META-INF/dubbo/internal/org.apache.dubbo.metadata.store.MetadataReportFactory</p> |
| </blockquote> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>redis<span style="color:#719e07">=</span><span style="color:#2aa198">org.apache.dubbo.metadata.store.redis.RedisMetadataReportFactory</span> |
| </span></span></code></pre></div><p>只要将上面的修改和project打包成jar包，然后配置元数据中心的url：redis://10.20.153.10:6379。</p> |
| <p>至此，一个自定义的元数据存储就可以运行了。</p> |
| <h3 id="数据存储">数据存储</h3> |
| <h4 id="接口级别元数据">接口级别元数据</h4> |
| <h5 id="zookeeper">Zookeeper</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:metadata-report</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Zookeeper 基于树形结构进行数据存储，它的元数据信息位于以下节点:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>Provider: /dubbo/metadata/{interface name}/{version}/{group}/provider/{application name} |
| </span></span><span style="display:flex;"><span>Consumer: /dubbo/metadata/{interface name}/{version}/{group}/consumer/{application name} |
| </span></span></code></pre></div><p>当 version 或者 group 不存在时，version 路径和 group 路径会取消，路径如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>Provider: /dubbo/metadata/{interface name}/provider/{application name} |
| </span></span><span style="display:flex;"><span>Consumer: /dubbo/metadata/{interface name}/consumer/{application name} |
| </span></span></code></pre></div><p>通过 zkCli get 操作查看数据.</p> |
| <p>Provider node:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: localhost:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 8<span style="color:#719e07">]</span> get /dubbo/metadata/org.apache.dubbo.demo.DemoService/provider/demo-provider |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">{</span><span style="color:#2aa198">&#34;parameters&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;side&#34;</span>:<span style="color:#2aa198">&#34;provider&#34;</span>,<span style="color:#2aa198">&#34;interface&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.DemoService&#34;</span>,<span style="color:#2aa198">&#34;metadata-type&#34;</span>:<span style="color:#2aa198">&#34;remote&#34;</span>,<span style="color:#2aa198">&#34;application&#34;</span>:<span style="color:#2aa198">&#34;demo-provider&#34;</span>,<span style="color:#2aa198">&#34;dubbo&#34;</span>:<span style="color:#2aa198">&#34;2.0.2&#34;</span>,<span style="color:#2aa198">&#34;release&#34;</span>:<span style="color:#2aa198">&#34;&#34;</span>,<span style="color:#2aa198">&#34;anyhost&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;delay&#34;</span>:<span style="color:#2aa198">&#34;5000&#34;</span>,<span style="color:#2aa198">&#34;methods&#34;</span>:<span style="color:#2aa198">&#34;sayHello,sayHelloAsync&#34;</span>,<span style="color:#2aa198">&#34;deprecated&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span>,<span style="color:#2aa198">&#34;dynamic&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;timeout&#34;</span>:<span style="color:#2aa198">&#34;3000&#34;</span>,<span style="color:#2aa198">&#34;generic&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span><span style="color:#719e07">}</span>,<span style="color:#2aa198">&#34;canonicalName&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.DemoService&#34;</span>,<span style="color:#2aa198">&#34;codeSource&#34;</span>:<span style="color:#2aa198">&#34;file:/Users/apple/IdeaProjects/dubbo/dubbo-demo/dubbo-demo-interface/target/classes/&#34;</span>,<span style="color:#2aa198">&#34;methods&#34;</span>:<span style="color:#719e07">[{</span><span style="color:#2aa198">&#34;name&#34;</span>:<span style="color:#2aa198">&#34;sayHelloAsync&#34;</span>,<span style="color:#2aa198">&#34;parameterTypes&#34;</span>:<span style="color:#719e07">[</span><span style="color:#2aa198">&#34;java.lang.String&#34;</span><span style="color:#719e07">]</span>,<span style="color:#2aa198">&#34;returnType&#34;</span>:<span style="color:#2aa198">&#34;java.util.concurrent.CompletableFuture&#34;</span><span style="color:#719e07">}</span>,<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;name&#34;</span>:<span style="color:#2aa198">&#34;sayHello&#34;</span>,<span style="color:#2aa198">&#34;parameterTypes&#34;</span>:<span style="color:#719e07">[</span><span style="color:#2aa198">&#34;java.lang.String&#34;</span><span style="color:#719e07">]</span>,<span style="color:#2aa198">&#34;returnType&#34;</span>:<span style="color:#2aa198">&#34;java.lang.String&#34;</span><span style="color:#719e07">}]</span>,<span style="color:#2aa198">&#34;types&#34;</span>:<span style="color:#719e07">[{</span><span style="color:#2aa198">&#34;type&#34;</span>:<span style="color:#2aa198">&#34;java.util.concurrent.CompletableFuture&#34;</span>,<span style="color:#2aa198">&#34;properties&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;result&#34;</span>:<span style="color:#2aa198">&#34;java.lang.Object&#34;</span>,<span style="color:#2aa198">&#34;stack&#34;</span>:<span style="color:#2aa198">&#34;java.util.concurrent.CompletableFuture.Completion&#34;</span><span style="color:#719e07">}}</span>,<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;type&#34;</span>:<span style="color:#2aa198">&#34;java.lang.Object&#34;</span><span style="color:#719e07">}</span>,<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;type&#34;</span>:<span style="color:#2aa198">&#34;java.lang.String&#34;</span><span style="color:#719e07">}</span>,<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;type&#34;</span>:<span style="color:#2aa198">&#34;java.util.concurrent.CompletableFuture.Completion&#34;</span>,<span style="color:#2aa198">&#34;properties&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;next&#34;</span>:<span style="color:#2aa198">&#34;java.util.concurrent.CompletableFuture.Completion&#34;</span>,<span style="color:#2aa198">&#34;status&#34;</span>:<span style="color:#2aa198">&#34;int&#34;</span><span style="color:#719e07">}}</span>,<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;type&#34;</span>:<span style="color:#2aa198">&#34;int&#34;</span><span style="color:#719e07">}]}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cZxid</span> <span style="color:#719e07">=</span> 0x25a9b1 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ctime</span> <span style="color:#719e07">=</span> Mon Jun <span style="color:#2aa198">28</span> 21:35:17 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mZxid</span> <span style="color:#719e07">=</span> 0x25a9b1 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mtime</span> <span style="color:#719e07">=</span> Mon Jun <span style="color:#2aa198">28</span> 21:35:17 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">pZxid</span> <span style="color:#719e07">=</span> 0x25a9b1 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cversion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">aclVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ephemeralOwner</span> <span style="color:#719e07">=</span> 0x0 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataLength</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">1061</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">numChildren</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span></code></pre></div><p>Consumer node:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: localhost:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 10<span style="color:#719e07">]</span> get /dubbo/metadata/org.apache.dubbo.demo.DemoService/consumer/demo-consumer |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">{</span><span style="color:#2aa198">&#34;side&#34;</span>:<span style="color:#2aa198">&#34;consumer&#34;</span>,<span style="color:#2aa198">&#34;interface&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.DemoService&#34;</span>,<span style="color:#2aa198">&#34;metadata-type&#34;</span>:<span style="color:#2aa198">&#34;remote&#34;</span>,<span style="color:#2aa198">&#34;application&#34;</span>:<span style="color:#2aa198">&#34;demo-consumer&#34;</span>,<span style="color:#2aa198">&#34;dubbo&#34;</span>:<span style="color:#2aa198">&#34;2.0.2&#34;</span>,<span style="color:#2aa198">&#34;release&#34;</span>:<span style="color:#2aa198">&#34;&#34;</span>,<span style="color:#2aa198">&#34;sticky&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span>,<span style="color:#2aa198">&#34;check&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span>,<span style="color:#2aa198">&#34;methods&#34;</span>:<span style="color:#2aa198">&#34;sayHello,sayHelloAsync&#34;</span><span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cZxid</span> <span style="color:#719e07">=</span> 0x25aa24 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ctime</span> <span style="color:#719e07">=</span> Mon Jun <span style="color:#2aa198">28</span> 21:57:43 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mZxid</span> <span style="color:#719e07">=</span> 0x25aa24 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mtime</span> <span style="color:#719e07">=</span> Mon Jun <span style="color:#2aa198">28</span> 21:57:43 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">pZxid</span> <span style="color:#719e07">=</span> 0x25aa24 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cversion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">aclVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ephemeralOwner</span> <span style="color:#719e07">=</span> 0x0 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataLength</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">219</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">numChildren</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span></code></pre></div><h5 id="redis">Redis</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:metadata-report</span> address=<span style="color:#2aa198">&#34;redis://127.0.0.1:6779&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>在Redis中，使用string数据结构来进行存储元数据信息:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>Provider: {service name}:{version}:{group}:provider:{application name} |
| </span></span><span style="display:flex;"><span>Consumer: {service name}:{version}:{group}:consumer:{application name} |
| </span></span></code></pre></div><p>当 version 或者 group 不存在时，<code>:</code> 依然保留:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>Provider: {service name}:::provider:{application name} |
| </span></span><span style="display:flex;"><span>Consumer: {service name}:::consumer:{application name} |
| </span></span></code></pre></div><p>通过 Redis client get key 查看数据.</p> |
| <p>Provider key:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>127.0.0.1:6379&gt; get org.apache.dubbo.demo.DemoService:::provider:demo-provider |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;{\&#34;parameters\&#34;:{\&#34;side\&#34;:\&#34;provider\&#34;,\&#34;interface\&#34;:\&#34;org.apache.dubbo.demo.DemoService\&#34;,\&#34;metadata-type\&#34;:\&#34;remote\&#34;,\&#34;application\&#34;:\&#34;demo-provider\&#34;,\&#34;dubbo\&#34;:\&#34;2.0.2\&#34;,\&#34;release\&#34;:\&#34;\&#34;,\&#34;anyhost\&#34;:\&#34;true\&#34;,\&#34;delay\&#34;:\&#34;5000\&#34;,\&#34;methods\&#34;:\&#34;sayHello,sayHelloAsync\&#34;,\&#34;deprecated\&#34;:\&#34;false\&#34;,\&#34;dynamic\&#34;:\&#34;true\&#34;,\&#34;timeout\&#34;:\&#34;3000\&#34;,\&#34;generic\&#34;:\&#34;false\&#34;},\&#34;canonicalName\&#34;:\&#34;org.apache.dubbo.demo.DemoService\&#34;,\&#34;codeSource\&#34;:\&#34;file:/Users/apple/IdeaProjects/dubbo/dubbo-demo/dubbo-demo-interface/target/classes/\&#34;,\&#34;methods\&#34;:[{\&#34;name\&#34;:\&#34;sayHello\&#34;,\&#34;parameterTypes\&#34;:[\&#34;java.lang.String\&#34;],\&#34;returnType\&#34;:\&#34;java.lang.String\&#34;},{\&#34;name\&#34;:\&#34;sayHelloAsync\&#34;,\&#34;parameterTypes\&#34;:[\&#34;java.lang.String\&#34;],\&#34;returnType\&#34;:\&#34;java.util.concurrent.CompletableFuture\&#34;}],\&#34;types\&#34;:[{\&#34;type\&#34;:\&#34;java.util.concurrent.CompletableFuture\&#34;,\&#34;properties\&#34;:{\&#34;result\&#34;:\&#34;java.lang.Object\&#34;,\&#34;stack\&#34;:\&#34;java.util.concurrent.CompletableFuture.Completion\&#34;}},{\&#34;type\&#34;:\&#34;java.lang.Object\&#34;},{\&#34;type\&#34;:\&#34;java.lang.String\&#34;},{\&#34;type\&#34;:\&#34;java.util.concurrent.CompletableFuture.Completion\&#34;,\&#34;properties\&#34;:{\&#34;next\&#34;:\&#34;java.util.concurrent.CompletableFuture.Completion\&#34;,\&#34;status\&#34;:\&#34;int\&#34;}},{\&#34;type\&#34;:\&#34;int\&#34;}]}&#34;</span> |
| </span></span></code></pre></div><p>Consumer key:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>127.0.0.1:6379&gt; get org.apache.dubbo.demo.DemoService:::consumer:demo-consumer |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;{\&#34;side\&#34;:\&#34;consumer\&#34;,\&#34;interface\&#34;:\&#34;org.apache.dubbo.demo.DemoService\&#34;,\&#34;metadata-type\&#34;:\&#34;remote\&#34;,\&#34;application\&#34;:\&#34;demo-consumer\&#34;,\&#34;dubbo\&#34;:\&#34;2.0.2\&#34;,\&#34;release\&#34;:\&#34;\&#34;,\&#34;sticky\&#34;:\&#34;false\&#34;,\&#34;check\&#34;:\&#34;false\&#34;,\&#34;methods\&#34;:\&#34;sayHello,sayHelloAsync\&#34;}&#34;</span> |
| </span></span></code></pre></div><h5 id="nacos">Nacos</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:metadata-report</span> address=<span style="color:#2aa198">&#34;nacos://127.0.0.1:8848&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>在 Nacos 中，本身就存在配置中心这个概念，正好用于元数据存储。在配置中心的场景下，存在命名空间- namespace 的概念，在 namespace 之下，还存在 group 概念。即通过 namespace 和 group 以及 dataId 去定位一个配置项，在不指定 namespace 的情况下，默认使用 <code>public</code> 作为默认的命名空间。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>Provider: namespace: &#39;public&#39;, dataId: &#39;{service name}:{version}:{group}:provider:{application name}&#39;, group: &#39;dubbo&#39; |
| </span></span><span style="display:flex;"><span>Consumer: namespace: &#39;public&#39;, dataId: &#39;{service name}:{version}:{group}:consumer:{application name}&#39;, group: &#39;dubbo&#39; |
| </span></span></code></pre></div><p>当 version 或者 group 不存在时，<code>:</code> 依然保留:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>Provider: namespace: &#39;public&#39;, dataId: &#39;{service name}:::provider:{application name}&#39;, group: &#39;dubbo&#39; |
| </span></span><span style="display:flex;"><span>Consumer: namespace: &#39;public&#39;, dataId: &#39;{service name}:::consumer:{application name}&#39;, group: &#39;dubbo&#39; |
| </span></span></code></pre></div><p>可以通过 Nacos 自带的 web console 界面进行查看.</p> |
| <p>Provider data: |
| <img src="https://dubbo.apache.org/imgs/user/nacos-metadata-report-provider-metadata.png" alt="nacos-metadata-report-provider-metadata.png"></p> |
| <p>Consumer data: |
| <img src="https://dubbo.apache.org/imgs/user/nacos-metadata-report-consumer-metadata.png" alt="nacos-metadata-report-consumer-metadata.png"></p> |
| <h4 id="应用级别元数据">应用级别元数据</h4> |
| <p>应用级别元数据只有当一个应用定义服务之后，才会进行暴露。会根据当前应用的自身信息，以及接口信息，去计算出该应用的 revision 修订值，用于保存应用级别元数据，</p> |
| <h5 id="zookeeper-1">Zookeeper</h5> |
| <p>Zookeeper 的应用级别元数据位于 /dubbo/metadata/{application name}/{revision}</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: localhost:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 33<span style="color:#719e07">]</span> get /dubbo/metadata/demo-provider/da3be833baa2088c5f6776fb7ab1a436 |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">{</span><span style="color:#2aa198">&#34;app&#34;</span>:<span style="color:#2aa198">&#34;demo-provider&#34;</span>,<span style="color:#2aa198">&#34;revision&#34;</span>:<span style="color:#2aa198">&#34;da3be833baa2088c5f6776fb7ab1a436&#34;</span>,<span style="color:#2aa198">&#34;services&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;org.apache.dubbo.demo.DemoService:dubbo&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;name&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.DemoService&#34;</span>,<span style="color:#2aa198">&#34;protocol&#34;</span>:<span style="color:#2aa198">&#34;dubbo&#34;</span>,<span style="color:#2aa198">&#34;path&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.DemoService&#34;</span>,<span style="color:#2aa198">&#34;params&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;side&#34;</span>:<span style="color:#2aa198">&#34;provider&#34;</span>,<span style="color:#2aa198">&#34;release&#34;</span>:<span style="color:#2aa198">&#34;&#34;</span>,<span style="color:#2aa198">&#34;methods&#34;</span>:<span style="color:#2aa198">&#34;sayHello,sayHelloAsync&#34;</span>,<span style="color:#2aa198">&#34;deprecated&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span>,<span style="color:#2aa198">&#34;dubbo&#34;</span>:<span style="color:#2aa198">&#34;2.0.2&#34;</span>,<span style="color:#2aa198">&#34;pid&#34;</span>:<span style="color:#2aa198">&#34;38298&#34;</span>,<span style="color:#2aa198">&#34;interface&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.DemoService&#34;</span>,<span style="color:#2aa198">&#34;service-name-mapping&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;timeout&#34;</span>:<span style="color:#2aa198">&#34;3000&#34;</span>,<span style="color:#2aa198">&#34;generic&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span>,<span style="color:#2aa198">&#34;metadata-type&#34;</span>:<span style="color:#2aa198">&#34;remote&#34;</span>,<span style="color:#2aa198">&#34;delay&#34;</span>:<span style="color:#2aa198">&#34;5000&#34;</span>,<span style="color:#2aa198">&#34;application&#34;</span>:<span style="color:#2aa198">&#34;demo-provider&#34;</span>,<span style="color:#2aa198">&#34;dynamic&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;REGISTRY_CLUSTER&#34;</span>:<span style="color:#2aa198">&#34;registry1&#34;</span>,<span style="color:#2aa198">&#34;anyhost&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;timestamp&#34;</span>:<span style="color:#2aa198">&#34;1626887121829&#34;</span><span style="color:#719e07">}}</span>,<span style="color:#2aa198">&#34;org.apache.dubbo.demo.RestDemoService:1.0.0:rest&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;name&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.RestDemoService&#34;</span>,<span style="color:#2aa198">&#34;version&#34;</span>:<span style="color:#2aa198">&#34;1.0.0&#34;</span>,<span style="color:#2aa198">&#34;protocol&#34;</span>:<span style="color:#2aa198">&#34;rest&#34;</span>,<span style="color:#2aa198">&#34;path&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.RestDemoService&#34;</span>,<span style="color:#2aa198">&#34;params&#34;</span>:<span style="color:#719e07">{</span><span style="color:#2aa198">&#34;side&#34;</span>:<span style="color:#2aa198">&#34;provider&#34;</span>,<span style="color:#2aa198">&#34;release&#34;</span>:<span style="color:#2aa198">&#34;&#34;</span>,<span style="color:#2aa198">&#34;methods&#34;</span>:<span style="color:#2aa198">&#34;getRemoteApplicationName,sayHello,hello,error&#34;</span>,<span style="color:#2aa198">&#34;deprecated&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span>,<span style="color:#2aa198">&#34;dubbo&#34;</span>:<span style="color:#2aa198">&#34;2.0.2&#34;</span>,<span style="color:#2aa198">&#34;pid&#34;</span>:<span style="color:#2aa198">&#34;38298&#34;</span>,<span style="color:#2aa198">&#34;interface&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.demo.RestDemoService&#34;</span>,<span style="color:#2aa198">&#34;service-name-mapping&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;version&#34;</span>:<span style="color:#2aa198">&#34;1.0.0&#34;</span>,<span style="color:#2aa198">&#34;timeout&#34;</span>:<span style="color:#2aa198">&#34;5000&#34;</span>,<span style="color:#2aa198">&#34;generic&#34;</span>:<span style="color:#2aa198">&#34;false&#34;</span>,<span style="color:#2aa198">&#34;revision&#34;</span>:<span style="color:#2aa198">&#34;1.0.0&#34;</span>,<span style="color:#2aa198">&#34;metadata-type&#34;</span>:<span style="color:#2aa198">&#34;remote&#34;</span>,<span style="color:#2aa198">&#34;delay&#34;</span>:<span style="color:#2aa198">&#34;5000&#34;</span>,<span style="color:#2aa198">&#34;application&#34;</span>:<span style="color:#2aa198">&#34;demo-provider&#34;</span>,<span style="color:#2aa198">&#34;dynamic&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;REGISTRY_CLUSTER&#34;</span>:<span style="color:#2aa198">&#34;registry1&#34;</span>,<span style="color:#2aa198">&#34;anyhost&#34;</span>:<span style="color:#2aa198">&#34;true&#34;</span>,<span style="color:#2aa198">&#34;timestamp&#34;</span>:<span style="color:#2aa198">&#34;1626887120943&#34;</span><span style="color:#719e07">}}}}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cZxid</span> <span style="color:#719e07">=</span> 0x25b336 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ctime</span> <span style="color:#719e07">=</span> Thu Jul <span style="color:#2aa198">22</span> 01:05:55 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mZxid</span> <span style="color:#719e07">=</span> 0x25b336 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mtime</span> <span style="color:#719e07">=</span> Thu Jul <span style="color:#2aa198">22</span> 01:05:55 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">pZxid</span> <span style="color:#719e07">=</span> 0x25b336 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cversion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">aclVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ephemeralOwner</span> <span style="color:#719e07">=</span> 0x0 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataLength</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">1286</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">numChildren</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span></code></pre></div><h4 id="redis-1">Redis</h4> |
| <p>Redis 元数据中心目前还不支持应用级别元数据，但已提上日程，会在近期进行实现。</p> |
| <h5 id="nacoshttpsnacosio"><a href="https://nacos.io/">Nacos</a></h5> |
| <p>Nacos 应用级别的元数据位于 namespace: &lsquo;public&rsquo;, dataId: &lsquo;{application name}&rsquo;, group: &lsquo;{revision}&rsquo;</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/nacos-metadata-report-application-metadata.png" alt="nacos-metadata-report-application-metadata.png"></p> |
| <h4 id="服务自省映射---service-name-mapping">服务自省映射 - Service Name Mapping</h4> |
| <p>在Dubbo 3.0 中，默认使用了服务自省机制去实现服务发现，关于服务自省可以查看<a href="https://mercyblitz.github.io/2020/05/11/Apache-Dubbo-%E6%9C%8D%E5%8A%A1%E8%87%AA%E7%9C%81%E6%9E%B6%E6%9E%84%E8%AE%BE%E8%AE%A1/">服务自省</a></p> |
| <p>简而言之，服务自省机制需要能够通过 interface name 去找到对应的 application name，这个关系可以是一对多的，即一个 service name 可能会对应多个不同的 application name。在 3.0 中，元数据中心提供此项映射的能力。</p> |
| <h5 id="zookeeper-2">Zookeeper</h5> |
| <p>在上面提到，service name 和 application name 可能是一对多的，在 zookeeper 中，使用单个 key-value 进行保存，多个 application name 通过英文逗号<code>,</code>隔开。由于是单个 key-value 去保存数据，在多客户端的情况下可能会存在并发覆盖的问题。因此，我们使用 zookeeper 中的版本机制 version 去解决该问题。在 zookeeper 中，每一次对数据进行修改，dataVersion 都会进行增加，我们可以利用 version 这个机制去解决多个客户端同时更新映射的并发问题。不同客户端在更新之前，先去查一次 version，当作本地凭证。在更新时，把凭证 version 传到服务端比对 version, 如果不一致说明在此期间被其他客户端修改过，重新获取凭证再进行重试(CAS)。目前如果重试6次都失败的话，放弃本次更新映射行为。</p> |
| <p>Curator api.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>CuratorFramework client <span style="color:#719e07">=</span> <span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span>client<span style="color:#719e07">.</span>setData<span style="color:#719e07">().</span>withVersion<span style="color:#719e07">(</span>ticket<span style="color:#719e07">).</span>forPath<span style="color:#719e07">(</span>path<span style="color:#719e07">,</span> dataBytes<span style="color:#719e07">);</span> |
| </span></span></code></pre></div><p>映射信息位于:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>/dubbo/mapping/{service name} |
| </span></span></code></pre></div><p>通过 zkCli get 操作查看数据.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: localhost:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 26<span style="color:#719e07">]</span> get /dubbo/mapping/org.apache.dubbo.demo.DemoService |
| </span></span><span style="display:flex;"><span>demo-provider,two-demo-provider,dubbo-demo-annotation-provider |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cZxid</span> <span style="color:#719e07">=</span> 0x25a80f |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ctime</span> <span style="color:#719e07">=</span> Thu Jun <span style="color:#2aa198">10</span> 01:36:40 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mZxid</span> <span style="color:#719e07">=</span> 0x25a918 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">mtime</span> <span style="color:#719e07">=</span> Fri Jun <span style="color:#2aa198">11</span> 18:46:40 CST <span style="color:#2aa198">2021</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">pZxid</span> <span style="color:#719e07">=</span> 0x25a80f |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">cversion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">2</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">aclVersion</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">ephemeralOwner</span> <span style="color:#719e07">=</span> 0x0 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dataLength</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">62</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">numChildren</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span> |
| </span></span></code></pre></div><h5 id="redis-2">Redis</h5> |
| <p>Redis 元数据中心目前还不支持服务自省映射，但已提上日程，会在近期进行实现。</p> |
| <h5 id="nacos-1">Nacos</h5> |
| <p>在上面提到，service name 和 application name 可能是一对多的，在 nacos 中，使用单个 key-value 进行保存，多个 application name 通过英文逗号<code>,</code>隔开。由于是单个 key-value 去保存数据，在多客户端的情况下可能会存在并发覆盖的问题。因此，我们使用 nacos 中 publishConfigCas 的能力去解决该问题。在 nacos 中，使用 publishConfigCas 会让用户传递一个参数 casMd5，该值的含义是之前配置内容的 md5 值。不同客户端在更新之前，先去查一次 nacos 的 content 的值，计算出 md5 值，当作本地凭证。在更新时，把凭证 md5 传到服务端比对 md5 值, 如果不一致说明在此期间被其他客户端修改过，重新获取凭证再进行重试(CAS)。目前如果重试6次都失败的话，放弃本次更新映射行为。</p> |
| <p>Nacos api:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ConfigService configService <span style="color:#719e07">=</span> <span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span>configService<span style="color:#719e07">.</span>publishConfigCas<span style="color:#719e07">(</span>key<span style="color:#719e07">,</span> group<span style="color:#719e07">,</span> content<span style="color:#719e07">,</span> ticket<span style="color:#719e07">);</span> |
| </span></span></code></pre></div><p>映射信息位于 namespace: &lsquo;public&rsquo;, dataId: &lsquo;{service name}&rsquo;, group: &lsquo;mapping&rsquo;.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/nacos-metadata-report-service-name-mapping.png" alt="nacos-metadata-report-service-name-mapping.png"></p></description></item><item><title>Docs: API 参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/api/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/api/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/api/">最新版本</a>。</p> |
| </div> |
| <p>Dubbo 的常规功能，都保持零侵入，但有些功能不得不用 API 侵入才能实现。</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">提示</h4> |
| Dubbo 中除这里声明以外的接口或类，都是内部接口或扩展接口，普通用户请不要直接依赖，否则升级版本可能出现不兼容。 |
| </div> |
| <p>API 汇总如下：</p> |
| <h2 id="配置-api">配置 API</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>org.apache.dubbo.config.ServiceConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.ReferenceConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.ProtocolConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.RegistryConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.MonitorConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.ApplicationConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.ModuleConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.ProviderConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.ConsumerConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.MethodConfig |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.ArgumentConfig |
| </span></span></code></pre></div><p>详细参见：<a href="../configuration/api">API配置</a></p> |
| <h2 id="注解-api">注解 API</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>org.apache.dubbo.config.annotation.DubboService |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.annotation.DubboReference |
| </span></span></code></pre></div><p>详细参见：<a href="../configuration/annotation">注解配置</a></p> |
| <h2 id="模型-api">模型 API</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>org.apache.dubbo.common.URL |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.rpc.RpcException |
| </span></span></code></pre></div><h2 id="上下文-api">上下文 API</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>org.apache.dubbo.rpc.RpcContext |
| </span></span></code></pre></div><p>详细参见：<a href="../../advanced/context">上下文信息</a> &amp; <a href="../../advanced/attachment">隐式传参</a> &amp; <a href="../../advanced/async-call">异步调用</a></p> |
| <h2 id="服务-api">服务 API</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>org.apache.dubbo.rpc.service.GenericService |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.rpc.service.GenericException |
| </span></span></code></pre></div><p>详细参见：<a href="../../advanced/generic-reference">泛化引用</a> &amp; <a href="../../advanced/generic-service">泛化实现</a></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>org.apache.dubbo.rpc.service.EchoService |
| </span></span></code></pre></div><p>详细参见：<a href="../../advanced/echo-service">回声测试</a></p></description></item><item><title>Docs: Kubernetes 生命周期对齐探针</title><link>https://dubbo.apache.org/zh-cn/docs/references/lifecycle/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/lifecycle/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/advanced-features-and-usage/others/dubbo-kubernetes-probe/">最新版本</a>。</p> |
| </div> |
| <p>和 Kubernetes 生命周期对齐的一些扩展点</p></description></item><item><title>Docs: 在线运维命令参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/qos/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/qos/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/qos/">最新版本</a>。</p> |
| </div> |
| <p>dubbo <code>2.5.8</code> 新版本增加了 QOS 模块，提供了新的 telnet 命令支持。</p> |
| <h2 id="端口">端口</h2> |
| <p>新版本的 telnet 端口 与 dubbo 协议的端口是不同的端口，默认为 <code>22222</code>，可通过配置文件<code>dubbo.properties</code> 修改:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.application.qos-port=33333 |
| </span></span></code></pre></div><p>或者通过设置 JVM 参数:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>-Ddubbo.application.qos-port=33333 |
| </span></span></code></pre></div><h2 id="安全">安全</h2> |
| <p>默认情况下，dubbo 接收任何主机发起的命令，可通过配置文件<code>dubbo.properties</code> 修改:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.application.qos-accept-foreign-ip=false |
| </span></span></code></pre></div><p>或者通过设置 JVM 参数:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>-Ddubbo.application.qos-accept-foreign-ip=false |
| </span></span></code></pre></div><p>拒绝远端主机发出的命令，只允许服务本机执行</p> |
| <h2 id="telnet-与-http-协议">telnet 与 http 协议</h2> |
| <p>telnet 模块现在同时支持 http 协议和 telnet 协议，方便各种情况的使用</p> |
| <p>示例如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>➜ ~ telnet localhost 22222 |
| </span></span><span style="display:flex;"><span>Trying ::1... |
| </span></span><span style="display:flex;"><span>telnet: connect to address ::1: Connection refused |
| </span></span><span style="display:flex;"><span>Trying 127.0.0.1... |
| </span></span><span style="display:flex;"><span>Connected to localhost. |
| </span></span><span style="display:flex;"><span>Escape character is &#39;^]&#39;. |
| </span></span><span style="display:flex;"><span> ████████▄ ███ █▄ ▀█████████▄ ▀█████████▄ ▄██████▄ |
| </span></span><span style="display:flex;"><span> ███ ▀███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ▄███▄▄▄██▀ ▄███▄▄▄██▀ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ▀▀███▀▀▀██▄ ▀▀███▀▀▀██▄ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ███ ██▄ ███ ██▄ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ▄███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ████████▀ ████████▀ ▄█████████▀ ▄█████████▀ ▀██████▀ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt;ls |
| </span></span><span style="display:flex;"><span>As Provider side: |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>| Provider Service Name |PUB| |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>|org.apache.dubbo.demo.DemoService| N | |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>As Consumer side: |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span>|Consumer Service Name|NUM| |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>➜ ~ curl &#34;localhost:22222/ls?arg1=xxx&amp;arg2=xxxx&#34; |
| </span></span><span style="display:flex;"><span>As Provider side: |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>| Provider Service Name |PUB| |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>|org.apache.dubbo.demo.DemoService| N | |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>As Consumer side: |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span>|Consumer Service Name|NUM| |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span></code></pre></div><h2 id="支持的命令">支持的命令</h2> |
| <h3 id="ls-列出消费者和提供者">ls 列出消费者和提供者</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo&gt;ls |
| </span></span><span style="display:flex;"><span>As Provider side: |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>| Provider Service Name |PUB| |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>|org.apache.dubbo.demo.DemoService| Y | |
| </span></span><span style="display:flex;"><span>+----------------------------------+---+ |
| </span></span><span style="display:flex;"><span>As Consumer side: |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span>|Consumer Service Name|NUM| |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span></code></pre></div><p>列出 dubbo 的所提供的服务和消费的服务，以及消费的服务地址数</p> |
| <h3 id="online-上线服务命令">Online 上线服务命令</h3> |
| <p>当使用延迟发布功能的时候(通过设置 org.apache.dubbo.config.AbstractServiceConfig#register 为 false)，后续需要上线的时候，可通过 Online 命令</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>//上线所有服务 |
| </span></span><span style="display:flex;"><span>dubbo&gt;online |
| </span></span><span style="display:flex;"><span>OK |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>//根据正则，上线部分服务 |
| </span></span><span style="display:flex;"><span>dubbo&gt;online com.* |
| </span></span><span style="display:flex;"><span>OK |
| </span></span></code></pre></div><p>常见使用场景：</p> |
| <ul> |
| <li>当线上的 QPS 比较高的时候，当刚重启机器的时候，由于没有进行JIT 预热或相关资源没有预热，可能会导致大量超时，这个时候，可通过分批发布服务，逐渐加大流量</li> |
| <li>当由于某台机器由于某种原因，需要下线服务，然后又需要重新上线服务</li> |
| </ul> |
| <h3 id="offline-下线服务命令">Offline 下线服务命令</h3> |
| <p>由于故障等原因，需要临时下线服务保持现场，可以使用 Offline 下线命令。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>//下线所有服务 |
| </span></span><span style="display:flex;"><span>dubbo&gt;offline |
| </span></span><span style="display:flex;"><span>OK |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>//根据正则，下线部分服务 |
| </span></span><span style="display:flex;"><span>dubbo&gt;offline com.* |
| </span></span><span style="display:flex;"><span>OK |
| </span></span></code></pre></div><h3 id="help-命令">help 命令</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>//列出所有命令 |
| </span></span><span style="display:flex;"><span>dubbo&gt;help |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>//列出单个命令的具体使用情况 |
| </span></span><span style="display:flex;"><span>dubbo&gt;help online |
| </span></span><span style="display:flex;"><span>+--------------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| COMMAND NAME | online | |
| </span></span><span style="display:flex;"><span>+--------------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| EXAMPLE | online dubbo | |
| </span></span><span style="display:flex;"><span>| | online xx.xx.xxx.service | |
| </span></span><span style="display:flex;"><span>+--------------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; |
| </span></span></code></pre></div><h2 id="相关参数说明">相关参数说明</h2> |
| <p>QoS提供了一些启动参数，来对启动进行配置，他们主要包括：</p> |
| <table> |
| <thead> |
| <tr> |
| <th>参数</th> |
| <th>说明</th> |
| <th>默认值</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>qos-enable</td> |
| <td>是否启动QoS</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>qos-port</td> |
| <td>启动QoS绑定的端口</td> |
| <td>22222</td> |
| </tr> |
| <tr> |
| <td>qos-accept-foreign-ip</td> |
| <td>是否允许远程访问</td> |
| <td>false</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <p>注意，从2.6.4/2.7.0开始，qos-accept-foreign-ip默认配置改为false，如果qos-accept-foreign-ip设置为true，有可能带来安全风险，请仔细评估后再打开。</p> |
| </blockquote> |
| <p>QoS参数可以通过如下方式进行配置</p> |
| <ul> |
| <li>系统属性</li> |
| <li>dubbo.properties</li> |
| <li>XML方式</li> |
| <li>Spring-boot自动装配方式</li> |
| </ul> |
| <p>其中，上述方式的优先顺序为系统属性 &gt; dubbo.properties &gt; XML/Spring-boot自动装配方式。</p> |
| <h3 id="使用系统属性方式进行配置">使用系统属性方式进行配置</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>-Ddubbo.application.qos-enable=true |
| </span></span><span style="display:flex;"><span>-Ddubbo.application.qos-port=33333 |
| </span></span><span style="display:flex;"><span>-Ddubbo.application.qos-accept-foreign-ip=false |
| </span></span></code></pre></div><h3 id="使用dubboproperties文件进行配置">使用dubbo.properties文件进行配置</h3> |
| <p>在项目的<code>src/main/resources</code>目录下添加dubbo.properties文件，内容如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.application.qos-enable=true |
| </span></span><span style="display:flex;"><span>dubbo.application.qos-port=33333 |
| </span></span><span style="display:flex;"><span>dubbo.application.qos-accept-foreign-ip=false |
| </span></span></code></pre></div><h3 id="使用xml方法进行配置">使用XML方法进行配置</h3> |
| <p>如果要通过XML配置响应的QoS相关的参数，可以进行如下配置：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://www.springframework.org/schema/beans/spring-beans.xsd |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;demo-provider&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:parameter</span> key=<span style="color:#2aa198">&#34;qos-enable&#34;</span> value=<span style="color:#2aa198">&#34;true&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:parameter</span> key=<span style="color:#2aa198">&#34;qos-accept-foreign-ip&#34;</span> value=<span style="color:#2aa198">&#34;false&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:parameter</span> key=<span style="color:#2aa198">&#34;qos-port&#34;</span> value=<span style="color:#2aa198">&#34;33333&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dubbo:application&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;multicast://224.5.6.7:1234&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.provider.DemoService&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.provider.DemoServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h3 id="使用spring-boot自动装配方式配置">使用spring-boot自动装配方式配置</h3> |
| <p>如果是spring-boot的应用，可以在<code>application.properties</code>或者<code>application.yml</code>上配置:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.application.qos-enable=true |
| </span></span><span style="display:flex;"><span>dubbo.application.qos-port=33333 |
| </span></span><span style="display:flex;"><span>dubbo.application.qos-accept-foreign-ip=false |
| </span></span></code></pre></div></description></item><item><title>Docs: Telnet 命令参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/telnet/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/telnet/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/qos/">最新版本</a>。</p> |
| </div> |
| <p>从 <code>2.0.5</code> 版本开始，dubbo 开始支持通过 telnet 命令来进行服务治理。</p> |
| <h2 id="使用">使用</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>telnet localhost <span style="color:#2aa198">20880</span> |
| </span></span></code></pre></div><p>或者：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span><span style="color:#b58900">echo</span> status | nc -i <span style="color:#2aa198">1</span> localhost <span style="color:#2aa198">20880</span> |
| </span></span></code></pre></div><p>status命令所检查的资源也可以扩展，参见：<a href="../../references/spis/status-checker">扩展参考手册</a>。</p> |
| <h2 id="命令">命令</h2> |
| <p>以下展示了 dubbo 内建的 telnet 命令的说明和用法，此外，telnet 命令还支持用户自行扩展，参见：<a href="../../references/spis/telnet-handler">Telnet 命令扩展</a>。</p> |
| <h3 id="ls"><code>ls</code></h3> |
| <ol start="0"> |
| <li><code>ls</code>: 显示服务列表</li> |
| <li><code>ls -l</code>: 显示服务详细信息列表</li> |
| <li><code>ls XxxService</code>: 显示服务的方法列表</li> |
| <li><code>ls -l XxxService</code>: 显示服务的方法详细信息列表</li> |
| </ol> |
| <h3 id="ps"><code>ps</code></h3> |
| <ol start="0"> |
| <li><code>ps</code>: 显示服务端口列表</li> |
| <li><code>ps -l</code>: 显示服务地址列表</li> |
| <li><code>ps 20880</code>: 显示端口上的连接信息</li> |
| <li><code>ps -l 20880</code>: 显示端口上的连接详细信息</li> |
| </ol> |
| <h3 id="cd"><code>cd</code></h3> |
| <ol start="0"> |
| <li><code>cd XxxService</code>: 改变缺省服务，当设置了缺省服务，凡是需要输入服务名作为参数的命令，都可以省略服务参数</li> |
| <li><code>cd /</code>: 取消缺省服务</li> |
| </ol> |
| <h3 id="pwd"><code>pwd</code></h3> |
| <p><code>pwd</code>: 显示当前缺省服务</p> |
| <h3 id="trace"><code>trace</code></h3> |
| <ol start="0"> |
| <li><code>trace XxxService</code>: 跟踪 1 次服务任意方法的调用情况</li> |
| <li><code>trace XxxService 10</code>: 跟踪 10 次服务任意方法的调用情况</li> |
| <li><code>trace XxxService xxxMethod</code>: 跟踪 1 次服务方法的调用情况</li> |
| <li><code>trace XxxService xxxMethod 10</code>: 跟踪 10 次服务方法的调用情况</li> |
| </ol> |
| <h3 id="count"><code>count</code></h3> |
| <ol start="0"> |
| <li><code>count XxxService</code>: 统计 1 次服务任意方法的调用情况</li> |
| <li><code>count XxxService 10</code>: 统计 10 次服务任意方法的调用情况</li> |
| <li><code>count XxxService xxxMethod</code>: 统计 1 次服务方法的调用情况</li> |
| <li><code>count XxxService xxxMethod 10</code>: 统计 10 次服务方法的调用情况</li> |
| </ol> |
| <h3 id="invoke"><code>invoke</code></h3> |
| <ol start="0"> |
| <li><code>invoke XxxService.xxxMethod(1234, &quot;abcd&quot;, {&quot;prop&quot; : &quot;value&quot;})</code>: 调用服务的方法</li> |
| <li><code>invoke com.xxx.XxxService.XxxService.xxxMethod(1234, &quot;abcd&quot;, {&quot;prop&quot; : &quot;value&quot;})</code>: 调用全路径服务的方法</li> |
| <li><code>invoke xxxMethod(1234, &quot;abcd&quot;, {&quot;prop&quot; : &quot;value&quot;})</code>: 调用服务的方法(自动查找包含此方法的服务)</li> |
| <li><code>invoke xxxMethod({&quot;name&quot;:&quot;zhangsan&quot;,&quot;age&quot;:12,&quot;class&quot;:&quot;org.apache.dubbo.qos.legacy.service.Person&quot;})</code> :当有参数重载，或者类型转换失败的时候，可以通过增加class属性指定需要转换类</li> |
| <li>当参数为Map&lt;Integer,T&gt;，key的类型为Integer时，建议指定类型。例如<code>invoke com.xxx.xxxApiService({&quot;3&quot;:0.123, &quot;class&quot;:&quot;java.util.HashMap&quot;})</code></li> |
| </ol> |
| <h3 id="select-2"><code>select</code> <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></h3> |
| <ol start="0"> |
| <li><code>select 1</code>: 当 invoke 命令匹配到多个方法时使用，根据提示列表选择需要调用的方法</li> |
| </ol> |
| <h3 id="status"><code>status</code></h3> |
| <ol start="0"> |
| <li><code>status</code>: 显示汇总状态，该状态将汇总所有资源的状态，当全部 OK 时则显示 OK，只要有一个 ERROR 则显示 ERROR，只要有一个 WARN 则显示 WARN</li> |
| <li><code>status -l</code>: 显示状态列表</li> |
| </ol> |
| <h3 id="log-1"><code>log</code> <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></h3> |
| <ol start="0"> |
| <li><code>log debug</code>: 修改 dubbo logger 的日志级别</li> |
| <li><code>log 100</code>: 查看 file logger 的最后 100 字符的日志</li> |
| </ol> |
| <h3 id="help"><code>help</code></h3> |
| <ol start="0"> |
| <li><code>help</code>: 显示 telnet 命帮助信息</li> |
| <li><code>help xxx</code>: 显示xxx命令的详细帮助信息</li> |
| </ol> |
| <h3 id="clear"><code>clear</code></h3> |
| <ol start="0"> |
| <li><code>clear</code>: 清除屏幕上的内容</li> |
| <li><code>clear 100</code>: 清除屏幕上的指定行数的内容</li> |
| </ol> |
| <h3 id="exit"><code>exit</code></h3> |
| <p><code>exit</code>: 退出当前 telnet 命令行</p> |
| <h3 id="shutdown-2"><code>shutdown</code> <sup id="fnref1:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></h3> |
| <ol start="0"> |
| <li><code>shutdown</code>: 关闭 dubbo 应用</li> |
| <li><code>shutdown -t 1000</code>: 延迟 1000 毫秒关闭 dubbo 应用</li> |
| </ol> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p><code>2.7.1</code> 以上版本支持&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a>&#160;<a href="#fnref1:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p><code>2.0.6</code> 以上版本支持&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Maven 插件参考手册</title><link>https://dubbo.apache.org/zh-cn/docs/references/maven/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/maven/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/">最新版本</a>。</p> |
| </div> |
| <h2 id="启动一个简易注册中心">启动一个简易注册中心</h2> |
| <p>以指定的 9099 端口启动一个简易注册中心 <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn dubbo:registry -Dport<span style="color:#719e07">=</span><span style="color:#2aa198">9099</span> |
| </span></span></code></pre></div><h2 id="生成-demo-服务提供者应用">生成 demo 服务提供者应用</h2> |
| <p>生成指定接口和版本的服务提供者应用：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn dubbo:create -Dapplication<span style="color:#719e07">=</span>xxx -Dpackage<span style="color:#719e07">=</span>com.alibaba.xxx -Dservice<span style="color:#719e07">=</span>XxxService,YyyService -Dversion<span style="color:#719e07">=</span>1.0.0 |
| </span></span></code></pre></div><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>如果端口不指定，默认端口为 9090&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: RPC协议</title><link>https://dubbo.apache.org/zh-cn/docs/references/protocols/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/protocols/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/protocol/">最新版本</a>。</p> |
| </div> |
| <p>Dubbo 中目前支持的RPC协议</p></description></item><item><title>Docs: 支持graalvm</title><link>https://dubbo.apache.org/zh-cn/docs/references/graalvm/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/graalvm/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/advanced-features-and-usage/performance/support-graalvm/">最新版本</a>。</p> |
| </div></description></item><item><title>Docs: 路由规则</title><link>https://dubbo.apache.org/zh-cn/docs/references/routers/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/routers/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/advanced-features-and-usage/traffic/">最新版本</a>。</p> |
| </div> |
| <h3 id="基本思想">基本思想</h3> |
| <p>基于路由链，采用Pipeline的处理方式，如下图所示：</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/route-rule1.png" alt="route-rule1.png"></p> |
| <p>可以把路由链的逻辑简单的理解为 target = rn(&hellip;r3(r2(r1(src))))。对于每一个 router 内部的逻辑，可以抽象为输入地址 addrs-in 与 router 中按全量地址 addrs-all 实现切分好的 n 个互不相交的地址池 addrs-pool-1 &hellip; addrs-pool-n 按实现定义好的规则取交集作为输出 addrs-out。以此类推，完成整个路由链的计算。</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/route-rule2.png" alt="route-rule2.png"></p> |
| <p>另外一方面，如果 router(n) 需要执行 fallback 逻辑的时候，那么需要经过 router(n) 就应该决定好 fallback 逻辑</p> |
| <h3 id="fallback-处理原则">fallback 处理原则</h3> |
| <p>由于多个 router 之间多个条件组件之后，很容易出现地址被筛选为空的情况，那么我们需要针对这情况进行 fallback 处理，保证业务在正确性的前提下，能够顺利找到有效地址。</p> |
| <p>首先我们看一下以下规则</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">apiVersion</span>: service.dubbo.apache.org/v1alpha1 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">kind</span>: VirtualService |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">metadata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: demo-route |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">spec</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">hosts</span>: |
| </span></span><span style="display:flex;"><span> - demo // 统一定义为应用名 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">dubbo</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">service</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">exact</span>: com.taobao.hsf.demoService:1.0.0 |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">exact</span>: com.taobao.hsf.demoService:2.0.0 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">routedetail</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: sayHello-String-method-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">match</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">method</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name_match</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">exact</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span> |
| </span></span><span style="display:flex;"><span> ..... |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">argp</span>: |
| </span></span><span style="display:flex;"><span> - string |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v1 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v2 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v3 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: sayHello-method-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">match</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">method</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name_match</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">exact</span>: <span style="color:#2aa198">&#34;s-method&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v2 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v3 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: interface-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v3 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">service</span>: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> .... |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">apiVersion</span>: service.dubbo.apache.org/v1alpha1 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">kind</span>: DestinationRule |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">metadata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: demo-route |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">spec</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subsets</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: v1 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">labels</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">sigma.ali/mg</span>: v1-host |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: v2 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">labels</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">sigma.ali/mg</span>: v2-host |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: v3 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">labels</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">sigma.ali/mg</span>: v3-host |
| </span></span></code></pre></div><p>我们以脚本路由为例，这个脚本路由的匹配条件是遵循一个原则的，就是匹配的范围是从精确到广泛的一个过程，在这个示例来说，就是 sayHello(string)参数 -&gt; sayHello 方法 -&gt; 接口级路由 的一个匹配查找过程。</p> |
| <p>那么如果我们已经满足某个条件，但是选到的 subset 地址为空，我们将如何进行 fallback 处理呢？</p> |
| <p>以匹配 sayHello(string)参数 条件为例，我们选择到的是 v1 subset,如果是空，我们可以向上一级是寻找地址，也就是方法级去寻找地址，具体的配置为下</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: sayHello-String-method-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">match</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">method</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name_match</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">exact</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span> |
| </span></span><span style="display:flex;"><span> ..... |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">argp</span>: |
| </span></span><span style="display:flex;"><span> - string |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v1 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v2 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v3 |
| </span></span></code></pre></div><p>此时我们选到的地址是 v2 方法级地址，如果 v2 还是没有地址，根据规则的定义，我们是可以 fallback 到 v3 接口级。</p> |
| <p>假设我们有一个方法匹配时，如果没有地址，需要不进行 fallback，直接报错，我们可以这样配置</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">apiVersion</span>: service.dubbo.apache.org/v1alpha1 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">kind</span>: VirtualService |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">metadata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: demo-route |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">spec</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">hosts</span>: |
| </span></span><span style="display:flex;"><span> - demo // 统一定义为应用名 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">dubbo</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">service</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">exact</span>: com.taobao.hsf.demoService:1.0.0 |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">exact</span>: com.taobao.hsf.demoService:2.0.0 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">routedetail</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: sayHello-String-method-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">match</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">method</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name_match</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">exact</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span> |
| </span></span><span style="display:flex;"><span> ..... |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">argp</span>: |
| </span></span><span style="display:flex;"><span> - string |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v1 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v2 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v3 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: sayHello-method-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">match</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">method</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name_match</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">exact</span>: <span style="color:#2aa198">&#34;s-method&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v2 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">fallback</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v3 |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: some-method-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">match</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">method</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name_match</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">exact</span>: <span style="color:#2aa198">&#34;some-method&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v4 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: interface-route |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">route</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">destination</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subset</span>: v3 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">service</span>: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> .... |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">apiVersion</span>: service.dubbo.apache.org/v1alpha1 |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">kind</span>: DestinationRule |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">metadata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: demo-route |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">spec</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">host</span>: demo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">subsets</span>: |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: v1 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">labels</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">sigma.ali/mg</span>: v1-host |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: v2 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">labels</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">sigma.ali/mg</span>: v2-host |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> - <span style="color:#268bd2">name</span>: v3 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">labels</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">sigma.ali/mg</span>: v3-host |
| </span></span></code></pre></div><p>从这个规则我们看出来匹配到 some-method 条件时对应的是 v4 subset，那么 v4 为空时，因为没有配置 fallback ，此时会直接报错</p> |
| <h4 id="fallback-处理原则总结">fallback 处理原则总结</h4> |
| <ul> |
| <li>我们应该在 VirtualService route 中配置好 Destination 的 fallback 处理逻辑</li> |
| <li>在 fallback subset 时，如果对应的 subset 也配置有 fallback subset 时，也应递归处理；fallback subset 之间的关系也应该是从具体到广泛</li> |
| <li>我们在编写匹配条件时，应该遵循从 具体条件到广泛条件 的原则</li> |
| </ul> |
| <h3 id="routechain-的组装模式-目前未实现">RouteChain 的组装模式 (目前未实现)</h3> |
| <p><img src="https://dubbo.apache.org/imgs/user/route-rule3.png" alt="route-rule3.png"></p> |
| <p>我们看到上面的图，在路由的过程当中，我们是 Pipeline 的处理方式，Pipeline 的 Router 节点存在顺序，并且每个 Router 都有一个唯一对应的 VirtualService 和 <strong>多个</strong> 相应的 DestinationRule 进行描述。</p> |
| <p>以 Nacos 上存着的路由规则配置为例，配置的格式如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">DataId</span>: Demo.rule.yaml |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">GROUP</span>: HSF |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">content</span>: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>VirtualService A |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span>DestinationRule A1 |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span>DestinationRule A2 |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span>VirtualService B |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span>DestinationRule B |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span>VirtualService C |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span>DestinationRule C |
| </span></span><span style="display:flex;"><span>--- |
| </span></span><span style="display:flex;"><span>... |
| </span></span></code></pre></div><p><code>VirtualService A</code> 与 <code>DestinationRule A1</code> 、<code>DestinationRule A2</code> 组成一个 Router A，<code>VirtualService B</code> 与 <code>DestinationRule B</code> 组成 Router B,以此类推，完成整个 router 链的组装。</p></description></item></channel></rss> |
