| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Documentation</title><link>https://dubbo.apache.org/en/docs/</link><description>Recent content in Documentation on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs3-V2: 0-1 - thread pool resource exhausted</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/0/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/0/1/</guid><description> |
| <p>The server&rsquo;s thread resources are exhausted. |
| By default, the number of business threads on the Dubbo server is 200. If the number of concurrent requests exceeds 200, new requests will be rejected and this error will be thrown.</p> |
| <h3 id="possible-reason">Possible Reason</h3> |
| <ol> |
| <li>The amount of concurrent requests from the Consumer is too large, causing the number of threads created on the Provider to exceed the limit.</li> |
| <li>It is possible that when the Provider side executes the business, the thread is blocked because the business calls the external application interface, which makes the thread pool unable to recycle the thread.</li> |
| </ol> |
| <h3 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h3> |
| <ul> |
| <li>Enable Dubbo&rsquo;s access log function to check whether there are a large number of calls to RPC services in a short period of time.</li> |
| <li>Check the status of each thread in the thread pool through the <code>jps</code> and <code>jstack</code> instructions to see if there is any business calling the external application interface to cause blocking.</li> |
| <li>If the amount of concurrent requests from the Consumer is too large, then adjust the <code>dubbo.provider.threads</code> parameter on the Provider side to increase the number of Dubbo thread pools.</li> |
| <li>If the QPS of the Provider business is too large to be handled by the current number of servers, then increase the number of Provider-side servers so that more servers can share the pressure.</li> |
| </ul> |
| <blockquote> |
| <p>The FAQ page of this error code refers to <a href="https://github.com/StabilityMan/StabilityGuide/blob/master/docs/diagnosis/plugin/rpc/%E7%B3%BB%E7%BB%9F%E7%A8%B3%E5%AE%9A%E6%80%A7%E2%80%94%E2%80%94Dubbo%E5%B8%B8%E8%A7%81%E9%94%99%E8%AF%AF%E5%8F%8A%E8%A7%A3%E5%86%B3%E6%96%B9%E6%B3%95.md">&ldquo;Dubbo Common Errors and Solutions&rdquo;</a>. |
| Articles cited are compiled under license <a href="http://creativecommons.org/licenses/by/4.0/">CC-BY-4.0</a>. Thanks to the original author here.</p> |
| </blockquote></description></item><item><title>Docs3-V2: 1-1 - Address Illegal</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/1/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/1/1/</guid><description> |
| <p>This log can be ignored, service version or grouping mismatch. Appears only in the zookeeper registry, this check has been removed in version 3.1.7.</p> |
| <h3 id="possible-reason">possible reason</h3> |
| <ol> |
| <li>The <code>service.group</code> configured on the Provider side does not match the <code>reference.group</code> configured on the Consumer side (that is, the configuration of the service group).</li> |
| <li>The <code>service.version</code> configured on the Provider side does not match the <code>reference.version</code> configured on the Consumer side (that is, the configuration of the service version).</li> |
| </ol> |
| <h3 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h3> |
| <p>Can be ignored, this check has been removed in version 3.1.7.</p></description></item><item><title>Docs3-V2: 2-1 - Routing execution failed</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/2/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/2/1/</guid><description> |
| <h2 id="routing-address-execution-failed">Routing address execution failed</h2></description></item><item><title>Docs3-V2: 2.x to 3.x Operation Guide</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/upgrades-and-compatibility/2.x-to-3.x-compatibility-guide/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/upgrades-and-compatibility/2.x-to-3.x-compatibility-guide/</guid><description> |
| <h2 id="benefits-of-upgrading-to-dubbo-3x">Benefits of upgrading to Dubbo 3.X</h2> |
| <p>Dubbo3 still maintains the classic architecture of 2.x. Its main responsibility is to solve the communication between microservice processes, and to better manage and control microservice clusters through rich service governance (such as address discovery, traffic management, etc.); The upgrade of the framework is comprehensive, reflected in almost every aspect of the core Dubbo features, through the upgrade to achieve a comprehensive improvement in stability, performance, scalability, and ease of use.</p> |
| <p><img src="https://dubbo.apache.org/imgs/v3/concepts/architecture-1.png" alt="architecture-1"></p> |
| <ul> |
| <li>**Universal communication protocol. ** The new RPC protocol should abandon the private protocol stack, use the more general HTTP/2 protocol as the transport layer carrier, and use the standardized features of the HTTP protocol to solve the problems of traffic versatility and penetration, so that the protocol can better respond Scenarios such as front-end and back-end docking, gateway proxy, etc.; supports the Stream communication mode, which meets the demands of different business communication models and brings greater throughput to the cluster.</li> |
| <li>**For millions of cluster instances, the cluster is highly scalable. ** With the promotion of micro-service practices, the scale of micro-service cluster instances is also constantly expanding, which benefits from the characteristics of light-weight micro-services and easy horizontal expansion, but also brings a burden to the entire cluster capacity, especially It is some centralized service governance components; Dubbo3 needs to solve various resource bottlenecks caused by the expansion of instance scale, and realize truly unlimited horizontal expansion.</li> |
| <li>**Comprehensively embrace cloud native. **</li> |
| </ul> |
| <h2 id="dubbo-30-new-features">Dubbo 3.0 new features</h2> |
| <p>The new features provided by Dubbo 3.0 include:</p> |
| <ul> |
| <li>** New address discovery model (application-level service discovery). ** |
| <ul> |
| <li>See <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/upgrades-and-compatibility/service-discovery/service-discovery-samples/">Application-Level Service Discovery Migration Samples</a>.</li> |
| <li>See <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/upgrades-and-compatibility/service-discovery/migration-service-discovery/">Migration steps for application-level service discovery</a></li> |
| <li>See <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/upgrades-and-compatibility/service-discovery/service-discovery-rule/">Description of application-level service discovery address migration rules</a></li> |
| </ul> |
| </li> |
| <li>**The next generation of the HTTP/2-based Triple protocol. ** |
| <ul> |
| <li>See <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/upgrades-and-compatibility/migration-triple/">Triple Protocol Migration Steps</a></li> |
| <li>See <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/protocol/triple/guide/">Triple protocol usage</a></li> |
| <li>See <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/protocol/triple/overview/">Triple Protocol Design and Implementation</a>.</li> |
| </ul> |
| </li> |
| <li>**Unified routing rules. ** |
| <ul> |
| <li>See <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/traffic/mesh-style/">Design and Implementation of Unified Routing Rules</a></li> |
| </ul> |
| </li> |
| </ul> |
| <h2 id="compatibility-check-before-upgrade">Compatibility check before upgrade</h2> |
| <p>In the process of cross-version upgrade, the existing risks are from big to small: directly modify Dubbo source code -&gt; expand based on Dubbo SPI extension points -&gt; use methods based on API or Spring.</p> |
| <h3 id="1-directly-modify-dubbo-source-code">1. Directly modify Dubbo source code</h3> |
| <p>For those who need to directly modify this part of Dubbo source code, the modifying party must judge whether it works normally in the higher version. For this non-standard behavior, Dubbo cannot guarantee its previous compatibility. In addition, the modification of Dubbo at runtime through javagent or asm is also within this scope. Most of these modifications can be detected by the scanning tools provided below.</p> |
| <h3 id="2-spi-extension">2. SPI extension</h3> |
| <h4 id="incompatibilities">Incompatibilities</h4> |
| <p>For SPI extensions, except that the two mechanisms of application-level service direction and EventDispatcher have been destructively modified in 3.x, most of the extensions provided in 2.7.x are also provided in 3.x. There are two areas to focus on in this section:</p> |
| <ul> |
| <li>Event bus: Due to the complexity of event management, the support of EventDispatcher and EventListener in Dubbo 3.x has been removed. If there is a use of the corresponding extension mechanism, please consider refactoring to an extension corresponding to the Dubbo function.</li> |
| <li>Application-level service discovery: The overall mechanism of application-level service discovery in Dubbo 2.7 has been completely refactored in Dubbo 3.x, and the performance and stability of functions have been greatly improved. Therefore, we recommend that you do not use the application-level service discovery mechanism in Dubbo 2.7. If there is a corresponding extension, you can re-verify the implementation based on the new code after upgrading to Dubbo 3.x (most APIs for application-level service discovery are forward Compatible).</li> |
| </ul> |
| <h4 id="optimization-items-optional">Optimization items (optional)</h4> |
| <p>In addition, Dubbo 3.x has optimized the working mechanism of some extension points, which can greatly improve the performance of the application.</p> |
| <ul> |
| <li> |
| <ol> |
| <li>Interceptor mechanism</li> |
| </ol> |
| </li> |
| </ul> |
| <p>Dubbo can intercept requests based on Filter interceptors. In Dubbo 2.7, it is supported to intercept the request after the routing address is selected. In Dubbo 3.x, a new ClusterFilter mechanism is abstracted, which can greatly reduce the memory usage, and has great benefits for ultra-large-scale clusters. |
| If you have some interceptors on the consumer side that are implemented based on the Filter mechanism, and if there is no logic that is strongly bound to the remote IP address, we recommend that you add the corresponding <code>org.apache.dubbo.rpc.Filter</code> SPI extension point Migrated to the new SPI extension point <code>org.apache.dubbo.rpc.cluster.filter.ClusterFilter</code>. The method definitions of the two interfaces are exactly the same.</p> |
| <ul> |
| <li> |
| <ol start="2"> |
| <li>Router -&gt; StateRouter</li> |
| </ol> |
| </li> |
| </ul> |
| <p>Dubbo provides Router, the ability to dynamically select and route, and most of the service governance capabilities are also implemented based on this Router extension point. In Dubbo 3.x, Dubbo abstracts a new StateRouter mechanism based on Router, which can greatly optimize address selection performance and memory usage. We will publish more about StateRouter in subsequent documents.</p> |
| <h3 id="3-api--spring-usage">3. API / Spring usage</h3> |
| <p>For the use based on API or Spring, Dubbo 3.x and 2.7.x are used in the same way. In Dubbo 3.x, some invalid configurations are strongly checked, and this part of the exception will directly report an error during the startup process. , please follow the prompts to modify.</p> |
| <h2 id="upgrade-process">Upgrade process</h2> |
| <h3 id="1-dependency-upgrade">1. Dependency upgrade</h3> |
| <p>If you use Nacos as the registration center, due to the support of Nacos features, you need to upgrade Nacos Server to 2.x before upgrading to Dubbo 3.x (refer to the document <a href="https://nacos.io/zh-cn/docs/v2/upgrading/2.0.0-upgrading.html">https://nacos.io/zh-cn/docs/v2 /upgrading/2.0.0-upgrading.html</a>), and then upgrade the Nacos Client of the application . No processing is required if using a Zookeeper registry. |
| If you are using Spring Cloud Alibaba Dubbo for access, please upgrade to xxx due to changes in some internal APIs of Dubbo.</p> |
| <p>Please upgrade to the latest version 3.1.3 for Dubbo dependencies. Dubbo and the corresponding springboot starter GAV 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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>3.1.3<span style="color:#268bd2">&lt;/version&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:#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;version&gt;</span>3.1.3<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><h3 id="2-gray-scale-upgrade">2. Gray scale upgrade</h3> |
| <p>The Dubbo 3 upgrade has no special restrictions on the release process, and it can be released according to normal business. |
| Since Dubbo is undergoing changes and upgrades across major versions, please release as many batches as possible during the release, and at the same time increase the time interval between the first batch and the second batch of releases, and make sufficient observations. |
| During the publishing process, we recommend that you first upgrade the downstream of the application (that is, the service provider), and then proceed with subsequent publishing after verifying that the service is processed normally.</p> |
| <h3 id="3-upgrade-observation-indicators">3. Upgrade observation indicators</h3> |
| <p>During the release process, there are the following latitude indicators to judge whether there is a problem with the upgrade.</p> |
| <ul> |
| <li>CPU, memory usage of the machine</li> |
| <li>Interface request success rate</li> |
| <li>Interface Request RT</li> |
| <li>Log error message</li> |
| <li>Does the custom extension behave as expected</li> |
| </ul> |
| <h2 id="precautions">Precautions</h2> |
| <h3 id="1-application-level-service-discovery">1. Application-level service discovery</h3> |
| <p>Due to design problems in the application-level service discovery model of Dubbo 2.7, a large number of format changes have been made in Dubbo 3.x, so the application-level service discovery of 2.7.x and 3.x may not be able to subscribe to each other. sex. Although Dubbo will eliminate unrecognized instances, from the perspective of stability, if you enable the application-level service discovery feature in 2.7.x (not registered by default in 2.7.x), we recommend first Turn it off, and turn it on again after upgrading to 3.x.</p></description></item><item><title>Docs3-V2: 3-1 - Failed to convert address to Invoker</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/3/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/3/1/</guid><description> |
| <h2 id="possible-reason">Possible Reason</h2> |
| <ol> |
| <li> |
| <p>The protocol configured on the client side does not match the protocol configured on the server side. (For example, the protocol configured by the client is the Dubbo protocol, but the server can only provide services of the Rest protocol.)</p> |
| </li> |
| <li> |
| <p>The registration center (or configuration center) is unreliable and pushes illegal data.</p> |
| </li> |
| </ol> |
| <h2 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h2> |
| <ol> |
| <li>Check the protocol configuration of both the provider and the consumer.</li> |
| <li>Update the version of the registry.</li> |
| </ol> |
| <p style="margin-top: 3rem;"> </p></description></item><item><title>Docs3-V2: 4-1 - Unsupported protocol</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/4/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/4/1/</guid><description> |
| <h2 id="possible-reason">Possible Reason</h2> |
| <p>This situation may occur in the scenario of custom Protocol. Dubbo&rsquo;s SPI mechanism cannot find the Protocol specified in the URL.</p> |
| <h2 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h2> |
| <ol> |
| <li>Make sure that the Consumer has dependencies on the Protocol used by the server.</li> |
| <li>Make sure that the name of the SPI configuration file of the Protocol&rsquo;s dependent package is correct.</li> |
| </ol> |
| <h2 id="see-also">see also</h2> |
| <p><a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/overview/">Dubbo SPI Overview</a></p> |
| <p><a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/protocol/">Protocol Extension Description</a></p> |
| <p style="margin-top: 3rem;"> </p></description></item><item><title>Docs3-V2: 5-1 - Failed to connect to configuration center</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/5/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/5/1/</guid><description> |
| <h2 id="possible-reason">Possible Reason</h2> |
| <ol> |
| <li>The server where the configuration center is located is shut down or down.</li> |
| <li>Wrong IP or port number.</li> |
| <li>The firewall blocked the port of the configuration center by mistake.</li> |
| </ol> |
| <h2 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h2> |
| <ol> |
| <li>Check configuration center IP and port configuration.</li> |
| <li>Check whether the server is turned on and works normally.</li> |
| <li>Check whether the port used by the configuration center is allowed by the firewall or not.</li> |
| </ol> |
| <p style="margin-top: 3rem;"> </p></description></item><item><title>Docs3-V2: 6-1 - Server Connection Failed</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/6/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/6/1/</guid><description> |
| <p>Network communication layer, failed to connect to the service provider service</p> |
| <h2 id="possible-reason">Possible Reason</h2> |
| <p>The service provider&rsquo;s network is abnormally disconnected or blocked by firewalls and third-party tools, and cannot provide external services.</p> |
| <h2 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h2> |
| <ol> |
| <li>If it is a rest connection, check whether the requested server configuration is correct.</li> |
| <li>Check whether the network communication is normal, you can use some simple cmd commands to detect, such as <code>ping</code> and so on.</li> |
| </ol> |
| <p style="margin-top: 3rem;"> </p></description></item><item><title>Docs3-V2: 7-1 - QOS OFF</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/7/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/7/1/</guid><description> |
| <h2 id="possible-reason">Possible Reason</h2> |
| <p>QOS is off</p> |
| <h2 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h2> |
| <p>Please refer to <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/qos/">QOS Operation Manual</a>.</p> |
| <p style="margin-top: 3rem;"> </p></description></item><item><title>Docs3-V2: 99-1 - Program Interrupted</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/99/1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/faq/99/1/</guid><description> |
| <p>Unknown error inside Dubbo.</p> |
| <h3 id="possible-reason">Possible Reason</h3> |
| <p>The program receives an interrupt notification from the JVM level and is forced to stop blocking and waiting</p> |
| <h3 id="troubleshooting-and-resolution-steps">Troubleshooting and resolution steps</h3> |
| <p>This exception usually occurs when the thread pool is closed or the application is closed. |
| Please check whether the normal use of the business is affected. If there is no impact, it can be ignored. If there is an impact, please refer to the corresponding troubleshooting manual. |
| For more troubleshooting ideas, please refer to <a href="../0/">99-0</a>.</p></description></item><item><title>Docs3-V2: Access Ingress Traffic</title><link>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/governance/service-mesh/pixiu/http_triple/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/governance/service-mesh/pixiu/http_triple/</guid><description> |
| <h2 id="1-preparations">1. Preparations</h2> |
| <p>-kubectl</p> |
| <ul> |
| <li>A k8s cluster with kubeconfig configured</li> |
| </ul> |
| <h2 id="2-use-the-http-protocol-to-call-the-triple-application-through-the-gateway">2. Use the HTTP protocol to call the Triple application through the gateway</h2> |
| <p>The Dubbo-go-pixiu gateway supports calling GO/Java Dubbo clusters. In the Dubbo-go 3.0 scenario, we can use the Pixiu gateway to request the Pixiu gateway with the HTTP protocol outside the cluster, perform protocol conversion at the gateway layer, and further call the Dubbo-go service in the cluster.</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/golang-sdk/tasks/pixiu/http_triple/triple-pixiu.png" alt="image.png"></p> |
| <p>The path for users to call Dubbo-go service is http://$(app_name)/$(service_name)/$(method).</p> |
| <p>For example, a proto file has the following definition:</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-protobuf" data-lang="protobuf"><span style="display:flex;"><span><span style="color:#719e07">package</span> org<span style="color:#719e07">.</span>apache.dubbo.quickstart.samples; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">service</span> UserProvider { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">rpc</span> SayHello (HelloRequest) <span style="color:#719e07">returns</span> (User) {} |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">message</span> <span style="color:#268bd2">HelloRequest</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">string</span> name <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span>; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>And configure the application name in dubbogo.yml when the dubbo-go service is started: my-dubbogo-app:</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>: my-dubbogo-app |
| </span></span></code></pre></div><p>The pixiu gateway can resolve the route whose path is my-dubbogo-app/org.apache.dubbo.quickstart.samples.UserProvider/SayHello and forward it to the corresponding service. The body from the external HTTP request is a json serialized request parameter, such as {&ldquo;name&rdquo;:&ldquo;test&rdquo;}.</p> |
| <p>We currently recommend using Nacos as the registry.</p> |
| <p>Users can deploy our demo in their own clusters. It is better for the cluster to have the ability to expose lb type services, so that the services in the cluster can be accessed from the public network, and you can also make requests directly in the cluster.</p> |
| <p>For your cluster, execute:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>$ kubectl apply -f https://raw.githubusercontent.com/dubbogo/triple-pixiu-demo/master/deploy/pixiu-triple-demo.yml |
| </span></span></code></pre></div><p>The following resources will be created under the dubbogo-triple-nacos namespace, including three triple-servers, one pixiu gateway, and one nacos server. And expose the service to the public network through Servcie.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>namespace/dubbogo-triple-nacos created |
| </span></span><span style="display:flex;"><span>service/dubbo-go-nacos created |
| </span></span><span style="display:flex;"><span>deployment.apps/dubbogo-nacos-deployment created |
| </span></span><span style="display:flex;"><span>deployment.apps/pixiu created |
| </span></span><span style="display:flex;"><span>deployment.apps/server created |
| </span></span><span style="display:flex;"><span>service/pixiu created |
| </span></span></code></pre></div><p>Obtain pixiu public network ip and call it</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>$ kubectl get svc -n dubbogo-triple-nacos |
| </span></span><span style="display:flex;"><span>NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE |
| </span></span><span style="display:flex;"><span>dubbo-go-nacos ClusterIP 192.168.123.204 &lt;none&gt; 8848/TCP 32s |
| </span></span><span style="display:flex;"><span>pixiu LoadBalancer 192.168.156.175 30.XXX.XXX.XX 8881:30173/TCP 32s |
| </span></span></code></pre></div><p>Call the demo service through curl and get the response result.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>$ curl -X POST -d <span style="color:#2aa198">&#39;{&#34;name&#34;:&#34;laurence&#34;}&#39;</span> http://30.XXX.XXX.XX:8881/dubbogoDemoServer/org.apache.dubbo.laurence.samples.UserProvider/SayHello |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">{</span><span style="color:#2aa198">&#34;name&#34;</span>:<span style="color:#2aa198">&#34;Hello Laurence&#34;</span>,<span style="color:#2aa198">&#34;id&#34;</span>:<span style="color:#2aa198">&#34;12345&#34;</span>,<span style="color:#2aa198">&#34;age&#34;</span>:21<span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Install Admin Console</title><link>https://dubbo.apache.org/en/docs/v2.7/admin/install/admin-console/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/admin/install/admin-console/</guid><description> |
| <p>The current version of dubbo admin is under development, including: route rule, dynamic configuration, access control, weight adjustment, load balance, etc.</p> |
| <p>Install:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>git clone https://github.com/apache/dubbo-admin.git /var/tmp/dubbo-admin |
| </span></span><span style="display:flex;"><span><span style="color:#b58900">cd</span> /var/tmp/dubbo-admin |
| </span></span><span style="display:flex;"><span>mvn clean package |
| </span></span></code></pre></div><p>Configuration <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>configuration file： |
| </span></span><span style="display:flex;"><span>dubbo-admin-server/src/main/resources/application.properties |
| </span></span><span style="display:flex;"><span>configurations： |
| </span></span><span style="display:flex;"><span>admin.registry.address<span style="color:#719e07">=</span>zookeeper://127.0.0.1:2181 |
| </span></span><span style="display:flex;"><span>admin.config-center<span style="color:#719e07">=</span>zookeeper://127.0.0.1:2181 |
| </span></span><span style="display:flex;"><span>admin.metadata-report.address<span style="color:#719e07">=</span>zookeeper://127.0.0.1:2181 |
| </span></span></code></pre></div><p>Start:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn --projects dubbo-admin-backend spring-boot:run |
| </span></span></code></pre></div><p>For more information, please visit:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>https://github.com/apache/dubbo-admin |
| </span></span></code></pre></div><p>Visit [^2]:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>http://127.0.0.1:8080 |
| </span></span></code></pre></div><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>There&rsquo;s no login for current version, will be added later&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Latest: Advantage</title><link>https://dubbo.apache.org/en/latest/facade-docs/why/advantage/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/latest/facade-docs/why/advantage/</guid><description/></item><item><title>Docs3-V2: Application-Level Service Discovery Benchmark</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/performance/benchmarking/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/performance/benchmarking/</guid><description> |
| <h2 id="1-benchmark-conclusion">1 Benchmark Conclusion</h2> |
| <p>Compared with 2.x version, Dubbo3 version</p> |
| <ul> |
| <li>Significantly improved service discovery resource utilization. |
| <ul> |
| <li>Compared with interface-level services, it is found that the resident memory of a single machine is reduced by 50%, and the GC consumption during the address change period is reduced by an order of magnitude (hundred times -&gt; ten times)</li> |
| <li>Comparing application-level services, it is found that the resident memory of a single machine is reduced by 75%, and the number of GCs tends to zero</li> |
| </ul> |
| </li> |
| </ul> |
| <p>The following is the detailed pressure measurement process and data</p> |
| <h2 id="2-application-level-service-discovery-address-push-link">2 Application-level service discovery (address push link)</h2> |
| <p>This part of the stress test data is given by the ICBC Dubbo team based on internal production data. The stress test process simulates the service discovery architecture of &ldquo;production environment address + zookeeper&rdquo;.</p> |
| <h3 id="21-environment">2.1 Environment</h3> |
| <p>| | Description | |
| | &mdash;&mdash;&mdash;&mdash; | &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash; &mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash;&mdash; | |
| | <strong>Pressure test data</strong> | Provider<br/>500 running instances✖️8interface✖️5protocol, that is, each provider registers 40 URLs with the registration center, a total of 20,000 URLs, and the length of each URL is about 1k characters. <br/><br/>Registration center<br/>2 independent zookeeper registration centers, service providers and consumers adopt parallel configuration. <br/><br/>Consumer<br/>Configure 1c2g, xmx=768, enable GC, subscribe from 2 registries, and call the service every 5 seconds. Run for 20 hours. | |
| | <strong>Pressure test environment</strong> | Java version &ldquo;1.8.0&rdquo;<br/>Java(TM) SE Runtime Environment (build pxa6480sr3fp12-20160919_01(SR3 FP12))<br/>IBM J9 VM (Build 2.8, JRE 1.8 .0 Linux amd64-64 Compressed References 20160915_318796, JIT enabled, AOT enabled) |</p> |
| <h3 id="22-data-analysis">2.2 Data Analysis</h3> |
| <p><img src="https://dubbo.apache.org/imgs/v3/performance/registry-mem.svg" alt="//imgs/v3/performance/registry-mem.svg"></p> |
| <p><br />Figure 1 Changes in memory usage of the service discovery model<br /><br /></p> |
| <ul> |
| <li>Dubbo3 interface-level service discovery model, the resident memory is reduced by about 50% compared with version 2.x</li> |
| <li>Dubbo3 application-level service discovery model, the resident memory is reduced by about 75% compared with version 2.x</li> |
| </ul> |
| <p><img src="https://dubbo.apache.org/imgs/v3/performance/registry-gc.svg" alt="//imgs/v3/performance/registry-gc.svg"></p> |
| <p><br />Figure 2 Service Discovery Model GC Changes<br /><br /></p> |
| <ul> |
| <li>Dubbo3 interface-level service discovery model, the number of YGC times in version 2.x has dropped significantly, from hundreds of times to more than a dozen times</li> |
| <li>Dubbo3 application-level service discovery model, the number of FGC times in version 2.x has dropped significantly, from hundreds of times to zero</li> |
| </ul></description></item><item><title>Docs3-V2: Apply Template</title><link>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/develop/template/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/develop/template/</guid><description> |
| <h2 id="1-preparations">1. Preparations</h2> |
| <ul> |
| <li>dubbo-go cli tools and dependent tools have been installed</li> |
| </ul> |
| <h2 id="2-use-dubbogo-cli-to-create-a-project-template">2. Use dubbogo-cli to create a project template</h2> |
| <p>Run <code>dubbogo-cli newApp .</code></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-plain" data-lang="plain"><span style="display:flex;"><span>$ mkdir cli-create-server |
| </span></span><span style="display:flex;"><span>$ cd cli-create-server |
| </span></span><span style="display:flex;"><span>$ dubbogo-cli newApp . |
| </span></span><span style="display:flex;"><span>$ tree . |
| </span></span><span style="display:flex;"><span>. |
| </span></span><span style="display:flex;"><span>├── Makefile |
| </span></span><span style="display:flex;"><span>├── api |
| </span></span><span style="display:flex;"><span>│ └── api.proto |
| </span></span><span style="display:flex;"><span>├──build |
| </span></span><span style="display:flex;"><span>│ └── Dockerfile |
| </span></span><span style="display:flex;"><span>├── chart |
| </span></span><span style="display:flex;"><span>│ ├── app |
| </span></span><span style="display:flex;"><span>│ │ ├── Chart.yaml |
| </span></span><span style="display:flex;"><span>│ │ ├── templates |
| </span></span><span style="display:flex;"><span>│ │ │ ├── _helpers.tpl |
| </span></span><span style="display:flex;"><span>│ │ │ ├── deployment.yaml |
| </span></span><span style="display:flex;"><span>│ │ │ ├── service.yaml |
| </span></span><span style="display:flex;"><span>│ │ │ └── serviceaccount.yaml |
| </span></span><span style="display:flex;"><span>│ │ └── values.yaml |
| </span></span><span style="display:flex;"><span>│ └── nacos_env |
| </span></span><span style="display:flex;"><span>│ ├── Chart.yaml |
| </span></span><span style="display:flex;"><span>│ ├── templates |
| </span></span><span style="display:flex;"><span>│ │ ├── _helpers.tpl |
| </span></span><span style="display:flex;"><span>│ │ ├── deployment.yaml |
| </span></span><span style="display:flex;"><span>│ │ └── service.yaml |
| </span></span><span style="display:flex;"><span>│ └── values.yaml |
| </span></span><span style="display:flex;"><span>├── cmd |
| </span></span><span style="display:flex;"><span>│ └── app.go |
| </span></span><span style="display:flex;"><span>├── conf |
| </span></span><span style="display:flex;"><span>│ └── dubbogo.yaml |
| </span></span><span style="display:flex;"><span>├── go.mod |
| </span></span><span style="display:flex;"><span>├── go.sum |
| </span></span><span style="display:flex;"><span>└── pkg |
| </span></span><span style="display:flex;"><span> └── service |
| </span></span><span style="display:flex;"><span> └── service.go |
| </span></span></code></pre></div><p>The generated project includes several directories:</p> |
| <ul> |
| <li> |
| <p>api: place interface files: proto file and generated pb.go file</p> |
| </li> |
| <li> |
| <p>build: place build related files</p> |
| </li> |
| <li> |
| <p>chart: place the chart package for publishing, the chart package of the basic environment: nacos, mesh (under development)</p> |
| </li> |
| <li> |
| <p>cmd: program entry</p> |
| </li> |
| <li> |
| <p>conf: framework configuration</p> |
| </li> |
| <li> |
| <p>pkg/service: RPC service implementation</p> |
| </li> |
| <li> |
| <p>Makefile:</p> |
| <ul> |
| <li> |
| <p>Image, application name:</p> |
| <ul> |
| <li> |
| <p>IMAGE = $(your_repo)/$(namespace)/$(image_name) |
| TAG = 1.0.0</p> |
| </li> |
| <li> |
| <p>APPNAME = dubbo-go-app # For helm publishing, corresponding to chart name, application name and service name (service name)</p> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>Provide scripts such as:</p> |
| <ul> |
| <li> |
| <p>make build # Package the image and push it</p> |
| </li> |
| <li> |
| <p>make buildx-publish # The arm architecture locally packs the amd64 image and pushes it, relying on docker buildx</p> |
| </li> |
| <li> |
| <p>make deploy # Publish the application through helm</p> |
| </li> |
| <li> |
| <p>make remove # Delete the published helm application</p> |
| </li> |
| <li> |
| <p>make proto-gen # generate pb.go file under api/</p> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul></description></item><item><title>Docs: Background</title><link>https://dubbo.apache.org/en/docs/v2.7/user/preface/background/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/preface/background/</guid><description> |
| <h1 id="background">Background</h1> |
| <p>With the fast development of Internet, the scale of web applications expands unceasingly, and finally we find that the traditional vertical architecture(monolithic) can not handle this any more. Distributed service architecture and the flow computing architecture are imperative, and a governance system is urgently needed to ensure an orderly evolution of the architecture.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-architecture-roadmap.jpg" alt="image"></p> |
| <h4 id="monolithic-architecture">Monolithic architecture</h4> |
| <p>When the traffic is very low, there is only one application, all the features are deployed together to reduce the deployment node and cost. At this point, the data access framework (ORM) is the key to simplifying the workload of the CRUD.</p> |
| <h4 id="vertical-architecture">Vertical architecture</h4> |
| <p>When the traffic gets heavier, add monolithic application instances can not accelerate the access very well, one way to improve efficiency is to split the monolithic into discrete applications. At this point, the Web framework (MVC) used to accelerate front-end page development is the key.</p> |
| <h4 id="distributed-service-architecture">Distributed service architecture</h4> |
| <p>When there are more and more vertical applications, the interaction between applications is inevitable, some core businesses are extracted and served as independent services, which gradually forms a stable service center，this way the front-end application can respond to the changeable market demand more quickly. At this point, the distributed service framework (RPC) for business reuse and integration is the key.</p> |
| <h4 id="flow-computing-architecture">Flow computing architecture</h4> |
| <p>When there are more and more services, capacity evaluation becomes difficult, and also services with small scales often causes waste of resources. To solve these problems, a scheduling center should be added to manage the cluster capacity based on traffics and to improve the utilization of the cluster. At this time, the resource scheduling and governance centers (SOA), which are used to improve machine utilization, are the keys.</p></description></item><item><title>Docs: Source Code Build</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/build/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/build/</guid><description> |
| <h2 id="checkout">Checkout</h2> |
| <p>checkout the lastest project source code with commands blow:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>git clone https://github.com/apache/dubbo.git dubbo |
| </span></span></code></pre></div><h2 id="branches">Branches</h2> |
| <p>We use <code>master</code> as the major branch for new feature development, and use other branches for maintenance. Tags for all versions can be checked via <a href="https://github.com/apache/dubbo/tags">https://github.com/apache/dubbo/tags</a>.</p> |
| <h2 id="building">Building</h2> |
| <p>Dubbo relies on <a href="http://maven.apache.org">maven</a> as the building tool.</p> |
| <p>Requirements:</p> |
| <ul> |
| <li>Java above 1.8 version</li> |
| <li>Maven version 2.2.1 or above</li> |
| </ul> |
| <p>The following <code>MAVEN_OPTS</code>should be configured before building:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span><span style="color:#b58900">export</span> <span style="color:#268bd2">MAVEN_OPTS</span><span style="color:#719e07">=</span>-Xmx1024m -XX:MaxPermSize<span style="color:#719e07">=</span>512m |
| </span></span></code></pre></div><p>build with below command:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn clean install |
| </span></span></code></pre></div><p>skip testing using below building command:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn install -Dmaven.test.skip |
| </span></span></code></pre></div><h2 id="building-jar-package-of-source-code">Building jar package of source code</h2> |
| <p>build Dubbo source code jar package with below command.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn clean source:jar install -Dmaven.test.skip |
| </span></span></code></pre></div><p>and modify the dubbo dependency in your sample project to the SANPSHOT version of the local repository, and then use remote debugger to debug dubbo.</p> |
| <h2 id="ide-support">IDE support</h2> |
| <p>use below command to generate IDE.</p> |
| <h3 id="intellij-idea">Intellij Idea</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-sh" data-lang="sh"><span style="display:flex;"><span>mvn idea:idea |
| </span></span></code></pre></div><h3 id="eclipse">Eclipse</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-sh" data-lang="sh"><span style="display:flex;"><span>mvn eclipse:eclipse |
| </span></span></code></pre></div><p>Importing into eclipse</p> |
| <p>Firstly, a maven repository needs to be configured in eclipse. Define <code>M2_REPO</code> and point it to the local maven repository by clicking <code>Preferences -&gt; Java -&gt; Build Path -&gt; Classpath</code>.</p> |
| <p>Use the following maven command as well:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn eclipse:configure-workspace -Declipse.workspace<span style="color:#719e07">=</span>/path/to/the/workspace/ |
| </span></span></code></pre></div><ol> |
| <li>view the source code through <a href="https://github.com/apache/dubbo">https://github.com/apache/dubbo</a></li> |
| <li>path under UNIX is ${HOME}/.m2/repository, path under Windows is C:\Documents and Settings&lt;user&gt;.m2\repository</li> |
| </ol></description></item><item><title>Docs3-V2: Check at startup</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/preflight-check/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/preflight-check/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>By default, Dubbo will check whether the dependent service is available at startup, and will throw an exception when it is unavailable, preventing Spring initialization from completing, so that problems can be detected early when going online. The default <code>check=&quot;true&quot;</code>.</p> |
| <p>Checking can be turned off by <code>check=&quot;false&quot;</code>. For example, when testing, some services do not care, or there is a circular dependency, and one of them must be started first.</p> |
| <p>In addition, if your Spring container is lazy-loaded, or if you delay the reference service through API programming, please turn off check, otherwise when the service is temporarily unavailable, an exception will be thrown and a null reference will be obtained. If <code>check=&quot;false&quot;</code>, always Yes, it will return the reference, and when the service is restored, it can be connected automatically.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <ul> |
| <li>One-way dependency: with dependency (recommended default setting) and without dependency (check=false can be set)</li> |
| <li>Interdependence: that is, circular dependency, (it is not recommended to set check=false)</li> |
| <li>Lazy loading handling</li> |
| </ul> |
| <blockquote> |
| <p>check is only used to check at startup, if there is no corresponding dependency at runtime, an error will still be reported.</p> |
| </blockquote> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="via-spring-configuration-file">via spring configuration file</h3> |
| <p>Turn off startup checks for a service</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> check=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Turn off startup checks for all services</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:consumer</span> check=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Turn off registry checks at startup</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:registry</span> check=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="via-dubboproperties">via dubbo.properties</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.reference.com.foo.BarService.check<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span><span style="display:flex;"><span>dubbo.consumer.check<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.check<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span></code></pre></div><h3 id="via-the--d-parameter">via the -D parameter</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-sh" data-lang="sh"><span style="display:flex;"><span>java -Ddubbo.reference.com.foo.BarService.check<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span><span style="display:flex;"><span>java -Ddubbo.consumer.check<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span><span style="display:flex;"><span>java -Ddubbo.registry.check<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span></code></pre></div><h2 id="meaning-of-configuration">Meaning of configuration</h2> |
| <p><code>dubbo.reference.com.foo.BarService.check</code>, overrides the check value of the reference of <code>com.foo.BarService</code>, even if there is a statement in the configuration, it will be overwritten.</p> |
| <p><code>dubbo.consumer.check=false</code> is the default value of <code>check</code> for setting reference. If there is an explicit statement in the configuration, such as: <code>&lt;dubbo:reference check=&quot;true&quot;/&gt;</code>, it will not be affected influences.</p> |
| <p><code>dubbo.registry.check=false</code>, the first two means that the subscription is successful, but whether the provider list is empty or whether an error is reported, if the registration subscription fails, it is also allowed to start, you need to use this option, and will retry periodically in the background .</p></description></item><item><title>Docs: Apache Committer Guide</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/committer/new-committer-guide_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/committer/new-committer-guide_dev/</guid><description> |
| <h2 id="first-how-to-become-a-committer">First: How to become a committer</h2> |
| <h3 id="initial-committers-at-the-project-incubator-stage">Initial committers at the project incubator stage</h3> |
| <p>At the project incubator stage, there will be an initial committers list in the proposal of the incubator project. Confirm that you are one of the initial committers. After the vote is passed in the Apache incubator community, these committers can start preparing their account. See <a href="https://wiki.apache.org/incubator/">incubator wiki</a> for details.</p> |
| <h3 id="the-active-contributor-is-elected-as-a-committer">The active contributor is elected as a committer</h3> |
| <p>At the late development stage, an active contributor can be elected as a committer. See <a href="https://www.apache.org/dev/new-committers-guide.html#becoming-a-committer">how to become a committer</a></p> |
| <h2 id="second-the-individual-contributor-signs-icla">Second: The individual contributor signs ICLA</h2> |
| <h3 id="1-apache-id">1, Apache ID</h3> |
| <p>Choose a Apache ID not in the <a href="http://people.apache.org/committer-index.html">apache committers list page</a>.</p> |
| <h3 id="2-individual-contributor-license-agreement--icla">2, Individual Contributor License Agreement (ICLA):</h3> |
| <p>Download the <a href="https://www.apache.org/licenses/icla.pdf">ICLA template</a>. After filling the icla.pdf with personal information correctly, print, sign, scan, and send it in mail as an attachment to the secretary <a href="mailto:secretary@apache.org">secretary@apache.org</a>, the secretary will help to create the Apache user ID. At the same time, a <a href="mailto:your-id@apache.org">your-id@apache.org</a> mailbox will be created. You can see if the user has been created on the [apache committers list page (http://people.apache.org/committer-index.html).</p> |
| <h2 id="third-join-the-apache-developer-group">Third: Join The Apache Developer Group</h2> |
| <ul> |
| <li> |
| <p>1, login via the <a href="https://id.apache.org/">Apache account tool</a>, when you login at the first time, you can select the &ldquo;Change password?&rdquo; checkbox to get the initial password. Then the initial password will be sent to the forward mailbox (the developer mail recorded in the project incubator proposal)</p> |
| </li> |
| <li> |
| <p>2, about Apache mailbox: does not have its own mail content storage server. It needs to borrow the mail content storage and mail sending functions of other mail providers. In many voting sessions, Apache mailbox is recommended.</p> |
| </li> |
| </ul> |
| <p>There is a question about how to configure the apache.org mailbox forwarding function using other mailboxes.</p> |
| <ol> |
| <li> |
| <p>inbox: to receive mails that sent to <a href="mailto:youer-id@apache.org">youer-id@apache.org</a> mailbox. The forward mailbox configured in the Apache account tool in the first step can use the forward mailbox to pick up incoming mail.</p> |
| </li> |
| <li> |
| <p>the Outbox: emails sent out will show the sender as <a href="mailto:your-id@apache.org">your-id@apache.org</a> account. Please refer to: <a href="https://reference.apache.org/committer/email">set up Apache mailbox guide</a> and <a href="http://gmailblog.blogspot.com/2009/07/send-mail-from-another-address-without.html">Gmail mailbox setting</a>. In other mailbox service settings, this forwarding mode is not easy to find. Gmail is the most convenient, which is recommended (no advertising).</p> |
| </li> |
| </ol> |
| <ul> |
| <li> |
| <p>3, Modify the homepage URL option in the edit page, homepage link of your account can be added in <a href="http://people.apache.org/committer-index.html">apache committer index page</a></p> |
| </li> |
| <li> |
| <p>4, Modify the GitHub account in the edit page, and an email will be sent to invite you to join the github.com/apache-commiiters group. Now, please learn from the way <a href="http://www.apache.org/foundation/how-it-works.html#developers">ASF works</a> to do some basic preparation of ASF development.</p> |
| </li> |
| </ul> |
| <h2 id="fourth-to-obtain-write-permission-of-the-project">Fourth: To obtain write permission of the project</h2> |
| <p>Operation of the <a href="https://gitbox.apache.org/setup/">GitBox account link tool</a></p> |
| <h3 id="1-apache-account-authorization">1, Apache account authorization</h3> |
| <p>According to the prompt, the OAuth protocol of Apache account is authorized to login.</p> |
| <h3 id="2-github-account-authorization">2, Github account authorization</h3> |
| <p>According to the prompt, the OAuth protocol of Github account is authorized to login.</p> |
| <h3 id="3-set-up-github-account-in-githubcom-two-factors-authorization-2fa">3, Set up GitHub account in github.com, two-factors authorization (2FA)</h3> |
| <ul> |
| <li> |
| <ol> |
| <li>install &ldquo;Google Authenticator&rdquo; app on your cell phone</li> |
| </ol> |
| </li> |
| <li>2), Following the <a href="https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication">authorized GitHub 2FA wiki</a>, you can operation step by step .</li> |
| </ul> |
| <p>In the <a href="https://github.com/settings/security">two-factors authorization authentication (2. Scan this barcode with your app.)</a> page, it is not recommended to select a two-dimensional code with a cell phone, because some of the cell phones will not be able to scan.</p> |
| <p>Please open the cell phone &ldquo;Google Authenticator&rdquo; app, click &ldquo;+&rdquo; to select &ldquo;input the secret key&rdquo;: write the GitHub account in the account name input box. In your &ldquo;secret key&rdquo; input box, write the text of the &ldquo;enter this text code&rdquo; link in the open web page. After clicking &ldquo;add&rdquo; in app, 6 digit dynamic will be generated for this account. Write the 6 digit number to the text box in the web page, and then click &ldquo;Enable&rdquo;. In this way, the 2fa is set successfully.</p> |
| <ul> |
| <li> |
| <p>3), logout and login to Github again, and one more step will appear after entering user name and password. Fill in the 6 digit number dynamic password generated by the app</p> |
| </li> |
| <li> |
| <p>4),It will take about half an hour, and you will be notified by mail that you have joined the XX project-committers developer group. You can also check it in the [apache teams] (<a href="https://github.com/orgs/apache/teams">https://github.com/orgs/apache/teams</a>) page yourself.</p> |
| </li> |
| <li> |
| <p>5), After the 2fa has been submitted, you will have the permission check problem for the cloned projects. The solution is one of below two:</p> |
| </li> |
| <li> |
| <p>A. Apply for Access Token</p> |
| </li> |
| </ul> |
| <p>When access token is generated on GitHub, the token where the instruction line needs a password is pasted.</p> |
| <p>Refer to website <a href="https://docs.github.com/en/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors">referenced link one</a> and <a href="https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token">referenced link two</a></p> |
| <ul> |
| <li>B. switch to SSH</li> |
| </ul> |
| <p>ssh-keygen then paste the content in the pub file into GitHub.</p> |
| <p><strong>Note</strong>: ensure that GitHub&rsquo;s 2fa is &ldquo;enabled&rdquo;. When you set 2fa to &ldquo;off&rdquo;, it will be delisted by the corresponding Apache committer write permission group until you set it up again.</p> |
| <h2 id="fifth-other">Fifth: other</h2> |
| <h3 id="the-apache-way">The Apache way</h3> |
| <p>See <a href="http://apache.org/foundation/governance/">wiki</a>.</p> |
| <p>The community is more important than the code |
| If not discussed in the community (mailing list), just as it did not happen.</p> |
| <h3 id="add-your-name">Add your name</h3> |
| <p>Please update Dubbo incubator status <a href="https://incubator.apache.org/projects/dubbo.html">page</a> to add your name. See this <a href="https://dubbo.apache.org/en/latest/contribution-guidelines/contributor/">guide</a> for instructions.</p> |
| <p>Please update Dubbo official <a href="https://dubbo.apache.org/en/latest/contribution-guidelines/committer">website</a> to update your name.</p> |
| <h3 id="a-small-benefit">A small benefit</h3> |
| <p>Jetbrains company gives Apache committers a small benefit, which is free to use IDEA&rsquo;s full series products. The specific address is: <a href="https://www.jetbrains.com/shop/eform/apache?Product=ALL">https://www.jetbrains.com/shop/eform/apache?Product=ALL</a></p> |
| <h3 id="reference-wiki">Reference wiki</h3> |
| <p><a href="https://www.apache.org/dev/new-committers-guide.html">https://www.apache.org/dev/new-committers-guide.html</a></p></description></item><item><title>Docs3-V2: configuration item reference</title><link>https://dubbo.apache.org/en/docs3-v2/golang-sdk/refer/config/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/golang-sdk/refer/config/</guid><description> |
| <h2 id="root-configuration">root configuration</h2> |
| <h2 id="client-configuration">Client configuration</h2> |
| <h2 id="server-configuration">Server configuration</h2> |
| <h2 id="registry-configuration">Registry configuration</h2> |
| <h3 id="using-the-configuration-api">Using the Configuration API</h3> |
| <ul> |
| <li>The client sets up the registry using the configuration API</li> |
| </ul> |
| <p>You can quickly set the registry for debugging by calling the config.NewRegistryConfigWithProtocolDefaultPort method, and support zookeeper(127.0.0.1:2181) and nacos(127.0.0.1:8848)</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-go" data-lang="go"><span style="display:flex;"><span>rc <span style="color:#719e07">:=</span> config. <span style="color:#268bd2">NewRootConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetConsumer</span>(config. <span style="color:#268bd2">NewConsumerConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetRegistryIDs</span>(<span style="color:#2aa198">&#34;zookeeperID&#34;</span>). <span style="color:#586e75">// use defined registryID |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddRegistry</span>(<span style="color:#2aa198">&#34;zookeeperID&#34;</span>, config. <span style="color:#268bd2">NewRegistryConfigWithProtocolDefaultPort</span>(<span style="color:#2aa198">&#34;zookeeper&#34;</span>)). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">build</span>() |
| </span></span></code></pre></div><p>All interfaces: can be configured by calling the rich interfaces provided by RegistryConfigBuilder.</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-go" data-lang="go"><span style="display:flex;"><span>rc <span style="color:#719e07">:=</span> config. <span style="color:#268bd2">NewRootConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetConsumer</span>(config. <span style="color:#268bd2">NewConsumerConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetRegistryIDs</span>(<span style="color:#2aa198">&#34;nacosRegistryID&#34;</span>). <span style="color:#586e75">// use defined registryID |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">AddReference</span>(<span style="color:#2aa198">&#34;GreeterClientImpl&#34;</span>, <span style="color:#586e75">/*...*/</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">build</span>() |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddRegistry</span>(<span style="color:#2aa198">&#34;nacosRegistryID&#34;</span>, config. <span style="color:#268bd2">NewRegistryConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetProtocol</span>(<span style="color:#2aa198">&#34;nacos&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetAddress</span>(<span style="color:#2aa198">&#34;127.0.0.1:8848&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetGroup</span>(<span style="color:#2aa198">&#34;dubbo-go&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetNamespace</span>(<span style="color:#2aa198">&#34;dubbo&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetUsername</span>(<span style="color:#2aa198">&#34;admin&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetPassword</span>(<span style="color:#2aa198">&#34;admin&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetTimeout</span>(<span style="color:#2aa198">&#34;3s&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">build</span>() |
| </span></span></code></pre></div><ul> |
| <li>The server uses the configuration API to set the configuration center</li> |
| </ul> |
| <p>Simple interface config.NewRegistryConfigWithProtocolDefaultPort</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-go" data-lang="go"><span style="display:flex;"><span>rc <span style="color:#719e07">:=</span> config. <span style="color:#268bd2">NewRootConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetProvider</span>(config. <span style="color:#268bd2">NewProviderConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddService</span>(<span style="color:#2aa198">&#34;GreeterProvider&#34;</span>, <span style="color:#586e75">/*...*/</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetRegistryIDs</span>(<span style="color:#2aa198">&#34;registryKey&#34;</span>). <span style="color:#586e75">// use defined registryIDs |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddRegistry</span>(<span style="color:#2aa198">&#34;registryKey&#34;</span>, config. <span style="color:#268bd2">NewRegistryConfigWithProtocolDefaultPort</span>(<span style="color:#2aa198">&#34;zookeeper&#34;</span>)). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">build</span>() |
| </span></span></code></pre></div><p>All interfaces: can be configured by calling the rich interfaces provided by RegistryConfigBuilder.</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-go" data-lang="go"><span style="display:flex;"><span>rc <span style="color:#719e07">:=</span> config. <span style="color:#268bd2">NewRootConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetProvider</span>(config. <span style="color:#268bd2">NewProviderConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddService</span>(<span style="color:#2aa198">&#34;GreeterProvider&#34;</span>, <span style="color:#586e75">/*...*/</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetRegistryIDs</span>(<span style="color:#2aa198">&#34;registryKey&#34;</span>). <span style="color:#586e75">// use defined registryIDs |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddRegistry</span>(<span style="color:#2aa198">&#34;registryKey&#34;</span>, config. <span style="color:#268bd2">NewRegistryConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetProtocol</span>(<span style="color:#2aa198">&#34;nacos&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetAddress</span>(<span style="color:#2aa198">&#34;127.0.0.1:8848&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetGroup</span>(<span style="color:#2aa198">&#34;dubbo-go&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetNamespace</span>(<span style="color:#2aa198">&#34;dubbo&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetUsername</span>(<span style="color:#2aa198">&#34;admin&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetPassword</span>(<span style="color:#2aa198">&#34;admin&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetTimeout</span>(<span style="color:#2aa198">&#34;3s&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">build</span>() |
| </span></span></code></pre></div><h3 id="heading"></h3> |
| <h2 id="network-protocol">Network protocol</h2> |
| <h3 id="configuration-file">configuration file</h3> |
| <h3 id="using-the-configuration-api-1">Using the Configuration API</h3> |
| <ul> |
| <li>The client sets the network protocol using the configuration API</li> |
| </ul> |
| <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-go" data-lang="go"><span style="display:flex;"><span>rc <span style="color:#719e07">:=</span> config. <span style="color:#268bd2">NewRootConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetConsumer</span>(config. <span style="color:#268bd2">NewConsumerConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddReference</span>(<span style="color:#2aa198">&#34;GreeterClientImpl&#34;</span>, config. <span style="color:#268bd2">NewReferenceConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetInterface</span>(<span style="color:#2aa198">&#34;org. apache. dubbo. UserProvider&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetProtocol</span>(<span style="color:#2aa198">&#34;tri&#34;</span>). <span style="color:#586e75">// set reference protocol to triple |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">build</span>() |
| </span></span></code></pre></div><ul> |
| <li>The server uses the configuration API to set the network protocol</li> |
| </ul> |
| <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-go" data-lang="go"><span style="display:flex;"><span>rc <span style="color:#719e07">:=</span> config. <span style="color:#268bd2">NewRootConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetProvider</span>(config. <span style="color:#268bd2">NewProviderConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddService</span>(<span style="color:#2aa198">&#34;GreeterProvider&#34;</span>, config. <span style="color:#268bd2">NewServiceConfigBuilder</span>(). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetInterface</span>(<span style="color:#2aa198">&#34;org. apache. dubbo. UserProvider&#34;</span>). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">SetProtocolIDs</span>(<span style="color:#2aa198">&#34;tripleProtocolKey&#34;</span>). <span style="color:#586e75">// use protocolID &#39;tripleProtocolKey&#39; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">AddProtocol</span>(<span style="color:#2aa198">&#34;tripleProtocolKey&#34;</span>, config. <span style="color:#268bd2">NewProtocolConfigBuilder</span>(). <span style="color:#586e75">// define protocol config with protocolID &#39;tripleProtocolKey&#39; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">SetName</span>(<span style="color:#2aa198">&#34;tri&#34;</span>). <span style="color:#586e75">// set service protocol to triple |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">Build</span>()). |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">build</span>() |
| </span></span></code></pre></div><h3 id="heading-1"></h3></description></item><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>(String<span style="color:#719e07">[]</span> args) <span style="color:#268bd2">throws</span> IOException { |
| </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.setApplication(<span style="color:#719e07">new</span> ApplicationConfig(<span style="color:#2aa198">&#34;first-dubbo-provider&#34;</span>)); |
| </span></span><span style="display:flex;"><span> service.setRegistry(<span style="color:#719e07">new</span> RegistryConfig(<span style="color:#2aa198">&#34;multicast://224.5.6.7:1234&#34;</span>)); |
| </span></span><span style="display:flex;"><span> service.setInterface(GreetingsService.class); |
| </span></span><span style="display:flex;"><span> service.setRef(<span style="color:#719e07">new</span> GreetingsServiceImpl()); |
| </span></span><span style="display:flex;"><span> service. <span style="color:#268bd2">export</span>(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;first-dubbo-provider is running.&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.in.read(); |
| </span></span><span style="display:flex;"><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></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></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>(String name) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;async provider received: &#34;</span> <span style="color:#719e07">+</span> name); |
| </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></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: Custom service call middleware</title><link>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/governance/features/aop/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/governance/features/aop/</guid><description> |
| <p>Refer to samples <a href="https://github.com/apache/dubbo-go-samples/tree/master/filter">dubbo-go-samples/filter</a></p> |
| <h2 id="1-preparations">1. Preparations</h2> |
| <ul> |
| <li>dubbo-go cli tools and dependent tools have been installed</li> |
| <li>Read <a href="https://dubbo.apache.org/en/docs3-v2/golang-sdk/preface/design/aop_and_extension/">[Component Loading and Extensibility]</a></li> |
| <li>Create a new demo application</li> |
| </ul> |
| <h2 id="2-configure-the-specified-filter">2. Configure the specified Filter</h2> |
| <p>When specifying a filter, it can be separated by &lsquo;,&rsquo;</p> |
| <ul> |
| <li> |
| <p>Consumer side</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">consumer</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">filter</span>: echo,token,tps,myCustomFilter <span style="color:#586e75"># Custom filter can be specified</span> |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Provider side</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">provider</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">services</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">GreeterProvider</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">filter</span>: myCustomFilter, echo, tps |
| </span></span></code></pre></div></li> |
| </ul> |
| <h2 id="3-custom-filter">3. Custom Filter</h2> |
| <p>Users can customize Filter in the code, register it on the framework, and choose to use it in 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-go" data-lang="go"><span style="display:flex;"><span><span style="color:#268bd2">func</span> <span style="color:#268bd2">init</span>() { |
| </span></span><span style="display:flex;"><span>extension. <span style="color:#268bd2">SetFilter</span>(<span style="color:#2aa198">&#34;myCustomFilter&#34;</span>, NewMyClientFilter) |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">func</span> <span style="color:#268bd2">NewMyClientFilter</span>() filter. Filter { |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">return</span> <span style="color:#719e07">&amp;</span>MyClientFilter{} |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">type</span> MyClientFilter <span style="color:#268bd2">struct</span> { |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">func</span> (f <span style="color:#719e07">*</span>MyClientFilter) <span style="color:#268bd2">Invoke</span>(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result { |
| </span></span><span style="display:flex;"><span>fmt.<span style="color:#268bd2">Println</span>(<span style="color:#2aa198">&#34;MyClientFilter Invoke is called, method Name = &#34;</span>, invocation.<span style="color:#268bd2">MethodName</span>()) |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">return</span> invoker. <span style="color:#268bd2">Invoke</span>(ctx, invocation) |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">func</span> (f <span style="color:#719e07">*</span>MyClientFilter) <span style="color:#268bd2">OnResponse</span>(ctx context.Context, result protocol.Result, invoker protocol.Invoker, protocol protocol.Invocation) protocol.Result { |
| </span></span><span style="display:flex;"><span>fmt.<span style="color:#268bd2">Println</span>(<span style="color:#2aa198">&#34;MyClientFilter OnResponse is called&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">return</span> result |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Custom Service Container</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/others/service-container/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/others/service-container/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The service container of Dubbo 3 is a standalone startup program, because the background service does not need the functions of web containers such as Tomcat or JBoss. If you insist on using the web container to load the service provider, it will increase complexity and waste resources. Therefore, services usually do not require the features of web containers such as Tomcat/JBoss, and there is no need to use web containers to load services.</p> |
| <p>The Dubbo3 service container is just a simple Main method and loads a simple Spring container for exposing services.</p> |
| <p>The loading content of the service container can be extended, and spring, jetty, log4j, etc. are built-in, and can be extended through <a href="../../../reference-manual/spi/description/container">container extension point</a>. The configuration is configured in the -D parameter of the java command or <code>dubbo.properties</code>.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>The web container is mainly used to respond to http requests and static pages. The Dubbo service provider only provides dubbo services externally. It is not suitable to use the web container. As a dubbo service provider alone, it only needs to load a simple spring container through a main method Expose the service.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="spring-container">Spring Container</h3> |
| <ul> |
| <li> |
| <p>Autoload all Spring configurations under the <code>META-INF/spring</code> directory.</p> |
| </li> |
| <li> |
| <p>Configure the spring configuration loading location:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.spring.config=classpath*:META-INF/spring/*.xml |
| </span></span></code></pre></div></li> |
| </ul> |
| <h3 id="jetty-container">Jetty Container</h3> |
| <ul> |
| <li>Starts an embedded Jetty for reporting status.</li> |
| <li>configuration: |
| <ul> |
| <li><code>dubbo.jetty.port=8080</code>: configure jetty startup port</li> |
| <li><code>dubbo.jetty.directory=/foo/bar</code>: Configure a directory that can be directly accessed through jetty to store static files</li> |
| <li><code>dubbo.jetty.page=log,status,system</code>: configure the displayed pages, all pages are loaded by default</li> |
| </ul> |
| </li> |
| </ul> |
| <h3 id="log4j-container">Log4j Container</h3> |
| <ul> |
| <li>Automatically configure the configuration of log4j. When multiple processes are started, the log files are automatically divided into directories by process.</li> |
| <li>configuration: |
| <ul> |
| <li><code>dubbo.log4j.file=/foo/bar.log</code>: configure log file path</li> |
| <li><code>dubbo.log4j.level=WARN</code>: configure log level</li> |
| <li><code>dubbo.log4j.subdirectory=20880</code>: Configure the log subdirectory for multi-process startup to avoid conflicts</li> |
| </ul> |
| </li> |
| </ul> |
| <h3 id="container-loading-instructions">Container loading instructions</h3> |
| <p>Only spring is loaded by default</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>java org.apache.dubbo.container.Main |
| </span></span></code></pre></div><p>Pass in the container to be loaded through the main function parameter</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>java org.apache.dubbo.container.Main spring jetty log4j |
| </span></span></code></pre></div><p>Pass in the container to be loaded through the JVM startup parameters</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>java org.apache.dubbo.container.Main -Ddubbo.container<span style="color:#719e07">=</span>spring,jetty,log4j |
| </span></span></code></pre></div><p>Pass in the container to be loaded through <code>dubbo.properties</code> configuration under the classpath</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.container=spring,jetty,log4j |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Deploy the Istio environment</title><link>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/governance/service-mesh/istio/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/governance/service-mesh/istio/</guid><description> |
| <h2 id="1-preparations">1. Preparations</h2> |
| <ul> |
| <li>The docker, helm, and kubectl environments have been installed.</li> |
| <li>dubbo-go cli tools and dependent tools have been installed</li> |
| </ul> |
| <h2 id="2-deploy-the-istio-environment">2. Deploy the Istio environment</h2> |
| <ol> |
| <li>Use helm to install istio base CRD and istiod components. You can also refer to <a href="https://istio.io/">Istio Documentation</a> to install using istioctl.</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-bash" data-lang="bash"><span style="display:flex;"><span>$ helm repo add istio https://istio-release.storage.googleapis.com/charts |
| </span></span><span style="display:flex;"><span>$ kubectl create namespace istio-system |
| </span></span><span style="display:flex;"><span>$ helm install istio-base istio/base -n istio-system |
| </span></span><span style="display:flex;"><span>$ helm install istiod istio/istiod --namespace istio-system |
| </span></span></code></pre></div><ol start="2"> |
| <li> |
| <p>Delete istio horizontal expansion resource</p> |
| <p>*Currently dubbo-go relies on a single istiod instance for service discovery.</p> |
| </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-bash" data-lang="bash"><span style="display:flex;"><span>$ kubectl delete hpa istiod -n istio-system |
| </span></span></code></pre></div><p>After the installation is complete, you can see an istiod pod running normally under the istio-system namespace.</p></description></item><item><title>Docs: The Devil Is In The Details</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/principals/code-detail/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/principals/code-detail/</guid><description> |
| <p>Recently, I have been worried about the quality of the Dubbo distributed service framework. If there are more maintenance personnel or changes, there will be a decline in quality. I am thinking, is there any need for everyone to abide by it, according to a habit when writing code, I have summarized it. The code process, especially the framework code, should always keep in mind the details. Maybe the following will be said, everyone will feel very simple, very basic, but always keep in mind. Considering these factors in every line of code requires a lot of patience. It is often said that the devil is in the details.</p> |
| <h2 id="prevent-null-pointer-dereference-and-index-out-of-bounds">Prevent null pointer dereference and index out of bounds</h2> |
| <p>This is the exception I least like to see, especially in the core framework, in contrast I would like to see a parameter not legal exception with detail information. This is also a robust program developer who should be prevented in the subconscious by writing every line of code. Basically, you must be able to ensure that the code that is written once will not appear in the case of no test.</p> |
| <h2 id="ensure-thread-safety-and-visibility">Ensure thread safety and visibility</h2> |
| <p>For framework developers, a deep understanding of thread safety and visibility is the most basic requirement. Developers are required to ensure that they are correct in the subconscious when writing each line of code. Because of this kind of code, it will look normal when doing functional tests under small concurrency. However, under high concurrency, there will be inexplicable problems, and the scene is difficult to reproduce, and it is extremely difficult to check.</p> |
| <h2 id="fail-fast-and-precondition">Fail fast and precondition</h2> |
| <p>Fail fast should also become a subconscious mind, assert at the entrance when there are incoming parameters and state changes. An illegal value and state should be reported at the first time, rather than waiting until the time is needed. Because when it is time to use, other related states may have been modified before, and few people in the program handle the rollback logic. After this error, the internal state may be confusing, and it is easy to cause the program to be unrecoverable on a hidden branch.</p> |
| <h2 id="separate-reliable-operation-and-unreliable-operation">Separate reliable operation and unreliable operation</h2> |
| <p>The reliability here is narrowly defined whether it will throw an exception or cause a state inconsistency. For example, writing a thread-safe Map can be considered reliable, but writing to a database can be considered unreliable. Developers must pay attention to its reliability when writing each line of code, divide it as much as possible in the code, and handle exceptions for failures, and provide clear logic for fault-tolerant, self-protection, automatic recovery or switching. The entry point ensures that the code that is subsequently added is not misplaced, and the original fault-tolerant processing is confusing.</p> |
| <h2 id="safeguard-against-exceptions-but-does-not-ignore-exceptions">Safeguard against exceptions, but does not ignore exceptions</h2> |
| <p>The exception defense mentioned here refers to the maximum tolerance of the code on the non-crucial path, including the bug on the program. For example, the version number of program is retrieved by scanning the Manifest and jar package names. This logic is auxiliary, but the code is quite a bit. Although the initial test works well but you should add a try-catch block to cover the whole getVersion() function, if something goes wrong then print error message and return the basic version. Because getVersion() may encounter exception for specific unknown scene, or other developers mistakenly modify the logic (usually they won&rsquo;t remove try-catch). Otherwise if it throws an exception, the main process will be interrupted which we don&rsquo;t want to see. It should be controlled properly, do not abuse try-catch, and do not eat the exception silently.</p> |
| <h2 id="reduce-scope-of-variable-and-use-final-liberally">Reduce scope of variable and use final liberally</h2> |
| <p>If a class can be an Immutable Class, it is preferred to design it as an Immutable Class. The immutable class has natural concurrency advantages, reduce synchronization and replication, it can efficiently help analyze the scope of thread safety. Even if a mutable class, for references passed in from constructor then held internally, it is better to make this field final, so as not to be mistakenly modified. Don&rsquo;t assume that the field won&rsquo;t be reassigned if this field is private or this class is written by myself. One factor to consider is that this code may be modified by others. He may not aware your weak convention， and the Final is a invariant contract.</p> |
| <h2 id="reduce-misunderstanding-when-modifying-do-not-bury-mine">Reduce misunderstanding when modifying, do not bury mine</h2> |
| <p>It is repeatedly mentioned that the code being modified by the others, and this is something developers should keep in mind. This other person includes the future of yourself, you always have to think about this code, someone may change it. I should give the modified person a hint, let him know my current design intent, instead of adding hidden rules in the program, or bury some easily overlooked mines, such as: use null to indicate that it is not available, the size is equal to 0 means black list, this is a mine. The next modifier, including yourself, will not remember to have such an agreement, may later change some of the other bugs, accidentally changed to here, directly detonated the fault. For this example, one principle is to never distinguish between null references and null values.</p> |
| <h2 id="improve-code-testability">Improve code testability</h2> |
| <p>The testability here mainly refers to the ease of Mock and the isolation of the test cases. As for the automation, repeatability, stability, disorder, completeness (full coverage), lightweight (fast execution) of the test, the general developer, plus the assist of tools such as JUnit can do it. Can also understand its benefits, just the matter of workload. Primary emphasis on unicity(only test the target class itself) and isolation(do not propagate failure). Nowadays there is too much emphasis on completeness, a lot of crossed and repeated test cases. It seems fine, but the more test code, the higher maintenance cost. A common problem is that modifying a line of code or adding an assertion causes more than 100 test cases to fail. It will cost a lot of time to fix these variance test cases. Over time, this test cases can&rsquo;t really reflect the current state of the code, and it will often be compromised to bypass. In the best case, modify a line of code, and only one line of test code does not pass. If the code is modified and the test case can still pass, that doesn&rsquo;t work, indicating that the scenario is not covered. In addition, Mockability is the basis of isolation, it hide the logic of indirect dependencies. One of the biggest killers of Mockability is the static method, which should be avoid as possible.</p></description></item><item><title>Docs3-V2: Distributed Transactions</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/transaction/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/transaction/</guid><description> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="first-step"><strong>First step</strong></h3> |
| <p>First visit: <a href="https://seata.io/zh-cn/blog/download.html">https://seata.io/zh-cn/blog/download.html</a></p> |
| <p>Download the seata1.5.2 service we need to use</p> |
| <h3 id="second-step"><strong>Second step</strong></h3> |
| <ol> |
| <li>Add the undo_log table to your database participating in global transactions (TCC, SAGA, XA can skip this step)</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-sql" data-lang="sql"><span style="display:flex;"><span><span style="color:#586e75">-- for AT mode you must to init this sql for you business database. the seata server not need it. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>undo_log<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>(<span style="color:#2aa198">20</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;branch transaction id&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">100</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;global transaction id&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>context<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;undo_log context, such as serialization&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>rollback_info<span style="color:#719e07">`</span> LONGBLOB <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;rollback info&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_status<span style="color:#719e07">`</span> <span style="color:#b58900">INT</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;0: normal status,1: defense status&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_created<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;create datetime&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_modified<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;modify datetime&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">UNIQUE</span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>ux_undo_log<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span>, <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> AUTO_INCREMENT <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8 <span style="color:#719e07">COMMENT</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">&#39;AT transaction mode undo table&#39;</span>; |
| </span></span></code></pre></div><ol start="2"> |
| <li>Create a library named seata in your mysql database, and use the following sql</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-sql" data-lang="sql"><span style="display:flex;"><span><span style="color:#586e75">-- -------------------------------- The script used when storeMode is &#39;db&#39; ------- ------------------------- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">-- the table to store GlobalSession data |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>global_table<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>status<span style="color:#719e07">`</span> TINYINT <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>application_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_service_group<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_name<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>timeout<span style="color:#719e07">`</span> <span style="color:#b58900">INT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>begin_time<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>application_data<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">2000</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_create<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_gmt_modified_status<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span>, <span style="color:#719e07">`</span>status<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_transaction_id<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">-- the table to store BranchSession data |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>branch_table<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>resource_group_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>resource_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">256</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_type<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">8</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>status<span style="color:#719e07">`</span> TINYINT, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>client_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">64</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>application_data<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">2000</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_create<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_xid<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">-- the table to store lock data |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>lock_table<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>row_key<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">96</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>resource_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">256</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span><span style="color:#719e07">table_name</span><span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>pk<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">36</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_create<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>row_key<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_branch_id<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8; |
| </span></span></code></pre></div><h3 id="third-step"><strong>third step</strong></h3> |
| <p>Introduce seata dependency into your project</p> |
| <p>spring-boot application:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span> &lt;dependency&gt; |
| </span></span><span style="display:flex;"><span> &lt;groupId&gt;io.seata&lt;/groupId&gt; |
| </span></span><span style="display:flex;"><span> &lt;artifactId&gt;seata-spring-boot-starter&lt;/artifactId&gt; |
| </span></span><span style="display:flex;"><span> &lt;version&gt;1.5.2&lt;/version&gt; |
| </span></span><span style="display:flex;"><span> &lt;/dependency&gt; |
| </span></span></code></pre></div><p>spring application:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span> &lt;dependency&gt; |
| </span></span><span style="display:flex;"><span> &lt;groupId&gt;io.seata&lt;/groupId&gt; |
| </span></span><span style="display:flex;"><span> &lt;artifactId&gt;seata-all&lt;/artifactId&gt; |
| </span></span><span style="display:flex;"><span> &lt;version&gt;1.5.2&lt;/version&gt; |
| </span></span><span style="display:flex;"><span> &lt;/dependency&gt; |
| </span></span></code></pre></div><h3 id="the-fourth-step"><strong>the fourth step</strong></h3> |
| <p>spring-boot application:</p> |
| <p>Reference <a href="https://github.com/seata/seata/tree/develop/script/client/spring">seata/script/client/spring at develop seata/seata (github.com)</a></p> |
| <p>Add it to your project&rsquo;s application.yml.</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">seata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">enabled</span>: <span style="color:#cb4b16">true</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application-id</span>: applicationName |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">tx-service-group</span>: my_test_tx_group |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">enable-auto-data-source-proxy</span>: <span style="color:#cb4b16">true</span> <span style="color:#586e75">#Only AT and XA modes need to be true, and the data source will be automatically proxied after opening</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">data-source-proxy-mode</span>: AT <span style="color:#586e75">#Optional AT&amp;XA</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">config</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">serverAddr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">data-id</span>: seata.properties |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registry</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: seata-server |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">server-addr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span></code></pre></div><p>spring application:</p> |
| <p>Add <a href="https://github.com/seata/seata/tree/develop/script/client/conf">seata/script/client/conf at develop · seata/seata (github.com)</a> under registry.conf, because High-availability deployment uses a third-party configuration center, so file.conf is not required</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>registry { |
| </span></span><span style="display:flex;"><span> # file, nacos, eureka, redis, zk, consul, etcd3, sofa, custom |
| </span></span><span style="display:flex;"><span> type = &#34;nacos&#34; |
| </span></span><span style="display:flex;"><span> nacos { |
| </span></span><span style="display:flex;"><span> application = &#34;seata-server&#34; |
| </span></span><span style="display:flex;"><span> serverAddr = &#34;127.0.0.1:8848&#34; |
| </span></span><span style="display:flex;"><span> group = &#34;SEATA_GROUP&#34; |
| </span></span><span style="display:flex;"><span> namespace = &#34;&#34; |
| </span></span><span style="display:flex;"><span> username = &#34;&#34; |
| </span></span><span style="display:flex;"><span> password = &#34;&#34; |
| </span></span><span style="display:flex;"><span> ##if use MSE Nacos with auth, mutex with username/password attribute |
| </span></span><span style="display:flex;"><span> #accessKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> #secretKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> ##if use Nacos naming meta-data for SLB service registry, specify nacos address pattern rules here |
| </span></span><span style="display:flex;"><span> #slbPattern = &#34;&#34; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>config { |
| </span></span><span style="display:flex;"><span> # file, nacos, apollo, zk, consul, etcd3, springCloudConfig, custom |
| </span></span><span style="display:flex;"><span> type = &#34;nacos&#34; |
| </span></span><span style="display:flex;"><span> nacos { |
| </span></span><span style="display:flex;"><span> serverAddr = &#34;127.0.0.1:8848&#34; |
| </span></span><span style="display:flex;"><span> namespace = &#34;&#34; |
| </span></span><span style="display:flex;"><span> group = &#34;SEATA_GROUP&#34; |
| </span></span><span style="display:flex;"><span> username = &#34;&#34; |
| </span></span><span style="display:flex;"><span> password = &#34;&#34; |
| </span></span><span style="display:flex;"><span> ##if use MSE Nacos with auth, mutex with username/password attribute |
| </span></span><span style="display:flex;"><span> #accessKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> #secretKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> dataId = &#34;seata.properties&#34; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="the-fifth-step"><strong>the fifth step</strong></h3> |
| <p>Run the nacos you downloaded, and refer to [https://github.com/seata/seata/tree/develop/script/config-center](<a href="https://gitee.com/link?target=https%3A%2F%25">https://gitee.com/link?target=https%3A%2F%</a> 2Fgithub.com%2Fseata%2Fseata%2Ftree%2Fdevelop%2Fscript%2Fconfig-center) and modify the config.txt</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">#Only used by client</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">#The transaction group is called my_test_tx_group and the corresponding seata-server cluster is default</span> |
| </span></span><span style="display:flex;"><span>service.vgroupMapping.my_test_tx_group<span style="color:#719e07">=</span><span style="color:#2aa198">default</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">#The following are only used by server</span> |
| </span></span><span style="display:flex;"><span>store.mode<span style="color:#719e07">=</span><span style="color:#2aa198">db</span> |
| </span></span><span style="display:flex;"><span>store.db.datasource<span style="color:#719e07">=</span><span style="color:#2aa198">druid</span> |
| </span></span><span style="display:flex;"><span>store.db.dbType<span style="color:#719e07">=</span><span style="color:#2aa198">mysql</span> |
| </span></span><span style="display:flex;"><span>store.db.driverClassName<span style="color:#719e07">=</span><span style="color:#2aa198">com.mysql.jdbc.Driver</span> |
| </span></span><span style="display:flex;"><span>store.db.url<span style="color:#719e07">=</span><span style="color:#2aa198">jdbc:mysql://127.0.0.1:3306/seata?useUnicode=true</span> |
| </span></span><span style="display:flex;"><span>store.db.user<span style="color:#719e07">=</span><span style="color:#2aa198">username</span> |
| </span></span><span style="display:flex;"><span>store.db.password<span style="color:#719e07">=</span><span style="color:#2aa198">password</span> |
| </span></span><span style="display:flex;"><span>store.db.minConn<span style="color:#719e07">=</span><span style="color:#2aa198">5</span> |
| </span></span><span style="display:flex;"><span>store.db.maxConn<span style="color:#719e07">=</span><span style="color:#2aa198">30</span> |
| </span></span><span style="display:flex;"><span>store.db.globalTable<span style="color:#719e07">=</span><span style="color:#2aa198">global_table</span> |
| </span></span><span style="display:flex;"><span>store.db.branchTable<span style="color:#719e07">=</span><span style="color:#2aa198">branch_table</span> |
| </span></span><span style="display:flex;"><span>store.db.queryLimit<span style="color:#719e07">=</span><span style="color:#2aa198">100</span> |
| </span></span><span style="display:flex;"><span>store.db.lockTable<span style="color:#719e07">=</span><span style="color:#2aa198">lock_table</span> |
| </span></span><span style="display:flex;"><span>store.db.maxWait<span style="color:#719e07">=</span><span style="color:#2aa198">5000</span> |
| </span></span></code></pre></div><p>Open the nacos console, create a configuration whose dataId is seata.properties under the corresponding namespace, fill in the group as SEATA_GROUP, and fill in the above content and select the type as properties to save |
| <img src="https://dubbo.apache.org/imgs/blog/Dingtalk_20220724021635.jpg" alt="Dingtalk_20220724021635.jpg.png" style="zoom:50%;" /></p> |
| <h3 id="step-6"><strong>Step 6</strong></h3> |
| <p>Change application.yml in server</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">server</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">port</span>: <span style="color:#2aa198">7091</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">spring</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>: seata-server |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">record</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">config</span>: classpath:logback-spring.xml |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">file</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">path</span>: ${user.home}/logs/seata |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">console</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">user</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: seata |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: seata |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">seata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">config</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75"># support: nacos, consul, apollo, zk, etcd3</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">server-addr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">##if use MSE Nacos with auth, mutex with username/password attribute</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#access-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#secret-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">data-id</span>: seata.properties |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registry</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75"># support: nacos, eureka, redis, zk, consul, etcd3, sofa</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: seata-server |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">server-addr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">namespace</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">cluster</span>: default |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">##if use MSE Nacos with auth, mutex with username/password attribute</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#access-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#secret-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># server:</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># service-port: 8091 #If not configured, the default is &#39;${server.port} + 1000&#39;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">security</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">secretKey</span>: SeataSecretKey0c382ef121d778043159209298fd40bf3850a017 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">tokenValidityInMilliseconds</span>: <span style="color:#2aa198">1800000</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">ignore</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">urls</span>: /,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*. png, /**/*.ico, /console-fe/public/**, /api/v1/auth/login |
| </span></span></code></pre></div><h3 id="step-seven"><strong>Step Seven</strong></h3> |
| <p>An example of adding @GlobalTransactional to the interface of the global transaction caller (the service that initiates the global transaction) 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@GetMapping</span>(value <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;testCommit&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@GlobalTransactional</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> Object <span style="color:#268bd2">testCommit</span>(<span style="color:#268bd2">@RequestParam</span>(name <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;id&#34;</span>,defaultValue <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1&#34;</span>) Integer id, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@RequestParam</span>(name <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;sum&#34;</span>, defaultValue <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1&#34;</span>) Integer sum) { |
| </span></span><span style="display:flex;"><span> Boolean ok <span style="color:#719e07">=</span> productService. <span style="color:#268bd2">reduceStock</span>(id, sum); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (ok) { |
| </span></span><span style="display:flex;"><span> LocalDateTime now <span style="color:#719e07">=</span> LocalDateTime.now(); |
| </span></span><span style="display:flex;"><span> Orders orders <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Orders(); |
| </span></span><span style="display:flex;"><span> orders.setCreateTime(now); |
| </span></span><span style="display:flex;"><span> orders.setProductId(id); |
| </span></span><span style="display:flex;"><span> orders. <span style="color:#268bd2">setReplaceTime</span>(now); |
| </span></span><span style="display:flex;"><span> orders. <span style="color:#268bd2">setSum</span>(sum); |
| </span></span><span style="display:flex;"><span> orderService. <span style="color:#268bd2">save</span>(orders); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;ok&#34;</span>; |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;fail&#34;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Spring applications need to manually proxy the data source to select the transaction mode and initialize the transaction scanner when using AT or XA mode</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">@Primary</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Bean</span>(<span style="color:#2aa198">&#34;dataSource&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> DataSource <span style="color:#268bd2">dataSource</span>(DataSource druidDataSource) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//AT agent choose one of the two</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> DataSourceProxy(druidDataSource); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//XA Proxy</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> DataSourceProxyXA(druidDataSource) |
| </span></span><span style="display:flex;"><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:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> GlobalTransactionScanner <span style="color:#268bd2">globalTransactionScanner</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> GlobalTransactionScanner(<span style="color:#2aa198">&#34;application name&#34;</span>, <span style="color:#2aa198">&#34;my_test_tx_group&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>If you use tcc mode, you need to additionally define two-stage try and confirm(commit) cancel(rollback) in the serviceimpl of the corresponding provider</p> |
| <p>The spring-boot application needs to close the data source proxy</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">seata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">enable-auto-data-source-proxy</span>: <span style="color:#cb4b16">false</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:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Define two-phase commit name = the bean name of the tcc, globally unique commitMethod = commit is the two-phase confirmation method rollbackMethod = rollback is the two-phase cancellation method |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * useTCCFence=true is to enable anti-hanging |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * BusinessActionContextParameter annotation to pass parameters to the second stage |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param params - input parameters |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return String |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@TwoPhaseBusinessAction</span>(name <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;beanName&#34;</span>, commitMethod <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;commit&#34;</span>, rollbackMethod <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;rollback&#34;</span>, useTCCFence <span style="color:#719e07">=</span> <span style="color:#cb4b16">true</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">insert</span>(<span style="color:#268bd2">@BusinessActionContextParameter</span>(paramName <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;params&#34;</span>) Map<span style="color:#719e07">&lt;</span>String, String<span style="color:#719e07">&gt;</span> params) { |
| </span></span><span style="display:flex;"><span> logger.info(<span style="color:#2aa198">&#34;You can reserve resources here, or use the characteristics of tcc to mix with AT. In the second stage, use the messages stored here in the first stage and send them out through the second stage, such as redis, mq and other operations&#34;</span>); |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * The confirmation method can be named otherwise, but it must be consistent with the commitMethod. The context can pass the parameters of the try method |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param context context |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return boolean |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">commit</span>(BusinessActionContext context) { |
| </span></span><span style="display:flex;"><span> logger.info(<span style="color:#2aa198">&#34;Reserved resources are actually processed, or send mq messages and redis storage&#34;</span>); |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Two-stage cancellation method |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param context context |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return boolean |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">rollback</span>(BusinessActionContext context) { |
| </span></span><span style="display:flex;"><span> logger.info(<span style="color:#2aa198">&#34;Release reserved resources, or clear the message cache sent when the first phase is ready to be submitted by the second phase&#34;</span>); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>linux/macos</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#b58900">cd</span> bin |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>sh seata-server.sh |
| </span></span></code></pre></div><p>windows</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#b58900">cd</span> bin |
| </span></span><span style="display:flex;"><span>./seata-server.bat |
| </span></span></code></pre></div><p>Run seata-server, after success, run your own service dubbo provider&amp;consumer</p> |
| <h3 id="the-eighth-step-is-to-build-a-highly-available-seata-server"><strong>The eighth step is to build a highly available Seata-server</strong></h3> |
| <p>Since seata-server supports the separation mode of computing and storage, and supports exposing service addresses to multiple registration centers, it only needs to be configured according to the sixth step and then expanded horizontally</p> |
| <p>For details, please visit: <a href="https://seata.io/">https://seata.io/</a></p></description></item><item><title>Docs3-V2: Dubbo Class Inspection Mechanism</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/security/class-check/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/security/class-check/</guid><description> |
| <h2 id="supported-versions">Supported versions</h2> |
| <p>Dubbo &gt;= 3.1.6</p> |
| <h2 id="scope-of-application">Scope of application</h2> |
| <p>Currently, the serialization check supports Hessian2, Fastjson2 serialization and generalized calls. Other serialization methods are not currently supported.</p> |
| <h2 id="configuration-method">configuration method</h2> |
| <h3 id="1-check-mode">1. Check mode</h3> |
| <p>The inspection mode is divided into three levels: <code>STRICT</code> strict inspection, <code>WARN</code> warning, <code>DISABLED</code> disabled. |
| <code>STRICT</code> Strict checks: disallow deserialization of all classes that are not in the allowed serialization list (whitelist). |
| <code>WARN</code> warning: only prohibits serialization of all classes in the disallowed serialization list (blacklist), and alerts through logs when deserializing classes that are not in the allowed serialization list (whitelist). |
| <code>DISABLED</code> Disabled: Do not do any checks.</p> |
| <p>Version 3.1 defaults to <code>WARN</code> warning level, and version 3.2 defaults to <code>STRICT</code> strict checking level.</p> |
| <p>Configuration via ApplicationConfig:</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>ApplicationConfig applicationConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>applicationConfig.setSerializeCheckStatus(<span style="color:#2aa198">&#34;STRICT&#34;</span>); |
| </span></span></code></pre></div><p>Configuration via Spring XML:</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:application</span> name=<span style="color:#2aa198">&#34;demo-provider&#34;</span> serialize-check-status=<span style="color:#2aa198">&#34;STRICT&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Configure via Spring Properties / dubbo.properties:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.application.serialize-check-status<span style="color:#719e07">=</span><span style="color:#2aa198">STRICT</span> |
| </span></span></code></pre></div><p>Configure via System Property:</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>-Ddubbo.application.serialize-check-status<span style="color:#719e07">=</span><span style="color:#2aa198">STRICT</span> |
| </span></span></code></pre></div><p>After the configuration is successful, you can see the following prompts in the log:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>INFO utils.SerializeSecurityManager: [DUBBO] Serialize check level: STRICT |
| </span></span></code></pre></div><p>Note: If multiple applications under the same process (Dubbo Framework Model) are configured with different inspection modes at the same time, the &ldquo;loosenest&rdquo; level will eventually take effect. If two Spring Contexts are started at the same time, one is configured as <code>STRICT</code> and the other is configured as <code>WARN</code>, the <code>WARN</code> level configuration will finally take effect.</p> |
| <h3 id="2-serializable-interface-check">2. Serializable interface check</h3> |
| <p>The Serializable interface check mode is divided into two levels: <code>true</code> is enabled, and <code>false</code> is disabled. When the check is turned on, it will refuse to deserialize all classes that do not implement <code>Serializable</code>.</p> |
| <p>The default configuration in Dubbo is <code>true</code> to enable the check.</p> |
| <p>Configuration via ApplicationConfig:</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>ApplicationConfig applicationConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>applicationConfig.setCheckSerializable(<span style="color:#cb4b16">true</span>); |
| </span></span></code></pre></div><p>Configuration via Spring XML:</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:application</span> name=<span style="color:#2aa198">&#34;demo-provider&#34;</span> check-serializable=<span style="color:#2aa198">&#34;true&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Configure via Spring Properties / dubbo.properties:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.application.check-serializable<span style="color:#719e07">=</span><span style="color:#2aa198">true</span> |
| </span></span></code></pre></div><p>Configure via System Property:</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>-Ddubbo.application.check-serializable<span style="color:#719e07">=</span><span style="color:#2aa198">true</span> |
| </span></span></code></pre></div><p>After the configuration is successful, you can see the following prompts in the log:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>INFO utils.SerializeSecurityManager: [DUBBO] Serialize check serializable: true |
| </span></span></code></pre></div><p>Note 1: If multiple applications under the same process (Dubbo Framework Model) are configured with different Serializable interface inspection modes at the same time, the &ldquo;loosenest&rdquo; level will eventually take effect. If two Spring Contexts are started at the same time, one configured as <code>true</code> and the other configured as <code>false</code>, the <code>false</code> level configuration will finally take effect. |
| Note 2: At present, the built-in <code>Serializable</code> check configuration of Hessian2 and Fastjson2 has not been opened. For generalized calls, you only need to configure <code>dubbo.application.check-serializable</code> to modify the check configuration; for Hessian2 serialization, you need to modify <code>dubbo.application.check-serializable</code> and <code>dubbo.hessian.allowNonSerializable</code> at the same time</p> |
| <h3 id="3-automatically-scan-related-configurations">3. Automatically scan related configurations</h3> |
| <p>There are two configuration items in the Dubbo class automatic scanning mechanism: `AutoTrustSerializeClass</p> |
| <p>To put it simply, after automatic class scanning is enabled, Dubbo will automatically scan all related classes that may be used by the interface through <code>ReferenceConfig</code> and <code>ServiceConfig</code>, and recursively trust its package. `TrustSerializeClassLevel</p> |
| <p>The default configuration in Dubbo is `AutoTrustSerializeClass</p> |
| <p>Configuration via ApplicationConfig:</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>ApplicationConfig applicationConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>applicationConfig.setAutoTrustSerializeClass(<span style="color:#cb4b16">true</span>); |
| </span></span><span style="display:flex;"><span>applicationConfig.setTrustSerializeClassLevel(3); |
| </span></span></code></pre></div><p>Configuration via Spring XML:</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:application</span> name=<span style="color:#2aa198">&#34;demo-provider&#34;</span> auto-trust-serialize-class=<span style="color:#2aa198">&#34;true&#34;</span> trust-serialize-class-level=<span style="color:#2aa198">&#34;3&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Configure via Spring Properties / dubbo.properties:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.application.auto-trust-serialize-class<span style="color:#719e07">=</span><span style="color:#2aa198">true</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.trust-serialize-class-level<span style="color:#719e07">=</span><span style="color:#2aa198">3</span> |
| </span></span></code></pre></div><p>Configure via System Property:</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>-Ddubbo.application.auto-trust-serialize-class<span style="color:#719e07">=</span><span style="color:#2aa198">true</span> |
| </span></span><span style="display:flex;"><span>-Ddubbo.application.trust-serialize-class-level<span style="color:#719e07">=</span><span style="color:#2aa198">3</span> |
| </span></span></code></pre></div><p>After the configuration is successful, you can use the QoS command to check whether the results of the currently loaded trusted classes meet expectations.</p> |
| <p>Note: After the check is enabled, there will be a certain performance loss during the startup process.</p> |
| <h3 id="4-custom-configuration-of-trusteduntrusted-classes">4. Custom configuration of trusted/untrusted classes</h3> |
| <p>In addition to Dubbo&rsquo;s automatic scanning classes, it also supports configuration of trusted/untrusted class lists through resource files.</p> |
| <p>Configuration method: define the following files under the resource directory (resource).</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"># security/serialize.allowlist</span> |
| </span></span><span style="display:flex;"><span>io.dubbo.test |
| </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"># security/serialize.blockedlist</span> |
| </span></span><span style="display:flex;"><span>io.dubbo.block |
| </span></span></code></pre></div><p>After the configuration is successful, you can see the following prompts in the log:</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>INFO <span style="color:#2aa198">utils.SerializeSecurityConfigurator: [DUBBO] Read serialize allow list from file:/Users/albumen/code/dubbo-samples/99-integration/dubbo-samples-serialize-check/target/classes/security/serialize.allowlist</span> |
| </span></span><span style="display:flex;"><span>INFO <span style="color:#2aa198">utils.SerializeSecurityConfigurator: [DUBBO] Read serialize blocked list from file:/Users/albumen/code/dubbo-samples/99-integration/dubbo-samples-serialize-check/target/classes/security/serialize.blockedlist</span> |
| </span></span></code></pre></div><p>The configuration priority is: user-defined trusted class = built-in trusted class of the framework &gt; user-defined untrusted class = built-in untrusted class of the framework &gt; automatic class scanning trusted class.</p> |
| <h2 id="audit-method">Audit method</h2> |
| <p>Dubbo supports real-time viewing of current configuration information and trusted/untrusted class lists through QoS commands. Currently supports two commands: <code>serializeCheckStatus</code> to view the current configuration information, <code>serializeWarnedClasses</code> to view the real-time alarm list.</p> |
| <ol> |
| <li><code>serializeCheckStatus</code> View the current configuration information</li> |
| </ol> |
| <p>Access directly through the console:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>&gt; telnet 127.0.0.1 <span style="color:#2aa198">22222</span> |
| </span></span><span style="display:flex;"><span>Trying 127.0.0.1... |
| </span></span><span style="display:flex;"><span>Connected to localhost. |
| </span></span><span style="display:flex;"><span>Escape character is <span style="color:#2aa198">&#39;^]&#39;</span>. |
| </span></span><span style="display:flex;"><span> ___ __ __ ___ ___ ____ |
| </span></span><span style="display:flex;"><span> / _ <span style="color:#cb4b16">\ </span>/ / / // _ <span style="color:#719e07">)</span> / _ <span style="color:#719e07">)</span> / __ <span style="color:#cb4b16">\ |
| </span></span></span><span style="display:flex;"><span><span style="color:#cb4b16"></span> / // // /_/ // _ |/ _ |/ /_/ / |
| </span></span><span style="display:flex;"><span>/____/ <span style="color:#cb4b16">\_</span>___//____//____/ <span style="color:#cb4b16">\_</span>___/ |
| </span></span><span style="display:flex;"><span>dubbo&gt;serializeCheckStatus |
| </span></span><span style="display:flex;"><span>CheckStatus: WARN |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>CheckSerializable: <span style="color:#b58900">true</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>AllowedPrefix: |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>DisAllowedPrefix: |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; |
| </span></span></code></pre></div><p>Request the result in json format via http:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>&gt; curl http://127.0.0.1:22222/serializeCheckStatus |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">{</span><span style="color:#2aa198">&#34;checkStatus&#34;</span>: <span style="color:#2aa198">&#34;WARN&#34;</span>,<span style="color:#2aa198">&#34;allowedPrefix&#34;</span>:<span style="color:#719e07">[</span>...<span style="color:#719e07">]</span>,<span style="color:#2aa198">&#34;checkSerializable&#34;</span>:true,<span style="color:#2aa198">&#34;disAllowedPrefix&#34;</span>:<span style="color:#719e07">[</span>...<span style="color:#719e07">]}</span> |
| </span></span></code></pre></div><ol start="2"> |
| <li><code>serializeWarnedClasses</code> view real-time warning list</li> |
| </ol> |
| <p>Access directly through the console:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>&gt; telnet 127.0.0.1 <span style="color:#2aa198">22222</span> |
| </span></span><span style="display:flex;"><span>Trying 127.0.0.1... |
| </span></span><span style="display:flex;"><span>Connected to localhost. |
| </span></span><span style="display:flex;"><span>Escape character is <span style="color:#2aa198">&#39;^]&#39;</span>. |
| </span></span><span style="display:flex;"><span> ___ __ __ ___ ___ ____ |
| </span></span><span style="display:flex;"><span> / _ <span style="color:#cb4b16">\ </span>/ / / // _ <span style="color:#719e07">)</span> / _ <span style="color:#719e07">)</span> / __ <span style="color:#cb4b16">\ |
| </span></span></span><span style="display:flex;"><span><span style="color:#cb4b16"></span> / // // /_/ // _ |/ _ |/ /_/ / |
| </span></span><span style="display:flex;"><span>/____/ <span style="color:#cb4b16">\_</span>___//____//____/ <span style="color:#cb4b16">\_</span>___/ |
| </span></span><span style="display:flex;"><span>dubbo&gt;serializeWarnedClasses |
| </span></span><span style="display:flex;"><span>Warned Classes: |
| </span></span><span style="display:flex;"><span>io.dubbo.test.NotSerializable |
| </span></span><span style="display:flex;"><span>io.dubbo.test2.NotSerializable |
| </span></span><span style="display:flex;"><span>io.dubbo.test2.OthersSerializable |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.samples.NotSerializable |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; |
| </span></span></code></pre></div><p>Request the result in json format via http:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>&gt; curl http://127.0.0.1:22222/serializeWarnedClasses |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">{</span><span style="color:#2aa198">&#34;warnedClasses&#34;</span>:<span style="color:#719e07">[</span><span style="color:#2aa198">&#34;io.dubbo.test2.NotSerializable&#34;</span>,<span style="color:#2aa198">&#34;org.apache.dubbo.samples.NotSerializable&#34;</span>,<span style="color:#2aa198">&#34;io.dubbo.test.NotSerializable&#34;</span>,<span style="color:#2aa198">&#34;io.dubbo.test2.OthersSerializable&#34;</span><span style="color:#719e07">]}</span> |
| </span></span></code></pre></div><p>Note: It is recommended to pay attention to the result of <code>serializeWarnedClasses</code> in time, and judge whether it is attacked by whether the returned result is not empty.</p></description></item><item><title>Docs3-V2: Dubbo SPI Overview</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/spi/overview/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/reference-manual/spi/overview/</guid><description> |
| <h2 id="extended-design-ideas">Extended Design Ideas</h2> |
| <p>Scalability is what any system pursues, and it is equally applicable to Dubbo.</p> |
| <h3 id="what-is-scalability">What is scalability</h3> |
| <p>Scalability is a design concept that represents our vision for the future. We hope that based on the existing architecture or design, when some aspects change in the future, we can adapt to this with minimal changes. kind of change.</p> |
| <h3 id="advantages-of-scalability">Advantages of Scalability</h3> |
| <p>The advantage of scalability is mainly manifested in the decoupling between modules, which conforms to the principle of opening and closing, which is open to expansion and closed to modification. When a new function is added to the system, there is no need to modify the structure and code of the existing system, just add an extension.</p> |
| <h3 id="extended-implementation">Extended implementation</h3> |
| <p>Generally speaking, the system will use Factory, IoC, OSGI, etc. to manage the extension (plug-in) life cycle. Considering the applicability of Dubbo, I don&rsquo;t want to strongly rely on IoC containers such as Spring. |
| And building a small IoC container by myself feels a bit over-designed, so choose the simplest Factory way to manage extensions (plug-ins). In Dubbo, all internal and third-party implementations are equal.</p> |
| <h3 id="scalability-in-dubbo">Scalability in Dubbo</h3> |
| <ul> |
| <li>Treat third-party implementations equally. In Dubbo, all internal implementations and third-party implementations are equal, and users can replace the native implementations provided by Dubbo based on their own business needs.</li> |
| <li>Each extension point only encapsulates one change factor to maximize reuse. The implementers of each extension point often only care about one thing. If users need to expand, they only need to expand the extension points they care about, which greatly reduces the workload of users.</li> |
| </ul> |
| <h2 id="features-of-dubbo-extension">Features of Dubbo extension</h2> |
| <p>The extension capability in Dubbo is enhanced from the JDK standard SPI extension point discovery mechanism, which improves the following problems of the JDK standard SPI:</p> |
| <ul> |
| <li>The JDK standard SPI will instantiate all the implementations of the extension point at one time. If there is an extension implementation, it will be time-consuming to initialize, but if it is not used, it will be loaded, which will be a waste of resources.</li> |
| <li>If the extension point fails to load, even the name of the extension point cannot be obtained. For example: JDK standard ScriptEngine, get the name of the script type through getName(), but if RubyScriptEngine fails to load the RubyScriptEngine class because the jruby. When the user executes the ruby script, it will report that ruby is not supported, not the real reason for the failure.</li> |
| </ul> |
| <p>Based on the expansion capabilities provided by Dubbo, users can easily expand other protocols, filters, routes, etc. based on their own needs. The following introduces the characteristics of Dubbo&rsquo;s extension capabilities.</p> |
| <ul> |
| <li>Load on demand. Dubbo&rsquo;s extension capability does not instantiate all implementations at once, but instantiates with extended classes to reduce resource waste.</li> |
| <li>Increase the IOC capability of the extended class. Dubbo&rsquo;s extension ability is not just to discover the extension service implementation class, but to go further on this basis. If the attributes of the extension class depend on other objects, Dubbo will automatically complete the injection function of the dependent object.</li> |
| <li>Increase the AOP capability of extended classes. Dubbo&rsquo;s extension capability will automatically discover the wrapper class of the extension class, complete the construction of the wrapper class, and enhance the function of the extension class.</li> |
| <li>Possess the ability to dynamically select the extension implementation. The Dubbo extension will dynamically select the corresponding extension class at runtime based on parameters, which improves Dubbo&rsquo;s scalability.</li> |
| <li>The extension implementation can be sorted. The execution order of the extension implementation can be specified based on user requirements.</li> |
| <li>Provides the Adaptive capability of the extension point. This capability enables some extension classes to take effect on the consumer side, and some extension classes to take effect on the provider side.</li> |
| </ul> |
| <p>From the design goal of Dubbo extension, it can be seen that some features implemented by Dubbo, such as dynamic selection of extension implementation, IOC, AOP, etc., can provide users with very flexible expansion capabilities.</p> |
| <h2 id="dubbo-extension-loading-process">Dubbo extension loading process</h2> |
| <p>The whole process of Dubbo loading extension is as follows:</p> |
| <p><img src="https://dubbo.apache.org/imgs/v3/concepts/extension-load.png" alt="//imgs/v3/concepts/extension-load.png"></p> |
| <p>There are 4 main steps:</p> |
| <ul> |
| <li>Read and parse configuration files</li> |
| <li>Cache all extension implementations</li> |
| <li>Based on the extension name executed by the user, instantiate the corresponding extension implementation</li> |
| <li>Perform IOC injection of extended instance attributes and instantiate extended wrapper classes to realize AOP features</li> |
| </ul> |
| <h2 id="how-to-use-dubbos-extension-capability-to-expand">How to use Dubbo&rsquo;s extension capability to expand</h2> |
| <p>The following takes the extension protocol as an example to illustrate how to use the extension capabilities provided by Dubbo to extend the Triple protocol.</p> |
| <p>(1) Place a text file in the protocol implementation jar package: META-INF/dubbo/org.apache.dubbo.remoting.api.WireProtocol</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>tri=org.apache.dubbo.rpc.protocol.tri.TripleHttp2Protocol |
| </span></span></code></pre></div><p>(2) Implementation class content</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">@Activate</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">TripleHttp2Protocol</span> <span style="color:#268bd2">extends</span> Http2WireProtocol { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//...</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Instructions: Http2WireProtocol implements the WireProtocol interface</p> |
| <p>(3) In the Dubbo configuration module, each extension point has a corresponding configuration attribute or label, and the configuration specifies which extension to use. 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-text" data-lang="text"><span style="display:flex;"><span>&lt;dubbo:protocol name=&#34;tri&#34; /&gt; |
| </span></span></code></pre></div><p>As can be seen from the above expansion steps, the user basically completes the expansion under the black box.</p> |
| <h2 id="dubbo-extended-application">Dubbo extended application</h2> |
| <p>Dubbo&rsquo;s expansion capability is very flexible, and it is ubiquitous in the realization of its own functions.</p> |
| <p><img src="https://dubbo.apache.org/imgs/v3/concepts/extension-use.png" alt="//imgs/v3/concepts/extension-use.png"></p> |
| <p>Dubbo&rsquo;s extensibility makes it easy to divide the Dubbo project into sub-modules one by one to realize the hot-swappable feature. Users can completely replace Dubbo&rsquo;s native implementation based on their own needs to meet their own business needs.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <ul> |
| <li>If you need to customize the load balancing strategy, you can use Dubbo&rsquo;s scalability.</li> |
| <li>If you need to implement a custom registry, you can use Dubbo&rsquo;s extension capabilities.</li> |
| <li>If you need to implement custom filters, you can use Dubbo&rsquo;s extension capabilities.</li> |
| </ul> |
| <p>Dubbo extensions treat internal implementations and third-party implementations equally. For more usage scenarios, see <a href="../description/">SPI extension implementation</a></p></description></item><item><title>Docs: dubbo protocol</title><link>https://dubbo.apache.org/en/docs/v2.7/user/references/protocol/dubbo/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/references/protocol/dubbo/</guid><description> |
| <p>Dubbo protocol which is the default protocol of Dubbo RPC Framework uses a single long connection and NIO asynchronous communication,it is suitable for small data but with high concurrency RPC call and the number of consumer machine is much greater than provider</p> |
| <p>On the other hand, the Dubbo protocol is not suitable for transmitting large amounts of data, such as file transmission, video transmission, etc., unless the request is very low.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-protocol.jpg" alt="dubbo-protocol.jpg"></p> |
| <ul> |
| <li>Transporter: mina, netty, grizzy</li> |
| <li>Serialization: dubbo, hessian2, java, json</li> |
| <li>Dispatcher: all, direct, message, execution, connection</li> |
| <li>ThreadPool: fixed, cached</li> |
| </ul> |
| <h2 id="features">Features</h2> |
| <p>The default protocol is Dubbo protocol ,based on netty <code>3.2.5.Final</code> and Hessian2 <code>3.2.1-fixed-2(Alibaba embed version)</code>.</p> |
| <ul> |
| <li>Default connection number: single connection</li> |
| <li>Default connection mode: long connection</li> |
| <li>Transmission protocol: TCP</li> |
| <li>Transmission mode: NIO asynchronous transmission</li> |
| <li>Serialization: Hessian2 serialization</li> |
| <li>Scope of application: incoming and outgoing data packets are small (recommended less than 100K),try not to transfer large files or large strings with Dubbo protocol.</li> |
| <li>Applicable scenarios:: most RPC scenarios</li> |
| </ul> |
| <h2 id="constraint">Constraint</h2> |
| <ul> |
| <li>Parameters and return values must implement <code>Serializable</code> interface</li> |
| <li>Parameters and return values can not be customized to implement <code>List</code>,<code> Map</code>, <code>Number</code>,<code> Date</code>, <code>Calendar</code> interface, can only be implemented with the JDK, because Hessian2 will do some special treatment, Attribute values in the class will be lost.</li> |
| <li>Hessian serialization:to solve compatibility issues, only serialize class name,all the fields declared by the class,not included static fields,method information</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>Data transformation</th> |
| <th>Cases</th> |
| <th>Result</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>A-&gt;B</td> |
| <td>Class A has one more property than Class B</td> |
| <td>It doesn&rsquo;t throw exception ，Class B doesn&rsquo;t have Class A new property,other is normal</td> |
| </tr> |
| <tr> |
| <td>A-&gt;B</td> |
| <td>enum Class A has one more new enum than enum Class B，when use Class A new enum to transfor to B</td> |
| <td>throw exception</td> |
| </tr> |
| <tr> |
| <td>A-&gt;B</td> |
| <td>enum Class A has one more new enum than enum Class B，when don&rsquo;t use Class A new enum to transfor to B</td> |
| <td>It doesn&rsquo;t throw exception</td> |
| </tr> |
| <tr> |
| <td>A-&gt;B</td> |
| <td>Class A and Class B have same property name,but the property type is different</td> |
| <td>throw exception</td> |
| </tr> |
| <tr> |
| <td>A-&gt;B</td> |
| <td>serialId is not same</td> |
| <td>normal</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The interface new addition method has no effect on the client. If the method is not required by the client, the client does not need to redeploy it. The input parameter and result class add new properties, and if the client does not need new properties, it does not need to be redeployed too.</p> |
| <p>The change of input parameter and result property name has no effect on client serialization, but if the client is not redeployed, no matter the input or output, the value of which property name had change is not available.</p> |
| <p>Summary: the server side and the client do not need to be fully consistent with the domain objects,but you still should know about what would happen.</p> |
| <h2 id="configuration">Configuration</h2> |
| <p>configure protocol</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;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>configure provider level default protocol:</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:provider</span> protocol=<span style="color:#2aa198">&#34;dubbo&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>configure service level default protocol:</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:service</span> protocol=<span style="color:#2aa198">&#34;dubbo&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>configure multiple port：</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> id=<span style="color:#2aa198">&#34;dubbo1&#34;</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> id=<span style="color:#2aa198">&#34;dubbo2&#34;</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20881&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>configure protocol options:</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">“dubbo”</span> port=<span style="color:#2aa198">“9090”</span> server=<span style="color:#2aa198">“netty”</span> client=<span style="color:#2aa198">“netty”</span> codec=<span style="color:#2aa198">“dubbo”</span> serialization=<span style="color:#2aa198">“hessian2”</span> charset=<span style="color:#2aa198">“UTF-8”</span> threadpool=<span style="color:#2aa198">“fixed”</span> threads=<span style="color:#2aa198">“100”</span> queues=<span style="color:#2aa198">“0”</span> iothreads=<span style="color:#2aa198">“9”</span> buffer=<span style="color:#2aa198">“8192”</span> accepts=<span style="color:#2aa198">“1000”</span> payload=<span style="color:#2aa198">“8388608”</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>configure multiple connectios:</p> |
| <p>Dubbo protocol default uses a single long connection per service per consumer for each service provider,and multiple connections can be used if the amount of data is large</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;dubbo&#34;</span> connections=<span style="color:#2aa198">&#34;2&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li><code>&lt;dubbo:service connections=&quot;0&quot;&gt;</code> OR <code>&lt;dubbo:reference connections=&quot;0&quot;&gt;</code> It means that the service uses a share long connection per provider. <code>default</code></li> |
| <li><code>&lt;dubbo:service connections=&quot;1&quot;&gt;</code> OR <code>&lt;dubbo:reference connections=&quot;1&quot;&gt;</code> It means that the service uses a separate long connection.</li> |
| <li><code>&lt;dubbo:service connections=&quot;2&quot;&gt;</code> OR<code>&lt;dubbo:reference connections=&quot;2&quot;&gt;</code> It means that the service uses two separate long connection.</li> |
| </ul> |
| <p>To prevent being hung up by a large number of connections, you can limit the number of connections at the service provider side.</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;dubbo&#34;</span> accepts=<span style="color:#2aa198">&#34;1000&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or configure in <code>dubbo.properties</code>：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.service.protocol=dubbo |
| </span></span></code></pre></div></description></item><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><item><title>Docs: Dubbo Admin Functions</title><link>https://dubbo.apache.org/en/docs/v2.7/admin/ops/functions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/admin/ops/functions/</guid><description> |
| <h2 id="page-search">Page search</h2> |
| <p>If you need to manage a Dubbo service, you need to search it first and open it&rsquo;s management page</p> |
| <p><img src="https://dubbo.apache.org/imgs/admin/dubbo-search.jpg" alt="/admin-guide/images/dubbo-search.png"></p> |
| <h2 id="service-provider-page">Service provider page</h2> |
| <p><img src="https://dubbo.apache.org/imgs/admin/dubbo-providers.jpg" alt="/admin-guide/images/dubbo-providers.png"></p> |
| <h2 id="service-consumer-page">Service consumer page</h2> |
| <p><img src="https://dubbo.apache.org/imgs/admin/dubbo-consumers.jpg" alt="/admin-guide/images/dubbo-consumers.png"></p> |
| <h2 id="add-route-rule-page">Add route rule page</h2> |
| <p><img src="https://dubbo.apache.org/imgs/admin/dubbo-add-route.jpg" alt="/admin-guide/images/dubbo-add-route.png"></p> |
| <h2 id="add-dynamic-configuration-page">Add dynamic configuration page</h2> |
| <p><img src="https://dubbo.apache.org/imgs/admin/dubbo-add-config.jpg" alt="/admin-guide/images/dubbo-add-config.png"></p></description></item><item><title>Docs3-V2: Group Aggregation</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/group-merger/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/group-merger/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Aggregate the results by grouping and return the aggregated results, such as menu service, use group to distinguish multiple implementations of the same interface, now the consumer needs to call once from each group and return the result, and return the result after merging, so You can implement aggregated menu items.</p> |
| <p>For relevant codes, please refer to <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-merge">Samples in the dubbo project</a></p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Service Grouping and Multiple Versions</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="search-all-groups">Search all groups</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:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span> merger=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="merge-specified-groups">Merge specified groups</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:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;aaa,bbb&#34;</span> merger=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="specify-method-merge">Specify method merge</h3> |
| <p>Combine the results of the specified method, and other unspecified methods will only call one Group</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#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;getMenuItems&#34;</span> merger=<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:reference&gt;</span> |
| </span></span></code></pre></div><h3 id="a-method-is-not-merged">A method is not merged</h3> |
| <p>One method does not combine results, others combine results</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.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span> merger=<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</span> name=<span style="color:#2aa198">&#34;getMenuItems&#34;</span> merger=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><h3 id="specify-merge-strategy">Specify merge strategy</h3> |
| <p>Specify the merge strategy, the default is to automatically match according to the return value type, if there are two combiners of the same type, you need to specify the name of the combiner [Merge result extension](../../../reference-manual/spi/ description/merger)</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.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#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;getMenuItems&#34;</span> merger=<span style="color:#2aa198">&#34;mymerge&#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><h3 id="specify-merge-method">Specify merge method</h3> |
| <p>Specify the merge method to merge the specified method that returns the result of the call. The parameter type of the merge method must be the return result type itself</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.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#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;getMenuItems&#34;</span> merger=<span style="color:#2aa198">&#34;.addAll&#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><h4 id="hint">hint:</h4> |
| <p>Supported since <code>2.1.0</code> version</p></description></item><item><title>Docs: How to become a Dubbo committer</title><link>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/become-a-committer_dev/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/become-a-committer_dev/</guid><description> |
| <p>Anyone can be a contributor to an Apache project. Being a contributor simply means that you take an interest in the project and contribute in some way, ranging from asking sensible questions (which documents the project and provides feedback to developers) through to providing new features as patches.</p> |
| <p>If you become a valuable contributor to the project you may well be invited to become a committer. Committer is a term used at the ASF to signify someone who is committed to a particular project. It brings with it the privilege of write access to the project repository and resources.</p> |
| <p>In Dubbo community, if a committer who have earned even more merit, can be invited to be a part of the Project Management Committee (PMC).</p> |
| <p>One thing that is sometimes hard to understand when you are new to the open development process used at the ASF, is that we value the community more than the code. A strong and healthy community will be respectful and be a fun and rewarding place. More importantly, a diverse and healthy community can continue to support the code over the longer term, even as individual companies come and go from the field.</p> |
| <p>More details could be found <a href="https://community.apache.org/contributors/">here</a>.</p> |
| <h3 id="what-can-i-contribute">What can I contribute?</h3> |
| <p>Please refer to the <a href="https://dubbo.apache.org/en/docs/contribution-guidelines/contributor/new-contributor-guide_dev">new contributor guide</a>.</p></description></item><item><title>Docs3-V2: Install Dubbo-go development environment</title><link>https://dubbo.apache.org/en/docs3-v2/golang-sdk/quickstart/install/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/golang-sdk/quickstart/install/</guid><description> |
| <h3 id="1-install-the-go-language-environment">1. Install the Go language environment</h3> |
| <p>It is recommended to use the latest version of go 1.17</p> |
| <p>go version &gt;= go 1.15</p> |
| <p><a href="https://golang.google.cn/">[Go language official website download address]</a></p> |
| <p>Add $GOPATH/bin to environment variable</p> |
| <h3 id="2-install-the-serialization-tool-protoc">2. Install the serialization tool protoc</h3> |
| <p><a href="https://github.com/protocolbuffers/protobuf/releases">[protoc download address]</a></p> |
| <h3 id="3-install-dubbogo-cli-and-related-plugins">3. Install dubbogo-cli and related plugins</h3> |
| <p>Execute the following command to install dubbogo-cli to $GOPATH/bin</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>$ <span style="color:#b58900">export</span> <span style="color:#268bd2">GOPROXY</span><span style="color:#719e07">=</span><span style="color:#2aa198">&#34;https://goproxy.cn&#34;</span> |
| </span></span><span style="display:flex;"><span>$ go install github.com/dubbogo/dubbogo-cli@latest |
| </span></span><span style="display:flex;"><span>$ dubbogo-cli |
| </span></span><span style="display:flex;"><span>hello |
| </span></span></code></pre></div><p>Install dependent tool plugins</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>$ dubbogo-cli install all |
| </span></span></code></pre></div><p>Make sure the tools installed above are located in the system environment variables</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>$ protoc --version |
| </span></span><span style="display:flex;"><span>libprotoc 3.14.0 |
| </span></span><span style="display:flex;"><span>$ protoc-gen-go --version |
| </span></span><span style="display:flex;"><span>protoc-gen-go v1.26.0 |
| </span></span><span style="display:flex;"><span>$ protoc-gen-go-triple --version |
| </span></span><span style="display:flex;"><span>protoc-gen-go-triple 1.0.8 |
| </span></span></code></pre></div></description></item><item><title>Latest: Introduction</title><link>https://dubbo.apache.org/en/latest/facade-docs/what/overview/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/latest/facade-docs/what/overview/</guid><description/></item><item><title>Overview: Introduction to Dubbo</title><link>https://dubbo.apache.org/en/overview/what/overview/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/overview/what/overview/</guid><description> |
| <p>Apache Dubbo is an RPC service development framework, which is used to solve service governance and communication problems under the microservice architecture. It officially provides multi-language SDK implementations such as Java and Golang. Microservices developed using Dubbo are natively capable of remote address discovery and communication with each other. |
| Using the rich service governance features provided by Dubbo, service governance demands such as service discovery, load balancing, and traffic scheduling can be realized. Dubbo is designed to be highly scalable, and users can easily implement various custom logics for traffic interception and location selection.</p> |
| <p>Dubbo3 is defined as a cloud-native-oriented next-generation RPC service framework. 3.0 has evolved based on Dubbo 2.x. While maintaining the original core features, Dubbo3 has improved in ease of use, ultra-large-scale microservice practice, cloud-native infrastructure adaptation, and security. Comprehensive upgrades have been made in several major directions, including ease of use, hyperscale microservice practices, cloud-native infrastructure adaptation, and security.</p> |
| <h3 id="what-is-dubbo">What is Dubbo</h3> |
| <p>Apache Dubbo was originally donated by Alibaba as an open source in 2008, and soon became the de facto standard framework for the selection of open source service frameworks in China, and has been widely used in various industries. In 2017, Dubbo officially donated to the Apache Software Foundation and became a top-level project of Apache. Currently, Dubbo3 is already a one-stop microservice solution providing:</p> |
| <ul> |
| <li>HTTP/2-based <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/concepts-and-architecture/triple/">Triple protocol</a> and programming experience for proxy API.</li> |
| <li>Powerful [traffic management capability] (../../tasks/traffic-management), such as address discovery, load balancing, routing address selection, dynamic configuration, etc.</li> |
| <li><a href="../../mannual/">Multi-language SDK implementation</a>, covering Java, Golang, Javascript, etc. More language implementations will be released in succession.</li> |
| <li>Flexible adaptation and expansion capabilities, which can be easily adapted to other components of the microservice system such as Tracing and Transaction.</li> |
| <li><a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/concepts-and-architecture/mesh/">Dubbo Mesh Solution</a>, while supporting flexible Mesh deployment solutions such as Sidecar and Proxyless.</li> |
| </ul> |
| <p>The overall architecture of Apache Dubbo can well meet the large-scale microservice practice of enterprises, because it is designed to solve the practical problems of ultra-large-scale microservice clusters from the beginning, whether it is Alibaba, ICBC, China Ping An, Ctrip and other community users, They have fully verified the stability and performance of Dubbo through years of large-scale production environment traffic. Therefore, Dubbo has unparalleled advantages in solving business landing and large-scale practice:</p> |
| <ul> |
| <li>out of the box |
| <ul> |
| <li>High ease of use, such as the interface-oriented proxy feature of the Java version can realize local transparent calls</li> |
| <li>Rich in functions, most of the microservice governance capabilities can be realized based on native libraries or lightweight extensions</li> |
| </ul> |
| </li> |
| <li>Designed for ultra-large-scale microservice clusters |
| <ul> |
| <li>Extreme performance, high-performance RPC communication protocol design and implementation</li> |
| <li>Horizontally scalable, easily supporting address discovery and traffic management of millions of cluster instances</li> |
| </ul> |
| </li> |
| <li><a href="../extensibility">highly extensible</a> |
| <ul> |
| <li>Interception and extension of traffic and protocols during calling, such as Filter, Router, LB, etc.</li> |
| <li>Extension of microservice governance components, such as Registry, Config Center, Metadata Center, etc.</li> |
| </ul> |
| </li> |
| <li>Enterprise-level microservice governance capabilities |
| <ul> |
| <li>The de facto standard service framework supported by domestic public cloud vendors</li> |
| <li>Years of enterprise practical experience test</li> |
| </ul> |
| </li> |
| </ul> |
| <h3 id="dubbo-basic-workflow">Dubbo basic workflow</h3> |
| <p><img src="https://dubbo.apache.org/imgs/v3/concepts/rpc.png" alt="dubbo-rpc"></p> |
| <p>First of all, Dubbo is an RPC framework, which defines its own RPC communication protocol and programming method. As shown in the figure above, when using Dubbo, users first need to define the Dubbo service; secondly, after deploying the Dubbo service online, rely on Dubbo&rsquo;s application layer communication protocol to realize data exchange, and the data transmitted by Dubbo must be serialized. And here the serialization protocol is fully extensible. |
| The first step in using Dubbo is to define Dubbo services. The definition of services in Dubbo is a set of methods to complete business functions. You can choose to define them in a way that is bound to a certain language. For example, in Java, Dubbo services have a set of The Interface interface of the method can also use the language-neutral Protobuf Buffers <a href="../../tasks/triple/idl/">IDL definition service</a>. After the service is defined, the server (Provider) needs to provide a specific implementation of the service and declare it as a Dubbo service. From the perspective of the service consumer (Consumer), a service proxy can be obtained by calling the API provided by the Dubbo framework ( stub) object, and then you can call the service method like a local service. |
| After the consumer initiates a call to the service method, the Dubbo framework is responsible for sending the request to the service provider deployed on the remote machine. After receiving the request, the provider will call the implementation class of the service, and then return the processing result to the consumer. This completes a complete service call. The data flow of Request and Response in the figure is shown.</p> |
| <blockquote> |
| <p>It should be noted that in Dubbo, when we refer to services, we usually refer to RPC-grained interfaces or methods that provide the function of adding, deleting, and modifying a specific business, which is not the same as the services generally referred to in some microservice concept books concept.</p> |
| </blockquote> |
| <p>In a distributed system, especially with the development of the microservice architecture, the deployment, release, and scaling of applications become extremely frequent. As an RPC consumer, how to dynamically discover the address of the service provider becomes a precondition for RPC communication . Dubbo provides an automatic address discovery mechanism to deal with the dynamic migration of machine instances in distributed scenarios. As shown in the figure below, the address of the provider and the consumer is coordinated by introducing the registration center. After the provider starts, it registers its own address with the registration center, and the consumer dynamically perceives the address list of the provider by pulling or subscribing to a specific node in the registration center. Variety.</p> |
| <p><img src="https://dubbo.apache.org/imgs/architecture.png" alt="arch-service-discovery"></p> |
| <h3 id="dubbo-core-features">Dubbo core features</h3> |
| <h4 id="high-performance-rpc-communication-protocol">High performance RPC communication protocol</h4> |
| <p>Service communication across processes or hosts is a basic capability of Dubbo. Dubbo RPC sends the request data (Request) to the backend service in a predefined protocol encoding method, and receives the calculation result (Response) returned by the server. RPC communication is completely transparent to the user, and the user does not need to care about how and where the request is sent, and only needs to get the correct call result for each call. In addition to the Request-Response communication model in synchronous mode, Dubbo3 also provides a richer selection of communication models:</p> |
| <ul> |
| <li>Consumer side asynchronous request (Client Side Asynchronous Request-Response)</li> |
| <li>Provider side asynchronous execution (Server Side Asynchronous Request-Response)</li> |
| <li>Consumer request stream (Request Streaming)</li> |
| <li>Provider response stream (Response Streaming)</li> |
| <li>Bidirectional Streaming</li> |
| </ul> |
| <p>For details, please refer to the list of optional protocols implemented by each language SDK or <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/concepts-and-architecture/triple/">Triple Protocol</a></p> |
| <h4 id="automatic-service-address-discovery">Automatic service (address) discovery</h4> |
| <p>Dubbo&rsquo;s service discovery mechanism allows microservice components to evolve independently and be deployed arbitrarily, and the consumer can complete communication without knowing the deployment location and IP address of the peer. Dubbo provides a Client-Based service discovery mechanism, and users can enable service discovery in various ways:</p> |
| <ul> |
| <li>Use independent registry components, such as <a href="https://nacos.io/">Nacos</a>, Zookeeper, Consul, Etcd, etc.</li> |
| <li>Leave the organization and registration of services to the underlying container platform, such as Kubernetes, which is understood to be a more cloud-native usage</li> |
| </ul> |
| <h4 id="run-state-traffic-control">Run state traffic control</h4> |
| <p>Transparent address discovery allows Dubbo requests to be sent to any IP instance, and traffic is randomly allocated during this process. When richer and finer-grained control of traffic is required, Dubbo&rsquo;s traffic control strategy can be used. Dubbo provides strategies including load balancing, traffic routing, request timeout, traffic degradation, retry, etc., based on these basic capabilities You can easily implement more scenario-based routing solutions, including canary release, A/B testing, weight routing, same-region priority, etc. What&rsquo;s even cooler is that Dubbo supports traffic control policies to take effect dynamically in the running state without redeployment . For details, please refer to:</p> |
| <ul> |
| <li><a href="../../tasks/traffic-management">Traffic management example</a></li> |
| </ul> |
| <h4 id="rich-extension-components-and-ecology">Rich extension components and ecology</h4> |
| <p>Dubbo&rsquo;s powerful service governance capabilities are not only reflected in the core framework, but also include its excellent expansion capabilities and the support of surrounding supporting facilities. Through the definition of extension points that exist in almost every key process, such as Filter, Router, and Protocol, we can enrich Dubbo&rsquo;s functions or realize the connection with other microservice supporting systems, including Transaction and Tracing. Currently, there are implementations that extend through SPI For details, please refer to the details of Dubbo extensibility, and you can also find more extension implementations in the <a href="https://github.com/apache/dubbo-spi-extensions">apache/dubbo-spi-extensions</a> project. For details, please refer to:</p> |
| <ul> |
| <li><a href="../../what/ecosystem">Dubbo Ecosystem</a></li> |
| <li><a href="../../what/extensibility">Dubbo Extensibility Design</a></li> |
| </ul> |
| <h4 id="cloud-native-design">Cloud Native Design</h4> |
| <p>Dubbo is designed to fully follow the development concept of cloud-native microservices, which is reflected in many aspects. First, it supports cloud-native infrastructure and deployment architecture, including containers, Kubernetes, etc. The overall solution of Dubbo Mesh is also in version 3.1 Official release; on the other hand, many core components of Dubbo have been upgraded for cloud native, including Triple protocol, unified routing rules, and support for multiple languages.</p> |
| <p>It is worth mentioning that how to use Dubbo to support elastic scaling services such as Serverless is also planned in the future, including using Native Image to improve Dubbo&rsquo;s startup speed and resource consumption.</p> |
| <p>Combined with the current version, this section mainly expands Dubbo&rsquo;s cloud-native features from the following two points</p> |
| <ul> |
| <li><a href="../../tasks/kubernetes/deploy-on-k8s">Container Scheduling Platform (Kubernetes)</a></li> |
| <li><a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/concepts-and-architecture/mesh/">Dubbo Mesh</a></li> |
| </ul> |
| <h5 id="kubernetes">Kubernetes</h5> |
| <p>For Dubbo microservices to support Kubernetes platform scheduling, the most basic thing is to realize the alignment of the dubbo service life cycle and the container life cycle, which includes life cycle events such as Dubbo startup, destruction, and service registration. Compared with the past where Dubbo defined life cycle events by itself and required developers to abide by the agreement during operation and maintenance practice, the underlying infrastructure of Kubernetes defines strict component life cycle events (probes), and instead requires Dubbo to adapt according to the agreement.</p> |
| <p>Kubernetes Service is another level of adaptation, which reflects the trend of service definition and registration sinking to the cloud-native underlying infrastructure. In this mode, users no longer need to build additional registry components, Dubbo consumer end nodes can automatically connect to Kubernetes (API-Server or DNS), and query the instance list (Kubernetes endpoints) according to the service name (Kubernetes Service Name) . At this point, the service is defined through the standard Kubernetes Service API and dispatched to each node.</p> |
| <h5 id="dubbo-mesh">Dubbo Mesh</h5> |
| <p>Service Mesh has been widely disseminated and recognized in the industry, and is considered to be the next-generation microservice architecture, mainly because it solves many difficult problems, including transparent upgrades, multilingualism, dependency conflicts, and traffic management. The typical architecture of Service Mesh is to intercept all egress and ingress traffic by deploying independent Sidecar components, and integrate rich traffic management strategies such as load balancing and routing in Sidecar. In addition, Service Mesh also requires a control plane (Control Panel) to realize the control of Sidecar traffic, that is, to issue various policies. We call this architecture here Classic Mesh.</p> |
| <p>However, no technical architecture is perfect, and classic Mesh also faces the problem of high cost at the implementation level</p> |
| <ol> |
| <li>Operation and maintenance control panel (Control Panel) is required</li> |
| <li>Need to operate and maintain Sidecar</li> |
| <li>Need to consider how to migrate from the original SDK to Sidecar</li> |
| <li>It is necessary to consider the performance loss of the entire link after introducing Sidecar</li> |
| </ol> |
| <p>In order to solve the related cost problems introduced by Sidecar, Dubbo introduced and implemented a new Proxyless Mesh architecture. As the name suggests, Proxyless Mesh refers to the deployment without Sidecar, and the Dubbo SDK directly interacts with the control plane. The architecture diagram is as follows</p> |
| <p><img src="https://dubbo.apache.org/imgs/v3/mesh/dubbo-proxyless.png" alt="dubbo-proxyless"></p> |
| <p>It can be imagined that in different organizations and different development stages, microservices built with Dubbo will allow three deployment architectures in the future: traditional SDK, Sidecar-based Service Mesh, and Proxyless Mesh without Sidecar. Based on Sidecar&rsquo;s Service Mesh, that is, the classic Mesh architecture, the independent sidecar runtime takes over all the traffic, separate from the Sidecar&rsquo;s Proxyless Mesh, and the secondary SDK directly communicates with the control plane through xDS. Dubbo microservices allow deployment on physical machines, containers, and Kubernetes platforms, and can use Admin as the control plane and manage them with unified traffic governance rules.</p></description></item><item><title>Docs3-V2: Introduction to Configuration Center</title><link>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/develop/config-center/desc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/golang-sdk/tutorial/develop/config-center/desc/</guid><description/></item><item><title>Overview: Java SDK</title><link>https://dubbo.apache.org/en/overview/mannual/java/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/overview/mannual/java/</guid><description/></item></channel></rss> |
