| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Configuration Manual</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/</link><description>Recent content in Configuration Manual on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs3-V2: Configuration Overview</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/overview/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/overview/</guid><description> |
| <p>Quickly jump to the content you care about through the following links:</p> |
| <ul> |
| <li><a href="../../../quick-start/spring-boot/">Use Spring Boot to quickly develop Dubbo applications</a></li> |
| <li><a href="../properties">Configuration item reference manual to know what configuration items are available</a></li> |
| <li><a href="../principle">How configuration loading and overriding works</a></li> |
| </ul> |
| <h2 id="configuration-components">Configuration components</h2> |
| <p>In order to better manage various configurations, Dubbo abstracts a set of structured configuration components. Each component is generally divided by purpose and controls the behavior of different scopes.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-config.jpg" alt="dubbo-config"></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Component Name</th> |
| <th>Description</th> |
| <th>Scope</th> |
| <th>Required</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>application</td> |
| <td>Specify the application-level information such as the application name</td> |
| <td>Only one application is allowed in an application</td> |
| <td>Required</td> |
| </tr> |
| <tr> |
| <td>service</td> |
| <td>Declare a common interface or implementation class as a Dubbo service</td> |
| <td>There can be 0 or more services in an application</td> |
| <td>At least one service/reference</td> |
| </tr> |
| <tr> |
| <td>reference</td> |
| <td>Declare a common interface as a Dubbo service</td> |
| <td>There can be 0 or more references in an application</td> |
| <td>At least one service/reference</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td>The RPC protocol to be exposed and related configurations such as port numbers, etc.</td> |
| <td>One application can be configured with multiple, one protocol can be used for a set of service&amp;reference</td> |
| <td>optional, default dubbo</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td>Registry type, address and related configuration</td> |
| <td>Multiple configurations can be made in one application, and one registry can be applied to a group of service&amp;references</td> |
| <td>Mandatory</td> |
| </tr> |
| <tr> |
| <td>config-center</td> |
| <td>configuration center type, address and related configurations</td> |
| <td>multiple configurations in one application, shared by all services</td> |
| <td>optional</td> |
| </tr> |
| <tr> |
| <td>metadata-report</td> |
| <td>metadata center type, address and related configuration</td> |
| <td>multiple configurations in one application, shared by all services</td> |
| <td>optional</td> |
| </tr> |
| <tr> |
| <td>Consumer</td> |
| <td>The default configuration shared between references</td> |
| <td>Multiple configurations can be configured in one application, and one consumer can act on a group of references</td> |
| <td>Optional</td> |
| </tr> |
| <tr> |
| <td>Provider</td> |
| <td>The default configuration shared between services</td> |
| <td>Multiple configurations can be configured in one application, and one provider can be used for a group of services</td> |
| <td>Optional</td> |
| </tr> |
| <tr> |
| <td>monitor</td> |
| <td>monitoring system type and address</td> |
| <td>only one can be configured in an application</td> |
| <td>optional</td> |
| </tr> |
| <tr> |
| <td>metrics</td> |
| <td>related configuration of the data acquisition module</td> |
| <td>only one configuration is allowed in an application</td> |
| <td>optional</td> |
| </tr> |
| <tr> |
| <td>ssl</td> |
| <td>ssl/tls security link-related certificate configuration</td> |
| <td>Only one configuration is allowed in an application</td> |
| <td>optional</td> |
| </tr> |
| <tr> |
| <td>method</td> |
| <td>specifies method-level configuration</td> |
| <td>subconfigurations for service and reference</td> |
| <td>optional</td> |
| </tr> |
| <tr> |
| <td>argument</td> |
| <td>parameter configuration of a method</td> |
| <td>subconfiguration of method</td> |
| <td>optional</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <ol> |
| <li>From the perspective of implementation principle, all configuration items of Dubbo will be assembled into the URL in the end, and the URL will be used as the carrier to pass during subsequent startup and RPC calls, thereby controlling the behavior of the framework. For more information, please refer to the Dubbo source code analysis series of documents or [Blog](/zh-cn/blog/2019/10/17/dubbo-in-url-unified model/#rpc call).</li> |
| <li>For the specific configuration items supported by each component and their meanings, please refer to <a href="../properties">Configuration Item Manual</a></li> |
| </ol> |
| </blockquote> |
| <h3 id="service-and-reference">service and reference</h3> |
| <p><code>service</code> and <code>reference</code> are the two most basic configuration items of Dubbo, they are used to register a specified interface or implementation class as a Dubbo service, and control the behavior of the service through configuration items.</p> |
| <ul> |
| <li><code>service</code> is used on the service provider side, the interface and implementation class configured by <code>service</code> will be defined as a standard Dubbo service, so as to provide external RPC request services.</li> |
| <li><code>reference</code> is used for service consumers, the interface configured by <code>reference</code> will be defined as a standard Dubbo service, and the generated proxy can initiate an RPC request to the remote end.</li> |
| </ul> |
| <p>Any number of <code>service</code> and <code>reference</code> can be configured in an application.</p> |
| <h3 id="consumer-and-provider">consumer and provider</h3> |
| <ul> |
| <li>When there are multiple <code>reference</code> configurations in the application, <code>consumer</code> specifies the default values shared by these <code>reference</code>s, such as shared timeouts, etc. to simplify cumbersome configurations, such as setting configurations separately in a <code>reference</code> Item value, the configuration in this <code>reference</code> takes precedence.</li> |
| <li>When there are multiple <code>service</code> configurations in the application, <code>provider</code> specifies the default value shared by these <code>service</code>, if a configuration item value is set separately in a <code>service</code>, the configuration priority in the <code>service</code> higher.</li> |
| </ul> |
| <blockquote> |
| <p>The consumer component can also carry out virtual grouping of references, and references under different groups can have different consumer default value settings; for example, in XML format configuration, the &lt;dubbo:reference /&gt; tag can be nested in &lt;dubbo:consumer / &gt; Implement grouping within tags. The same effect can also be achieved between provider and service.</p> |
| </blockquote> |
| <h2 id="configuration-method">configuration method</h2> |
| <p>According to the driving mode, it can be divided into the following five modes:</p> |
| <h3 id="api-configuration">API configuration</h3> |
| <p>The configuration is organized in the form of Java coding, including Raw API and Bootstrap API. For details, please refer to <a href="../api">API configuration</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> IOException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ServiceConfig<span style="color:#719e07">&lt;</span>GreetingsService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setApplication<span style="color:#719e07">(</span><span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;first-dubbo-provider&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRegistry<span style="color:#719e07">(</span><span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;multicast://224.5.6.7:1234&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>GreetingsService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> GreetingsServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span> <span style="color:#268bd2">export</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;first-dubbo-provider is running.&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>in<span style="color:#719e07">.</span>read<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="xml-configuration">XML configuration</h3> |
| <p>Configure various components in XML and support seamless integration with Spring. For details, please refer to <a href="../xml">XML Configuration</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:#586e75">&lt;!-- dubbo-provier.xml --&gt;</span> |
| </span></span><span style="display:flex;"><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: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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span> simplified=<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:metadata-report</span> address=<span style="color:#2aa198">&#34;redis://127.0.0.1:6379&#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></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.samples.basic.impl.DemoServiceImpl&#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.samples.basic.api.DemoService&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="annotation-configuration">Annotation configuration</h3> |
| <p>Expose services and reference service interfaces in the form of annotations, and support seamless integration with Spring. For details, please refer to <a href="../annotation">Annotation Configuration</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-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#586e75">// AnnotationService service implementation |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@DubboService</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AnnotationServiceImpl</span> <span style="color:#268bd2">implements</span> AnnotationService <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> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;async provider received: &#34;</span> <span style="color:#719e07">+</span> name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;annotation: hello, &#34;</span> <span style="color:#719e07">+</span> name<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><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> |
| </span></span><span style="display:flex;"><span>dubbo.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">annotation-provider</span> |
| </span></span><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>dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">20880</span> |
| </span></span></code></pre></div><h3 id="spring-boot">Spring Boot</h3> |
| <p>Use Spring Boot to reduce unnecessary configuration, and combine Annotation and application.properties/application.yml to develop Dubbo applications. For details, please refer to <a href="../annotation">Annotation Configuration</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-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75">## application.properties</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Spring boot application</span> |
| </span></span><span style="display:flex;"><span>spring.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo-externalized-configuration-provider-sample</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Base packages to scan Dubbo Component: @com.alibaba.dubbo.config.annotation.Service</span> |
| </span></span><span style="display:flex;"><span>dubbo.scan.base-packages<span style="color:#719e07">=</span><span style="color:#2aa198">com.alibaba.boot.dubbo.demo.provider.service</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Dubbo Application</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## The default value of dubbo.application.name is ${spring.application.name}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## dubbo.application.name=${spring.application.name}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">#Dubbo Protocol</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">12345</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## Dubbo Registry</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address<span style="color:#719e07">=</span><span style="color:#2aa198">N/A</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## DemoService version</span> |
| </span></span><span style="display:flex;"><span>demo.service.version<span style="color:#719e07">=</span><span style="color:#2aa198">1.0.0</span> |
| </span></span></code></pre></div><h3 id="property-configuration">Property configuration</h3> |
| <p>Generate configuration components according to the attribute Key-value, similar to SpringBoot&rsquo;s ConfigurationProperties, please refer to <a href="../properties">property configuration</a> for details.</p> |
| <p>Another important feature of property configuration is [property override](../principle/#32-property override), which overrides the created configuration component property with the value of an external property.</p> |
| <p>If you want to put the attribute configuration in an external configuration center, please refer to [Externalized Configuration](../principle/#33-Externalized Configuration).</p> |
| <p>In addition to the differences in peripheral drive methods, Dubbo&rsquo;s configuration reading generally follows the following principles:</p> |
| <ol> |
| <li>Dubbo supports multi-level configuration, and automatically realizes the coverage between configurations according to the predetermined priority. Finally, all configurations are summarized into the data bus URL to drive subsequent service exposure, reference and other processes.</li> |
| <li>The configuration format is mainly Properties, and the configuration content follows the agreed <code>path-based</code>[naming convention](../principle/#1-configuration format)</li> |
| </ol> |
| <h2 id="configure-the-loading-process">Configure the loading process</h2> |
| <h3 id="configuration-specifications-and-sources">Configuration specifications and sources</h3> |
| <p>Dubbo follows a <a href="../principle/">path-based configuration specification</a>, and each configuration component can be expressed in this way. In terms of configuration sources, a total of 6 configuration sources are supported, that is, Dubbo will try to load configuration data from the following locations:</p> |
| <ul> |
| <li>JVM System Properties, JVM -D parameter</li> |
| <li>System environment, the environment variable of the JVM process</li> |
| <li>Externalized Configuration, [externalized configuration] (../principle/#33-externalized configuration), read from the configuration center</li> |
| <li>Application Configuration, application attribute configuration, extract the attribute set starting with &ldquo;dubbo&rdquo; from the Spring application Environment</li> |
| <li>The configuration collected by programming interfaces such as API/XML/annotation can be understood as a kind of configuration source, which is a configuration collection method directly oriented to user programming</li> |
| <li>Read configuration file dubbo.properties from classpath</li> |
| </ul></description></item><item><title>Docs3-V2: API Configuration</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/api/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/api/</guid><description> |
| <p>Assemble configuration, start Dubbo, publish and subscribe services through API coding. This method can support dynamic creation of ReferenceConfig/ServiceConfig, combined with generalized calls to meet the needs of API Gateway or test platform.</p> |
| <blockquote> |
| <p>Reference <a href="https://github.com/apache/dubbo-samples/tree/master/1-basic/dubbo-samples-api">API Samples</a></p> |
| </blockquote> |
| <h2 id="service-provider">service provider</h2> |
| <p>Expose the service interface through ServiceConfig, and publish the service interface to the registration center.</p> |
| <blockquote> |
| <p>Note: In order to better support Dubbo3 application-level service discovery, it is recommended to use the new <a href="#bootstrap-api">DubboBootstrap API</a>.</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ProviderConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ServiceConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.xxx.DemoService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.xxx.DemoServiceImpl<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">class</span> <span style="color:#268bd2">DemoProvider</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// service implementation |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> DemoService demoService <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> DemoServiceImpl<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// current application configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ApplicationConfig application <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> application<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo-provider&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// connect registry configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> RegistryConfig registry <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> registry<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://10.20.130.230:2181&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// service provider protocol configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ProtocolConfig protocol <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> protocol<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocol<span style="color:#719e07">.</span>setPort<span style="color:#719e07">(</span>12345<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocol<span style="color:#719e07">.</span>setThreads<span style="color:#719e07">(</span>200<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Note: ServiceConfig is a heavy object, which internally encapsulates the connection with the registration center and opens the service port |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// The service provider exposes the service configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ServiceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;();</span> <span style="color:#586e75">// This instance is very heavy and encapsulates the connection with the registration center, please cache it yourself, otherwise it may cause memory and connection leaks |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> service<span style="color:#719e07">.</span> <span style="color:#268bd2">setApplication</span><span style="color:#719e07">(</span>application<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRegistry<span style="color:#719e07">(</span>registry<span style="color:#719e07">);</span> <span style="color:#586e75">// Multiple registries can use setRegistries() |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> service<span style="color:#719e07">.</span>setProtocol<span style="color:#719e07">(</span>protocol<span style="color:#719e07">);</span> <span style="color:#586e75">// multiple protocols can use setProtocols() |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> service<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span>demoService<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// expose and register services |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> service<span style="color:#719e07">.</span> <span style="color:#268bd2">export</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Suspend waiting (to prevent the process from exiting) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> System<span style="color:#719e07">.</span>in<span style="color:#719e07">.</span>read<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><h2 id="service-consumer">Service Consumer</h2> |
| <p>Reference the remote service through ReferenceConfig, and subscribe to the service interface from the registry.</p> |
| <blockquote> |
| <p>Note: In order to better support Dubbo3 application-level service discovery, it is recommended to use the new <a href="#bootstrap-api">DubboBootstrap API</a>.</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ConsumerConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ReferenceConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.xxx.DemoService<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">class</span> <span style="color:#268bd2">DemoConsumer</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// current application configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ApplicationConfig application <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> application<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo-consumer&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// connect registry configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> RegistryConfig registry <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> registry<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://10.20.130.230:2181&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Note: ReferenceConfig is a heavy object, which internally encapsulates the connection with the registry and the connection with the service provider |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// reference the remote service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;();</span> <span style="color:#586e75">// This instance is very heavy and encapsulates the connection with the registry and the provider, please cache it yourself, otherwise it may cause memory and connection leaks |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> reference<span style="color:#719e07">.</span>setApplication<span style="color:#719e07">(</span>application<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> reference<span style="color:#719e07">.</span>setRegistry<span style="color:#719e07">(</span>registry<span style="color:#719e07">);</span> <span style="color:#586e75">// Multiple registries can use setRegistries() |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> reference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> reference<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// use demoService like local bean |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// Note: This proxy object internally encapsulates all communication details, the object is heavy, please cache and reuse |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> DemoService demoService <span style="color:#719e07">=</span> reference<span style="color:#719e07">.</span> <span style="color:#268bd2">get</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> demoService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Dubbo&#34;</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><h2 id="bootstrap-api">Bootstrap API</h2> |
| <p>DubboBootstrap API can reduce repeated configuration, better control the startup process, support batch publishing/subscribing service interfaces, and better support Dubbo3&rsquo;s application-level service discovery.</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:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ProviderConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ServiceConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.xxx.DemoService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.xxx.DemoServiceImpl<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">class</span> <span style="color:#268bd2">DemoProvider</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// service provider protocol configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ProtocolConfig protocol <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> protocol<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocol<span style="color:#719e07">.</span>setPort<span style="color:#719e07">(</span>12345<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocol<span style="color:#719e07">.</span>setThreads<span style="color:#719e07">(</span>200<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Note: ServiceConfig is a heavy object, which internally encapsulates the connection with the registration center and opens the service port |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// The service provider exposes the service configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ServiceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> demoServiceConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> demoServiceConfig<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> demoServiceConfig<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> DemoServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> demoServiceConfig<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Second service configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ServiceConfig<span style="color:#719e07">&lt;</span>FooService<span style="color:#719e07">&gt;</span> fooServiceConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> fooServiceConfig<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>FooService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> fooServiceConfig<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> FooServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> fooServiceConfig<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Use DubboBootstrap to simplify configuration assembly and control the startup process |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> DubboBootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">getInstance</span><span style="color:#719e07">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>application<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo-provider&#34;</span><span style="color:#719e07">)</span> <span style="color:#586e75">// application configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>registry<span style="color:#719e07">(</span><span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">))</span> <span style="color:#586e75">// registry configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>protocol<span style="color:#719e07">(</span>protocol<span style="color:#719e07">)</span> <span style="color:#586e75">// global default protocol configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>service<span style="color:#719e07">(</span>demoServiceConfig<span style="color:#719e07">)</span> <span style="color:#586e75">// add ServiceConfig |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>service<span style="color:#719e07">(</span>fooServiceConfig<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>start<span style="color:#719e07">()</span> <span style="color:#586e75">// start Dubbo |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>await<span style="color:#719e07">();</span> <span style="color:#586e75">// suspend waiting (to prevent the process from exiting) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ProviderConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ServiceConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.xxx.DemoService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.xxx.DemoServiceImpl<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">class</span> <span style="color:#268bd2">DemoConsumer</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// reference the remote service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> demoServiceReference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span> demoServiceReference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> demoServiceReference<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> ReferenceConfig<span style="color:#719e07">&lt;</span>FooService<span style="color:#719e07">&gt;</span> fooServiceReference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>FooService<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span> fooServiceReference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>FooService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> fooServiceReference<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Use DubboBootstrap to simplify configuration assembly and control the startup process |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> DubboBootstrap bootstrap <span style="color:#719e07">=</span> DubboBootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">getInstance</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> bootstrap<span style="color:#719e07">.</span>application<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo-consumer&#34;</span><span style="color:#719e07">)</span> <span style="color:#586e75">// application configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>registry<span style="color:#719e07">(</span><span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">))</span> <span style="color:#586e75">// registry configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>reference<span style="color:#719e07">(</span>demoServiceReference<span style="color:#719e07">)</span> <span style="color:#586e75">// add ReferenceConfig |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>service<span style="color:#719e07">(</span>fooServiceReference<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>start<span style="color:#719e07">();</span> <span style="color:#586e75">// Start Dubbo |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// use demoService like local bean |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// Obtain the remote service interface proxy through Interface, without relying on the ReferenceConfig object |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> DemoService demoService <span style="color:#719e07">=</span> DubboBootstrap<span style="color:#719e07">.</span>getInstance<span style="color:#719e07">().</span>getCache<span style="color:#719e07">().</span>get<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> demoService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Dubbo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> FooService fooService <span style="color:#719e07">=</span> DubboBootstrap<span style="color:#719e07">.</span>getInstance<span style="color:#719e07">().</span>getCache<span style="color:#719e07">().</span>get<span style="color:#719e07">(</span>FooService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> fooService<span style="color:#719e07">.</span> <span style="color:#268bd2">greeting</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Dubbo&#34;</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></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="other-configuration">Other configuration</h2> |
| <ul> |
| <li>basic configuration</li> |
| <li>Method level configuration</li> |
| <li>Point-to-point direct connection</li> |
| </ul> |
| <p>The API provides the most flexible and rich configuration capabilities, the following are some examples of configurable components.</p> |
| <h4 id="basic-configuration">basic configuration</h4> |
| <p>Global basic configuration can be set in DubboBootstrap, including application configuration, protocol configuration, registration center, configuration center, metadata center, module, monitoring, SSL, provider configuration, consumer configuration, etc.</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:#586e75">// registry |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>RegistryConfig registry <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://192.168.10.1:2181&#34;</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></span><span style="display:flex;"><span><span style="color:#586e75">// service provider protocol configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ProtocolConfig protocol <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>protocol<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>protocol<span style="color:#719e07">.</span>setPort<span style="color:#719e07">(</span>12345<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>protocol<span style="color:#719e07">.</span>setThreads<span style="color:#719e07">(</span>200<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></span><span style="display:flex;"><span><span style="color:#586e75">// configuration center |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></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://192.168.10.2:2181&#34;</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></span><span style="display:flex;"><span><span style="color:#586e75">// metadata center |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>MetadataReportConfig metadataReport <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> MetadataReportConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>metadataReport<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://192.168.10.3:2181&#34;</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></span><span style="display:flex;"><span><span style="color:#586e75">// Metrics |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>MetricsConfig metrics <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> MetricsConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>metrics<span style="color:#719e07">.</span>setProtocol<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo&#34;</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></span><span style="display:flex;"><span><span style="color:#586e75">// SSL |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>SslConfig ssl <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> SslConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>ssl<span style="color:#719e07">.</span>setServerKeyCertChainPath<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;/path/ssl/server-key-cert-chain&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>ssl<span style="color:#719e07">.</span>setServerPrivateKeyPath<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;/path/ssl/server-private-key&#34;</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></span><span style="display:flex;"><span><span style="color:#586e75">// Provider configuration (ServiceConfig default configuration) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ProviderConfig provider <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProviderConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>provider<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>provider<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</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></span><span style="display:flex;"><span><span style="color:#586e75">// Consumer configuration (ReferenceConfig default configuration) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ConsumerConfig consumer <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConsumerConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>consumer<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>consumer<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>consumer<span style="color:#719e07">.</span>setTimeout<span style="color:#719e07">(</span>2000<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></span><span style="display:flex;"><span>DubboBootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">getInstance</span><span style="color:#719e07">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>application<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo-app&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>registry<span style="color:#719e07">(</span>registry<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>protocol<span style="color:#719e07">(</span>protocol<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>configCenter<span style="color:#719e07">(</span>configCenter<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>metadataReport<span style="color:#719e07">(</span>metadataReport<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>module<span style="color:#719e07">(</span><span style="color:#719e07">new</span> ModuleConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;module&#34;</span><span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>metrics<span style="color:#719e07">(</span>metrics<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>ssl <span style="color:#719e07">(</span>ssl<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>provider<span style="color:#719e07">(</span>provider<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>consumer<span style="color:#719e07">(</span>consumer<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>start<span style="color:#719e07">();</span> |
| </span></span></code></pre></div><h4 id="method-level-settings">Method level settings</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:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// method-level configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>List<span style="color:#719e07">&lt;</span>MethodConfig<span style="color:#719e07">&gt;</span> methods <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ArrayList<span style="color:#719e07">&lt;</span>MethodConfig<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span>MethodConfig method <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> MethodConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>method<span style="color:#719e07">.</span> <span style="color:#268bd2">setName</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;sayHello&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>method<span style="color:#719e07">.</span>setTimeout<span style="color:#719e07">(</span>10000<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>method<span style="color:#719e07">.</span> <span style="color:#268bd2">setRetries</span><span style="color:#719e07">(</span>0<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>methods<span style="color:#719e07">.</span> <span style="color:#268bd2">add</span><span style="color:#719e07">(</span>method<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// reference the remote service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;();</span> <span style="color:#586e75">// This instance is very heavy and encapsulates the connection with the registry and the provider, please cache it yourself, otherwise it may cause memory and connection leaks |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setMethods<span style="color:#719e07">(</span>methods<span style="color:#719e07">);</span> <span style="color:#586e75">// Set method-level configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span></code></pre></div><h4 id="point-to-point-direct-connection">Point-to-point direct connection</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></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// This instance is very heavy, it encapsulates the connection with the registry and the provider, please cache it yourself, otherwise it may cause memory and connection leaks |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// If point-to-point direct connection, you can use reference.setUrl() to specify the target address. After setting the url, the registration center will be bypassed. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// Among them, the protocol corresponds to the value of provider.setProtocol(), and the port corresponds to the value of provider.setPort(). |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// The path corresponds to the value of service.setPath(). If no path is set, the default path is the interface name |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>reference<span style="color:#719e07">.</span>setUrl<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo://10.20.130.230:20880/com.xxx.DemoService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Annotation configuration</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/annotation/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/annotation/</guid><description> |
| <p>This article uses the Spring Boot + Annotation mode to describe Dubbo application development. Check out the Spring Annotation development mode without Spring Boot here [complete example](<a href="https://github.com/apache/dubbo-samples/tree/master/1-basic/">https://github.com/apache/dubbo-samples/tree/master/1-basic/</a> dubbo-samples-annotation)</p> |
| <p>In Dubbo Spring Boot development, you only need to add a few annotations and configure the <code>application.properties</code> or <code>application.yml</code> file to complete the Dubbo service definition:</p> |
| <ul> |
| <li>Annotations include <code>@DubboService</code>, <code>@DubboReference</code> and <code>EnableDubbo</code>. Among them, <code>@DubboService</code> and <code>@DubboReference</code> are used to mark Dubbo services, and <code>EnableDubbo</code> starts Dubbo-related configuration and specifies the Spring Boot scanning package path.</li> |
| <li>Configuration file <code>application.properties</code> or <code>application.yml</code></li> |
| </ul> |
| <p>For complete examples of the following content, please refer to <a href="https://github.com/apache/dubbo-samples/tree/master/1-basic/dubbo-samples-spring-boot">dubbo-samples</a></p> |
| <h2 id="add-maven-dependency">Add Maven dependency</h2> |
| <p>Use Dubbo Spring Boot Starter to first introduce the following Maven dependencies</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;dependencyManagement&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Spring Boot --&gt;</span> |
| </span></span><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.springframework.boot<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>spring-boot-dependencies<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${spring-boot.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;scope&gt;</span>import<span style="color:#268bd2">&lt;/scope&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Dubbo --&gt;</span> |
| </span></span><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-bom<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;scope&gt;</span>import<span style="color:#268bd2">&lt;/scope&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Zookeeper --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- NOTICE: Dubbo only provides dependency management module for Zookeeper, add Nacos or other product dependency directly if you want to use them. --&gt;</span> |
| </span></span><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-dependencies-zookeeper<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><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;/dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependencyManagement&gt;</span> |
| </span></span></code></pre></div><p>Then add it to the pom of the corresponding module</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;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- dubbo --&gt;</span> |
| </span></span><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<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><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-dependencies-zookeeper<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- dubbo starter --&gt;</span> |
| </span></span><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-spring-boot-starter<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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- spring starter --&gt;</span> |
| </span></span><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.springframework.boot<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>spring-boot-starter<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><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.springframework.boot<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>spring-boot-autoconfigure<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><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependencies&gt;</span> |
| </span></span></code></pre></div><blockquote> |
| <p>Distinguish between ** and ** above</p> |
| </blockquote> |
| <h2 id="applicationyml-or-applicationproperties">application.yml or application.properties</h2> |
| <p>Components other than service and reference can be set in the application.yml file. If you want to extend the annotation configuration of service or reference, you need to add <code>dubbo.properties</code> configuration file or use other non-annotation methods such as Java Config. For details, please See [Extended Annotation Configuration](#Extended Annotation Configuration) below.</p> |
| <p>Service and reference components can also be associated with global components in the application through <code>id</code>, take the following configuration as an 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-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">dubbo</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: dubbo-springboot-demo-provider |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protocol</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: dubbo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">port</span>: -<span style="color:#2aa198">1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registry</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">id</span>: zk-registry |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">address</span>: zookeeper://127.0.0.1:2181 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">config-center</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">address</span>: zookeeper://127.0.0.1:2181 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">metadata-report</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">address</span>: zookeeper://127.0.0.1:2181 |
| </span></span></code></pre></div><p>Associate the service with the specific registry defined above via annotations</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">@DubboService</span><span style="color:#719e07">(</span>registry<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;zk-registry&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService <span style="color:#719e07">{}</span> |
| </span></span></code></pre></div><p>The same is true for association through Java Config configuration</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">@Configuration</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderConfiguration</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ServiceConfig <span style="color:#268bd2">demoService</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ServiceConfig service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRegistry<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zk-registry&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> service<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><h2 id="annotation">Annotation</h2> |
| <h3 id="dubboservice-annotation">@DubboService annotation</h3> |
| <blockquote> |
| <p>The <code>@Service</code> annotation has been deprecated since version 3.0, use <code>@DubboService</code> to distinguish it from Spring&rsquo;s <code>@Service</code> annotation</p> |
| </blockquote> |
| <p>After defining the Dubbo service interface, provide the implementation logic of the service interface and mark it with <code>@DubboService</code> annotation to realize the service exposure of Dubbo</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">@DubboService</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService <span style="color:#719e07">{}</span> |
| </span></span></code></pre></div><p>If you want to set service parameters, <code>@DubboService</code> also provides a way to set common parameters. If you have more complex parameter setting requirements, you can consider using other setting methods</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">@DubboService</span><span style="color:#719e07">(</span>version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">,</span> group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;dev&#34;</span><span style="color:#719e07">,</span> timeout <span style="color:#719e07">=</span> 5000<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService <span style="color:#719e07">{}</span> |
| </span></span></code></pre></div><h3 id="dubboreference-annotation">@DubboReference annotation</h3> |
| <blockquote> |
| <p>The <code>@Reference</code> annotation has been deprecated since version 3.0, use <code>@DubboReference</code> to distinguish it from Spring&rsquo;s <code>@Reference</code> annotation</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Component</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoClient</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@DubboReference</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> DemoService demoService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>The <code>@DubboReference</code> annotation will be automatically injected as a Dubbo service proxy instance, and remote service calls can be initiated using demoService</p> |
| <h3 id="enabledubbo-annotation">@EnableDubbo annotation</h3> |
| <p>The <code>@EnableDubbo</code> annotation must be configured, otherwise the service defined by the Dubbo annotation will not be loaded, <code>@EnableDubbo</code> can be defined on the main class</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">@SpringBootApplication</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderApplication</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> Exception <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> SpringApplication<span style="color:#719e07">.</span>run<span style="color:#719e07">(</span>ProviderApplication<span style="color:#719e07">.</span>class<span style="color:#719e07">,</span> args<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><p>Spring Boot annotations will only scan the package where the main class is located by default. If the service is defined in other packages, you need to add the configuration <code>EnableDubbo(scanBasePackages = {&quot;org.apache.dubbo.springboot.demo.provider&quot;})</code></p> |
| <h3 id="extended-annotation-configuration">Extended annotation configuration</h3> |
| <p>Although the configuration parameters can be adjusted through <code>@DubboService</code> and <code>DubboReference</code> (as shown in the code snippet below), overall the configuration items provided by annotations are still very limited. In this case, if there are more complex parameter setting requirements, you can use <code>Java Config</code> or <code>dubbo.properties</code> two ways.</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">@DubboService</span><span style="color:#719e07">(</span>version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">,</span> group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;dev&#34;</span><span style="color:#719e07">,</span> timeout <span style="color:#719e07">=</span> 5000<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@DubboReference</span><span style="color:#719e07">(</span>version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">,</span> group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;dev&#34;</span><span style="color:#719e07">,</span> timeout <span style="color:#719e07">=</span> 5000<span style="color:#719e07">)</span> |
| </span></span></code></pre></div><h3 id="use-java-config-instead-of-annotations">Use Java Config instead of annotations</h3> |
| <p>Note that Java Config is an alternative to <code>DubboService</code> or <code>DubboReference</code>, which is recommended for services with complex configuration requirements.</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">@Configuration</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderConfiguration</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ServiceConfig <span style="color:#268bd2">demoService</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ServiceConfig service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> DemoServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dev&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> String<span style="color:#719e07">&gt;</span> parameters <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span> <span style="color:#268bd2">setParameters</span><span style="color:#719e07">(</span>parameters<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> service<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><h3 id="supplementary-configuration-through-dubboproperties">Supplementary configuration through dubbo.properties</h3> |
| <p>For scenarios using <code>DubboService</code> or <code>DubboReference</code>, you can use dubbo.properties as a configuration supplement, [specific format](../principle/#1-configuration format) is explained in more detail here.</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.service.org.apache.dubbo.springboot.demo.DemoService.timeout<span style="color:#719e07">=</span><span style="color:#2aa198">5000</span> |
| </span></span><span style="display:flex;"><span>dubbo.service.org.apache.dubbo.springboot.demo.DemoService.parameters<span style="color:#719e07">=</span><span style="color:#2aa198">[{myKey:myValue},{anotherKey:anotherValue}]</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.org.apache.dubbo.springboot.demo.DemoService.timeout<span style="color:#719e07">=</span><span style="color:#2aa198">6000</span> |
| </span></span></code></pre></div><blockquote> |
| <p>Properties format configuration is currently not very structural, for example, the key field is more redundant, and support for yaml format will be considered in the future.</p> |
| </blockquote></description></item><item><title>Docs3-V2: XML Configuration</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/xml/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/xml/</guid><description> |
| <p>Dubbo has custom configuration components based on Spring Schema extensions, and the configuration capabilities that can be achieved using XML are generally equivalent to <a href="../properties">Configuration Reference Manual</a>.</p> |
| <p>For complete examples of the following content, please refer to <a href="https://github.com/apache/dubbo-samples/tree/master/1-basic/dubbo-samples-spring-xml">dubbo-samples</a></p> |
| <h2 id="service-provider">service provider</h2> |
| <h3 id="define-service-interface">Define service interface</h3> |
| <p>DemoService.java:</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:#719e07">package</span> org.apache.dubbo.demo<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">interface</span> <span style="color:#268bd2">DemoService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="implement-the-interface-on-the-service-provider-side">Implement the interface on the service provider side</h3> |
| <p>DemoServiceImpl.java:</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:#719e07">package</span> org.apache.dubbo.demo.provider<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.demo.DemoService<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">class</span> <span style="color:#268bd2">DemoServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<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:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name<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><h3 id="expose-services-with-spring-configuration-declarations">Expose services with Spring configuration declarations</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-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: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> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> xmlns:context=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/context&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans 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 http://www.springframework.org/schema/context http://www.springframework .org/schema/context/spring-context.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;context:property-placeholder/&gt;</span> |
| </span></span><span style="display:flex;"><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></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://${zookeeper.address:127.0.0.1}:2181&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:provider</span> token=<span style="color:#2aa198">&#34;true&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><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.samples.basic.impl.DemoServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><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.samples.basic.api.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></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h3 id="load-spring-configuration">Load Spring configuration</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-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">DemoServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService <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> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;[&#34;</span> <span style="color:#719e07">+</span> <span style="color:#719e07">new</span> SimpleDateFormat<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;HH:mm:ss&#34;</span><span style="color:#719e07">).</span>format<span style="color:#719e07">(</span><span style="color:#719e07">new</span> Date<span style="color:#719e07">())</span> <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;] Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;, request from consumer: &#34;</span> <span style="color:#719e07">+</span> RpcContext<span style="color:#719e07">.</span> <span style="color:#268bd2">getContext</span><span style="color:#719e07">().</span> getRemoteAddress<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, response from provider: &#34;</span> <span style="color:#719e07">+</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getLocalAddress<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><h2 id="service-consumer">Service Consumer</h2> |
| <h3 id="reference-remote-services-through-spring-configuration">Reference remote services through Spring configuration</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-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: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> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> xmlns:context=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/context&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans 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 http://www.springframework.org/schema/context http://www.springframework .org/schema/context/spring-context.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;context:property-placeholder/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;demo-consumer&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://${zookeeper.address:127.0.0.1}:2181&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> check=<span style="color:#2aa198">&#34;true&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.basic.api.DemoService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h3 id="load-spring-configuration-and-call-remote-service">Load Spring configuration and call remote service</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-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">BasicConsumer</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;spring/dubbo-demo-consumer.xml&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> context<span style="color:#719e07">.</span> <span style="color:#268bd2">start</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> DemoService demoService <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>DemoService<span style="color:#719e07">)</span> context<span style="color:#719e07">.</span> <span style="color:#268bd2">getBean</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demoService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> String hello <span style="color:#719e07">=</span> demoService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;world&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span>hello<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></description></item><item><title>Docs3-V2: How Configuration Works</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/principle/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/principle/</guid><description> |
| <p>The following is an example of Dubbo property configuration <a href="https://github.com/apache/dubbo-spring-boot-project/tree/master/dubbo-spring-boot-samples">dubbo-spring-boot-samples</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-properties" data-lang="properties"><span style="display:flex;"><span> <span style="color:#586e75">## application.properties</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75"># Spring boot application</span> |
| </span></span><span style="display:flex;"><span> spring.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo-externalized-configuration-provider-sample</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75"># Base packages to scan Dubbo Component: @com.alibaba.dubbo.config.annotation.Service</span> |
| </span></span><span style="display:flex;"><span> dubbo.scan.base-packages<span style="color:#719e07">=</span><span style="color:#2aa198">com.alibaba.boot.dubbo.demo.provider.service</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75"># Dubbo Application</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">## The default value of dubbo.application.name is ${spring.application.name}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">## dubbo.application.name=${spring.application.name}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#Dubbo Protocol</span> |
| </span></span><span style="display:flex;"><span> dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span> dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">12345</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">## Dubbo Registry</span> |
| </span></span><span style="display:flex;"><span> dubbo.registry.address<span style="color:#719e07">=</span><span style="color:#2aa198">N/A</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">## service default version</span> |
| </span></span><span style="display:flex;"><span> dubbo.provider.version<span style="color:#719e07">=</span><span style="color:#2aa198">1.0.0</span> |
| </span></span></code></pre></div><p>Next, around this example, we analyze the working principle of Dubbo configuration from three aspects: configuration format, configuration source, and loading process.</p> |
| <h2 id="1-configuration-format">1 configuration format</h2> |
| <p>All configurations currently supported by Dubbo are in <code>.properties</code> format, including <code>-D</code>, <code>Externalized Configuration</code>, etc. All configuration items in <code>.properties</code> follow a <code>path-based</code> configuration format.</p> |
| <p>In the Spring application, you can also put the attribute configuration in <code>application.yml</code>, and the tree hierarchy is more readable.</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><span style="color:#586e75"># Application-level configuration (no id)</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Instance-level configuration (specify id or name)</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}s.{config-id}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}s.{config-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Service interface configuration</span> |
| </span></span><span style="display:flex;"><span>dubbo.service.{interface-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.{interface-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># method configuration</span> |
| </span></span><span style="display:flex;"><span>dubbo.service.{interface-name}.{method-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.{interface-name}.{method-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Method argument configuration</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.{interface-name}.{method-name}.{argument-index}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span></code></pre></div><h3 id="11-application-level-configuration-no-id">1.1 Application-level configuration (no id)</h3> |
| <p>The format of application-level configuration is: configuration type singular prefix, no id/name.</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><span style="color:#586e75"># Application-level configuration (no id)</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span></code></pre></div><p>Similar to <code>application</code>, <code>monitor</code>, <code>metrics</code>, etc. are all application-level components, so only a single instance is allowed to be configured; while <code>protocol</code>, <code>registry</code>, etc. allow to configure multiple components, when only singleton configuration is required , in the format described in this section. Common examples are 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.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">demo-provider</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.qos-enable<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><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></span><span style="display:flex;"><span>dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">-1</span> |
| </span></span></code></pre></div><h3 id="12-instance-level-configuration-specify-id-or-name">1.2 Instance-level configuration (specify id or name)</h3> |
| <p>The attribute configuration for an instance needs to specify an id or name, and its prefix format is: configuration type plural prefix + id/name. Applicable to <code>protocol</code>, <code>registry</code> and other components that support multiple configurations.</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><span style="color:#586e75"># Instance-level configuration (specify id or name)</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}s.{config-id}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}s.{config-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span></code></pre></div><ul> |
| <li>If there is no instance of the id or name, the framework will create a configuration component instance based on the properties listed here.</li> |
| <li>If an instance with the same id or name already exists, the framework will use the attributes listed here as a supplement to the existing instance configuration. For details, please refer to [Attribute Override](../principle#32-Attribute Override).</li> |
| <li>Please refer to the [single and plural configuration comparison table] (../principle#17-single and plural configuration item comparison table)</li> |
| </ul> |
| <p>Configuration 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-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.registries.unit1.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.registries.unit2.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://127.0.0.1:2182</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo.protocols.dubbo.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocols.dubbo.port<span style="color:#719e07">=</span><span style="color:#2aa198">20880</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo.protocols.hessian.name<span style="color:#719e07">=</span><span style="color:#2aa198">hessian</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocols.hessian.port<span style="color:#719e07">=</span><span style="color:#2aa198">8089</span> |
| </span></span></code></pre></div><h3 id="13-service-interface-configuration">1.3 Service interface configuration</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-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.service.org.apache.dubbo.samples.api.DemoService.timeout<span style="color:#719e07">=</span><span style="color:#2aa198">5000</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.org.apache.dubbo.samples.api.DemoService.timeout<span style="color:#719e07">=</span><span style="color:#2aa198">6000</span> |
| </span></span></code></pre></div><h3 id="method-configuration">Method configuration</h3> |
| <p>Method configuration format:</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><span style="color:#586e75"># method configuration</span> |
| </span></span><span style="display:flex;"><span>dubbo.service.{interface-name}.{method-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.{interface-name}.{method-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Method argument configuration</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.{interface-name}.{method-name}.{argument-index}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span></code></pre></div><p>Example method configuration:</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.reference.org.apache.dubbo.samples.api.DemoService.sayHello.timeout<span style="color:#719e07">=</span><span style="color:#2aa198">7000</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.org.apache.dubbo.samples.api.DemoService.sayHello.oninvoke<span style="color:#719e07">=</span><span style="color:#2aa198">notifyService.onInvoke</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.org.apache.dubbo.samples.api.DemoService.sayHello.onreturn<span style="color:#719e07">=</span><span style="color:#2aa198">notifyService.onReturn</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.org.apache.dubbo.samples.api.DemoService.sayHello.onthrow<span style="color:#719e07">=</span><span style="color:#2aa198">notifyService.onThrow</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.org.apache.dubbo.samples.api.DemoService.sayHello.0.callback<span style="color:#719e07">=</span><span style="color:#2aa198">true</span> |
| </span></span></code></pre></div><p>Equivalent to XML configuration:</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:reference</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.api.DemoService&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;sayHello&#34;</span> timeout=<span style="color:#2aa198">&#34;7000&#34;</span> oninvoke=<span style="color:#2aa198">&#34;notifyService.onInvoke&#34;</span> |
| </span></span><span style="display:flex;"><span> onreturn=<span style="color:#2aa198">&#34;notifyService.onReturn&#34;</span> onthrow=<span style="color:#2aa198">&#34;notifyService.onThrow&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:argument</span> index=<span style="color:#2aa198">&#34;0&#34;</span> callback=<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:method&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><h3 id="14-parameter-configuration">1.4 Parameter configuration</h3> |
| <p>The parameters parameter is a map object, which supports configuration in the form of xxx.parameters=[{key:value},{key:value}].</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.application.parameters<span style="color:#719e07">=</span><span style="color:#2aa198">[{item1:value1},{item2:value2}]</span> |
| </span></span><span style="display:flex;"><span>dubbo.reference.org.apache.dubbo.samples.api.DemoService.parameters<span style="color:#719e07">=</span><span style="color:#2aa198">[{item3:value3}]</span> |
| </span></span></code></pre></div><h3 id="15-transport-layer-configuration">1.5 Transport layer configuration</h3> |
| <p>The triple protocol uses Http2 as the underlying communication protocol, allowing users to customize [6 settings parameters] of Http2 (<a href="https://datatracker.ietf.org/doc/html/rfc7540#section-6.5.2">https://datatracker.ietf.org/doc/html/rfc7540#section-6.5.2</a>)</p> |
| <p>The configuration format 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-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75"># Notify the peer header of the upper limit of compressed index tables</span> |
| </span></span><span style="display:flex;"><span>dubbo.rpc.tri.header-table-size<span style="color:#719e07">=</span><span style="color:#2aa198">4096</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Enable server-side push function</span> |
| </span></span><span style="display:flex;"><span>dubbo.rpc.tri.enable-push<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Notify the peer of the maximum number of concurrent streams allowed</span> |
| </span></span><span style="display:flex;"><span>dubbo.rpc.tri.max-concurrent-streams<span style="color:#719e07">=</span><span style="color:#2aa198">2147483647</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Declare the window size of the sender</span> |
| </span></span><span style="display:flex;"><span>dubbo.rpc.tri.initial-window-size<span style="color:#719e07">=</span><span style="color:#2aa198">1048576</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Set the maximum number of bytes for the frame</span> |
| </span></span><span style="display:flex;"><span>dubbo.rpc.tri.max-frame-size<span style="color:#719e07">=</span><span style="color:#2aa198">32768</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Notify the peer of the maximum number of uncompressed bytes in the header</span> |
| </span></span><span style="display:flex;"><span>dubbo.rpc.tri.max-header-list-size<span style="color:#719e07">=</span><span style="color:#2aa198">8192</span> |
| </span></span></code></pre></div><p>Equivalent to yml configuration:</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">dubbo</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">rpc</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">tri</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">header-table-size</span>: <span style="color:#2aa198">4096</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">enable-push</span>: <span style="color:#cb4b16">false</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">max-concurrent-streams</span>: <span style="color:#2aa198">2147483647</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">initial-window-size</span>: <span style="color:#2aa198">1048576</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">max-frame-size</span>: <span style="color:#2aa198">32768</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">max-header-list-size</span>: <span style="color:#2aa198">8192</span> |
| </span></span></code></pre></div><h3 id="16-attribute-and-xml-configuration-mapping-rules">1.6 Attribute and XML configuration mapping rules</h3> |
| <p>The xml tag name and attribute name can be combined, separated by &lsquo;.&rsquo;. One attribute per line.</p> |
| <ul> |
| <li><code>dubbo.application.name=foo</code> is equivalent to <code>&lt;dubbo:application name=&quot;foo&quot; /&gt;</code></li> |
| <li><code>dubbo.registry.address=10.20.153.10:9090</code> is equivalent to <code>&lt;dubbo:registry address=&quot;10.20.153.10:9090&quot; /&gt; </code></li> |
| </ul> |
| <p>If there is more than one tag in xml configuration, then you can use &lsquo;id&rsquo; to differentiate. If you don&rsquo;t specify an id, it will apply to all tags.</p> |
| <ul> |
| <li><code>dubbo.protocols.rmi.port=1099</code> is equivalent to <code>&lt;dubbo:protocol id=&quot;rmi&quot; name=&quot;rmi&quot; port=&quot;1099&quot; /&gt; </code></li> |
| <li><code>dubbo.registries.china.address=10.20.153.10:9090</code> is equivalent to <code>&lt;dubbo:registry id=&quot;china&quot; address=&quot;10.20.153.10:9090&quot; /&gt;</code></li> |
| </ul> |
| <h3 id="17-single-and-plural-comparison-table-for-configuration-items">1.7 Single and plural comparison table for configuration items</h3> |
| <p>Plural configurations are named in the same way as regular words are pluralized:</p> |
| <ol> |
| <li>When the letter y ends, remove y and change to ies</li> |
| <li>At the end of the letter s, add es</li> |
| <li>Others add s</li> |
| </ol> |
| <p>| Config Type | Singular Configuration | Plural Configuration | |
| | &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash; | &mdash;&mdash;&mdash;&mdash;&mdash; &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash; | &mdash;- &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;- | |
| | application | dubbo.application.xxx=xxx | dubbo.applications.{id}.xxx=xxx <br/> dubbo.applications.{name}.xxx=xxx | |
| | protocol | dubbo.protocol.xxx=xxx | dubbo.protocols.{id}.xxx=xxx <br/> dubbo.protocols.{name}.xxx=xxx | |
| | module | dubbo.module.xxx=xxx | dubbo.modules.{id}.xxx=xxx <br/> dubbo.modules.{name}.xxx=xxx | |
| | registry | dubbo.registry.xxx=xxx | dubbo.registries.{id}.xxx=xxx | |
| | monitor | dubbo.monitor.xxx=xxx | dubbo.monitors.{id}.xxx=xxx | |
| | config-center | dubbo.config-center.xxx=xxx | dubbo.config-centers.{id}.xxx=xxx | |
| | metadata-report | dubbo.metadata-report.xxx=xxx | dubbo.metadata-reports.{id}.xxx=xxx | |
| | ssl | dubbo.ssl.xxx=xxx | dubbo.ssls.{id}.xxx=xxx | |
| | metrics | dubbo.metrics.xxx=xxx | dubbo.metricses.{id}.xxx=xxx | |
| | provider | dubbo.provider.xxx=xxx | dubbo.providers.{id}.xxx=xxx | |
| | consumer | dubbo.consumer.xxx=xxx | dubbo.consumers.{id}.xxx=xxx | |
| | service | dubbo.service.{interfaceName}.xxx=xxx | None | |
| | reference | dubbo.reference.{interfaceName}.xxx=xxx | None | |
| | method | dubbo.service.{interfaceName}.{methodName}.xxx=xxx <br/> dubbo.reference.{interfaceName}.{methodName}.xxx=xxx | None | |
| | argument | dubbo.service.{interfaceName}.{methodName}.{arg-index}.xxx=xxx | None |</p> |
| <h2 id="2-configure-sources">2 Configure sources</h2> |
| <p>Dubbo supports 6 configuration sources by default:</p> |
| <ul> |
| <li>JVM System Properties, JVM -D parameter</li> |
| <li>System environment, the environment variable of the JVM process</li> |
| <li>Externalized Configuration, [externalized configuration] (#33-externalized configuration), read from the configuration center</li> |
| <li>Application Configuration, application attribute configuration, extract the attribute set starting with &ldquo;dubbo&rdquo; from the Spring application Environment</li> |
| <li>The configuration collected by programming interfaces such as API/XML/annotation can be understood as a kind of configuration source, which is a configuration collection method directly oriented to user programming</li> |
| <li>Read configuration file dubbo.properties from classpath</li> |
| </ul> |
| <p>About the dubbo.properties attribute:</p> |
| <ol> |
| <li>If there is more than one dubbo.properties file under the classpath, for example, two jar packages each contain dubbo.properties, dubbo will randomly select one to load and print an error log.</li> |
| <li>Dubbo can automatically load dubbo.properties in the root directory of the classpath, but you can also use JVM parameters to specify the path: <code>-Ddubbo.properties.file=xxx.properties</code>.</li> |
| </ol> |
| <h3 id="21-coverage-relationship">2.1 Coverage relationship</h3> |
| <p>If the same configuration item is specified through multiple configuration sources, configuration items will overlap each other. Please refer to the next section for specific coverage relationship and priority.</p> |
| <h2 id="3-configuration-loading-process">3 Configuration loading process</h2> |
| <h3 id="31-processing-flow">3.1 Processing flow</h3> |
| <p>Dubbo configuration loading is roughly divided into two stages:</p> |
| <p><img src="https://dubbo.apache.org/imgs/v3/config/config-load.svg" alt="Configuration loading process"></p> |
| <ul> |
| <li>The first stage is before the initialization of DubboBootstrap, parse and process the XML configuration/annotation configuration/Java-config or execute the API configuration code when the Spring context starts, create a config bean and add it to the ConfigManager.</li> |
| <li>The second stage is the DubboBootstrap initialization process, which reads the external configuration from the configuration center, processes instance-level attribute configuration and application-level attribute configuration in turn, and finally refreshes the attributes of all configuration instances, that is, [property override](../principle#32 -property override).</li> |
| </ul> |
| <h3 id="32-property-override">3.2 Property Override</h3> |
| <p>There may be two situations where property overriding occurs, and the two may occur at the same time:</p> |
| <ol> |
| <li>The same configuration item is configured in different configuration sources</li> |
| <li>The same configuration source, but the same configuration item is specified at different levels</li> |
| </ol> |
| <h4 id="321-different-configuration-sources">3.2.1 Different configuration sources</h4> |
| <p><img src="https://dubbo.apache.org/imgs/blog/configuration.jpg" alt="Override relationship"></p> |
| <h4 id="321-same-configuration-source">3.2.1 Same configuration source</h4> |
| <p>Property override refers to overriding the properties of the config bean instance with the configured property values, similar to Spring [PropertyOverrideConfigurer](<a href="https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/beans/">https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/beans/</a> factory/config/PropertyOverrideConfigurer.html) .</p> |
| <blockquote> |
| <p>Property resource configurer that overrides bean property values in an application context definition. It pushes values from a properties file into bean definitions. |
| Configuration lines are expected to be of the following form:</p> |
| <p>beanName.property=value</p> |
| </blockquote> |
| <p>But the difference from <code>PropertyOverrideConfigurer</code> is that Dubbo&rsquo;s property override has multiple matching formats, and the priority from high to low is:</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><span style="color:#586e75">#1. Instance-level configuration of the specified id</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}s.{config-id}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">#2. Specify the instance-level configuration of the name</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}s.{config-name}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">#3. Application-level configuration (singular configuration)</span> |
| </span></span><span style="display:flex;"><span>dubbo.{config-type}.{config-item}<span style="color:#719e07">=</span><span style="color:#2aa198">{config-item-value}</span> |
| </span></span></code></pre></div><p>Attribute override processing flow:</p> |
| <p>Search in order of priority from high to low. If an attribute starting with this prefix is found, use this prefix to extract the attribute and ignore the subsequent configuration.</p> |
| <p><img src="https://dubbo.apache.org/imgs/v3/config/properties-override.svg" alt="Properties Override Process"></p> |
| <h3 id="33-externalization-configuration">3.3 Externalization configuration</h3> |
| <p>One of the purposes of external configuration is to achieve centralized management of configuration. There are already many mature professional configuration systems in this part of the industry, such as Apollo, Nacos, etc. What Dubbo does is mainly to ensure that it can work with these systems.</p> |
| <p>There is no difference in content and format between externalized configuration and other local configurations. It can be simply understood as the externalized storage of <code>dubbo.properties</code>. The configuration center is more suitable for extracting some public configurations such as registration centers and metadata center configurations for future use. centralized management.</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><span style="color:#586e75"># Centralized management of registration center address, metadata center address and other configurations can achieve a unified environment and reduce development-side perception.</span> |
| </span></span><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>dubbo.registry.simplified<span style="color:#719e07">=</span><span style="color:#2aa198">true</span> |
| </span></span><span style="display:flex;"><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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">20880</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo.application.qos.port<span style="color:#719e07">=</span><span style="color:#2aa198">33333</span> |
| </span></span></code></pre></div><ul> |
| <li> |
| <p>priority |
| By default, the externalized configuration has a higher priority than the local configuration, so the content configured here will override the local configuration value. There is a separate chapter explaining the [Override Relationship] (#21-Override Relationship) between various configuration forms.</p> |
| </li> |
| <li> |
| <p>scope |
| There are two levels of external configuration: global and application. The global configuration is shared by all applications. The application-level configuration is maintained by each application and is only visible to itself. Currently supported extensions include Zookeeper, Apollo, and Nacos.</p> |
| </li> |
| </ul> |
| <h4 id="331-how-to-use-external-configuration">3.3.1 How to use external configuration</h4> |
| <ol> |
| <li>Add config-center configuration</li> |
| </ol> |
| <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><ol start="2"> |
| <li>Add global configuration items in the corresponding configuration center (zookeeper, Nacos, etc.), take Nacos as an example as follows:</li> |
| </ol> |
| <p><img src="https://dubbo.apache.org/imgs/v3/config-center/nacos-extenal-properties.png" alt="nacos-extenal-properties"></p> |
| <p>After the external configuration is enabled, global configurations such as registry, metadata-report, protocol, and qos theoretically no longer need to be configured in the application. The application development side focuses on business service configuration, and some globally shared global configurations are transferred to O&amp;M. The personnel are uniformly configured in the remote configuration center.</p> |
| <p>The effect of this is that the application only needs to care about:</p> |
| <ul> |
| <li>Service exposure, subscription configuration</li> |
| <li>Configuration center address |
| When deployed to different environments, other configurations can be automatically read from the corresponding configuration center.</li> |
| </ul> |
| <p>For example, only the following Dubbo-related configurations in each application may be sufficient, and the rest are hosted in the configuration center in the corresponding environment:</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>dubbo |
| </span></span><span style="display:flex;"><span> application |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: demo |
| </span></span><span style="display:flex;"><span> config-center |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">address</span>: nacos://127.0.0.1:8848 |
| </span></span></code></pre></div><h4 id="332-load-external-configuration-by-itself">3.3.2 Load external configuration by itself</h4> |
| <p>The so-called Dubbo&rsquo;s support for the configuration center is essentially to pull <code>.properties</code> from the remote to the local, and then integrate it with the local configuration. In theory, as long as the Dubbo framework can get the required configuration, it can start normally. It doesn&rsquo;t care whether these configurations are loaded by itself or directly inserted by the application, so Dubbo also provides the following APIs to allow users to organize themselves. The configuration is stuffed into the Dubbo framework (the configuration loading process is to be completed by the user), so that the Dubbo framework no longer directly interacts with Apollo or Zookeeper to read the configuration.</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:#586e75">// The application loads its own configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> String<span style="color:#719e07">&gt;</span> dubboConfigurations <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> dubboConfigurations<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo.registry.address&#34;</span><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> dubboConfigurations<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo.registry.simplified&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;true&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">//Throw the organized configuration into the Dubbo framework |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></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>setExternalConfig<span style="color:#719e07">(</span>dubboConfigurations<span style="color:#719e07">);</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Configuration Item Reference Manual</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/properties/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/config/properties/</guid><description> |
| <h2 id="configuration-details">Configuration Details</h2> |
| <h3 id="application">application</h3> |
| <p>Each application must have one and only one application configuration, corresponding configuration class: <code>org.apache.dubbo.config.ApplicationConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>name</td> |
| <td>application</td> |
| <td>string</td> |
| <td><b>Required</b></td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The name of the current application, which is used by the registry to calculate dependencies between applications. Note: the consumer and provider application names should not be the same, this parameter is not Matching conditions, you can fill in the name of your current project, which has nothing to do with the role of the provider and consumer. For example, if the kylin application calls the service of the morgan application, the kylin project will be kylin, and the morgan project will be morgan. Maybe kylin also provides other The service is used by others, but the kylin project will always be dubbed kylin, so the registry will show that kylin depends on morgan</td> |
| <td>version 2.7 .0 or later</td> |
| </tr> |
| <tr> |
| <td>compiler</td> |
| <td>compiler</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>javassist</td> |
| <td>performance optimization</td> |
| <td>Java bytecode compiler, used to generate dynamic classes, optional: jdk or javassist</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>logger</td> |
| <td>logger</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>slf4j</td> |
| <td>performance optimization</td> |
| <td>log output method, optional: slf4j, jcl, log4j, log4j2, jdk</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The person in charge of the application, used for service governance, please fill in the email prefix of the person in charge</td> |
| <td>Version above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>organization</td> |
| <td>organization</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Organization name (BU or department), which is used by the registration center to distinguish service sources. It is recommended not to use autoconfig for this configuration item, and write it directly in the configuration, such as china, intl, itu, crm, asc, dw, aliexpress, etc.</td> |
| <td>Version 2.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>architecture <br class="atl-forced-newline" /></td> |
| <td>architecture <br class="atl-forced-newline" /></td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>. Different architectures use different layers.</td> |
| <td>Version 2.0. 7 and above</td> |
| </tr> |
| <tr> |
| <td>environment</td> |
| <td>environment</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Application environment, such as: develop/test/product, different environments use different default values, and it is only used as a restriction for developing and testing functions</td> |
| <td>2.0.0 and above version</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>application.version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>current application version</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>dumpDirectory</td> |
| <td>dump.directory</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>When the process has a problem such as the thread pool is full, the storage path of the framework&rsquo;s automatic dump file</td> |
| <td>Version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>qosEnable</td> |
| <td>qos.enable</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Whether to enable the qos operation and maintenance port</td> |
| <td>Version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>qosHost</td> |
| <td>qos.host</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Network interface address to monitor, default 0.0.0.0</td> |
| <td>Version 2.7.3 or later</td> |
| </tr> |
| <tr> |
| <td>qosPort</td> |
| <td>qos.port</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>network port to monitor</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>qosAcceptForeignIp</td> |
| <td>qos.accept.foreign.ip</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Security configuration, whether to accept external requests except localhost local access</td> |
| <td>Version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>shutwait</td> |
| <td>dubbo.service.shutdown.wait</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>shutdown waiting time (ms) during graceful shutdown</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>hostname</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>local hostname</td> |
| <td>service governance</td> |
| <td>hostname</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>registerConsumer</td> |
| <td>registerConsumer</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>whether to register the instance to the registry. Only set to <code>false</code> when the instance is a pure consumer</td> |
| <td>Version 2.7.5 and above</td> |
| </tr> |
| <tr> |
| <td>repository</td> |
| <td>application.version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>current application version</td> |
| <td>version 2.7.6 or later</td> |
| </tr> |
| <tr> |
| <td>enableFileCache</td> |
| <td>file.cache</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>whether to enable local cache</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>service governance</td> |
| <td>preferred protocol, applicable when the preferred protocol cannot be determined</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>metadataType</td> |
| <td>metadata-type</td> |
| <td>String</td> |
| <td>Optional</td> |
| <td>local</td> |
| <td>Service Governance</td> |
| <td>Application-level service discovery The metadata delivery method is from the perspective of Provider, and the configuration on the Consumer side is invalid. The optional values are:<br> * remote - Provider Put the metadata in the remote registry, and the Consumer gets it from the registry;<br/>* local - Provider puts the metadata locally, and the Consumer gets it directly from the Provider;</td> |
| <td>Version 2.7.5 and above</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td></td> |
| <td></td> |
| <td></td> |
| <td></td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>metadataServicePort</td> |
| <td>metadata-service-port</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>If metadataType is configured as local, this property sets the port number used by the MetadataService service</td> |
| <td>Version 2.7.9 or later</td> |
| </tr> |
| <tr> |
| <td>livenessProbe</td> |
| <td>liveness-probe</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>concept and format corresponding to k8s system liveness probe</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>readinessProbe</td> |
| <td>readiness-probe</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>concept and format corresponding to k8s system readiness probe</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>startupProbe</td> |
| <td>startup-probe</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The concept and format correspond to the k8s system startup probe</td> |
| <td>Version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>registerMode</td> |
| <td>register-mode</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>all</td> |
| <td>Service Governance</td> |
| <td>Control address registration behavior, used for application-level service discovery and migration. <br/>* instance only registers application-level addresses;<br/>* interface only registers interface-level addresses;<br/>* all (default) registers both application-level and interface-level addresses;</td> |
| <td>Version 3.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>enableEmptyProtection</td> |
| <td>enable-empty-protection</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Service Governance</td> |
| <td>Whether to enable the protection of the empty address list on the consumer side globally. After enabling it, the empty address push from the registration center will be ignored. The default is true</td> |
| <td>Version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>None</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Reserved for extensions, any parameters can be extended and defined, and all extended parameters will be reflected in the URL configuration as they are</td> |
| <td>Version 2.7.0 and above</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="service">service</h3> |
| <p>A service provider exposes service configuration. Corresponding configuration class: <code>org.apache.dubbo.config.ServiceConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>interface</td> |
| <td></td> |
| <td>class</td> |
| <td><b>required</b></td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service interface name</td> |
| <td>version 1.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>ref</td> |
| <td></td> |
| <td>object</td> |
| <td><b>required</b></td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service object implementation reference</td> |
| <td>version 1.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>0.0.0</td> |
| <td>service discovery</td> |
| <td>service version, it is recommended to use a two-digit version, such as: 1.0, usually the version number needs to be upgraded when the interface is not compatible</td> |
| <td>version 1.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service grouping, when an interface has multiple implementations, they can be distinguished by grouping</td> |
| <td>version 1.0.7 or later</td> |
| </tr> |
| <tr> |
| <td>path</td> |
| <td><path></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default interface name</td> |
| <td>service discovery</td> |
| <td>service path (note: 1.0 does not support custom path, always use the interface name, if there is 1.0 to 2.0, the configuration service path may not be Compatible)</td> |
| <td>Version 1.0.12+</td> |
| </tr> |
| <tr> |
| <td>delay</td> |
| <td>delay</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td>0</td> |
| <td>Performance tuning</td> |
| <td>Delayed registration service time (milliseconds), when set to -1, it means that the service is delayed until the initialization of the Spring container is completed</td> |
| <td>Version 1.0.14 and above</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>timeout</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>1000</td> |
| <td>performance tuning</td> |
| <td>remote service call timeout (milliseconds)</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>retries</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td>2</td> |
| <td>Performance tuning</td> |
| <td>The number of remote service call retries, excluding the first call, please set it to 0 if you don&rsquo;t need to retry</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>connections</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>100</td> |
| <td>performance tuning</td> |
| <td>the maximum number of connections for each provider, short connection protocols such as rmi, http, and hessian indicate the limit on the number of connections, and long connection agreements such as dubbo indicate the established long connections Number</td> |
| <td>Version 2.0.0 or above</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>loadbalance</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>random</td> |
| <td>performance tuning</td> |
| <td>load balancing strategy, optional values: <br/>* random - random; <br/>* roundrobin - polling; <br/>* leastactive - Least active calls; br/&gt;* consistenthash - consistent hash (2.1.0+); <br/>* shortestresponse - shortest response (2.7.7+);</td> |
| <td>2.0.0+</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>async</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Performance tuning</td> |
| <td>Whether to execute asynchronously by default, unreliable asynchronous, just ignore the return value, do not block the execution thread</td> |
| <td>Version above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>local</td> |
| <td>local</td> |
| <td>class/boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>set to true, means to use the default proxy class name, that is: interface name + Local suffix, obsolete, please use stub</td> |
| <td>2.0.0 or above</td> |
| </tr> |
| <tr> |
| <td>stub</td> |
| <td>stub</td> |
| <td>class/boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Governance</td> |
| <td>Set to true, which means to use the default proxy class name, that is: interface name + Stub suffix, the local proxy class name of the service interface client, used in the client The client executes local logic, such as local cache, etc. The constructor of the local proxy class must allow remote proxy objects to be passed in, such as: public XxxServiceStub(XxxService xxxService)</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>mock</td> |
| <td>mock</td> |
| <td>class/boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Governance</td> |
| <td>Set to true, which means to use the default Mock class name, that is: interface name + Mock suffix, if the service interface fails to call the Mock implementation class , the Mock class must have A no-argument constructor, the difference from Local is that Local is always executed, while Mock is only executed when non-business exceptions (such as timeouts, network exceptions, etc.) occur, Local is executed before remote calls, and Mock is executed after remote calls .</td> |
| <td>Version 2.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>token</td> |
| <td>token</td> |
| <td>string/boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Consumers bypass the registration center for direct access to ensure that the authorization function of the registration center is valid. If point-to-point calls are used, the token function must be turned off</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default registration to all registries</td> |
| <td>configuration association</td> |
| <td>registration to the specified registry, used in multiple registries, the value is the id attribute of <a href="dubbo:registry">dubbo:registry</a>, used for multiple registries IDs Separated by commas, If you don&rsquo;t want to register the service to any registry, you can set the value to N/A</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>provider</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>the first provider configuration is used by default</td> |
| <td>configuration association</td> |
| <td>specify the provider, the value is the id attribute of <a href="dubbo:provider">dubbo:provider</a></td> |
| <td>version above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>deprecated</td> |
| <td>deprecated</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Governance</td> |
| <td>Whether the service is deprecated, if set to true, the consumer will print the service deprecated warning error log</td> |
| <td>2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>dynamic</td> |
| <td>dynamic</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Service Governance</td> |
| <td>Whether the service is dynamically registered, if it is set to false, the disabled status will be displayed after registration, and it needs to be manually enabled, and the registration will not be canceled automatically when the service provider stops , need to be disabled manually.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>accesslog</td> |
| <td>accesslog</td> |
| <td>string/boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>service management</td> |
| <td>set to true, the access log will be output to the logger, and the access log file path can also be filled in to output the access log directly to the specified file</td> |
| <td>2.0.5 and above version</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>document</td> |
| <td>document</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>service document URL</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>weight</td> |
| <td>weight</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>service weight</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>executes</td> |
| <td>executes</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>the maximum number of parallel execution requests per service and method of a service provider</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>actives</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>maximum number of concurrent calls per service consumer per service per method</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>javassist</td> |
| <td>performance tuning</td> |
| <td>generate dynamic proxy, optional: jdk/javassist</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>cluster</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>failover</td> |
| <td>performance tuning</td> |
| <td>cluster mode, optional: failover/failfast/failsafe/failback/forking/available/mergeable (2.1. )/zone-aware (version 2.7.5 or later)</td> |
| <td>version 2.0 .5 or later</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>service.filter</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default</td> |
| <td>performance tuning</td> |
| <td>service provider remote call process interceptor name, multiple names separated by commas</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>exporter.listener</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default</td> |
| <td>performance tuning</td> |
| <td>service provider export service listener name, multiple names separated by commas</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>configuration association</td> |
| <td>use the specified protocol to expose the service, used in multi-protocol, the value is the id attribute of <a href="dubbo:protocol">dubbo:protocol</a>, multiple protocol IDs are separated by commas</td> |
| <td>version 2.0 .5 or later</td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>the layer where the service provider resides. Such as: biz, dao, intl:web, china:acton.</td> |
| <td>Version 2.0.7 and above</td> |
| </tr> |
| <tr> |
| <td>register</td> |
| <td>register</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>whether the service of this protocol is registered to the registry</td> |
| <td>version 2.0.8 or later</td> |
| </tr> |
| <tr> |
| <td>validation</td> |
| <td>validation</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>whether to enable JSR303 standard annotation validation, if enabled, the annotations on the method parameters will be validated</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>None</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Reserved for extensions, any parameters can be extended and defined, and all extended parameters will be reflected in the URL configuration as they are</td> |
| <td>Version 2.0.0 and above</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="reference">reference</h3> |
| <p>A service consumer references a service configuration. Corresponding configuration class: <code>org.apache.dubbo.config.ReferenceConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td><b>required</b></td> |
| <td></td> |
| <td>configuration association</td> |
| <td>service reference BeanId</td> |
| <td>version 1.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>interface</td> |
| <td></td> |
| <td>class</td> |
| <td><b>required</b></td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service interface name</td> |
| <td>version 1.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service version, consistent with the version of the service provider</td> |
| <td>version above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service grouping, when an interface has multiple implementations, they can be distinguished by grouping, must be consistent with the service provider</td> |
| <td>version 1.0.7 or later</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>timeout</td> |
| <td>long</td> |
| <td>optional</td> |
| <td>timeout of <a href="dubbo:consumer">dubbo:consumer</a> is used by default</td> |
| <td>performance tuning</td> |
| <td>service method call timeout (milliseconds)</td> |
| <td>version 1.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>retries</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>retries of <a href="dubbo:consumer">dubbo:consumer</a> are used by default</td> |
| <td>performance tuning</td> |
| <td>retries of remote service calls, excluding the first call, please set to 0</td> |
| <td>2.0. Version 0 and above</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>connections</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>default connections of <a href="dubbo:consumer">dubbo:consumer</a></td> |
| <td>performance tuning</td> |
| <td>the maximum number of connections for each provider, rmi, http, hessian and other short connection protocols indicate the limit of the number of connections, dubbo The equal-length connection association indicates the number of established long connections</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>loadbalance</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default loadbalance of <a href="dubbo:consumer">dubbo:consumer</a></td> |
| <td>performance tuning</td> |
| <td>load balancing strategy, optional values: <br/>* random - random; <br/>* roundrobin - round <br/>* leastactive - least active call; <br/>* consistenthash - consistent hash (version 2.1.0 and above); <br/>* shortestresponse - shortest response (version 2.7.7 and above);</td> |
| <td>2.0 .0+ version</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>async</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>async of <a href="dubbo:consumer">dubbo:consumer</a> is used by default</td> |
| <td>performance tuning</td> |
| <td>whether to execute asynchronously, unreliable and asynchronous, just ignore the return value and not block the execution thread</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>generic</td> |
| <td>generic</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>default <a href="dubbo:consumer">dubbo:consumer</a> generic</td> |
| <td>service governance</td> |
| <td>whether to default the generic interface, if it is a generic interface, it will return GenericService</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>check</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>default check of <a href="dubbo:consumer">dubbo:consumer</a></td> |
| <td>service governance</td> |
| <td>check whether the provider exists at startup, true will report an error, false will ignore</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>url</td> |
| <td>url</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>point-to-point direct connection service provider address, will bypass the registration center</td> |
| <td>version 1.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>stub</td> |
| <td>stub</td> |
| <td>class/boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The name of the service interface client&rsquo;s local proxy class, which is used to execute local logic on the client, such as local cache, etc. The constructor of the local proxy class must allow input Remote proxy object, constructor such as: public XxxServiceLocal(XxxService xxxService)</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>mock</td> |
| <td>mock</td> |
| <td>class/boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Service interface call failure Mock implementation class name, the Mock class must have a no-argument constructor, the difference from Local is that Local is always executed, while Mock Execute only When a non-business exception occurs (such as timeout, network exception, etc.), Local is executed before the remote call, and Mock is executed after the remote call.</td> |
| <td>Supported by Dubbo1.0.13 and above</td> |
| </tr> |
| <tr> |
| <td>cache</td> |
| <td>cache</td> |
| <td>string/boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The call parameter is used as the key to cache the returned result, optional: lru, threadlocal, jcache, etc.</td> |
| <td>Supported by Dubbo2.1.0 and above</td> |
| </tr> |
| <tr> |
| <td>validation</td> |
| <td>validation</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>whether to enable JSR303 standard annotation validation, if enabled, the annotations on the method parameters will be validated</td> |
| <td>Dubbo2.1.0 and above versions support</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>javassist</td> |
| <td>performance tuning</td> |
| <td>choose dynamic proxy implementation strategy, optional: javassist, jdk</td> |
| <td>version above 2.0.2</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>client transport type setting, such as netty or mina of Dubbo protocol.</td> |
| <td>Supported by Dubbo2.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>By default, the service list will be obtained from all registries and the results will be merged</td> |
| <td>Configuration Association</td> |
| <td>Register to obtain the service list from the specified registry, used when there are multiple registries, the value is <a href="dubbo:registry">dubbo:registry</a> The id attribute, multiple registration center IDs are separated by commas</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>To call the person in charge of the service for service governance, please fill in the email prefix of the person in charge</td> |
| <td>Version above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>actives</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>maximum number of concurrent calls per service consumer per service per method</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>cluster</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>failover</td> |
| <td>performance tuning</td> |
| <td>cluster mode, optional: failover/failfast/failsafe/failback/forking/available/mergeable (2.1. )/zone-aware (version 2.7.5 or later)</td> |
| <td>version 2.0 .5 or later</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>connections</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>100</td> |
| <td>performance tuning</td> |
| <td>the maximum number of connections for each provider, short connection protocols such as rmi, http, and hessian indicate the limit on the number of connections, and long connection agreements such as dubbo indicate the established long connections Number</td> |
| <td>Version 2.0.0 or above</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>reference.filter</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default</td> |
| <td>performance tuning</td> |
| <td>service consumer remote call process interceptor name, multiple names separated by commas</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>invoker.listener</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default</td> |
| <td>performance tuning</td> |
| <td>The service consumer quotes the name of the service listener, and multiple names are separated by commas</td> |
| <td>Version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>the layer where the service caller resides. Such as: biz, dao, intl:web, china:acton.</td> |
| <td>Version 2.0.7 and above</td> |
| </tr> |
| <tr> |
| <td>init</td> |
| <td>init</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>Performance tuning</td> |
| <td>Whether to starvely initialize the reference when afterPropertiesSet(), otherwise wait until someone injects or references the instance before initializing.</td> |
| <td>Version 2.0.10 and above</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td>protocol</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>only call the service provider of the specified protocol, and ignore other protocols.</td> |
| <td>Version 2.7.0 and above</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo protocol defaults to netty</td> |
| <td>service discovery</td> |
| <td>protocol client implementation type, such as: dubbo protocol mina, netty, etc.</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>providerPort</td> |
| <td>provider-port</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Mesh</td> |
| <td>When dubbo.consumer.meshEnable=true, Dubbo will convert the request to K8S standard format by default, and combine VirtualService and DestinationRule for traffic management. At this time, the consumer can perceive to provider. If you don&rsquo;t want to use VirtualService and DestinationRule, please set providerPort to make the consumer aware of the service port exposed by the provider</td> |
| <td>Version 3.1.0 and above</td> |
| </tr> |
| <tr> |
| <td>unloadClusterRelated</td> |
| <td>unloadClusterRelated</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Mesh</td> |
| <td>When dubbo.consumer.meshEnable=true, in Service Mesh mode, set it to true to unload the Directory, Router and Load Balance related to the Cluster in the current call , Delegate retry, load balancing, timeout and other traffic management functions to Sidecar, use VirtualService and DestinationRule for traffic management</td> |
| <td>Version 3.1.0 and above</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>None</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Reserved for extensions, any parameters can be extended and defined, and all extended parameters will be reflected in the URL configuration as they are</td> |
| <td>Version 2.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>providedBy</td> |
| <td>provided-by</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Mesh</td> |
| <td>When dubbo.consumer.meshEnable=true, Dubbo will convert the request to K8S standard format by default, and combine VirtualService and DestinationRule for traffic management. At this time, the consumer can perceive to provider. The value should be consistent with the declared <code>k8s service</code></td> |
| <td>Version 3.1.0 or later</td> |
| </tr> |
| <tr> |
| <td>providerNamespace</td> |
| <td>provider-namespace</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Mesh</td> |
| <td>When dubbo.consumer.meshEnable=true, Dubbo will convert the request into K8S standard format by default, and combine VirtualService and DestinationRule for traffic management. At this time, the Consumer can perceive to provider. Please set the providerNamespace so that the consumer can address the provider dns according to this configuration, the default <code>default</code></td> |
| <td>version 3.1.2 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="registry">registry</h3> |
| <p>Registry configuration. Corresponding configuration class: <code>org.apache.dubbo.config.RegistryConfig</code>. At the same time, if there are multiple different registries, you can declare multiple <code>&lt;dubbo:registry&gt;</code> tags, and specify the registry to use in the <code>registry</code> attribute of <code>&lt;dubbo:service&gt;</code> or <code>&lt;dubbo:reference&gt;</code> .</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>configuration association</td> |
| <td>the registration center references the BeanId, which can be referenced in &lt;dubbo:service registry=&quot;&quot;&gt; or &lt;dubbo:reference registry=&quot;&quot;&gt;</td> |
| <td>version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>address</td> |
| <td><a href="host:port">host:port</a></td> |
| <td>string</td> |
| <td><b>Required</b></td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>The address of the registration center server. If the address has no port, the default is 9090. Multiple addresses in the same cluster are separated by commas. Such as: ip:port, ip:port, registry centers of different clusters, please configure multiple <a href="dubbo:registry">dubbo:registry</a> tags</td> |
| <td>Version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td><protocol></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>service discovery</td> |
| <td>registry address protocol, support <code>dubbo</code>, <code>multicast</code>, <code>zookeeper</code>, <code>redis</code>, <code>consul(2.7. .2)</code>, <code>etcd( 2.7.2)</code>, <code>nacos(2.7.2)</code> and other protocols</td> |
| <td>Version 2.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>port</td> |
| <td><port></td> |
| <td>int</td> |
| <td>optional</td> |
| <td>9090</td> |
| <td>service discovery</td> |
| <td>the default port of the registry, when the address does not have a port, use this port as the default value</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>username</td> |
| <td><username></td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Username for logging in to the registration center, if the registration center does not require verification, it can be left blank</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>password</td> |
| <td><password></td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Password for logging in to the registration center, if the registration center does not require verification, you can leave it blank</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>transport</td> |
| <td>registry.transporter</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>netty</td> |
| <td>performance tuning</td> |
| <td>network transport mode, optional mina, netty</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>registry.timeout</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>5000</td> |
| <td>performance tuning</td> |
| <td>registry center request timeout (milliseconds)</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>session</td> |
| <td>registry.session</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>60000</td> |
| <td>Performance tuning</td> |
| <td>Registry session timeout (milliseconds), used to detect dirty data after abnormal disconnection of the provider, such as the implementation of heartbeat detection, this time It is the heartbeat interval , which is different for different registration centers.</td> |
| <td>Version 2.1.0 and above</td> |
| </tr> |
| <tr> |
| <td>zone</td> |
| <td>zone</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>the region to which the registry belongs, usually used for traffic isolation</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>file</td> |
| <td>registry.file</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Use a file to cache the registry address list and service provider list. When the application is restarted, it will be restored based on this file. Note: two registries cannot use the same file storage</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>wait</td> |
| <td>registry.wait</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>wait notification completion time (milliseconds) when stopping</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>check</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>whether to report an error when the registration center does not exist</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>register</td> |
| <td>register</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Service Governance</td> |
| <td>Whether to register the service with this registry, if set to false, it will only subscribe and not register</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>subscribe</td> |
| <td>subscribe</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>whether to subscribe to this registry service, if set to false, it will only register, not subscribe</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>dynamic</td> |
| <td>dynamic</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Service Governance</td> |
| <td>Whether the service is dynamically registered, if it is set to false, it will be displayed as disabled after registration, it needs to be manually enabled, and when the service provider stops , it will not be automatically unregistered , need to be disabled manually.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>dubbo</td> |
| <td>Service Governance</td> |
| <td>Service registration grouping, cross-group services will not affect each other, and cannot call each other, suitable for environment isolation.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service version</td> |
| <td>version above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>simplified</td> |
| <td>simplified</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>whether the URL registered to the registration center is in simplified mode (compatible with lower versions)</td> |
| <td>version 2.7.0 or later</td> |
| </tr> |
| <tr> |
| <td>extra-keys</td> |
| <td>extraKeys</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>When simplified=true, extraKeys allows you to put extra keys in the URL besides the default parameters, in the format: &ldquo;interface,key1,key2&rdquo;.</td> |
| <td>Version 2.7 .0 and above</td> |
| </tr> |
| <tr> |
| <td>useAsConfigCenter</td> |
| <td></td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>whether the registry is used as a configuration center</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>useAsMetadataCenter</td> |
| <td></td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>whether the registry is used as a metadata center</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>accepts</td> |
| <td>accepts</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The registry receives a list of rpc protocols, multiple protocols are separated by commas, such as dubbo, rest</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>preferred</td> |
| <td>preferred</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>whether to be the preferred registry. When subscribing to multiple registries, if set to true, the registries will be preferred</td> |
| <td>Version 2.7.5 and above</td> |
| </tr> |
| <tr> |
| <td>weight</td> |
| <td>weight</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>registration traffic weight. When using multiple registries, you can use this value to adjust the distribution of registration traffic. This value does not take effect when setting the preferred registry</td> |
| <td>Version 2.7. 5 or later</td> |
| </tr> |
| <tr> |
| <td>registerMode</td> |
| <td>register-mode</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>all</td> |
| <td>Service Governance</td> |
| <td>Control address registration behavior, used for application-level service discovery and migration. <br/>* instance only registers application-level addresses;<br/>* interface only registers interface-level addresses;<br/>* all (default) registers both application-level and interface-level addresses;</td> |
| <td>Version 3.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>enableEmptyProtection</td> |
| <td>enable-empty-protection</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Service Governance</td> |
| <td>Whether to enable the protection of the empty address list on the consumer side globally. After enabling it, the empty address push from the registration center will be ignored. The default is true</td> |
| <td>Version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>None</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Reserved for extensions, any parameters can be extended and defined, and all extended parameters will be reflected in the URL configuration as they are</td> |
| <td>Version 2.0.0 and above</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="config-center">config-center</h3> |
| <p>configuration center. Corresponding configuration class: <code>org.apache.dubbo.config.ConfigCenterConfig</code></p> |
| <p>| Attribute | Corresponding URL parameter | Type | Required | Default | Description | Compatibility | |
| | &mdash;&mdash;&mdash;&mdash;&mdash;- | &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;- | &mdash;&mdash;&mdash; &mdash;&mdash;&mdash;- | &mdash;&mdash;&ndash; | &mdash;&mdash;&mdash;&mdash;&mdash;- | &mdash;&mdash;&mdash;&mdash;- &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&ndash; | &ndash; &mdash;- | |
| | protocol | protocol | string | optional | zookeeper | Which configuration center to use: apollo, zookeeper, nacos, etc. <br />Take zookeeper as an example<br />1. If the protocol is specified, the address can be simplified to <code>127.0.0.1:2181</code>;<br />2. If the protocol is not specified, the address value will be <code>zookeeper:// 127.0.0.1:2181</code> | Version 2.7.0 or higher | |
| | address | address | string | Mandatory | | Configuration center address. <br />See the protocol description for the value | Version 2.7.0 and above | |
| | highestPriority | highest-priority| boolean | optional | true | The configuration item from the configuration center has the highest priority, that is, the local configuration item will be overwritten. | Version 2.7.0 and above | |
| | namespace | namespace | string | optional | dubbo | Usually used for multi-tenant isolation, the actual meaning depends on the specific configuration center. <br />Such as: <br />zookeeper - environment isolation, the default value is <code> dubbo</code>; <br />apollo - distinguishes configuration sets in different domains, using <code>dubbo</code> and <code>application</code> by default | Version 2.7.0 and above | |
| | cluster | cluster | string | optional | | The meaning depends on the selected configuration center. <br />It is used to distinguish different configuration clusters in Apollo | Version 2.7.0 and above | |
| group | group | string | optional | dubbo | The meaning depends on the selected configuration center. <br />nacos - isolate different configuration sets<br />zookeeper - isolate different configuration sets | Version 2.7.0 and above | |
| | check | check | boolean | optional | true | Whether to terminate the application startup when the connection to the configuration center fails. | Version 2.7.0 and above | |
| | configFile | config-file | string | optional | dubbo.properties | the key to which the global configuration file is mapped<br />zookeeper - default path /dubbo/config/dubbo/dubbo.properties<br />apollo - dubbo dubbo.properties key in namespace | Version 2.7.0 or later | |
| | appConfigFile | app-config-file | string | optional | | &ldquo;configFile&rdquo; is shared globally. This item is restricted to properties configured by this application | 2.7.0+ | |
| | timeout | timeout | int | optional | 3000ms | get the configured timeout | version 2.7.0 or later | |
| | username | username | string | optional | | If the configuration center needs to be verified, the username<br />Apollo is not enabled yet | Version 2.7.0 or later | |
| | password | password | string | Optional | | If the configuration center needs to be verified, the password<br />Apollo is not enabled yet | Version 2.7.0 or later | |
| | parameters | parameters | Map&lt;string, string&gt; | Optional | | Extended parameters, used to support customized configuration parameters of different configuration centers | Version 2.7.0 or later | |
| | includeSpringEnv |include-spring-env| boolean | Optional | false | Supported when using the Spring framework. When true, the configuration will be automatically read from the Spring Environment. <br />By default, <br />key is dubbo .properties configuration <br />key is Dubbo.properties PropertySource | Version 2.7.0 or above |</p> |
| <h3 id="metadata-report-config">metadata-report-config</h3> |
| <p>metadata center. Corresponding configuration class: <code>org.apache.dubbo.config.MetadataReportConfig</code></p> |
| <p>| Attribute | Corresponding URL parameter | Type | Required | Default | Description | Compatibility | |
| | &mdash;&mdash;&mdash;&mdash;&mdash; | &mdash;&mdash;&mdash; | &mdash;&mdash; | &mdash;&mdash;&ndash; | &mdash;&mdash;- &ndash; | &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&ndash; &mdash;&mdash;&mdash;&mdash;- | &mdash;&mdash; | |
| | address | address | string | required | | metadata center address. | Version 2.7.0 and above | |
| protocol | protocol | string | optional | zookeeper | metadata center protocol: zookeeper, nacos, redis, etc. <br />Take zookeeper as an example<br />1. If the protocol is specified, the address can be simplified to <code>127.0.0.1:2181</code>;<br />2. If the protocol is not specified, the address value will be <code>zookeeper:// 127.0.0.1:2181</code> | Version 2.7.13 and above | |
| | port | port | int | optional | | metadata center port number. Specify the port, then the address can be simplified, no need to configure the port number | Version 2.7.13 or later | |
| | username | username | string | optional | | metadata center needs to be verified, username<br />Apollo is not enabled yet | version 2.7.0 or later | |
| | password | password | string | Optional | | The metadata center needs to be verified, and the password<br />Apollo is not enabled yet | Version 2.7.0 or later | |
| | timeout | timeout | int | optional | | get metadata timeout (ms) | version 2.7.0 or later | |
| | group | group | string | optional | dubbo | Metadata grouping, suitable for environment isolation. It has the same meaning as the registration center group | Version 2.7.0 and above | |
| | retryTimes | retry-times | int | optional | 100 | number of retries | version 2.7.0 or later | |
| | retryPeriod | retry-period | int | optional | 3000ms | retry interval (ms) | version 2.7.0 or later | |
| | cycleReport | cycle-report | boolean| optional | true | Whether to update full metadata every day | Version 2.7.0 and above | |
| | syncReport | sync-report | boolean| optional | false | whether to update metadata synchronously, the default is asynchronous | version 2.7.0 or later | |
| | cluster | cluster | string | optional | | The meaning depends on the selected metadata center. <br />It is used to distinguish different configuration clusters in Apollo | Version 2.7.0 and above | |
| | file | file | string | optional | | use the file cache metadata center list, when the application is restarted, it will be restored based on this file, note: two metadata centers cannot use the same file storage | version 2.7.0 or later | |
| | check | check | boolean | optional | true | Whether to terminate the application startup when the metadata center connection fails. | Version 3.0.0 and above | |
| | reportMetadata | report-metadata | boolean | Optional | false | Whether to upload the interface configuration report metadata in the address discovery, <code>dubbo.application.metadata-type=remote</code> If the configuration does not work, it will be reported, <code>dubbo. Whether to report when application.metadata-type=local</code> is determined by the configuration value | Version 3.0.0 or later | |
| | reportDefinition | report-definition | boolean | Optional | true | Whether to report metadata for service operation and maintenance | Version 3.0.0 or later | |
| | reportConsumerDefinition | report-consumer-definition | boolean | Optional | true | Whether to report metadata for service operation and maintenance on the consumer side | Version 3.0.0 or later | |
| | parameters | parameters | Map&lt;string, string&gt; | Optional | | Extended parameters, used to support customized configuration parameters of different metadata centers | Version 2.7.0 or later |</p> |
| <h3 id="protocol">protocol</h3> |
| <p>Service provider protocol configuration. Corresponding configuration class: <code>org.apache.dubbo.config.ProtocolConfig</code>. At the same time, if you need to support multiple protocols, you can declare multiple <code>&lt;dubbo:protocol&gt;</code> tags, and specify the used protocol through the <code>protocol</code> attribute in <code>&lt;dubbo:service&gt;</code>.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>configuration association</td> |
| <td>protocol BeanId, you can refer to this ID in &lt;dubbo:service protocol=&quot;&quot;&gt;, if the ID is not filled, the default is the same as the value of the name attribute, and if it is repeated, it will be in the name followed by the serial number.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>name</td> |
| <td><protocol></td> |
| <td>string</td> |
| <td><b>Required</b></td> |
| <td>dubbo</td> |
| <td>Performance tuning</td> |
| <td>Protocol name</td> |
| <td>Version above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>port</td> |
| <td><port></td> |
| <td>int</td> |
| <td>optional</td> |
| <td>The default port of dubbo protocol is 20880, the default port of rmi protocol is 1099, the default port of http and hessian protocol is 80; if <b>no</b> port is configured, The default port will be used automatically, if configured as <b>-1</b>, an unoccupied port will be allocated. For Dubbo 2.4.0+, the allocated port is increased on the basis of the default port of the protocol to ensure that the port segment is controllable.</td> |
| <td>Service Discovery</td> |
| <td>Service Port</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>host</td> |
| <td><host></td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>Automatically find local IP</td> |
| <td>Service discovery</td> |
| <td>- Service host name, used when selecting multiple network cards or specifying VIP and domain name, if it is empty, it will automatically find local IP, - it is recommended not to configure , let Dubbo automatically obtain the local IP</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>threadpool</td> |
| <td>threadpool</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>fixed</td> |
| <td>performance tuning</td> |
| <td>thread pool type, optional: fixed/cached/limit (above 2.5.3)/eager (above 2.6.x)</td> |
| <td>version 2.0.5 or above</td> |
| </tr> |
| <tr> |
| <td>threadname</td> |
| <td>threadname</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>thread pool name</td> |
| <td>version 2.7.6 or later</td> |
| </tr> |
| <tr> |
| <td>threads</td> |
| <td>threads</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>200</td> |
| <td>performance tuning</td> |
| <td>service thread pool size (fixed size)</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>corethreads</td> |
| <td>corethreads</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>200</td> |
| <td>performance tuning</td> |
| <td>thread pool core thread size</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>iothreads</td> |
| <td>threads</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>number of cpus + 1</td> |
| <td>performance tuning</td> |
| <td>io thread pool size (fixed size)</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>accepts</td> |
| <td>accepts</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td></td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>payload</td> |
| <td>payload</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>8388608(=8M)</td> |
| <td>performance tuning</td> |
| <td>request and response packet size limit, unit: byte</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>codec</td> |
| <td>codec</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>performance tuning</td> |
| <td>protocol encoding</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>serialization</td> |
| <td>serialization</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo protocol defaults to hessian2, rmi protocol defaults to java, http protocol defaults to json</td> |
| <td>performance tuning</td> |
| <td>protocol serialization method, used when the protocol supports multiple serialization methods , such as: dubbo, hessian2, java, compactedjava of dubbo protocol, and json of http protocol, etc.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>accesslog</td> |
| <td>accesslog</td> |
| <td>string/boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Set to true, the access log will be output to the logger, you can also fill in the access log file path, directly output the access log to the specified file</td> |
| <td>Version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>path</td> |
| <td><path></td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service discovery</td> |
| <td>provider context path, prefix of service path</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>transporter</td> |
| <td>transporter</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo protocol defaults to netty</td> |
| <td>performance tuning</td> |
| <td>protocol server and client implementation types, such as: dubbo protocol mina, netty, etc., can be split into server and client configuration</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>server</td> |
| <td>server</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>Dubbo protocol defaults to netty, http protocol defaults to servlet</td> |
| <td>Performance tuning</td> |
| <td>The server-side implementation type of the protocol, such as: mina, netty of dubbo protocol, etc., jetty of http protocol, servlet, etc.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>Dubbo protocol defaults to netty</td> |
| <td>Performance tuning</td> |
| <td>Protocol client implementation type, such as: dubbo protocol mina, netty, etc.</td> |
| <td>Version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>dispatcher</td> |
| <td>dispatcher</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo protocol defaults to all</td> |
| <td>performance tuning</td> |
| <td>protocol message distribution method, used to specify the thread model, such as: all, direct, message, execution, connection, etc. of dubbo protocol</td> |
| <td>2.1 .0+ version</td> |
| </tr> |
| <tr> |
| <td>queues</td> |
| <td>queues</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>thread pool queue size, when the thread pool is full, the size of the queue waiting to be executed, it is recommended not to set, when the thread pool is full, it should fail immediately, and retry other Serving provisioning machines, rather than queuing, unless there is a special need.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>charset</td> |
| <td>charset</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>UTF-8</td> |
| <td>performance tuning</td> |
| <td>serialization encoding</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>buffer</td> |
| <td>buffer</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>8192</td> |
| <td>performance tuning</td> |
| <td>network read and write buffer size</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>heartbeat</td> |
| <td>heartbeat</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td>0</td> |
| <td>Performance Tuning</td> |
| <td>A heartbeat is required to help check if a connection is broken</td> |
| <td>2.0.10+</td> |
| </tr> |
| <tr> |
| <td>telnet</td> |
| <td>telnet</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Supported telnet commands, separated by commas</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>register</td> |
| <td>register</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>whether the service of this protocol is registered to the registry</td> |
| <td>version 2.0.8 or later</td> |
| </tr> |
| <tr> |
| <td>contextpath</td> |
| <td>contextpath</td> |
| <td>String</td> |
| <td>optional</td> |
| <td>default is empty string</td> |
| <td>service governance</td> |
| <td>context path</td> |
| <td>version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>sslEnabled</td> |
| <td>ssl-enabled</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>whether to enable ssl</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>parameters</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>optional</td> |
| <td></td> |
| <td>extended parameters</td> |
| <td>version 2.0.0 or later</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="provider">provider</h3> |
| <p>Service provider default configuration. Corresponding configuration class: <code>org.apache.dubbo.config.ProviderConfig</code>. At the same time, this tag is the default value setting of <code>&lt;dubbo:service&gt;</code> and <code>&lt;dubbo:protocol&gt;</code> tags.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>configuration association</td> |
| <td>protocol BeanId, you can refer to this ID in &lt;dubbo:service proivder=&quot;&quot;&gt;</td> |
| <td>version above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td><protocol></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>performance tuning</td> |
| <td>protocol name</td> |
| <td>version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>host</td> |
| <td><host></td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>Automatically search for local IP</td> |
| <td>Service discovery</td> |
| <td>Service host name, used when selecting multiple network cards or specifying VIP and domain name, if it is empty, it will automatically search for local IP. Dubbo automatically obtains the local IP</td> |
| <td>version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>threads</td> |
| <td>threads</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>200</td> |
| <td>performance tuning</td> |
| <td>service thread pool size (fixed size)</td> |
| <td>version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>payload</td> |
| <td>payload</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>8388608(=8M)</td> |
| <td>performance tuning</td> |
| <td>request and response packet size limit, unit: byte</td> |
| <td>version above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>path</td> |
| <td><path></td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service discovery</td> |
| <td>provider context path, prefix of service path</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>transporter</td> |
| <td>transporter</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo protocol defaults to netty</td> |
| <td>performance tuning</td> |
| <td>protocol server and client implementation types, such as: dubbo protocol mina, netty, etc., can be split into server and client configuration</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>server</td> |
| <td>server</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>Dubbo protocol defaults to netty, http protocol defaults to servlet</td> |
| <td>Performance tuning</td> |
| <td>The server-side implementation type of the protocol, such as: mina, netty of dubbo protocol, etc., jetty of http protocol, servlet, etc.</td> |
| <td>Version 2.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>Dubbo protocol defaults to netty</td> |
| <td>Performance tuning</td> |
| <td>Protocol client implementation type, such as: dubbo protocol mina, netty, etc.</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>dispatcher</td> |
| <td>dispatcher</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo protocol defaults to all</td> |
| <td>performance tuning</td> |
| <td>protocol message distribution method, used to specify the thread model, such as: all, direct, message, execution, connection, etc. of dubbo protocol</td> |
| <td>2.1 .0+ version</td> |
| </tr> |
| <tr> |
| <td>codec</td> |
| <td>codec</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>performance tuning</td> |
| <td>protocol encoding</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>serialization</td> |
| <td>serialization</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo protocol defaults to hessian2, rmi protocol defaults to java, http protocol defaults to json</td> |
| <td>performance tuning</td> |
| <td>protocol serialization method, used when the protocol supports multiple serialization methods , such as: dubbo, hessian2, java, compactedjava of the dubbo protocol, and json, xml of the http protocol</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>default</td> |
| <td></td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>configuration association</td> |
| <td>whether it is the default protocol, used for multi-protocol</td> |
| <td>version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>service.filter</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>service provider remote call process interceptor name, multiple names separated by commas</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>exporter.listener</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>service provider export service listener name, multiple names separated by commas</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>threadpool</td> |
| <td>threadpool</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>fixed</td> |
| <td>performance tuning</td> |
| <td>thread pool type, optional: fixed/cached/limit (above 2.5.3)/eager (above 2.6.x)</td> |
| <td>version 2.0.5 or above</td> |
| </tr> |
| <tr> |
| <td>threadname</td> |
| <td>threadname</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>thread pool name</td> |
| <td>version 2.7.6 or later</td> |
| </tr> |
| <tr> |
| <td>accepts</td> |
| <td>accepts</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td></td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>0.0.0</td> |
| <td>service discovery</td> |
| <td>service version, it is recommended to use a two-digit version, such as: 1.0, usually the version number needs to be upgraded when the interface is incompatible</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service discovery</td> |
| <td>service grouping, when an interface has multiple implementations, they can be distinguished by grouping</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>delay</td> |
| <td>delay</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td>0</td> |
| <td>Performance tuning</td> |
| <td>Delayed registration service time (milliseconds) - When set to -1, it means that the service is delayed until the initialization of the Spring container is completed</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>default.timeout</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>1000</td> |
| <td>performance tuning</td> |
| <td>remote service call timeout (milliseconds)</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>default.retries</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>2</td> |
| <td>Performance tuning</td> |
| <td>The number of remote service call retries, excluding the first call, please set it to 0 if you don&rsquo;t need to retry</td> |
| <td>Version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>default.connections</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>the maximum number of connections for each provider, short connection protocols such as rmi, http, and hessian indicate the limit on the number of connections, long connection agreements such as dubbo indicate the established The number of long connections</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>default.loadbalance</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>random</td> |
| <td>performance tuning</td> |
| <td>load balancing strategy, optional values:<br/>* random - random; <br/>* roundrobin - round robin; leastactive - least active call; <br/>* consistenthash - consistent hash (2.1.0+); <br/>* shortestresponse - shortest response (2.7.7+);</td> |
| <td>2.0.5+</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>default.async</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>performance tuning</td> |
| <td>whether to execute asynchronously by default, unreliable and asynchronous, just ignore the return value and not block the execution thread</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>stub</td> |
| <td>stub</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Governance</td> |
| <td>If set to true, it means to use the default proxy class name, namely: interface name + Local suffix.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>mock</td> |
| <td>mock</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Governance</td> |
| <td>Set to true to use the default Mock class name, namely: interface name + Mock suffix.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>token</td> |
| <td>token</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Token verification, empty means not enabled, if true, means randomly generated dynamic tokens</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td>registry</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>register with all registries by default</td> |
| <td>configuration association</td> |
| <td>register with the specified registry, used when there are multiple registries, the value is the id attribute of <a href="dubbo:registry">dubbo:registry</a>, multiple registry IDs Separated by commas, if you do not want to register the service to any registry, you can set the value to N/A</td> |
| <td>Version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>dynamic</td> |
| <td>dynamic</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Service Governance</td> |
| <td>Whether the service is dynamically registered, if it is set to false, the disabled status will be displayed after registration, and it needs to be manually enabled, and the registration will not be canceled automatically when the service provider stops , need to be disabled manually.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>accesslog</td> |
| <td>accesslog</td> |
| <td>string/boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>service management</td> |
| <td>set to true, the access log will be output to the logger, and the access log file path can also be filled in to output the access log directly to the specified file</td> |
| <td>2.0.5 and above version</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>document</td> |
| <td>document</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>service document URL</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>weight</td> |
| <td>weight</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>service weight</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>executes</td> |
| <td>executes</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>the maximum number of parallel execution requests per service and method of a service provider</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>default.actives</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>maximum number of concurrent calls per service consumer per service per method</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>javassist</td> |
| <td>performance tuning</td> |
| <td>generate dynamic proxy, optional: jdk/javassist</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>default.cluster</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>failover</td> |
| <td>performance tuning</td> |
| <td>cluster mode, optional: failover/failfast/failsafe/failback/forking</td> |
| <td>version above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>deprecated</td> |
| <td>deprecated</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Governance</td> |
| <td>Whether the service is deprecated, if set to true, the consumer will print the service deprecated warning error log</td> |
| <td>2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>queues</td> |
| <td>queues</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>thread pool queue size, when the thread pool is full, the size of the queue waiting to be executed, it is recommended not to set, when the thread pool is full, it should fail immediately, and retry other Serving provisioning machines, rather than queuing, unless there is a special need.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>charset</td> |
| <td>charset</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>UTF-8</td> |
| <td>performance tuning</td> |
| <td>serialization encoding</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>buffer</td> |
| <td>buffer</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>8192</td> |
| <td>performance tuning</td> |
| <td>network read and write buffer size</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>iothreads</td> |
| <td>iothreads</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td>CPU + 1</td> |
| <td>Performance tuning</td> |
| <td>IO thread pool, receive network read and write interrupts, serialize and deserialize, do not process business, business thread pool see threads configuration, this thread pool It is related to the CPU and is not recommended to be configured.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>alive</td> |
| <td>alive</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>service management</td> |
| <td>thread pool keepAliveTime, the default unit is ms</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>telnet</td> |
| <td>telnet</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Supported telnet commands, separated by commas</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>wait</td> |
| <td>wait</td> |
| <td>int</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Waiting time when stopping the service</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>contextpath</td> |
| <td>contextpath</td> |
| <td>String</td> |
| <td>optional</td> |
| <td>default is empty string</td> |
| <td>service governance</td> |
| <td>context path</td> |
| <td>version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>the layer where the service provider resides. Such as: biz, dao, intl:web, china:acton.</td> |
| <td>Version 2.0.7 and above</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>parameters</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>extended parameters</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="consumer">consumer</h3> |
| <p>Service consumer default configuration. Configuration class: <code>org.apache.dubbo.config.ConsumerConfig</code>. At the same time, this tag is the default value setting of the <code>&lt;dubbo:reference&gt;</code> tag.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>timeout</td> |
| <td>default.timeout</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>1000</td> |
| <td>performance tuning</td> |
| <td>remote service call timeout (milliseconds)</td> |
| <td>version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>default.retries</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>2</td> |
| <td>Performance tuning</td> |
| <td>The number of remote service call retries, excluding the first call, please set it to 0 if you do not need to retry, it is only valid when the cluster is failback/failover</td> |
| <td>Version 1.0.16 and above</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>default.loadbalance</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>random</td> |
| <td>performance tuning</td> |
| <td>load balancing strategy, optional values:<br/>* random - random; <br/>* roundrobin - round robin; leastactive - least active call; <br/>* consistenthash - consistent hash (2.1.0+); <br/>* shortestresponse - shortest response (2.7.7+);</td> |
| <td>1.0.16+</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>default.async</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>performance tuning</td> |
| <td>whether to execute asynchronously by default, unreliable and asynchronous, just ignore the return value and not block the execution thread</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>sent</td> |
| <td>default.sent</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>when calling asynchronously, when the flag sent=true, it means that the network has sent data</td> |
| <td>version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>default.connections</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>100</td> |
| <td>performance tuning</td> |
| <td>the maximum number of connections for each service to each provider, rmi, http, hessian and other short connection protocols support this configuration, dubbo protocol long connection does not support This configuration</td> |
| <td>1.0.16+ version</td> |
| </tr> |
| <tr> |
| <td>generic</td> |
| <td>generic</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>whether to default the generic interface, if it is a generic interface, it will return GenericService</td> |
| <td>version above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>check</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Service Governance</td> |
| <td>Check whether the provider exists at startup, true reports an error, false ignores</td> |
| <td>version 1.0.16 and above</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>javassist</td> |
| <td>performance tuning</td> |
| <td>generate dynamic proxy, optional: jdk/javassist</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>To call the person in charge of the service for service governance, please fill in the email prefix of the person in charge</td> |
| <td>Version above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>default.actives</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>maximum number of concurrent calls per service consumer per service per method</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>default.cluster</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>failover</td> |
| <td>performance tuning</td> |
| <td>cluster mode, optional: failover/failfast/failsafe/failback/forking/available/mergeable (2.1. above)/zone-aware(2.7.5 above)</td> |
| <td>2.0.5 above</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>reference.filter</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>service consumer remote call process interceptor name, multiple names separated by commas</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>invoker.listener</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>the service consumer quotes the name of the service listener, multiple names are separated by commas</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td></td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default registration to all registries</td> |
| <td>configuration association</td> |
| <td>registration to the specified registry, used in multiple registries, the value is the id attribute of <a href="dubbo:registry">dubbo:registry</a>, used for multiple registries IDs Separated by commas, if you do not want to register the service to any registry, you can set the value to N/A</td> |
| <td>Version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>the layer where the service caller resides. Such as: biz, dao, intl:web, china:acton.</td> |
| <td>Version 2.0.7 and above</td> |
| </tr> |
| <tr> |
| <td>init</td> |
| <td>init</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>Performance tuning</td> |
| <td>Whether to starvely initialize the reference when afterPropertiesSet(), otherwise wait until someone injects or references the instance before initializing.</td> |
| <td>Version 2.0.10 and above</td> |
| </tr> |
| <tr> |
| <td>cache</td> |
| <td>cache</td> |
| <td>string/boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The call parameter is used as the key to cache the returned result, optional: lru, threadlocal, jcache, etc.</td> |
| <td>Supported by version 2.1.0 and above</td> |
| </tr> |
| <tr> |
| <td>validation</td> |
| <td>validation</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>whether to enable JSR303 standard annotation validation, if enabled, the annotations on the method parameters will be validated</td> |
| <td>2.1.0 and above version support</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>configure multiple versions for the same service in Dubbo</td> |
| <td>2.2.0 and above versions support</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td>Dubbo protocol defaults to netty</td> |
| <td>Performance tuning</td> |
| <td>Protocol client implementation type, such as: dubbo protocol mina, netty, etc.</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>threadpool</td> |
| <td>threadpool</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>fixed</td> |
| <td>performance tuning</td> |
| <td>thread pool type, optional: fixed/cached/limit (above 2.5.3)/eager (above 2.6.x)</td> |
| <td>version 2.0.5 or above</td> |
| </tr> |
| <tr> |
| <td>corethreads</td> |
| <td>corethreads</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>200</td> |
| <td>performance tuning</td> |
| <td>thread pool core thread size</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>threads</td> |
| <td>threads</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>200</td> |
| <td>performance tuning</td> |
| <td>service thread pool size (fixed size)</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>queues</td> |
| <td>queues</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>thread pool queue size, when the thread pool is full, the size of the queue waiting to be executed, it is recommended not to set, when the thread pool is full, it should fail immediately, and retry other Serving provisioning machines, rather than queuing, unless there is a special need.</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>shareconnections</td> |
| <td>shareconnections</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>1</td> |
| <td>performance tuning</td> |
| <td>number of shared connections. When the connection parameter is set to 0, the shared mode connection will be enabled, and there is only one connection by default. Only supports dubbo protocol</td> |
| <td>version 2.7.0 and above</td> |
| </tr> |
| <tr> |
| <td>referThreadNum</td> |
| <td></td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance optimization</td> |
| <td>thread pool size for asynchronous calls</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>meshEnable</td> |
| <td>mesh-enable</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>Service Mesh</td> |
| <td>Dubbo Mesh mode switch. After it is turned on, it can adapt to the SideCar mode and convert Dubbo service calls to K8S standard calls. Only supports the Triple protocol and is compatible with GRPC. After setting to true, the native docking K8S, no third-party registration center is required, just set dubbo.registry.address=N/A</td> |
| <td>Version 3.1.0 or later</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>parameters</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>extended parameters</td> |
| <td>version 2.0.0 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="metrics">metrics</h3> |
| <p>Indicator configuration. Configuration class: <code>org.apache.dubbo.config.MetricsConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>protocol</td> |
| <td>protocol</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>prometheus</td> |
| <td>performance tuning</td> |
| <td>protocol name, prometheus is used by default</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>prometheus</td> |
| <td></td> |
| <td>PrometheusConfig</td> |
| <td>optional</td> |
| <td></td> |
| <td>configuration association</td> |
| <td>prometheus related configuration</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>aggregation</td> |
| <td></td> |
| <td>AggregationConfig</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Configuration association</td> |
| <td>Indicator aggregation related configuration</td> |
| <td>Version 3.0.0 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>PrometheusConfig corresponding class: <code>org.apache.dubbo.config.nested.PrometheusConfig</code></li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>exporter.enabled</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>whether to enable prometheus exporter</td> |
| </tr> |
| <tr> |
| <td>exporter.enableHttpServiceDiscovery</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>whether to enable http service discovery</td> |
| </tr> |
| <tr> |
| <td>exporter.httpServiceDiscoveryUrl</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>http service discovery URL</td> |
| </tr> |
| <tr> |
| <td>exporter.metricsPort</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>port number to expose when using the pull method</td> |
| </tr> |
| <tr> |
| <td>exporter.metricsPath</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>path to expose metrics when using pull method</td> |
| </tr> |
| <tr> |
| <td>pushgateway.enabled</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>whether to publish metrics through the Pushgateway of prometheus</td> |
| </tr> |
| <tr> |
| <td>pushgateway.baseUrl</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>Pushgateway address</td> |
| </tr> |
| <tr> |
| <td>pushgateway.username</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>Pushgateway username</td> |
| </tr> |
| <tr> |
| <td>pushgateway.password</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>Pushgateway password</td> |
| </tr> |
| <tr> |
| <td>pushgateway.pushInterval</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>push indicator interval time</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>AggregationConfig corresponding class: <code>org.apache.dubbo.config.nested.AggregationConfig</code></li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>enabled</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>Whether to enable the local indicator aggregation function</td> |
| </tr> |
| <tr> |
| <td>bucketNum</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>the number of time window buckets</td> |
| </tr> |
| <tr> |
| <td>timeWindowSeconds</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>time window duration (s)</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="ssl">ssl</h3> |
| <p>TLS authentication configuration. Configuration class: <code>org.apache.dubbo.config.SslConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>serverKeyCertChainPath</td> |
| <td>server-key-cert-chain-path</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>serverPrivateKeyPath</td> |
| <td>server-private-key-path</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td>server private key path</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>serverKeyPassword</td> |
| <td>server-key-password</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td>server key password</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>serverTrustCertCollectionPath</td> |
| <td>server-trust-cert-collection-path</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td>server trust certificate path</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>clientKeyCertChainPath</td> |
| <td>client-key-cert-chain-path</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td>client signature certificate path</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>clientPrivateKeyPath</td> |
| <td>client-private-key-path</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td>client private key path</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>clientKeyPassword</td> |
| <td>client-key-password</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td>client key password</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| <tr> |
| <td>clientTrustCertCollectionPath</td> |
| <td>client-trust-cert-collection-path</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>security configuration</td> |
| <td>client trust certificate path</td> |
| <td>version 2.7.5 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="module">module</h3> |
| <p>Module information configuration. The corresponding configuration class <code>org.apache.dubbo.config.ModuleConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>name</td> |
| <td>module</td> |
| <td>string</td> |
| <td><b>Required</b></td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Current module name, used by the registry to calculate dependencies between modules</td> |
| <td>Version 2.2.0 or later</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>module.version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>current module version</td> |
| <td>version 2.2.0 or later</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>module.owner</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>The person in charge of the module, used for service governance, please fill in the email prefix of the person in charge</td> |
| <td>Version above 2.2.0</td> |
| </tr> |
| <tr> |
| <td>organization</td> |
| <td>module.organization</td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Organization name (BU or department), which is used by the registration center to distinguish service sources. It is recommended not to use autoconfig for this configuration item, and write it directly in the configuration, such as China, intl, itu, crm, asc, dw, aliexpress, etc.</td> |
| <td>Version 2.2.0 and above</td> |
| </tr> |
| <tr> |
| <td>background</td> |
| <td>background</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>whether to enable the background startup mode. If enabled, there is no need to wait for the spring ContextRefreshedEvent event to complete</td> |
| <td>Version 3.0.0 and above</td> |
| </tr> |
| <tr> |
| <td>referAsync</td> |
| <td>referAsync</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Performance tuning</td> |
| <td>Whether to enable asynchronous calls on the consumer side</td> |
| <td>Version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>referThreadNum</td> |
| <td>referThreadNum</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>thread pool size for asynchronous calls</td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>exportAsync</td> |
| <td>exportAsync</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Performance tuning</td> |
| <td>Whether export is enabled on the server</td> |
| <td>Version 3.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>exportThreadNum</td> |
| <td>exportThreadNum</td> |
| <td>int</td> |
| <td>optional</td> |
| <td></td> |
| <td>asynchronous export thread pool size</td> |
| <td></td> |
| <td>version 3.0.0 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="monitor">monitor</h3> |
| <p>Monitoring center configuration. Corresponding configuration class: <code>org.apache.dubbo.config.MonitorConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>protocol</td> |
| <td>protocol</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>service governance</td> |
| <td>monitoring center protocol, if it is protocol=&ldquo;registry&rdquo;, it means that the address of the monitoring center is found from the registry, otherwise it is directly connected to the monitoring center.</td> |
| <td>Version 2.0.9 and above</td> |
| </tr> |
| <tr> |
| <td>address</td> |
| <td><url></td> |
| <td>string</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Directly connected to the monitoring center server address, address=&ldquo;10.20.130.230:12080&rdquo;</td> |
| <td>Version 1.0.16 or later</td> |
| </tr> |
| <tr> |
| <td>username</td> |
| <td>username</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>monitoring center username</td> |
| <td>version 2.0.9 or later</td> |
| </tr> |
| <tr> |
| <td>password</td> |
| <td>password</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>monitoring center password</td> |
| <td>version 2.0.9 or later</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>grouping</td> |
| <td>version 2.0.9 or later</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>version number</td> |
| <td>version 2.0.9 or later</td> |
| </tr> |
| <tr> |
| <td>interval</td> |
| <td>interval</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>interval time</td> |
| <td>version 2.0.9 or later</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td>parameters</td> |
| <td>Map&lt;string, string&gt;</td> |
| <td>optional</td> |
| <td></td> |
| <td>custom parameters</td> |
| <td>version 2.0.0 or later</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="method">method</h3> |
| <p>Method-level configuration. Corresponding configuration class: <code>org.apache.dubbo.config.MethodConfig</code>. At the same time, this tag is a sub-tag of <code>service</code> or <code>reference</code>, which is used to control to the method level.</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.XxxService&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;findXxx&#34;</span> timeout=<span style="color:#2aa198">&#34;3000&#34;</span> retries=<span style="color:#2aa198">&#34;2&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>name</td> |
| <td></td> |
| <td>string</td> |
| <td><b>required</b></td> |
| <td></td> |
| <td>logo</td> |
| <td>method name</td> |
| <td>version 1.0.8 or later</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td><methodName>.timeout</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>default is timeout</td> |
| <td>performance tuning</td> |
| <td>method call timeout (milliseconds)</td> |
| <td>version 1.0.8 or later</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td><methodName>.retries</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>The default is retries of <a href="dubbo:reference">dubbo:reference</a></td> |
| <td>Performance tuning</td> |
| <td>The number of retries for remote service calls, excluding the first call, please set it to 0</td> |
| <td>Version 2.0.0 or higher</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td><methodName>.loadbalance</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>default is loadbalance</td> |
| <td>performance tuning</td> |
| <td>load balancing strategy, optional values: <br/>* random - random; <br/>* roundrobin - polling ; <br/>* leastactive - least active call; <br/>* consistenthash - consistent hash (version 2.1.0+); <br/>* shortestresponse - shortest response (version 2.7.7+);</td> |
| <td>2.0. Version 0 and above</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td><methodName>.async</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>The default is async of <a href="dubbo:reference">dubbo:reference</a></td> |
| <td>Performance tuning</td> |
| <td>Whether to execute asynchronously, unreliable and asynchronous, just ignore the return value and not block the execution thread</td> |
| <td>1.0.9 above version</td> |
| </tr> |
| <tr> |
| <td>sent</td> |
| <td><methodName>.sent</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Performance tuning</td> |
| <td>When calling asynchronously, when the mark sent=true, it means that the network has sent data</td> |
| <td>Version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td><methodName>.actives</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>maximum concurrent call limit for each service consumer</td> |
| <td>version 2.0.5 or later</td> |
| </tr> |
| <tr> |
| <td>executes</td> |
| <td><methodName>.executes</td> |
| <td>int</td> |
| <td>optional</td> |
| <td>0</td> |
| <td>performance tuning</td> |
| <td>the maximum number of threads used per service and method - -, this attribute is only used when <a href="dubbo:method">dubbo:method</a> is used as a subtag of <a href="dubbo:service">dubbo:service</a> Valid</td> |
| <td>Version 2.0.5 and above</td> |
| </tr> |
| <tr> |
| <td>deprecated</td> |
| <td><methodName>.deprecated</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>false</td> |
| <td>Service Governance</td> |
| <td>Whether the service method is deprecated, this attribute is only valid when <a href="dubbo:method">dubbo:method</a> is used as a subtag of <a href="dubbo:service">dubbo:service</a></td> |
| <td>Version above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>sticky</td> |
| <td><methodName>.sticky</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>set true All methods on this interface use the same provider. If you need more complex rules, please use routing</td> |
| <td>2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>return</td> |
| <td><methodName>.return</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td>true</td> |
| <td>Performance tuning</td> |
| <td>Whether the method call needs to return a value. It will take effect only when async is set to true. If it is set to true, it will return future, or call back methods such as onreturn. If set to false, Null will be returned directly after the request is sent successfully</td> |
| <td>Versions above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>oninvoke</td> |
| <td>attribute attribute, not reflected in the URL</td> |
| <td>String</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Performance tuning</td> |
| <td>Intercept before instance execution</td> |
| <td>Version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>onreturn</td> |
| <td>attribute attribute, not reflected in the URL</td> |
| <td>String</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Performance tuning</td> |
| <td>Intercept after instance execution returns</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>onthrow</td> |
| <td>attribute attribute, not reflected in the URL</td> |
| <td>String</td> |
| <td>optional</td> |
| <td></td> |
| <td>performance tuning</td> |
| <td>exception interception in instance execution</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>oninvokeMethod</td> |
| <td>attribute attribute, not reflected in the URL</td> |
| <td>String</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Performance tuning</td> |
| <td>Intercept before method execution</td> |
| <td>Version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>onreturnMethod</td> |
| <td>attribute attribute, not reflected in the URL</td> |
| <td>String</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Performance tuning</td> |
| <td>Intercept after method execution returns</td> |
| <td>Version above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>onthrowMethod</td> |
| <td>attribute attribute, not reflected in the URL</td> |
| <td>String</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Performance tuning</td> |
| <td>Method execution has exception interception</td> |
| <td>Version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>cache</td> |
| <td><methodName>.cache</td> |
| <td>string/boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Use the call parameter as the key to cache the returned result, optional: lru, threadlocal, jcache, etc.</td> |
| <td>Version above 2.1.0</td> |
| </tr> |
| <tr> |
| <td>validation</td> |
| <td><methodName>.validation</td> |
| <td>boolean</td> |
| <td>Optional</td> |
| <td></td> |
| <td>Service Governance</td> |
| <td>Whether to enable JSR303 standard annotation validation, if enabled, the annotations on method parameters will be validated</td> |
| <td>Version 2.1.0 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="argument">argument</h3> |
| <p>Method parameter configuration. Corresponding configuration class: <code>org.apache.dubbo.config.ArgumentConfig</code>. This tag is a sub-tag of <code>method</code>, which is used to describe the characteristics of method parameters, such as XML format:</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:method</span> name=<span style="color:#2aa198">&#34;findXxx&#34;</span> timeout=<span style="color:#2aa198">&#34;3000&#34;</span> retries=<span style="color:#2aa198">&#34;2&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:argument</span> index=<span style="color:#2aa198">&#34;0&#34;</span> callback=<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:method&gt;</span> |
| </span></span></code></pre></div><table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>index</td> |
| <td></td> |
| <td>int</td> |
| <td><b>required</b></td> |
| <td></td> |
| <td>identifier</td> |
| <td>parameter index</td> |
| <td>version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>type</td> |
| <td></td> |
| <td>String</td> |
| <td>choose one of index and index</td> |
| <td></td> |
| <td>identification</td> |
| <td>find parameter index by parameter type</td> |
| <td>version 2.0.6 or later</td> |
| </tr> |
| <tr> |
| <td>callback</td> |
| <td><metodName><index>.callback</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td></td> |
| <td>service governance</td> |
| <td>whether the parameter is a callback interface, if it is callback, the service provider will generate a reverse proxy, and the consumer can be reversely called from the service provider , usually used for event push.</td> |
| <td>Versions above 2.0.6</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="parameter">parameter</h3> |
| <p>Option parameter configuration. Corresponding configuration class: <code>java.util.Map</code>. At the same time, the label is a sub-label of <code>protocol</code> or <code>service</code> or <code>provider</code> or <code>reference</code> or <code>consumer</code> or <code>monitor</code> or <code>registry</code> or <code>metadata-config</code> or <code>config-center</code>, used for configuration Custom parameters, this configuration item will be used as an extension point to set custom parameters.</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;napoli&#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;http://10.20.160.198/wiki/display/dubbo/napoli.queue.name&#34;</span> value=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:protocol&gt;</span> |
| </span></span></code></pre></div><p>You can also:</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:protocol</span> name=<span style="color:#2aa198">&#34;jms&#34;</span> p:queue=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th></th> |
| <th></th> |
| <th></th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>key</td> |
| <td>key</td> |
| <td>string</td> |
| <td><b>Required</b></td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Routing parameter key</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| <tr> |
| <td>value</td> |
| <td>value</td> |
| <td>string</td> |
| <td><b>Required</b></td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Routing parameter value</td> |
| <td>Version 2.0.0 or later</td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="environment-variables">Environment variables</h3> |
| <p>The supported keys are the following two:</p> |
| <ol> |
| <li> |
| <p><code>dubbo.labels</code>, specify a list of key-value pairs configured in the URL, usually through JVM -D or system environment variables.</p> |
| <p>Add the following configuration:</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><span style="color:#586e75"># JVM</span> |
| </span></span><span style="display:flex;"><span>-Ddubbo.labels <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;tag1=value1; tag2=value2&#34;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># environment variables</span> |
| </span></span><span style="display:flex;"><span>DUBBO_LABELS <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;tag1=value1; tag2=value2&#34;</span> |
| </span></span></code></pre></div><p>The final generated URL will contain two keys tag1 and tag2: <code>dubbo://xxx?tag1=value1&amp;tag2=value2</code></p> |
| </li> |
| <li> |
| <p><code>dubbo.env.keys</code>, specify the environment variable key value, Dubbo will try to load each key from the environment variable</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><span style="color:#586e75"># JVM</span> |
| </span></span><span style="display:flex;"><span>-Ddubbo.env.keys<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;DUBBO_TAG1, DUBBO_TAG2&#34;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># environment variables</span> |
| </span></span><span style="display:flex;"><span>DUBBO_ENV_KEYS <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;DUBBO_TAG1, DUBBO_TAG2&#34;</span> |
| </span></span></code></pre></div><p>The final generated URL will contain two keys DUBBO_TAG1 and DUBBO_TAG2: <code>dubbo://xxx?DUBBO_TAG1=value1&amp;DUBBO_TAG2=value2</code></p> |
| </li> |
| </ol> |
| <h3 id="other-configuration">Other configuration</h3> |
| <h4 id="config-mode">config-mode</h4> |
| <p><strong>background</strong></p> |
| <p>Some types of configuration class instances can only appear once in each dubbo application (such as <code>ApplicationConfig</code>, <code>MonitorConfig</code>, <code>MetricsConfig</code>, <code>SslConfig</code>, <code>ModuleConfig</code>), and some can appear multiple times (such as <code>RegistryConfig</code> , <code>ProtocolConfig</code>, etc.).</p> |
| <p>If the application accidentally scans multiple unique configuration class instances (for example, the user misconfigures two <code>ApplicationConfig</code> in a dubbo application), which strategy should be used to deal with this situation? Is it throwing an exception directly? Is it to keep the former and ignore the latter? Is it to ignore the former and keep the latter? Or does it allow a certain form of coexistence (such as the attributes of the latter overriding the former)?</p> |
| <p>Currently, the only configuration class type in dubbo and the configuration modes/strategies allowed by finding multiple instances of a unique configuration type are as follows.</p> |
| <p><strong>Unique configuration class type</strong></p> |
| <p><code>ApplicationConfig</code>, <code>MonitorConfig</code>, <code>MetricsConfig</code>, <code>SslConfig</code>, <code>ModuleConfig</code>.</p> |
| <p>The first four belong to the application level, and the last one belongs to the module level.</p> |
| <p><strong>configuration mode</strong></p> |
| <ul> |
| <li><code>strict</code>: Strict mode. Throw an exception directly.</li> |
| <li><code>override</code>: override mode. Ignore the former and keep the latter.</li> |
| <li><code>ignore</code>: ignore pattern. Ignore the latter and keep the former.</li> |
| <li><code>override_all</code>: attribute override mode. No matter whether the attribute value of the former is empty or not, the attribute of the latter is overwritten/set on the former.</li> |
| <li><code>override_if_absent</code>: attribute override mode if absent. Only when the corresponding attribute value of the former is empty, can the attribute of the latter be overwritten/set on the former.</li> |
| </ul> |
| <p>Note: The latter two also affect property overrides for configuration instances. Because dubbo has multiple configuration methods, that is, there are multiple configuration sources, and the configuration sources also have priorities. For example, a <code>ServiceConfig</code> is configured through xml and the attribute <code>version=1.0.0</code> is specified. At the same time, we configure <code>dubbo.service.{interface}.version=2.0.0</code> in the external configuration (configuration center), Before the <code>config-mode</code> configuration item is introduced, according to the original configuration source priority, <code>version=2.0.0</code> of the final instance. However, after the <code>config-mode</code> configuration item is introduced, the configuration priority rules are no longer so strict, that is, if <code>config-mode is override_all</code> is specified, it is <code>version=2.0.0</code>, if <code>config-mode is override_if_absent</code> If it is <code>version=1.0.0</code>, if <code>config-mode</code> is other values, the property setting/overwriting will follow the original configuration priority.</p> |
| <p><strong>Configuration method</strong></p> |
| <p>The configured key is <code>dubbo.config.mode</code>, the configured values are as described above, and the default policy value is <code>strict</code>. A sample configuration is shown below</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><span style="color:#586e75"># JVM -D</span> |
| </span></span><span style="display:flex;"><span>-Ddubbo.config.mode<span style="color:#719e07">=</span><span style="color:#2aa198">strict</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># environment variables</span> |
| </span></span><span style="display:flex;"><span>DUBBO_CONFIG_MODE<span style="color:#719e07">=</span><span style="color:#2aa198">strict</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># External configuration (configuration center), Environment of Spring application, dubbo.properties</span> |
| </span></span><span style="display:flex;"><span>dubbo.config.mode<span style="color:#719e07">=</span><span style="color:#2aa198">strict</span> |
| </span></span></code></pre></div></description></item></channel></rss> |
