| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – References</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/</link><description>Recent content in References on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs/v2.7/user/references/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Schema Configuration Reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/</guid><description> |
| <p>The following pages show all the configuration properties <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> with XML Config <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup> as an example. For other configurations, please reference: <a href="../../configuration/properties">Properties Configuration</a>, <a href="../../configuration/annotation">Annotation Configuration</a>, <a href="../../configuration/api">API Configuration</a>.</p> |
| <p>All configuration properties fall into three categories, see the &ldquo;Function&rdquo; in the table below.</p> |
| <ul> |
| <li>Service discovery: used for service registration and discovery in order to find providers for consumers.</li> |
| <li>Service governance: used for service management and governance, such as to provide conveninence for dev or test.</li> |
| <li>Performance optinize: used for optimizing performance. Diffenent properties may has different performance impact.</li> |
| <li>All properties will transform into URL <sup id="fnref:3"><a href="#fn:3" class="footnote-ref" role="doc-noteref">3</a></sup> which is generated by provider. The url will be subscribed by consumers through registry. Please see the <code>Corresponding URL parameter</code> in the table below for each property.</li> |
| </ul> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Notice: These three properties, group, interface, and version determine a service. All other properties are used for service governance or performance optimize.&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <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:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:3"> |
| <p>URL format：<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: Protocol References</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/protocol/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/protocol/</guid><description> |
| <p>Dubbo protocol is recommended. The performance of each protocol, see: <a href="../../perf-test">Performance</a></p></description></item><item><title>Docs: Registry Server References</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/registry/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/registry/</guid><description> |
| <p>It is recommended to use <a href="zookeeper">zookeeper registry server</a></p></description></item><item><title>Docs: Metadata Reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/metadata/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/metadata/</guid><description> |
| <h2 id="background">Background</h2> |
| <p>There are close to <a href="https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-service/">30 configurations</a> in dubbo provider. Excluding registry center governance requirements, a large part of configurations are used by the provider itself and do not need to be delivered to the consumer. This part of the data does not need to be written to the registry, but only needs to be persisted as key-value. |
| There are also <a href="https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-reference/">20+ configurations</a> in dubbo consumer. In the registry center, only a few configurations such as application, version, group, ip, dubbo version are needed in the list of service consumers. Other configurations can also be persisted in key-value form. |
| This data is registered into the registry in the service dimension, which leads to the expansion of data volume, and then causes the increased network overhead of the registry (such as zookeeper) and decreased performance.</p> |
| <p>In addition to the storage of the above configuration items, Dubbo service metadata information also needs to be stored. Metadata information includes service interface and method information of interface. This information will be used for service mock, service test.</p> |
| <h2 id="goal">Goal</h2> |
| <p>The original data and metadata information in the registry center need to be stored in a separate key-value store, which can be DB, redis or other persistent storage. The core code supports zookeeper, redis(recommended) by default.</p> |
| <p>The format of provider storage content is the storage after gson&rsquo;s serialization of org.apache.dubbo.metadata.definition.model.FullServiceDefinition. |
| Consumer gets parameter information from the URL that it wrote to the registry and stores it in Map. That is, get the Map with URL.getParameterMap() and store it after gson&rsquo;s serialization.</p> |
| <p>For more details, you can refer to the sample below.</p> |
| <h2 id="configuration">Configuration</h2> |
| <p>The default metadata storage supports the following additional features:</p> |
| <ul> |
| <li>Failed retry</li> |
| <li>Refresh regularly</li> |
| </ul> |
| <h4 id="failed-retry">Failed retry</h4> |
| <p>Failed retries can be configured by retrytimes (retry times, default 100), retryperiod (retry cycle, default 3000ms).</p> |
| <h4 id="refresh-regularly">Refresh regularly</h4> |
| <p>It&rsquo;s opening by default and can be turned off by setting cycleReport=false.</p> |
| <h4 id="complete-configurations">Complete configurations:</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 ##Not necessary</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.password<span style="color:#719e07">=</span><span style="color:#2aa198">xxx ##Not necessary</span> |
| </span></span><span style="display:flex;"><span>dubbo.metadata-report.retry-times<span style="color:#719e07">=</span><span style="color:#2aa198">30 ##Not necessary,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 ##Not necessary,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 ##Not necessary,default true</span> |
| </span></span></code></pre></div><blockquote> |
| <p>If the metadata address (dubbo.metadata-report.address) is not configured, the writing of the entire metadata will not take effect, but it will not affect the running of the program.</p> |
| </blockquote> |
| <p>Let&rsquo;s look at a few sample configurations. Regardless of the configuration, some maven dependencies need to be introduced:</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>If redis is needed, the corresponding redis dependencies can be introduced:</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><blockquote> |
| <p><strong>Complete sample，refer to<a href="https://github.com/dubbo/dubbo-samples/tree/master">sample-2.7</a></strong></p> |
| </blockquote> |
| <h3 id="method-1-config-in-configcenter">Method 1: Config in Configcenter</h3> |
| <p>Refer to the sample: dubbo-samples-metadata-report/dubbo-samples-metadata-report-configcenter.</p> |
| <h5 id="configcenter-configuration">Configcenter Configuration</h5> |
| <p>Configurations of Configcenter，can refer to the document of Configcenter. As follows:</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">### Notice the hump style</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 ###Address of metadata storage</span> |
| </span></span></code></pre></div><p>In the sample, Zookeeper is used as the Configcenter. Run directly: org.Apache.Dubbo.Samples.Metadatareport.Configcenter.ZKTools after starting a local zookeeper service, then writing finished. |
| You can also use Nacos, Apollo as the Configcenter. These products themselves support ops configuration.</p> |
| <h5 id="application-configuration">Application Configuration</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>After completing the above two steps, the registry address and metadata address are retrieved from the Configcenter. You can now run the Provider and the Consumer in turn and get the corresponding output in console or view it directly through the client of zookeeper.</p> |
| <h5 id="provider-configuration">Provider Configuration</h5> |
| <p>The metadata stored on the Provider side is as follows:</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>The Provider side stores all the parameters that the Provider service fills in to the registry, as well as the method information of the service (method name, input and output format).</p> |
| <h5 id="consumer-configuration">Consumer Configuration</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>The Consumer side stores all the parameters that the Consumer fills in to the registry.</p> |
| <p>The above example is mainly a presentation of the provider side service information and consumer side service information stored in the metadata area by placing the metadata address in the Configcenter. |
| The next two examples focus on configuring in a project: the XML mode and the annotation mode .</p> |
| <h3 id="method-2-config-project-in-properties-way">Method 2: Config project in properties way</h3> |
| <p>Refer to the sample: dubbo-samples-metadata-report/dubbo-samples-metadata-report-local-xml.</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>After setting this configuration, have not to focus on others. You can also view the service information of the corresponding provider and consumer directly.</p> |
| <h5 id="provider-stores">Provider stores:</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-stores">Consumer stores:</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="method-3-config-project-in-annotation-way">Method 3: Config project in annotation way</h3> |
| <p>Refer to the sample: dubbo-samples-metadata-report/dubbo-samples-metadata-report-local-annotaion.</p> |
| <h5 id="bean-introduce-bean">@Bean introduce 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></span><span style="display:flex;"><span> MetadataReportConfig metadataReportConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> MetadataReportConfig(); |
| </span></span><span style="display:flex;"><span> metadataReportConfig.setAddress(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> metadataReportConfig; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>After introducing Bean, also have not to set others. View corresponding service information directly:</p> |
| <h5 id="provider-stores-1">Provider stores:</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-stores-1">Consumer stores:</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="extension">Extension</h2> |
| <h3 id="spi-definition">SPI Definition</h3> |
| <p>Refer to: 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:#2aa198">&#34;redis&#34;</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></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</span>({<span style="color:#2aa198">&#34;protocol&#34;</span>}) |
| </span></span><span style="display:flex;"><span> MetadataReport <span style="color:#268bd2">getMetadataReport</span>(URL url); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="custom-metadata-storage">Custom metadata storage</h3> |
| <p>Let&rsquo;s take Redis storage as an example to illustrate.</p> |
| <p>Create a new project supporting the following modifications:</p> |
| <h4 id="extend-abstractmetadatareport">Extend 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></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.getLogger(RedisMetadataReport.class); |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> JedisPool pool; |
| </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>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span>(url); |
| </span></span><span style="display:flex;"><span> pool <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> JedisPool(<span style="color:#719e07">new</span> JedisPoolConfig(), url.getHost(), url.getPort()); |
| </span></span><span style="display:flex;"><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>(ProviderMetadataIdentifier providerMetadataIdentifier, String serviceDefinitions) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span>.storeMetadata(providerMetadataIdentifier, serviceDefinitions); |
| </span></span><span style="display:flex;"><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>(ConsumerMetadataIdentifier consumerMetadataIdentifier, String value) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span>.storeMetadata(consumerMetadataIdentifier, value); |
| </span></span><span style="display:flex;"><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>(MetadataIdentifier metadataIdentifier, String v) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> (Jedis jedis <span style="color:#719e07">=</span> pool.getResource()) { |
| </span></span><span style="display:flex;"><span> jedis.set(metadataIdentifier.getIdentifierKey() <span style="color:#719e07">+</span> META_DATA_SOTRE_TAG, v); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable e) { |
| </span></span><span style="display:flex;"><span> logger.error(<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.getMessage(), e); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> RpcException(<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.getMessage(), e); |
| </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><h4 id="extend-abstractmetadatareportfactory">Extend 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></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>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> RedisMetadataReport(url); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h4 id="new-meta-infdubbointernalorgapachedubbometadatastoremetadatareportfactory">New META-INF/dubbo/internal/org.apache.dubbo.metadata.store.MetadataReportFactory</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>redis<span style="color:#719e07">=</span><span style="color:#2aa198">org.apache.dubbo.metadata.store.redis.RedisMetadataReportFactory</span> |
| </span></span></code></pre></div><p>As long as the above modifications along with the project are packaged into a jar, then config metadata center url: redis://10.20.153.10:6379.</p> |
| <p>Up to now, a custom metadata store is ready to run.</p></description></item><item><title>Docs: API Reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/api/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/api/</guid><description> |
| <p>Generally speaking, dubbo keeps its functionality no intrusive as much as possible, but for some particular features, there&rsquo;s no other way not only API can achieve. |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Warning</h4> |
| Do not rely on APIs other than what&rsquo;re mentioned here, otherwise your application may face the risk of incompatibility after upgrade dubbo. |
| </div> |
| These APIs are summarized here below:</p> |
| <h2 id="configuration-api">Configuration 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>Pls. refer to <a href="../../configuration/api">API Configuration</a> for further information.</p> |
| <h2 id="annotation-api">Annotation 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.Service |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.config.annotation.Reference |
| </span></span></code></pre></div><p>Pls. refer to <a href="../../configuration/annotation">Annotation Configuration</a> for further information.</p> |
| <h2 id="model-api">Model 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="context-api">Context 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>Pls. refer to <a href="../../examples/context">context</a> &amp; <a href="../../examples/attachment">pass parameter in attachment</a> &amp; <a href="../../examples/async-call">asynchronous call</a> for further information.</p> |
| <h2 id="service-api">Service 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>Pls. refer to <a href="../../examples/generic-reference">generic reference</a> &amp; <a href="../../examples/generic-service">generic service</a> for further information.</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>Pls. refer to <a href="../../examples/echo-service">test via echo service</a> for further details.</p></description></item><item><title>Docs: Qos Command Usage</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/qos/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/qos/</guid><description> |
| <p>In dubbo <code>2.5.8</code> a new QOS module is introduced, to provide new telnet command support.</p> |
| <h2 id="port">Port</h2> |
| <p>the port of new version telnet is different from the port of dubbo protocol. The default port is <code>22222</code>, which can be changed by modifying configuration file <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>or by modifying the JVM parameter</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="safety">Safety</h2> |
| <p>By default, dubbo can receive any command sent from the host, which can be changed by modifying the configuration file <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>or by configuring the JVM parameter</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>to reject command sent from the remote host, allowing only the local server to run the command</p> |
| <h2 id="telnet-and-http-protocol">Telnet and HTTP protocol</h2> |
| <p>The telnet module supports both http and telnet protocol, in order to facilitate the use of various situations</p> |
| <p>For example,</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="supported-commands">Supported Commands</h2> |
| <h3 id="ls-list-consumers-and-providers">ls List consumers and providers</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>List the services of the provides and the consumers that dubbo provide</p> |
| <h3 id="online-service-command">Online service command</h3> |
| <p>When using delay publishing function(org.apache.dubbo.config.AbstractServiceConfig#register set as false), you can use “online” command to online the service</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>//online all services |
| </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>//online part of servies according to regularity. |
| </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>Common usage situations:</p> |
| <ul> |
| <li>Because there is no JIT or the related resources warm-up, when the machine is restarted and the online QPS is relatively high , a large amount of timeout situations may occur. At this time,the problem can be solved by distributing the batch service and increasing the traffic gradually.</li> |
| <li>A machine needs to be back online after going offline due to some reasons.</li> |
| </ul> |
| <h3 id="offline-service-command">Offline service Command</h3> |
| <p>Offline command can be used if temporary offline service is needed when fault occurs.</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>//offline all service |
| </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>//offline some services according to regular rules |
| </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-command">help command</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>//list all commands |
| </span></span><span style="display:flex;"><span>dubbo&gt;help |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>//list the specific use case of a command |
| </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>dubbo&gt; |
| </span></span></code></pre></div><h2 id="qos-parameters">QoS&rsquo; Parameters</h2> |
| <p>You can use parameters that QoS provides to config its startup. These parameters include:</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Parameter</th> |
| <th>Explanation</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>qosEnable</td> |
| <td>Activate QoS or not</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>qosPort</td> |
| <td>The port QoS would bind to</td> |
| <td>22222</td> |
| </tr> |
| <tr> |
| <td>qosAcceptForeignIp</td> |
| <td>Enable remote access or not</td> |
| <td>false</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <p>Attention. From 2.6.4/2.7.0, <code>qosAcceptForeignIp</code> is set to <code>false</code> by default, because it&rsquo;s risky if this property is set to <code>true</code>. Think twice before you turn it on.</p> |
| </blockquote> |
| <p>You can configure these parameters in the following ways:</p> |
| <ul> |
| <li>System property</li> |
| <li><code>dubbo.properties</code></li> |
| <li>XML</li> |
| <li>Spring-boot auto configuration</li> |
| </ul> |
| <p>They have priority in the following order: system property &gt; <code>dubbo.properties</code> &gt; XML &gt; spring-boot.</p> |
| <h3 id="system-property">System Property</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"><code>Dubbo.properties</code></h3> |
| <p>Create a <code>dubbo.properties</code> file in this directory <code>src/main/resources</code> in your project, and copy the following codes into it:</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>If you are going to config using XML, you can try this:</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-auto-configuration">spring-boot auto configuration</h3> |
| <p>If you are developing a spring-boot application, you can configure in <code>application.properties</code> or <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.qosEnable=true |
| </span></span><span style="display:flex;"><span>dubbo.application.qosPort=33333 |
| </span></span><span style="display:flex;"><span>dubbo.application.qosAcceptForeignIp=false |
| </span></span></code></pre></div></description></item><item><title>Docs: Telnet Command Reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/telnet/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/telnet/</guid><description> |
| <p>Since <code>2.0.5</code> dubbo starts supporting to use telnet command to govern services.</p> |
| <h2 id="how-to-use">How To Use</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>Or:</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><h2 id="supported-commands">Supported Commands</h2> |
| <p>The built-in telnet commands are listed below. Furthermore, it is possible to extend telnet commands, pls. refer to |
| <a href="https://dubbo.apache.org/en/docs/v2.7/user/references/telnet/">extend telnet command</a> for more details.</p> |
| <h3 id="ls"><code>ls</code></h3> |
| <ol start="0"> |
| <li><code>ls</code>: list services</li> |
| <li><code>ls -l</code>: list services in more details</li> |
| <li><code>ls XxxService</code>: list methods for the particular service</li> |
| <li><code>ls -l XxxService</code>: list methods for the particular service in more dtails</li> |
| </ol> |
| <h3 id="ps"><code>ps</code></h3> |
| <ol start="0"> |
| <li><code>ps</code>: list service ports</li> |
| <li><code>ps -l</code>: list service addresses</li> |
| <li><code>ps 20880</code>: show connection info for the particular port</li> |
| <li><code>ps -l 20880</code>: show connection info for the particular port in more details</li> |
| </ol> |
| <h3 id="cd"><code>cd</code></h3> |
| <ol start="0"> |
| <li><code>cd XxxService</code>: switch default service. When default service is set, service parameter can be ignored in all commands when it&rsquo;s needed</li> |
| <li><code>cd /</code>: reset default service</li> |
| </ol> |
| <h3 id="pwd"><code>pwd</code></h3> |
| <p><code>pwd</code>: show what current default service is</p> |
| <h3 id="trace"><code>trace</code></h3> |
| <ol start="0"> |
| <li><code>trace XxxService</code>: trace method invocation once for the given service</li> |
| <li><code>trace XxxService 10</code>: trace method invocations 10 times for the given service</li> |
| <li><code>trace XxxService xxxMethod</code>: trace particular method invocation once for the given service</li> |
| <li><code>trace XxxService xxxMethod 10</code>: trace particular method invocations 10 times for the given service</li> |
| </ol> |
| <h3 id="count"><code>count</code></h3> |
| <ol start="0"> |
| <li><code>count XxxService</code>: count method invocation once for the given service</li> |
| <li><code>count XxxService 10</code>: count method invocations 10 times for the given service</li> |
| <li><code>count XxxService xxxMethod</code>: count particular method invocation once for the given service</li> |
| <li><code>count XxxService xxxMethod 10</code>: count particular method invocation 10 times for the given service</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>: invoke particular method for the given service</li> |
| <li><code>invoke com.xxx.XxxService.XxxService.xxxMethod(1234, &quot;abcd&quot;, {&quot;prop&quot; : &quot;value&quot;})</code>: invoke particular method for the given service</li> |
| <li><code>invoke xxxMethod(1234, &quot;abcd&quot;, {&quot;prop&quot; : &quot;value&quot;})</code>: invoke particular method for the default service</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> :When there is parameter overload, or the type conversion fails, you can specify the class to be converted by adding the class attribute</li> |
| <li>When the parameter is Map&lt;Integer, T&gt; and the key type is Integer, it is recommended to specify the type. E.g:<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>: used when the invoke command matches multiple methods, select the method to be called according to the prompt list</li> |
| </ol> |
| <h3 id="status"><code>status</code></h3> |
| <ol start="0"> |
| <li><code>status</code>: show summarized status. This status summarizes statuses from all resources, and it shows OK when all resources are OK, shows ERROR when any resource has ERROR, and WARN when any has WARN.</li> |
| <li><code>status -l</code>: show status list</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>: modify logger level to debug</li> |
| <li><code>log 100</code>: examine the last 100 characters from the file logger</li> |
| </ol> |
| <h3 id="help"><code>help</code></h3> |
| <ol start="0"> |
| <li><code>help</code>: show help for telnet commands</li> |
| <li><code>help xxx</code>: show help for particular telnet command</li> |
| </ol> |
| <h3 id="clear"><code>clear</code></h3> |
| <ol start="0"> |
| <li><code>clear</code>: clear screen</li> |
| <li><code>clear 100</code>: only clear particular lines on the screen</li> |
| </ol> |
| <h3 id="exit"><code>exit</code></h3> |
| <p><code>exit</code>: exit current telnet session</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>: shutdown dubbo application</li> |
| <li><code>shutdown -t 1000</code>: delay 1000 ms to shutdown dubbo application</li> |
| </ol> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>support since <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>support since <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 Plugin Reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/maven/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/maven/</guid><description> |
| <h2 id="start-a-simple-registry-server">Start a simple registry server</h2> |
| <p>Start a simple registry server listening on port 9099:</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Info</h4> |
| Default port is 9090 if the port is not specified |
| </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-bash" data-lang="bash"><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="generate-a-service-provider-demo-application">Generate a service provider demo application</h2> |
| <p>Generate a service provider with the specified interface and version:</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-bash" data-lang="bash"><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></description></item></channel></rss> |
