| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Schema Configuration Reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/</link><description>Recent content in Schema Configuration Reference on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs/v2.7/user/references/xml/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: dubbo:application</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-application/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-application/</guid><description> |
| <p>Application configuration. The corresponding class: <code>org.apache.dubbo.config.ApplicationConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Property</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Requisite</th> |
| <th>Default</th> |
| <th>Effect</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>name</td> |
| <td>application</td> |
| <td>string</td> |
| <td><b>Y</b></td> |
| <td></td> |
| <td>service governance</td> |
| <td>Application name is the unique identifier of an application. It is for registry combing the dependencies of applications. Note: Consumer and provider application name should not be the same, and this parameter is not a match condition. As a suggestion, you can name it as your project name. For example, kylin application invokes the service of morgan application, then you can name kylin application as &ldquo;kylin&rdquo;, and morgan application as &ldquo;morgan&rdquo;. Maybe kylin also works as a provider, but kylin should still called &ldquo;kylin&rdquo;. In this way, registry can understand the dependence of applications</td> |
| <td>above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>application.version</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>The version of current application</td> |
| <td>above 2.2.0</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Application manager. Pls. fill in the mailbox prefix of the person in charge</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>organization</td> |
| <td>organization</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Organization name is for registry distinguishing between the source of service. As a suggestion, this property should be written in config file directly. Such as china,intl,itu,crm,asc,dw,aliexpress etc.</td> |
| <td>above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>architecture <br class="atl-forced-newline" /></td> |
| <td>architecture <br class="atl-forced-newline" /></td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>The architecture of service layering. Like intl,china and so on. Different architecture use different layer</td> |
| <td>above 2.0.7</td> |
| </tr> |
| <tr> |
| <td>environment</td> |
| <td>environment</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Application environment. Like develop,test,product. Work as the limit condition of developing new function</td> |
| <td>above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>compiler</td> |
| <td>compiler</td> |
| <td>string</td> |
| <td>N</td> |
| <td>javassist</td> |
| <td>performance optimization</td> |
| <td>Java class compile.It is used for the generating of dynamic class. The options are JDK and javassist</td> |
| <td>above 2.1.0</td> |
| </tr> |
| <tr> |
| <td>logger</td> |
| <td>logger</td> |
| <td>string</td> |
| <td>N</td> |
| <td>slf4j</td> |
| <td>performance optimization</td> |
| <td>The format of log output，The options are slf4j,jcl,log4j,log4j2 and jdk</td> |
| <td>above 2.2.0</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:argument</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-argument/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-argument/</guid><description> |
| <p>Method argument configuration. The corresponding class：<code>org.apache.dubbo.config.ArgumentConfig</code>. This tag is child of <code>&lt;dubbo:method&gt;</code>, which is for feature description of method argument, such as:</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>Property</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Requisite</th> |
| <th>Default</th> |
| <th>Effect</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>index</td> |
| <td></td> |
| <td>int</td> |
| <td><b>Y</b></td> |
| <td></td> |
| <td>identification</td> |
| <td>method name</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>type</td> |
| <td></td> |
| <td>String</td> |
| <td>Index and type choose one</td> |
| <td></td> |
| <td>identification</td> |
| <td>Find index of argument by it</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>callback</td> |
| <td>&lt;metodName&gt;&lt;index&gt;.retries</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Mark whether this argument is a callback service. If true, provider will generate reverse proxy,which can invoke consumer in turn. Generally for event pushing</td> |
| <td>above 2.0.6</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:config-center</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-config-center/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-config-center/</guid><description> |
| <p>Configuration center. Corresponding configuration class: <code>org.apache.dubbo.config.ConfigCenterConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>property</th> |
| <th>Corresponding URL parameter</th> |
| <th>type</th> |
| <th>required</th> |
| <th>default value</th> |
| <th>description</th> |
| <th>compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>protocol</td> |
| <td>config.protocol</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>zookeeper</td> |
| <td>Which configuration center to use: apollo, zookeeper, nacos, etc.<br />take zookeeper for example<br />1. If protocol is specified, address can be simplified to <code>127.0.0.1:2181</code>;<br />2. If protocol is not specified, address is set to <code>zookeeper://127.0.0.1:2181</code></td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>address</td> |
| <td>config.address</td> |
| <td>string</td> |
| <td>required</td> |
| <td></td> |
| <td>Configuration center address.<br />See protocol description for values</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>highest-priority</td> |
| <td>config.highestPriority</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>Configuration items from the configuration center have the highest priority, it means that the local configuration items will be overwritten.</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>namespace</td> |
| <td>config.namespace</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>Using for multi-tenant isolation generally, the actual meaning varies depending on the configuration center. <br />For example:<br />zookeeper - Environment isolation, default <code>dubbo</code>；<br />apollo - Distinguish between sets of configurations for different domains and use them by default <code>dubbo</code> and <code>application</code></td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>config.cluster</td> |
| <td>string</td> |
| <td>optional</td> |
| <td></td> |
| <td>The meaning varies according to the configuration center selected.<br />For example, it&rsquo;s used to distinguish between different configuration clusters in apollo</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>config.group</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo</td> |
| <td>The meaning varies according to the configuration center selected.<br />nacos - Isolate different configuration sets<br />zookeeper - Isolate different configuration sets</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>config.check</td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>true</td> |
| <td>Whether to terminate application startup when the configuration hub connection fails.</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>config-file</td> |
| <td>config.configFile</td> |
| <td>string</td> |
| <td>optional</td> |
| <td>dubbo.properties</td> |
| <td>The key mapped to the global level profile<br />zookeeper - $DEFAULT_PATH/dubbo/config/dubbo/dubbo.properties<br />apollo - The dubbo.properties key in dubbo namespace</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>config.timeout</td> |
| <td>integer</td> |
| <td></td> |
| <td>3000ms</td> |
| <td>Gets the configured timeout</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>username</td> |
| <td></td> |
| <td>string</td> |
| <td></td> |
| <td></td> |
| <td>the username if the configuration center requires validation<br />Apollo is not yet enabled</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>password</td> |
| <td></td> |
| <td>string</td> |
| <td></td> |
| <td></td> |
| <td>password if configuration center needs to do check<br />Apollo is not yet enabled</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>parameters</td> |
| <td></td> |
| <td>Map&lt;string, string&gt;</td> |
| <td></td> |
| <td></td> |
| <td>Extended parameters to support customized configuration parameters for different configuration centers</td> |
| <td>2.7.0+</td> |
| </tr> |
| <tr> |
| <td>include-spring-env</td> |
| <td></td> |
| <td>boolean</td> |
| <td>optional</td> |
| <td>false</td> |
| <td>With the Spring framework support, when the value is <code>true</code>, it will automatically reads the configuration from the Spring Environment<br />Read by default<br />Configuration with key <code>dubbo.properties</code><br />PropertySource with key <code>dubbo.properties</code></td> |
| <td>2.7.0+</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:consumer</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-consumer/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-consumer/</guid><description> |
| <p>Consumer default configuration. The corresponding clas： <code>org.apache.dubbo.config.ConsumerConfig</code>. It is also default configuration of <code>&lt;dubbo:reference&gt;</code>.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Property</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Requisite</th> |
| <th>Default</th> |
| <th>Effect</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>timeout</td> |
| <td>default.timeout</td> |
| <td>int</td> |
| <td>N</td> |
| <td>1000</td> |
| <td>performance optimization</td> |
| <td>invoking timeout(ms)</td> |
| <td>above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>default.retries</td> |
| <td>int</td> |
| <td>N</td> |
| <td>2</td> |
| <td>performance optimization</td> |
| <td>Invoking retry times, exclude the first invoking. Set 0 to disable it.Only valid if the cluster&rsquo;s value is failback/failover</td> |
| <td>above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>default.loadbalance</td> |
| <td>string</td> |
| <td>N</td> |
| <td>random</td> |
| <td>performance optimization</td> |
| <td>Load balancing strategy. Choices：random, roundrobin(polling), leastactive(invoking least active service)</td> |
| <td>above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>default.async</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>false</td> |
| <td>performance optimization</td> |
| <td>Whether invoke asynchronously</td> |
| <td>above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>default.connections</td> |
| <td>int</td> |
| <td>N</td> |
| <td>100</td> |
| <td>performance optimization</td> |
| <td>The maximum number of connections of per service provider. Only short link protocol such as rmi,http,hessian etc. supports. Long link protocol such as dubbo doesn&rsquo;t support</td> |
| <td>above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>generic</td> |
| <td>generic</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>Whether default generic interface. A instance of GenericService will be got if true.</td> |
| <td>above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>check</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>true</td> |
| <td>service governance</td> |
| <td>Whether check the survival of provider. If true, throw exception when no provider of some services is alive. Otherwise, just ignore it</td> |
| <td>above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>string</td> |
| <td>N</td> |
| <td>javassist</td> |
| <td>performance optimization</td> |
| <td>Java class compile.It is used for the generating of dynamic class. The options are JDK and javassist</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Application manager. Pls. fill in the mailbox prefix of the person in charge</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>default.actives</td> |
| <td>int</td> |
| <td>N</td> |
| <td>0</td> |
| <td>performance optimization</td> |
| <td>The max concurrency of per service method for each corresponding consumer</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>default.cluster</td> |
| <td>string</td> |
| <td>N</td> |
| <td>failover</td> |
| <td>performance optimization</td> |
| <td>Cluster tolerance. Choices：failover/failfast/failsafe/failback/forking</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>reference.filter</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>performance optimization</td> |
| <td>The name of filter which intercepts consumer remote invoke. Multiple names are separated by commas</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>invoker.listener</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>performance optimization</td> |
| <td>The consumer referenced service listener name. Multiple names are separated by commas</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td></td> |
| <td>string</td> |
| <td>N</td> |
| <td>register with the registry</td> |
| <td>configuration relevant</td> |
| <td>Register with the designated registry. Generally，for multiple registries, and value is the &ldquo;id&rdquo; of &lt;dubbo:registry&gt;. Multiple registries are separated by commas.If you do not want to register the service to any registry，pls set &ldquo;N/A&rdquo;</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>The layer of consumer. Such as: biz, dao, intl:web, china:acton</td> |
| <td>above 2.0.7</td> |
| </tr> |
| <tr> |
| <td>init</td> |
| <td>init</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>false</td> |
| <td>performance optimization</td> |
| <td>If true, initialize when &ldquo;afterPropertiesSet()&rdquo; is invoked. Otherwise wait until the instance is referenced to initialize</td> |
| <td>above 2.0.10</td> |
| </tr> |
| <tr> |
| <td>cache</td> |
| <td>cache</td> |
| <td>string/boolean</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Cache return result, and key is call parameters. Choices: lru, threadlocal, jcache and so on</td> |
| <td>at least 2.1.0</td> |
| </tr> |
| <tr> |
| <td>validation</td> |
| <td>validation</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Whether enable JSR303 standard annotation validation</td> |
| <td>at least 2.1.0</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:method</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-method/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-method/</guid><description> |
| <p>Method level configuration. The corresponding class: <code>org.apache.dubbo.config.MethodConfig</code>. This tag is a child tag of <code>&lt;dubbo:service&gt;</code> or <code>&lt;dubbo:reference&gt;</code>, for accuracy to method level.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Property</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Requisite</th> |
| <th>Default</th> |
| <th>Effect</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>name</td> |
| <td></td> |
| <td>string</td> |
| <td><b>Y</b></td> |
| <td></td> |
| <td>identifier</td> |
| <td>Method name</td> |
| <td>above 1.0.8</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>&lt;metodName&gt;.timeout</td> |
| <td>int</td> |
| <td>N</td> |
| <td>&lt;dubbo:reference&gt; timeout</td> |
| <td>performance optimization</td> |
| <td>Method call timeout(ms)</td> |
| <td>above 1.0.8</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>&lt;metodName&gt;.retries</td> |
| <td>int</td> |
| <td>N</td> |
| <td>&lt;dubbo:reference&gt; retries</td> |
| <td>performance optimization</td> |
| <td>Invoking retry times, exclude the first invoking. Set 0 to disable it</td> |
| <td>above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>&lt;metodName&gt;.loadbalance</td> |
| <td>string</td> |
| <td>N</td> |
| <td>&lt;dubbo:reference&gt; loadbalance</td> |
| <td>performance optimization</td> |
| <td>Load balancing strategy. Choices：random, roundrobin(polling), leastactive(invoking least active service)</td> |
| <td>above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>&lt;metodName&gt;.async</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>&lt;dubbo:reference&gt; async</td> |
| <td>performance optimization</td> |
| <td>Whether invoke asynchronously</td> |
| <td>above 1.0.9</td> |
| </tr> |
| <tr> |
| <td>sent</td> |
| <td>&lt;methodName&gt;.sent</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>true</td> |
| <td>performance optimization</td> |
| <td>Generally used when async is true, and If true, indicate that the network has sent out data</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>&lt;metodName&gt;.actives</td> |
| <td>int</td> |
| <td>N</td> |
| <td>0</td> |
| <td>performance optimization</td> |
| <td>The max concurrency of per service method for each corresponding consumer</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>executes</td> |
| <td>&lt;metodName&gt;.executes</td> |
| <td>int</td> |
| <td>N</td> |
| <td>0</td> |
| <td>performance optimization</td> |
| <td>The maximum number of threads of per service method is limited- -. Only take effect when &lt;dubbo:method&gt; is &lt;dubbo:service&gt; child tag</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>deprecated</td> |
| <td>&lt;methodName&gt;.deprecated</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>Whether is deprecated method. Only take effect when &lt;dubbo:method&gt; is &lt;dubbo:service&gt; child tag</td> |
| <td>above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>sticky</td> |
| <td>&lt;methodName&gt;.sticky</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>false</td> |
| <td>service governance</td> |
| <td>If true, all methods on this interface use the same provider. If more complex rules are required, use routing</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>return</td> |
| <td>&lt;methodName&gt;.return</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td>true</td> |
| <td>performance optimization</td> |
| <td>Whether need return value. Only take effect when async is true. If true, return future, or callback such as &ldquo;onreturn&rdquo; method. Otherwise, return null.</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>oninvoke</td> |
| <td></td> |
| <td>String</td> |
| <td>N</td> |
| <td></td> |
| <td>performance optimization</td> |
| <td>Intercept before invoke</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>onreturn</td> |
| <td></td> |
| <td>String</td> |
| <td>N</td> |
| <td></td> |
| <td>performance optimization</td> |
| <td>Intercept after invoke</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>onthrow</td> |
| <td></td> |
| <td>String</td> |
| <td>N</td> |
| <td></td> |
| <td>performance optimization</td> |
| <td>Intercept when catch exception</td> |
| <td>above 2.0.6</td> |
| </tr> |
| <tr> |
| <td>cache</td> |
| <td>&lt;methodName&gt;.cache</td> |
| <td>string/boolean</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Cache return result, and key is call parameters. Choices: lru, threadlocal, jcache and so on</td> |
| <td>at least 2.1.0</td> |
| </tr> |
| <tr> |
| <td>validation</td> |
| <td>&lt;methodName&gt;.validation</td> |
| <td>boolean</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Whether enable JSR303 standard annotation validation</td> |
| <td>at least 2.1.0</td> |
| </tr> |
| </tbody> |
| </table> |
| <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></description></item><item><title>Docs: dubbo:module</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-module/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-module/</guid><description> |
| <p>Module configuration. The corresponding class <code>org.apache.dubbo.config.ModuleConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Property</th> |
| <th>The corresponding class</th> |
| <th>Type</th> |
| <th>Requisite</th> |
| <th>Default</th> |
| <th>Effect</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>name</td> |
| <td>module</td> |
| <td>string</td> |
| <td><b>Y</b></td> |
| <td></td> |
| <td>service governance</td> |
| <td>Module name is for registry combing the dependencies of modules.</td> |
| <td>above 2.2.0</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>module.version</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>module version</td> |
| <td>above 2.2.0</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Module manager, Pls. fill in the mailbox prefix of the person in charge</td> |
| <td>above 2.2.0</td> |
| </tr> |
| <tr> |
| <td>organization</td> |
| <td>organization</td> |
| <td>string</td> |
| <td>N</td> |
| <td></td> |
| <td>service governance</td> |
| <td>Organization name is for registry distinguishing between the source of service. As a suggestion, this property should be written in config file directly. Such as china,intl,itu,crm,asc,dw,aliexpress etc.</td> |
| <td>above 2.2.0</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:monitor</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-monitor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-monitor/</guid><description> |
| <p>Monitor center configuration. The corresponding class: <code>org.apache.dubbo.config.MonitorConfig</code></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Property</th> |
| <th>The corresponding class</th> |
| <th>Type</th> |
| <th>Requisite</th> |
| <th>Default</th> |
| <th>Effect</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>protocol</td> |
| <td>protocol</td> |
| <td>string</td> |
| <td>N</td> |
| <td>dubbo</td> |
| <td>service governance</td> |
| <td>Monitor center protocol. &ldquo;registry&rdquo; means looking up monitor center from registry. Others mean communicating to monitor center directly</td> |
| <td>above 2.0.9</td> |
| </tr> |
| <tr> |
| <td>address</td> |
| <td>&lt;url&gt;</td> |
| <td>string</td> |
| <td>N</td> |
| <td>N/A</td> |
| <td>service governance</td> |
| <td>Communicating to monitor center directly. address=&ldquo;10.20.130.230:12080&rdquo;</td> |
| <td>above 1.0.16</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:parameter</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-parameter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-parameter/</guid><description> |
| <p>Optional parameter configuration. The corresponding class is <code>java.util.Map</code>. This tag is used as a sub tag to configure custom parameters for extending <code>&lt;dubbo:protocol&gt;</code>, <code>&lt;dubbo:service&gt;</code>, <code>&lt;dubbo:provider&gt;</code>, <code>&lt;dubbo:reference&gt;</code> or <code>&lt;dubbo:consumer&gt;</code>.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default Value</th> |
| <th>Function</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>key</td> |
| <td>key</td> |
| <td>string</td> |
| <td><b>True</b></td> |
| <td></td> |
| <td>Service governance</td> |
| <td>routing parameter key</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>value</td> |
| <td>value</td> |
| <td>string</td> |
| <td><b>True</b></td> |
| <td></td> |
| <td>Service governance</td> |
| <td>routing parameter value</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| </tbody> |
| </table> |
| <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 use it like this:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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></description></item><item><title>Docs: dubbo:protocol</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-protocol/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-protocol/</guid><description> |
| <p>Service provider protocol configuration. The corresponding class is <code>org.apache.dubbo.config.ProtocolConfig</code>. If you need to support multiple protocols, you could declare multiple <code>&lt;dubbo:protocol&gt;</code> tags, and specify the protocol via <code>protocol</code> property.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default Value</th> |
| <th>Function</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td>False</td> |
| <td>dubbo</td> |
| <td>Configuration association</td> |
| <td>Bean Id of the protocol, can be referenced in &lt;dubbo:service protocol=&quot;&quot;&gt; The default value is equal to the value of <code>name</code> attribute while <code>id</code> is not filled. If <code>name</code> value has already existed, it will add index to it&rsquo;s suffix.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>name</td> |
| <td>&lt;protocol&gt;</td> |
| <td>string</td> |
| <td><b>True</b></td> |
| <td>dubbo</td> |
| <td>Performance optimize</td> |
| <td>Protocol name</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>port</td> |
| <td>&lt;port&gt;</td> |
| <td>int</td> |
| <td>False</td> |
| <td>The default port of dubbo protocol is 20880, rmi protocol is 1099, http and hessian protocol are 80；It will allocate the default port if <code>port</code> is not filled; It will allocate an unused port if <code>port</code> equals <code>-1</code>. To ensure the ports scope is controllable, the port will increase based on the corresponding protocol default port after Dubbo 2.4.0+</td> |
| <td>Service discovery</td> |
| <td>Service port</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>host</td> |
| <td>&lt;host&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td>Find local IP automatically</td> |
| <td>Service discovery</td> |
| <td>-The host name of services, to specify VIP and domain, or having multiple network cards. If null, it will find local IP automatically- It&rsquo;s recommended to let Dubbo find local IP automatically</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>threadpool</td> |
| <td>threadpool</td> |
| <td>string</td> |
| <td>False</td> |
| <td>fixed</td> |
| <td>Performance optimize</td> |
| <td>The type of Thread Pool, fixed/cached are available</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>threads</td> |
| <td>threads</td> |
| <td>int</td> |
| <td>False</td> |
| <td>200</td> |
| <td>Performance optimize</td> |
| <td>The size of the services&rsquo; Thread Pool(Fixed)</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>iothreads</td> |
| <td>threads</td> |
| <td>int</td> |
| <td>False</td> |
| <td>The count of CPU + 1</td> |
| <td>Performance optimize</td> |
| <td>The size of io Thread Pool(Fixed)</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>accepts</td> |
| <td>accepts</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The maximum connection count of the service provider</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>payload</td> |
| <td>payload</td> |
| <td>int</td> |
| <td>False</td> |
| <td>8388608(=8M)</td> |
| <td>Performance optimize</td> |
| <td>The length limit of request and response, unit is byte</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>codec</td> |
| <td>codec</td> |
| <td>string</td> |
| <td>False</td> |
| <td>dubbo</td> |
| <td>Performance optimize</td> |
| <td>Protocol encoding</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>serialization</td> |
| <td>serialization</td> |
| <td>string</td> |
| <td>False</td> |
| <td>The default serialization of dubbo protocol is hessian2, rmi protocol is java, http protocol is json</td> |
| <td>Performance optimize</td> |
| <td>Protocol serialization, It&rsquo;s used when a protocol has multiple serializations. For example, <code>dubbo</code> protocol has 4 serializations, they are <code>dubbo</code>, <code>hessian2</code>, <code>java</code> and <code>compactedjava</code>.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>accesslog</td> |
| <td>accesslog</td> |
| <td>string/boolean</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td><code>true</code> will write access log to logger. Specifying it to a log path, you can write access logs to special log file.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>path</td> |
| <td>&lt;path&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>Context path, the prefix of the service path</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>transporter</td> |
| <td>transporter</td> |
| <td>string</td> |
| <td>False</td> |
| <td>The default value of dubbo protocol is netty</td> |
| <td>Performance optimize</td> |
| <td>The server and client implements of the protocol. For example, mina and netty for dubbo protocol. You can configure server or client side separately.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>server</td> |
| <td>server</td> |
| <td>string</td> |
| <td>False</td> |
| <td>The default value of dubbo protocol is netty, http protocol is servlet</td> |
| <td>Performance optimize</td> |
| <td>The server implement of the protocol. For example, mina and netty for dubbo ptotocol, jetty and servlet for http protocol.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>False</td> |
| <td>The default value of dubbo protocol is netty</td> |
| <td>Performance optimize</td> |
| <td>The client implement of the protocol. For example, mina and netty for dubbo protocol.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>dispatcher</td> |
| <td>dispatcher</td> |
| <td>string</td> |
| <td>False</td> |
| <td>The default value of dubbo protocol is all</td> |
| <td>Performance optimize</td> |
| <td>specify the thread model of the way to dispatching. Such as <code>all</code>, <code>direct</code>, <code>message</code>, <code>execution</code>, and <code>connection</code> for dubbo protocol.</td> |
| <td>Above 2.1.0</td> |
| </tr> |
| <tr> |
| <td>queues</td> |
| <td>queues</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The queue size of the Thread Pool. It&rsquo;s recommended not to specify it in order to invoke other provides rather than queueing unless you have special requirement.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>charset</td> |
| <td>charset</td> |
| <td>string</td> |
| <td>False</td> |
| <td>UTF-8</td> |
| <td>Performance optimize</td> |
| <td>Serialization encoding</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>buffer</td> |
| <td>buffer</td> |
| <td>int</td> |
| <td>False</td> |
| <td>8192</td> |
| <td>Performance optimize</td> |
| <td>The buffer size of networking IO</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>heartbeat</td> |
| <td>heartbeat</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>Heartbeat interval. For long connection, it&rsquo;s difficult to receive closing event while the physical layer is disconnected. So heartbeat is necessary to help checking the connection quality</td> |
| <td>Above 2.0.10</td> |
| </tr> |
| <tr> |
| <td>telnet</td> |
| <td>telnet</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>Supported telnet commands, use <code>,</code> to separate commands.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>register</td> |
| <td>register</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service discovery</td> |
| <td>Whether registering the corresponding services to registry center</td> |
| <td>Above 2.0.8</td> |
| </tr> |
| <tr> |
| <td>contextpath</td> |
| <td>contextpath</td> |
| <td>String</td> |
| <td>False</td> |
| <td>Default value is an empty string</td> |
| <td>Service discovery</td> |
| <td></td> |
| <td>Above 2.0.6</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:provider</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-provider/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-provider/</guid><description> |
| <p>The default configuration of service provider. The corresponding class is <code>org.apache.dubbo.config.ProviderConfig</code>. This tag provider default values for <code>&lt;dubbo:service&gt;</code> and <code>&lt;dubbo:protocol&gt;</code>.</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Attribute</th> |
| <th>Corresponding URL parameter</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default Value</th> |
| <th>Function</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td>False</td> |
| <td>dubbo</td> |
| <td>Configuration association</td> |
| <td>Bean Id of the protocol, can be referenced in &lt;dubbo:service proivder=&quot;&quot;&gt;</td> |
| <td>Above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td>&lt;protocol&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td>dubbo</td> |
| <td>Performance optimize</td> |
| <td>Protocol name</td> |
| <td>Above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>host</td> |
| <td>&lt;host&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td>Find local IP automatically</td> |
| <td>Service discovery</td> |
| <td>The host name of services, to specify VIP and domain, or having multiple network cards. If null, it will find local IP automatically. It&rsquo;s recommended to let Dubbo find local IP automatically</td> |
| <td>Above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>threads</td> |
| <td>threads</td> |
| <td>int</td> |
| <td>False</td> |
| <td>200</td> |
| <td>Performance optimize</td> |
| <td>The size of the services&rsquo; Thread Pool(Fixed)</td> |
| <td>Above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>payload</td> |
| <td>payload</td> |
| <td>int</td> |
| <td>False</td> |
| <td>8388608(=8M)</td> |
| <td>Performance optimize</td> |
| <td>The length limit of request and response, unit is byte</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>path</td> |
| <td>&lt;path&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>Context path of the service provider, the prefix of the service path</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>server</td> |
| <td>server</td> |
| <td>string</td> |
| <td>False</td> |
| <td>Default is netty for dubbo protocol, servlet for http protocol</td> |
| <td>Performance optimize</td> |
| <td>The server implement of the protocol. For example, mina and netty for dubbo ptotocol, jetty and servlet for http protocol.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>False</td> |
| <td>Default is netty for dubbo protocol</td> |
| <td>Performance optimize</td> |
| <td>The client implement of the protocol. For example, mina and netty for dubbo protocol.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>codec</td> |
| <td>codec</td> |
| <td>string</td> |
| <td>False</td> |
| <td>dubbo</td> |
| <td>Performance optimize</td> |
| <td>Protocol encoding</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>serialization</td> |
| <td>serialization</td> |
| <td>string</td> |
| <td>False</td> |
| <td>Default is hessian2 for dubbo protocol, json for http protocol</td> |
| <td>Performance optimize</td> |
| <td>Protocol serialization, It&rsquo;s used when a protocol has multiple serializations. For example, <code>dubbo</code> protocol has 4 serializations, they are <code>dubbo</code>, <code>hessian2</code>, <code>java</code> and <code>compactedjava</code>, <code>http</code> protocol has <code>json</code> and <code>xml</code>.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>default</td> |
| <td></td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Configuration association</td> |
| <td>To specify the default protocol for support multiple protocols.</td> |
| <td>Above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>service.filter</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Performance optimize</td> |
| <td>The filter name of the RPC process of the provider, use <code>,</code> to separate multiple filter names.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>exporter.listener</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Performance optimize</td> |
| <td>The listener name of the provider, use <code>,</code> to separate multiple listener names.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>threadpool</td> |
| <td>threadpool</td> |
| <td>string</td> |
| <td>False</td> |
| <td>fixed</td> |
| <td>Performance optimize</td> |
| <td>The type of Thread Pool, fixed/cached are available</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>accepts</td> |
| <td>accepts</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The maximum connection count of the service provider</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>False</td> |
| <td>0.0.0</td> |
| <td>Service discovery</td> |
| <td>Service version. It&rsquo;s recommended to use 2 digitals such as <code>1.0</code>. It&rsquo;s necessary to upgrade version only when the service is not compatible.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>The group of the service providers. It can distinguish services when it has multiple implements.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>delay</td> |
| <td>delay</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The delay time(ms) for registering services. When set to -1, it indicates that the services will expose to registry after the Spring context is initialized</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>default.timeout</td> |
| <td>int</td> |
| <td>False</td> |
| <td>1000</td> |
| <td>Performance optimize</td> |
| <td>The RPC timeout(ms)</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>default.retries</td> |
| <td>int</td> |
| <td>False</td> |
| <td>2</td> |
| <td>Performance optimize</td> |
| <td>The retry count for RPC, not including the first invoke. Please set it to 0 if don&rsquo;t need to retry.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>default.connections</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The maximum connections of every provider. For short connection such as rmi, http and hessian, it&rsquo;s connection limit, but for long connection such as dubbo, it&rsquo;s connection count.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>default.loadbalance</td> |
| <td>string</td> |
| <td>False</td> |
| <td>random</td> |
| <td>Performance optimize</td> |
| <td>Strategy of load balance, <code>random</code>, <code>roundrobin</code> and <code>leastactive</code> are available.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>default.async</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Performance optimize</td> |
| <td>Asynchronous execution, not reliable. It does not block the execution thread just only ignores the return value.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>stub</td> |
| <td>stub</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td><code>true</code> means use the default proxy class name, which is the interface name with <code>Local</code> as the suffix.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>mock</td> |
| <td>mock</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td><code>true</code> means use the default mock class name, which is the interface name with <code>Mock</code> suffix.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>token</td> |
| <td>token</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td>Enable token validation. Disable token if it&rsquo;s null. It will generate token randomly when it is enable.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td>registry</td> |
| <td>string</td> |
| <td>False</td> |
| <td>By default, register to all registries</td> |
| <td>Configuration association</td> |
| <td>Register services to specified registry while having multiple registries. It is the <code>id</code> value of the &lt;dubbo:registry&gt;. If don&rsquo;t want to register to any registry, set it as <code>N/A</code></td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>dynamic</td> |
| <td>dynamic</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service governance</td> |
| <td>Whether the service is registered dynamically. If false, services will be showed as <code>disable</code>, you need to enable it manually. And you also need to disable it when provider shut down.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>accesslog</td> |
| <td>accesslog</td> |
| <td>string/boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td><code>true</code> will write access log to logger. Specifying it to a log path, you can write access logs to special log file.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The owner of the service. It&rsquo;s used for service governance.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>document</td> |
| <td>document</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Service document URL</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>weight</td> |
| <td>weight</td> |
| <td>int</td> |
| <td>False</td> |
| <td></td> |
| <td>Performance optimize</td> |
| <td>The weight of the service</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>executes</td> |
| <td>executes</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The maximum parallel execution request count per method per service for the provider.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>default.actives</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The maximum concurrent calls per method per service of the consumer.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>string</td> |
| <td>False</td> |
| <td>javassist</td> |
| <td>Performance optimize</td> |
| <td>The proxy implement, jdk/javassist are available.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>default.cluster</td> |
| <td>string</td> |
| <td>False</td> |
| <td>failover</td> |
| <td>Performance optimize</td> |
| <td>failover/failfast/failsafe/failback/forking are available.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>deprecated</td> |
| <td>deprecated</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td>Mark the service is deprecated. If true, there will log an error log on the client side.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>queues</td> |
| <td>queues</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The queue size of the Thread Pool. It&rsquo;s recommended not to specify it in order to invoke other provides rather than queueing unless you have special requirement.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>charset</td> |
| <td>charset</td> |
| <td>string</td> |
| <td>False</td> |
| <td>UTF-8</td> |
| <td>Performance optimize</td> |
| <td>Serialization encoding</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>buffer</td> |
| <td>buffer</td> |
| <td>int</td> |
| <td>False</td> |
| <td>8192</td> |
| <td>Performance optimize</td> |
| <td>The buffer size of networking IO</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>iothreads</td> |
| <td>iothreads</td> |
| <td>int</td> |
| <td>False</td> |
| <td>CPU + 1</td> |
| <td>Performance optimize</td> |
| <td>The size of io Thread Pool(Fixed). These threads are used to receive, serialize and deserialize IO data. See <code>threads</code> for configuring business thread pool. It&rsquo;s not recommended to configure this.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>telnet</td> |
| <td>telnet</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Supported telnet commands, use <code>,</code> to separate commands.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>contextpath</td> |
| <td>contextpath</td> |
| <td>String</td> |
| <td>False</td> |
| <td>Empty string</td> |
| <td>Service governance</td> |
| <td></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The biz layer of the service provider, such as biz, dao, intl:web and china:acton.</td> |
| <td>Above 2.0.7</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-reference/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-reference/</guid><description> |
| <p>The configuration of service consumer. The corresponding class is<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 Value</th> |
| <th>Function</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td><b>True</b></td> |
| <td></td> |
| <td>Configuration association</td> |
| <td>Bean Id of the service reference</td> |
| <td>Above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>interface</td> |
| <td></td> |
| <td>class</td> |
| <td><b>True</b></td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>Interface name of the service</td> |
| <td>Above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>Service version, must be equal to the provider&rsquo;s version</td> |
| <td>Above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>The group of the service reference, must be equal to the provider&rsquo;s group. It can distinguish services when it has multiple implements.</td> |
| <td>Above 1.0.7</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>timeout</td> |
| <td>long</td> |
| <td>False</td> |
| <td>By default, use &lt;dubbo:consumer&gt; timeout</td> |
| <td>Performance optimize</td> |
| <td>The RPC timeout(ms)</td> |
| <td>Above 1.0.5</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>retries</td> |
| <td>int</td> |
| <td>False</td> |
| <td>By default, use &lt;dubbo:consumer&gt; retries</td> |
| <td>Performance optimize</td> |
| <td>The retry count for RPC, not including the first invoke. Please set it to 0 if don&rsquo;t need to retry.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>connections</td> |
| <td>int</td> |
| <td>False</td> |
| <td>By default, use &lt;dubbo:consumer&gt; connections</td> |
| <td>Performance optimize</td> |
| <td>The maximum connections of every provider. For short connection such as rmi, http and hessian, it&rsquo;s connection limit, but for long connection such as dubbo, it&rsquo;s connection count.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>loadbalance</td> |
| <td>string</td> |
| <td>False</td> |
| <td>By default, use &lt;dubbo:consumer&gt; loadbalance</td> |
| <td>Performance optimize</td> |
| <td>Strategy of load balance, <code>random</code>, <code>roundrobin</code> and <code>leastactive</code> are available.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>async</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>By default, use &lt;dubbo:consumer&gt; async</td> |
| <td>Performance optimize</td> |
| <td>Asynchronous execution, not reliable. It does not block the execution thread just only ignores the return value.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>generic</td> |
| <td>generic</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>By default, use &lt;dubbo:consumer&gt; generic</td> |
| <td>Service governance</td> |
| <td>Enable generic interface. If true, the reference will return <code>GenericService</code></td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>check</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>By default, use &lt;dubbo:consumer&gt; check</td> |
| <td>Service governance</td> |
| <td>Check the exist of the provider. If true, it will throw exception when provider is not exist. If false, will ignore.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>url</td> |
| <td>url</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Connect to the provider directly via this url. It will bypass the registry.</td> |
| <td>Above 1.0.6</td> |
| </tr> |
| <tr> |
| <td>stub</td> |
| <td>stub</td> |
| <td>class/boolean</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The local proxy class name of the client, it&rsquo;s used to execute local logic such as caching. The proxy class must have a constructor with the remote proxy object as a parameter, such as <code>public XxxServiceLocal(XxxService xxxService)</code></td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>mock</td> |
| <td>mock</td> |
| <td>class/boolean</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The mock class name. It&rsquo;s called when the RPC is failed, such as timeout or IO exception. The mock class must carry a none parameter constructor. The difference between mock and local proxy is that local proxy is always invoked before RPC but mock is invoked only when exception after RPC.</td> |
| <td>Above 1.0.13</td> |
| </tr> |
| <tr> |
| <td>cache</td> |
| <td>cache</td> |
| <td>string/boolean</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>lru, threadlocal, jcache等Using RPC parameters as the key to cache the result. <code>lru</code>, <code>threadlocal</code> and <code>jcache</code> are available.</td> |
| <td>Above 2.1.0</td> |
| </tr> |
| <tr> |
| <td>validation</td> |
| <td>validation</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Enable JSR303 annotation validation. If true, it will validate the method parameters&rsquo; annotations.</td> |
| <td>Above 2.1.0</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>javassist</td> |
| <td>Performance optimize</td> |
| <td>The proxy implement, jdk/javassist are available.</td> |
| <td>Above 2.0.2</td> |
| </tr> |
| <tr> |
| <td>client</td> |
| <td>client</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Performance optimize</td> |
| <td>The transport type of the client, such as netty and mina for dubbo protocol.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td></td> |
| <td>string</td> |
| <td>False</td> |
| <td>By default, it will merge all the service providers that getting from all registries</td> |
| <td>Configuration association</td> |
| <td>Get provider lists from the specified registry. It is the <code>id</code> value of the &lt;dubbo:registry&gt;, use <code>,</code> to separate multiple regsitries id.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The owner of the service. It&rsquo;s used for service governance.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>actives</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The maximum concurrent calls per method per service of the consumer.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>cluster</td> |
| <td>string</td> |
| <td>False</td> |
| <td>failover</td> |
| <td>Performance optimize</td> |
| <td>failover/failfast/failsafe/failback/forking are available.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>reference.filter</td> |
| <td>string</td> |
| <td>False</td> |
| <td>default</td> |
| <td>Performance optimize</td> |
| <td>The filter name of the RPC process of the reference, use <code>,</code> to separate multiple filter names.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>invoker.listener</td> |
| <td>string</td> |
| <td>False</td> |
| <td>default</td> |
| <td>Performance optimize</td> |
| <td>The listener name of the reference, use <code>,</code> to separate multiple listener names.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The biz layer of the service provider, such as biz, dao, intl:web and china:acton.</td> |
| <td>Above 2.0.7</td> |
| </tr> |
| <tr> |
| <td>init</td> |
| <td>init</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Performance optimize</td> |
| <td>If true, init the service reference when <code>afterPropertiesSet()</code>is invoked, or it will init later only when it is referenced and autowired.</td> |
| <td>Above 2.0.10</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td>protocol</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Only invoke the providers with specified protocol, and ignore other protocol providers.</td> |
| <td>Above 2.2.0</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:registry</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-registry/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-registry/</guid><description> |
| <p>The configuration of the registry center. The corresponding class is <code>org.apache.dubbo.config.RegistryConfig</code>. If you have multiple different registries, you can declare multiple <code>&lt;dubbo:registry&gt;</code> tags, and then reference specified registry with <code>registry</code> property in <code>&lt;dubbo:service&gt;</code> or <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 Value</th> |
| <th>Function</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td></td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Configuration association</td> |
| <td>Bean Id of the registry center, can be referenced in &lt;dubbo:service registry=&quot;&quot;&gt;or &lt;dubbo:reference registry=&quot;&quot;&gt;</td> |
| <td>Above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>address</td> |
| <td>&lt;host:port&gt;</td> |
| <td>string</td> |
| <td><b>True</b></td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>The address of the registry center. If the address has no port, default port 9999 will be adopted. Multiple addresses within the same cluster use <code>,</code> to seperate, such as <code>ip:port,ip:port</code>. Multiple registries within different cluster, please configure different <code>dubbo:registry</code> tag.</td> |
| <td>Above 1.0.16</td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td>&lt;protocol&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td>dubbo</td> |
| <td>Service discovery</td> |
| <td>The protocol of the registry center. <code>dubbo</code>, <code>multicast</code>, <code>zookeeper</code>, <code>redis</code>, <code>consul(2.7.1)</code>, <code>sofa(2.7.2)</code>, <code>etcd(2.7.2)</code>, <code>nacos(2.7.2)</code> are available.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>port</td> |
| <td>&lt;port&gt;</td> |
| <td>int</td> |
| <td>False</td> |
| <td>9090</td> |
| <td>Service discovery</td> |
| <td>The default port of the registry. When the <code>address</code> has no port, this default port will be adopted.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>username</td> |
| <td>&lt;username&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The usename of the registry. Do not set it if the registry doesn&rsquo;t need validation.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>password</td> |
| <td>&lt;password&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The password of the registry. Do not set it if the registry doesn&rsquo;t need validation.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>transport</td> |
| <td>registry.transporter</td> |
| <td>string</td> |
| <td>False</td> |
| <td>netty</td> |
| <td>Performance optimize</td> |
| <td>mina, netty are available.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>registry.timeout</td> |
| <td>int</td> |
| <td>False</td> |
| <td>5000</td> |
| <td>Performance optimize</td> |
| <td>The timeout(ms) of the request to registry.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>session</td> |
| <td>registry.session</td> |
| <td>int</td> |
| <td>False</td> |
| <td>60000</td> |
| <td>Performance optimize</td> |
| <td>The session timeout(ms) of the registry. It&rsquo;s used to check whether the providers are alive. It depends on the implement of the registry. For example, for HeartBeat implement, the timeout is the interval of two heart beats.</td> |
| <td>Above 2.1.0</td> |
| </tr> |
| <tr> |
| <td>file</td> |
| <td>registry.file</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The local file to cache the address list of registries and providers. When application restarts, it will restore the registries and providers. Please use different file for different registy.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>wait</td> |
| <td>registry.wait</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>Stop wait for a notice completion time (ms)</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>check</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service governance</td> |
| <td>Whether throwing exception while the registry isn&rsquo;t existed.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>register</td> |
| <td>register</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service governance</td> |
| <td>whether registering to the registry center. If false, just subscribing, not registering.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>subscribe</td> |
| <td>subscribe</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service governance</td> |
| <td>whether subscribing from the registry center. If false, just registering, not subscribing.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>dynamic</td> |
| <td>dynamic</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service governance</td> |
| <td>Whether the service is registered dynamically. If false, services will be showed as <code>disable</code>, you need to enable it manually. And you also need to disable it when provider shut down.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>False</td> |
| <td>dubbo</td> |
| <td>Service governance</td> |
| <td>Service registration grouping, cross-group services will not affect each other, and can not be called each other, suitable for environmental isolation.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>simplified</td> |
| <td>simplified</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td>Registered with the registry URL whether to adopt the lean mode (compatible with low version)</td> |
| <td>Above 2.7.0</td> |
| </tr> |
| <tr> |
| <td>extra-keys</td> |
| <td>extraKeys</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>In simplified = true, extraKeys allows you to outside the default arguments put additional key in the URL, format: &ldquo;interface, key1, key2&rdquo;.</td> |
| <td>Above 2.7.0</td> |
| </tr> |
| </tbody> |
| </table></description></item><item><title>Docs: dubbo:service</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-service/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-service/</guid><description> |
| <p>The configuration of the service provider. The corresponding class is <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 Value</th> |
| <th>Function</th> |
| <th>Description</th> |
| <th>Compatibility</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>interface</td> |
| <td></td> |
| <td>class</td> |
| <td><b>True</b></td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>The service interface name</td> |
| <td>Above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>ref</td> |
| <td></td> |
| <td>object</td> |
| <td><b>True</b></td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>The reference to the service implementation</td> |
| <td>Above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version</td> |
| <td>string</td> |
| <td>False</td> |
| <td>0.0.0</td> |
| <td>Service discovery</td> |
| <td>Service version. It&rsquo;s recommended to use 2 digitals such as <code>1.0</code>. It&rsquo;s necessary to upgrade version only when the service is not compatible.</td> |
| <td>Above 1.0.0</td> |
| </tr> |
| <tr> |
| <td>group</td> |
| <td>group</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service discovery</td> |
| <td>The group of the service providers. It can distinguish services when it has multiple implements.</td> |
| <td>Above 1.0.7</td> |
| </tr> |
| <tr> |
| <td>path</td> |
| <td>&lt;path&gt;</td> |
| <td>string</td> |
| <td>False</td> |
| <td>default value is the interface name</td> |
| <td>Service discovery</td> |
| <td>In 1.0, service path is not supported, it&rsquo;s always equals to the interface name. So it may not compitable when a service reference in 1.0 calls a service provider in 2.0 that specified path.</td> |
| <td>Above 1.0.12</td> |
| </tr> |
| <tr> |
| <td>delay</td> |
| <td>delay</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The delay time(ms) for registering services. When set to -1, it indicates that the services will expose to registry after the Spring context is initialized</td> |
| <td>Above 1.0.14</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>timeout</td> |
| <td>int</td> |
| <td>False</td> |
| <td>1000</td> |
| <td>Performance optimize</td> |
| <td>The RPC timeout(ms)</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>retries</td> |
| <td>int</td> |
| <td>False</td> |
| <td>2</td> |
| <td>Performance optimize</td> |
| <td>The retry count for RPC, not including the first invoke. Please set it to 0 if don&rsquo;t need to retry.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>connections</td> |
| <td>int</td> |
| <td>False</td> |
| <td>100</td> |
| <td>Performance optimize</td> |
| <td>The maximum connections of every provider. For short connection such as rmi, http and hessian, it&rsquo;s connection limit, but for long connection such as dubbo, it&rsquo;s connection count.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>loadbalance</td> |
| <td>loadbalance</td> |
| <td>string</td> |
| <td>False</td> |
| <td>random</td> |
| <td>Performance optimize</td> |
| <td>Strategy of load balance, <code>random</code>, <code>roundrobin</code> and <code>leastactive</code> are available.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>async</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Performance optimize</td> |
| <td>Asynchronous execution, not reliable. It does not block the execution thread just only ignores the return value.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>local</td> |
| <td>local</td> |
| <td>class/boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td><code>true</code> means use the default proxy class name, which is the interface name with <code>Local</code> as the suffix. But it has been marked as @Deprecated.Pleas see also stub.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>stub</td> |
| <td>stub</td> |
| <td>class/boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td><code>true</code> means use the default proxy class name, which is the interface name with <code>Stub</code> as the suffix. It&rsquo;s used to execute local logic such as caching. The proxy class must have a constructor with the remote proxy object as a parameter, such as <code>public XxxServiceStub(XxxService xxxService)</code></td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>mock</td> |
| <td>mock</td> |
| <td>class/boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td><code>true</code> means use the default mock class name, which is the interface name with <code>Mock</code> suffix. It&rsquo;s called when the RPC is failed, such as timeout or IO exception. The mock class must carry a none parameter constructor. The difference between mock and local proxy is that local proxy is always invoked before RPC but mock is invoked only when exception after RPC.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>token</td> |
| <td>token</td> |
| <td>string/boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td>Enable token validation. Disable token if it&rsquo;s null. It will generate token randomly when enable, or will use static token. The token is designed to prevent consumers from bypassing the registry direct access to provider. If you want peer to peer, token validation must disbable.</td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>registry</td> |
| <td></td> |
| <td>string</td> |
| <td>False</td> |
| <td>register to all registries by default</td> |
| <td>Configuration association</td> |
| <td>Register services to specified registry while having multiple registries. It is the <code>id</code> value of the &lt;dubbo:registry&gt;. If don&rsquo;t want to register to any registry, set it as <code>N/A</code></td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>provider</td> |
| <td></td> |
| <td>string</td> |
| <td>False</td> |
| <td>use the first configured provider</td> |
| <td>Configuration association</td> |
| <td>The reference to <code>&lt;dubbo:provider&gt;</code></td> |
| <td>Above 2.0.0</td> |
| </tr> |
| <tr> |
| <td>deprecated</td> |
| <td>deprecated</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td>Mark the service is deprecated. If true, there will log an error log on the client side.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>dynamic</td> |
| <td>dynamic</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service governance</td> |
| <td>Whether the service is registered dynamically. If false, services will be showed as <code>disable</code>, you need to enable it manually. And you also need to disable it when provider shut down.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>accesslog</td> |
| <td>accesslog</td> |
| <td>string/boolean</td> |
| <td>False</td> |
| <td>false</td> |
| <td>Service governance</td> |
| <td><code>true</code> will write access log to logger. Specifying it to a log path, you can write access logs to special log file.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>owner</td> |
| <td>owner</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The owner of the service. It&rsquo;s used for service governance.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>document</td> |
| <td>document</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>Service document URL</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>weight</td> |
| <td>weight</td> |
| <td>int</td> |
| <td>False</td> |
| <td></td> |
| <td>Performance optimize</td> |
| <td>The weight of the service</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>executes</td> |
| <td>executes</td> |
| <td>int</td> |
| <td>False</td> |
| <td>0</td> |
| <td>Performance optimize</td> |
| <td>The maximum parallel execution request count per method per service for the provider.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>proxy</td> |
| <td>proxy</td> |
| <td>string</td> |
| <td>False</td> |
| <td>javassist</td> |
| <td>Performance optimize</td> |
| <td>The proxy implement, jdk/javassist are available.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>cluster</td> |
| <td>cluster</td> |
| <td>string</td> |
| <td>False</td> |
| <td>failover</td> |
| <td>Performance optimize</td> |
| <td>failover/failfast/failsafe/failback/forking are available.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>filter</td> |
| <td>service.filter</td> |
| <td>string</td> |
| <td>False</td> |
| <td>default</td> |
| <td>Performance optimize</td> |
| <td>The filter name of the RPC process of the provider, use <code>,</code> to separate multiple filter names.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>listener</td> |
| <td>exporter.listener</td> |
| <td>string</td> |
| <td>False</td> |
| <td>default</td> |
| <td>Performance optimize</td> |
| <td>The listener name of the provider, use <code>,</code> to separate multiple listener names.</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>protocol</td> |
| <td></td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Configuration association</td> |
| <td>Specify the protocol for service provider. It references the <code>id</code> of <code>&lt;dubbo:protocol&gt;</code> tag. Use <code>,</code> to separate multiple protocols.</td> |
| <td>Above 2.0.5</td> |
| </tr> |
| <tr> |
| <td>layer</td> |
| <td>layer</td> |
| <td>string</td> |
| <td>False</td> |
| <td></td> |
| <td>Service governance</td> |
| <td>The biz layer of the service provider, such as biz, dao, intl:web and china:acton.</td> |
| <td>Above 2.0.7</td> |
| </tr> |
| <tr> |
| <td>register</td> |
| <td>register</td> |
| <td>boolean</td> |
| <td>False</td> |
| <td>true</td> |
| <td>Service governance</td> |
| <td>Whether registering service providers to registry.</td> |
| <td>Above 2.0.8</td> |
| </tr> |
| </tbody> |
| </table></description></item></channel></rss> |
