| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Dubbo Examples</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/</link><description>Recent content in Dubbo Examples on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs/v2.7/user/examples/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Preflight Check</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/preflight-check/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/preflight-check/</guid><description> |
| <p>By default dubbo will check if the dependent service is available at startup . It will throw an exception to prevent Spring complete initialization when it is not available, so that you can find the problems early before publishing you application, the default setting: <code>check=true</code>.</p> |
| <p>You can turn off checking by <code>check=false</code>. For example, some services do not care it when you run testing, or you must have one started firstly because of circular dependency.</p> |
| <p>In addition, if your Spring bean is lazy-loaded or you delay reference service with API programming, turn off the check, |
| otherwise the service will throw an exception when the service is temporarily unavailable ,then get a null reference. If you configure <code>check=false</code> ,you can get a reference . When the service is restored, the service can automatically reconnect.</p> |
| <h2 id="example">Example</h2> |
| <h3 id="use-the-spring-configuration-file">Use the spring configuration file</h3> |
| <p>Disable the startup check of a service (throw some exception/error when no provider is provided):</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>Disable startup checking for all services (throw some exception/error when not provided):</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>Disable the registration center startup check (registration subscription failed error):</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="use-dubboproperties">Use 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.reference.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="use-the--d-parameter">Use 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.reference.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="configuration-meaning">Configuration Meaning</h2> |
| <p><code>dubbo.reference.check=false</code>, Change the check value of all references forcibly, even if the configuration has a declaration, it also will be overwritten.</p> |
| <p><code>dubbo.consumer.check=false</code> The default value of <code>check</code>. It will not be affected if there is an explicit declaration in the configuration such as<code> </code>&lt;dubbo: reference check =&quot; true &ldquo;/&gt;`.</p> |
| <p><code>dubbo.registry.check=false</code>, The two configuration above is to express success of the subscription. If the subscription is also allowed to start when the registration fails for the provider list is empty, you need to use this configuration. The system will try again in the background regularly.</p></description></item><item><title>Docs: Fault Tolerance Strategy</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/fault-tolerent-strategy/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/fault-tolerent-strategy/</guid><description> |
| <p>Dubbo offers a variety of fault-tolerant scenarios when a cluster call fails, with a default failover retry.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/cluster.jpg" alt="cluster"></p> |
| <p>The relationship between nodes:</p> |
| <ul> |
| <li>This <code>Invoker</code> is the callable Service&rsquo;s abstract of the<code> Provider</code>, and the <code>Invoker</code> packaging the<code> Provider</code>&rsquo;s address and <code>Service</code>&rsquo;s interface.</li> |
| <li>The <code>Directory</code> represent multiple <code>Invoker</code>,You can think of it as <code>List&lt;Invoker&gt;</code>,But unlike <code>List</code>,its value can be dynamically changing.such as registry push changes</li> |
| <li>The <code>Cluster</code> disguises multiple<code> Invoker</code> in <code>Directory</code> as a<code> Invoker</code>,The upper transparent, masquerade process contains fault-tolerant logic, call failed, try another</li> |
| <li>The <code>Router</code> is responsible for selecting subsets according to routing rules from multiple <code>Invoker</code>s, such as read-write separation, application isolation, etc.</li> |
| <li><code>LoadBalance</code> is responsible for selecting a specific one from multiple<code> Invoker</code> for this call. The selection process includes the load balancing algorithm. If the call fails, it needs to be re-selected</li> |
| </ul> |
| <h2 id="cluster-fault-tolerant-mode">Cluster fault-tolerant mode</h2> |
| <p>You can also customize the cluster fault tolerance strategy, see <a href="../../../dev/impls/cluster">Cluster extension</a> for more details.</p> |
| <h2 id="failover-cluster">Failover Cluster</h2> |
| <p>Failure automatically switch, when there is failure, retry the other server (default). Usually used for read operations, but retries can result in longer delays. The times of retries can be set via <code>retries =2</code> (excluding the first time).</p> |
| <p>The times of retries is configured 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;dubbo:service</span> retries=<span style="color:#2aa198">&#34;2&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> retries=<span style="color:#2aa198">&#34;2&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;findFoo&#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><h3 id="failfast-cluster">Failfast Cluster</h3> |
| <p>Fast failure, only made a call, failure immediately error. Usually used for non-idempotent write operations, such as adding records</p> |
| <h3 id="failsafe-cluster">Failsafe Cluster</h3> |
| <p>Failure of security, anomalies, directly ignored. Usually used to write audit logs and other operations.</p> |
| <h3 id="failback-cluster">Failback Cluster</h3> |
| <p>Failure automatically restored, failed to record the background request, regular retransmission. Usually used for message notification operations.</p> |
| <h3 id="forking-cluster">Forking Cluster</h3> |
| <p>Multiple servers are invoked in parallel, returning as soon as one succeeds. Usually used for real-time demanding read operations, but need to waste more service resources. The maximum number of parallelism can be set with <code>forks=2</code>.</p> |
| <h3 id="broadcast-cluster">Broadcast Cluster</h3> |
| <p>Calling all providers broadcast, one by one call, any error is reported (<code>2.1.0+</code>). It is usually used to notify all providers to update local resource information such as caches or logs.</p> |
| <p>Now in the broadcast call, the proportion of node call failures can be configured through broadcast.fail.percent. When this proportion is reached, BroadcastClusterInvoker will no longer call other nodes and directly throw an exception. The value of broadcast.fail.percent is in the range of 0-100. By default, an exception will be thrown when all calls fail. |
| broadcast.fail.percent only controls whether to continue to call other nodes after failure, and does not change the result (any one will report an error). broadcast.fail.percent parameters |
| Effective in dubbo2.7.10 and above.</p> |
| <p>Broadcast Cluster configuration broadcast.fail.percent.</p> |
| <p>broadcast.fail.percent=20 means that when 20% of the nodes fail to call, an exception will be thrown and no other nodes will be called.</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>@reference(cluster = &#34;broadcast&#34;, parameters = {&#34;broadcast.fail.percent&#34;, &#34;20&#34;}) |
| </span></span></code></pre></div><h2 id="cluster-mode-configuration">Cluster mode configuration</h2> |
| <p>Follow the example below to configure cluster mode on service providers and consumers</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> cluster=<span style="color:#2aa198">&#34;failsafe&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> cluster=<span style="color:#2aa198">&#34;failsafe&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Load Balance</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/loadbalance/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/loadbalance/</guid><description> |
| <p>Dubbo offers a number of balancing strategies for cluster load balancing, which defaults to <code>random</code>.</p> |
| <p>You can extend the load balancing strategy by yourself, see: <a href="../../../dev/impls/load-balance">LoadBalance extension</a></p> |
| <h2 id="loadbalance-strategy">LoadBalance strategy</h2> |
| <h3 id="random-loadbalance">Random LoadBalance</h3> |
| <ul> |
| <li><strong>Ramdom</strong>, set random probabilities by weight.</li> |
| <li>The probability of collisions on one section is high, but the larger the amount of calls, the more uniform the distribution. And when use weight based on probability the distribution turns out to be uniform, which also helps to dynamically adjust the provider weights.</li> |
| </ul> |
| <h3 id="roundrobin-loadbalance">RoundRobin LoadBalance</h3> |
| <ul> |
| <li><strong>RoundRobin</strong>, use the weight&rsquo;s common advisor to determine round robin ratio.</li> |
| <li>Traffic flow to slower providers may cause requests piled up, e.g., if there&rsquo;s a provider processing requests in a very slow speed, but it&rsquo;s still alive, which means it can receive request as normal. According to RoundRobin policy, consumers will continuously send requests to this provider on predetermined pace, have no aware of the provider&rsquo;s bad status. Finally, we will get many requests stuck on this unhealthy provider.</li> |
| </ul> |
| <h3 id="leastactive-loadbalance">LeastActive LoadBalance</h3> |
| <ul> |
| <li><strong>LeastActive</strong>, a random mechanism based on actives, <code>actives</code> means the num of requests a consumer have sent but not return yet。</li> |
| <li>Slower providers will receive fewer requests, cause slower provider have higher <code>actives</code>.</li> |
| </ul> |
| <h3 id="consistenthash-loadbalance">ConsistentHash LoadBalance</h3> |
| <ul> |
| <li><strong>ConsistentHash</strong>, the same parameters of the request is always sent to the same provider.</li> |
| <li>When a provider fails, the original request to the provider, based on the virtual node algorithm, averages to other providers, does not cause drastic changes.</li> |
| <li>Algorithm reference：http://en.wikipedia.org/wiki/Consistent_hashing</li> |
| <li>By default only the first parameter Hash, if you want to modify, please configure <code>&lt;dubbo:parameter key=&quot;hash.arguments&quot; value=&quot;0,1&quot; /&gt;</code></li> |
| <li>By default 160 virtual nodes, if you want to modify, please configure <code>&lt;dubbo:parameter key=&quot;hash.nodes&quot; value=&quot;320&quot; /&gt;</code></li> |
| </ul> |
| <p>See the algorithm at <a href="http://en.wikipedia.org/wiki/Consistent_hashing">http://en.wikipedia.org/wiki/Consistent_hashing</a></p> |
| <h2 id="configuration">Configuration</h2> |
| <h3 id="server-service-level">Server service level</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:service</span> interface=<span style="color:#2aa198">&#34;...&#34;</span> loadbalance=<span style="color:#2aa198">&#34;roundrobin&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="client-service-level">Client service level</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;...&#34;</span> loadbalance=<span style="color:#2aa198">&#34;roundrobin&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="server-method-level">Server method level</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:service</span> interface=<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;...&#34;</span> loadbalance=<span style="color:#2aa198">&#34;roundrobin&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:service&gt;</span> |
| </span></span></code></pre></div><h3 id="client-method-level">Client method level</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;...&#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;...&#34;</span> loadbalance=<span style="color:#2aa198">&#34;roundrobin&#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: Thread Model</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/thread-model/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/thread-model/</guid><description> |
| <h2 id="thread-model">Thread Model</h2> |
| <ul> |
| <li>If events handing can be executed quickly without sending new request like marking in memory. Events should be handled by I/O thread since it reduces thread dispatching.</li> |
| <li>If event handling will be executed slowly or needs to send new I/O request like querying from database, events should be handled in thread pool. Otherwise, I/O thread will be blocked and then will be not able to receive requests.</li> |
| <li>If events are handled by I/O thread, and send new I/O requests during the handling like sending a l login request during connect event, it will alert with “Potentially leading to deadlock”, but deadlock will not happen actually.</li> |
| </ul> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-protocol.jpg" alt="dubbo-protocol"></p> |
| <p>Thus, we need different dispatch strategies and different thread pool configurations to face difference scenarios.</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> dispatcher=<span style="color:#2aa198">&#34;all&#34;</span> threadpool=<span style="color:#2aa198">&#34;fixed&#34;</span> threads=<span style="color:#2aa198">&#34;100&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="dispatcher">Dispatcher</h2> |
| <ul> |
| <li>all: All messages will be dispatched to thread pool, including request, response, connect event, disconnect event and heartbeat.</li> |
| <li>direct: All messages will not be dispatched to thread pool and will be executed directly by I/O thread.</li> |
| <li>message: Only request, response messages will be dispatched to I/O thread. Other messages like disconnect, connect, heartbeat messages will be executed by I/O thread.</li> |
| <li>execution: Only request message will be dispatched to thread pool. Other messages like response, connect, disconnect, heartbeat will be directly executed by I/O thread.</li> |
| <li>connection: I/O thread will put disconnect and connect events in the queue and execute them sequentially, other messages will be dispatched to the thread pool.</li> |
| </ul> |
| <h2 id="thread-pool">Thread pool</h2> |
| <ul> |
| <li>fixed: A fixed size of thread pool. It creates threads when starts, never shut down.（default).</li> |
| <li>cached: A cached thread pool. Automatically delete the thread when it’s in idle for one minute. Recreate when needed.</li> |
| <li>limit: elastic thread pool. But it can only increase the size of the thread pool. The reason is to avoid performance issue caused by traffic spike when decrease the size of the thread pool.</li> |
| </ul></description></item><item><title>Docs: Explicit Target</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/explicit-target/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/explicit-target/</guid><description> |
| <p>In the development and testing environment, it is often necessary to bypass the registry and test only designated service providers. In this case, point-to-point direct connection may be required, and the service provider will ignore the list of provider registration providers. The interface A configure Point-to-point, does not affect the B interface to obtain a list from the registry.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-directly.jpg" alt="/user-guide/images/dubbo-directly.jpg"></p> |
| <h2 id="configure-with-xml">Configure with XML</h2> |
| <p>If it is online demand needs the point-to-point feature,You can configure the specified provider url at <code>&lt;dubbo:reference&gt;</code>.it will bypass the registry, multiple addresses separated by semicolons, the following configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;xxxService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.xxx.XxxService&#34;</span> url=<span style="color:#2aa198">&#34;dubbo://localhost:20890&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="configure-with-the--d-argument">Configure with the <code>-D</code> argument</h2> |
| <p>Add the -D parameter mapping service address to 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 -Dcom.alibaba.xxx.XxxService<span style="color:#719e07">=</span>dubbo://localhost:20890 |
| </span></span></code></pre></div><h2 id="configure-with-the-properties-file">Configure with the <code>.properties</code> file</h2> |
| <p>If you have more services, you can also use file mapping to specify the mapping file path with <code>-Ddubbo.resolve.file</code>. This configuration takes precedence over the configuration in<code>&lt;dubbo: reference&gt;</code>, 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-sh" data-lang="sh"><span style="display:flex;"><span>java -Ddubbo.resolve.file<span style="color:#719e07">=</span>xxx.properties |
| </span></span></code></pre></div><p>Then add the configuration in the mapping file <code>xxx.properties</code>, where key is the service name and value is the service provider URL:</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>com.alibaba.xxx.XxxService<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo://localhost:20890</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| To avoid complicating the online environment, do not use this feature online and should only be used during the testing phase |
| </div></description></item><item><title>Docs: Subscribe Only</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/subscribe-only/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/subscribe-only/</guid><description> |
| <p>To facilitate the development of tests, it is common to have a registry of all services available in develop environment.And the registration of a service provider under development may affect consumers&rsquo; inability to run.</p> |
| <p>You can let service provider developers only subscribe to services only (services developed may rely on other services) ,don&rsquo;t register services under development and testing services under development with directly connection.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/subscribe-only.jpg" alt="/user-guide/images/subscribe-only.jpg"></p> |
| <p>User configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;10.20.153.10:9090&#34;</span> register=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;10.20.153.10:9090?register=false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Multiple Protocols</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/multi-protocols/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/multi-protocols/</guid><description> |
| <p>Dubbo allows you to configure multiple protocols, support different protocols on different services, or support multiple protocols on the same service.</p> |
| <h2 id="every-service-export-to-one-specific-protocol-separately">Every service export to one specific protocol separately</h2> |
| <p>Different protocol performance is not the same. Such as big data should use short connection protocol, small data and concurrent should use long connection 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:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;world&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;registry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090&#34;</span> username=<span style="color:#2aa198">&#34;admin&#34;</span> password=<span style="color:#2aa198">&#34;hello1234&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- multiple protocols --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;rmi&#34;</span> port=<span style="color:#2aa198">&#34;1099&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Use dubbo protocol to expose the service --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> ref=<span style="color:#2aa198">&#34;helloService&#34;</span> protocol=<span style="color:#2aa198">&#34;dubbo&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Use rmi protocol to expose services --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.DemoService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span> protocol=<span style="color:#2aa198">&#34;rmi&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h2 id="one-service-export-to-several-protocols">One service export to several protocols</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;world&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;registry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090&#34;</span> username=<span style="color:#2aa198">&#34;admin&#34;</span> password=<span style="color:#2aa198">&#34;hello1234&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- multiple protocols--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;hessian&#34;</span> port=<span style="color:#2aa198">&#34;8080&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Service exposes multiple protocols --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> id=<span style="color:#2aa198">&#34;helloService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> protocol=<span style="color:#2aa198">&#34;dubbo,hessian&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Multiple Registries</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/multi-registry/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/multi-registry/</guid><description> |
| <p>Dubbo supports the same service to register multiple registries, or different services were registered to different registries, or even reference the same name service from different registries. In addition, the registry supports custom extensions <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>。</p> |
| <h2 id="one-service-register-to-multiple-registries">One service register to multiple registries</h2> |
| <p>For example: Alibaba some services are not deployed in Qingdao, only deployed in Hangzhou. While other applications in Qingdao need to reference this service, you can register your services to both registries at the same time.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;world&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Multi registries --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;hangzhouRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;qingdaoRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.151:9010&#34;</span> default=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Service register to multiple registries --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> ref=<span style="color:#2aa198">&#34;helloService&#34;</span> registry=<span style="color:#2aa198">&#34;hangzhouRegistry,qingdaoRegistry&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h2 id="different-services-register-to-different-registries">Different services register to different registries</h2> |
| <p>For example: Some CRM services are specifically designed for international stations, and some services are specifically designed for Chinese stations.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;world&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Multi registries --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;chinaRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;intlRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.154.177:9010&#34;</span> default=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Service register to Chinese station registry --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> ref=<span style="color:#2aa198">&#34;helloService&#34;</span> registry=<span style="color:#2aa198">&#34;chinaRegistry&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Service register to international station registry --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.DemoService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span> registry=<span style="color:#2aa198">&#34;intlRegistry&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h2 id="reference-services-from-multiple-registries">Reference services from multiple registries</h2> |
| <p>For example: CRM needs to call the PC2 service of Chinese station and international station at the same time. PC2 is deployed in both Chinese station and international station. The interfaces and version numbers are the same, but the database used is different.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;world&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Multi registries --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;chinaRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;intlRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.154.177:9010&#34;</span> default=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Reference Chinese station service --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;chinaHelloService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> registry=<span style="color:#2aa198">&#34;chinaRegistry&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Reference international station service --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;intlHelloService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> registry=<span style="color:#2aa198">&#34;intlRegistry&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><p>When testing, the service needs to be temporarily register to two registries, which can use vertical signs to separate multiple different registry addresses:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;world&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- The vertical separation means that multiple registries are connected at the same time. Multiple cluster addresses of the same registry are separated by commas --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090|10.20.154.177:9010&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- service reference --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;helloService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.hello.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>custom registry, see：<a href="https://dubbo.apache.org/en/docs/v2.7/dev/impls/registry/">registry extension</a>&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Service Group</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/service-group/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/service-group/</guid><description> |
| <p>When you have multi-impls of a interface,you can distinguish them with the group.</p> |
| <h2 id="service">Service</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> group=<span style="color:#2aa198">&#34;feedback&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.IndexService&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> group=<span style="color:#2aa198">&#34;member&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.IndexService&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="reference">Reference</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;feedbackIndexService&#34;</span> group=<span style="color:#2aa198">&#34;feedback&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.IndexService&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;memberIndexService&#34;</span> group=<span style="color:#2aa198">&#34;member&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.IndewxService&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Any 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> id=<span style="color:#2aa198">&#34;barService&#34;</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Warning</h4> |
| <code>group=&quot;*&quot;</code> is supported after version <code>2.2.0</code>, always select only one available group of implementations to invoke. |
| </div></description></item><item><title>Docs: Static Service</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/static-service/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/static-service/</guid><description> |
| <p>Sometimes we want to manually manage the registration and deregistration for service provider, we need to set registry to non-dynamoic 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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090&#34;</span> dynamic=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090?dynamic=false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>dynamic mode is disabled when service provider initially registers, then we need to enable it manually. When disconnects, the setting will not be deleted automatically, need to disable it manually.</p> |
| <p>For a third party service provider like “memcachd”, it can directly write the address information of service provider to registry, which can be used by consumer.</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>RegistryFactory registryFactory <span style="color:#719e07">=</span> ExtensionLoader<span style="color:#719e07">.</span>getExtensionLoader<span style="color:#719e07">(</span>RegistryFactory<span style="color:#719e07">.</span>class<span style="color:#719e07">).</span>getAdaptiveExtension<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>Registry registry <span style="color:#719e07">=</span> registryFactory<span style="color:#719e07">.</span>getRegistry<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://10.20.153.10:2181&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>register<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;memcached://10.20.153.11/com.foo.BarService?category=providers&amp;dynamic=false&amp;application=foo&#34;</span><span style="color:#719e07">));</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Multiple Versions</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/multi-versions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/multi-versions/</guid><description> |
| <p>When an interface to achieve an incompatible upgrade, you can use the version number transition. Different versions of the services do not reference each other.</p> |
| <p>You can follow the steps below for version migration:</p> |
| <ol start="0"> |
| <li>In the low pressure period, upgrade to half of the provider to the new version</li> |
| <li>Then upgrade all consumers to the new version</li> |
| <li>Then upgrade the remaining half providers to the new version</li> |
| </ol> |
| <p>Old version of the service provider configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>New version of the service provider configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> version=<span style="color:#2aa198">&#34;2.0.0&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Old version of the service consumer configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;barService&#34;</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>New version of the service consumer configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;barService&#34;</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> version=<span style="color:#2aa198">&#34;2.0.0&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>If you do not need to distinguish between versions, can be configured 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;dubbo:reference</span> id=<span style="color:#2aa198">&#34;barService&#34;</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> version=<span style="color:#2aa198">&#34;*&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| <code>version=&quot;*&quot;</code> is supported in <code>2.2.0</code> or above. |
| </div></description></item><item><title>Docs: Group Merger</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/group-merger/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/group-merger/</guid><description> |
| <p>According to the group to invoke server and return the merge result <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>, such as the menu service, the same interface, but there are a variety of implementations, using group distinction, consumers call each group and get the results, the merger can merge the resules, so that you can achieve aggregation Menu Item.</p> |
| <p>Related code can refer to <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-merge">dubbo project example</a></p> |
| <h2 id="configuration">Configuration</h2> |
| <p>Merge all groups</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></code></pre></div><p>Merge the specified 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;aaa,bbb&#34;</span> merger=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>The specified method to merge the results, 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><p>The Specified a method does not merge the results, others merge the 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><p>Specify the merge strategy, the default according to the type of return value automatically match, if the same type has two mergers, you need to specify the name of the merger<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</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-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><p>Specify the merge method, it will call the return type&rsquo;s method for merging, the merging method parameter type must be the return type</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><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>since <code>2.1.0</code> began to support&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>See also：<a href="../group-merger">merger extensions</a>&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Parameter Validation</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/parameter-validation/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/parameter-validation/</guid><description> |
| <p>The parameter validation <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> is based on [JSR303] (<a href="https://jcp.org/en/jsr/detail?id=303)">https://jcp.org/en/jsr/detail?id=303)</a>. The user simply add the validation annotation of the JSR303 and declares the filter for validation <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup>.</p> |
| <h2 id="maven-dependency">Maven Dependency</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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>javax.validation<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>validation-api<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>1.0.0.GA<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 style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.hibernate<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>hibernate-validator<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>4.2.0.Final<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><h2 id="sample">Sample</h2> |
| <h3 id="example-of-parameter-annotation">Example of Parameter Annotation</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> java.io.Serializable<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.Date<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.Future<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.Max<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.Min<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.NotNull<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.Past<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.Pattern<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.Size<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ValidationParameter</span> <span style="color:#268bd2">implements</span> Serializable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">static</span> <span style="color:#268bd2">final</span> <span style="color:#dc322f">long</span> serialVersionUID <span style="color:#719e07">=</span> 7158911668568000392L<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@NotNull</span> <span style="color:#586e75">// Required |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@Size</span><span style="color:#719e07">(</span>min <span style="color:#719e07">=</span> 1<span style="color:#719e07">,</span> max <span style="color:#719e07">=</span> 20<span style="color:#719e07">)</span> <span style="color:#586e75">// range |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">private</span> String name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@NotNull</span><span style="color:#719e07">(</span>groups <span style="color:#719e07">=</span> ValidationService<span style="color:#719e07">.</span>Save<span style="color:#719e07">.</span>class<span style="color:#719e07">)</span> <span style="color:#586e75">// It is not allowed to be blank when saving. When it is updated, it is allowed to be blank, indicating that the field is not updated |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@Pattern</span><span style="color:#719e07">(</span>regexp <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;^\\s*\\w+(?:\\.{0,1}[\\w-]+)*@[a-zA-Z0-9]+(?:[-.][a-zA-Z0-9]+)*\\.[a-zA-Z]+\\s*$&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String email<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Min</span><span style="color:#719e07">(</span>18<span style="color:#719e07">)</span> <span style="color:#586e75">// min value |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@Max</span><span style="color:#719e07">(</span>100<span style="color:#719e07">)</span> <span style="color:#586e75">// max value |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">int</span> age<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Past</span> <span style="color:#586e75">// Must be a past time |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">private</span> Date loginDate<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Future</span> <span style="color:#586e75">// Must be a future time |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">private</span> Date expiryDate<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">getName</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setName</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>name <span style="color:#719e07">=</span> name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">getEmail</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> email<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setEmail</span><span style="color:#719e07">(</span>String email<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>email <span style="color:#719e07">=</span> email<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">int</span> <span style="color:#268bd2">getAge</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> age<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setAge</span><span style="color:#719e07">(</span><span style="color:#dc322f">int</span> age<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>age <span style="color:#719e07">=</span> age<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Date <span style="color:#268bd2">getLoginDate</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> loginDate<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setLoginDate</span><span style="color:#719e07">(</span>Date loginDate<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>loginDate <span style="color:#719e07">=</span> loginDate<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Date <span style="color:#268bd2">getExpiryDate</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> expiryDate<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setExpiryDate</span><span style="color:#719e07">(</span>Date expiryDate<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>expiryDate <span style="color:#719e07">=</span> expiryDate<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="example-of-group-validation">Example of group validation</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">ValidationService</span> <span style="color:#719e07">{</span> <span style="color:#586e75">// By default, service interfaces are used to differentiate authentication scenarios. For example：@NotNull(groups = ValidationService.class) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@interface</span> Save<span style="color:#719e07">{}</span> <span style="color:#586e75">// The same name as the method interface, the first letter capitalized, used to distinguish between authentication scene. For example：@NotNull(groups = ValidationService.Save.class)，option |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">save</span><span style="color:#719e07">(</span>ValidationParameter parameter<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">update</span><span style="color:#719e07">(</span>ValidationParameter parameter<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="example-of-cascading-validation">Example of Cascading Validation</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.GroupSequence<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">ValidationService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@GroupSequence</span><span style="color:#719e07">(</span>Update<span style="color:#719e07">.</span>class<span style="color:#719e07">)</span> <span style="color:#586e75">// validate the Update group rules at the same time |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@interface</span> Save<span style="color:#719e07">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">save</span><span style="color:#719e07">(</span>ValidationParameter parameter<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@interface</span> Update<span style="color:#719e07">{}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">update</span><span style="color:#719e07">(</span>ValidationParameter parameter<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="example-of-parameter-validation">Example of parameter validation</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.Min<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.constraints.NotNull<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">ValidationService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">save</span><span style="color:#719e07">(</span><span style="color:#268bd2">@NotNull</span> ValidationParameter parameter<span style="color:#719e07">);</span> <span style="color:#586e75">// Param must not be null |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">delete</span><span style="color:#719e07">(</span><span style="color:#268bd2">@Min</span><span style="color:#719e07">(</span>1<span style="color:#719e07">)</span> <span style="color:#dc322f">int</span> id<span style="color:#719e07">);</span> <span style="color:#586e75">// validate the range |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="configuration">Configuration</h2> |
| <h3 id="validate-parameter-on-the-client">Validate Parameter on the client</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> id=<span style="color:#2aa198">&#34;validationService&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.examples.validation.api.ValidationService&#34;</span> validation=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="validate-parameter-on-the-server">Validate Parameter on the server</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:service</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.examples.validation.api.ValidationService&#34;</span> ref=<span style="color:#2aa198">&#34;validationService&#34;</span> validation=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="validate-exception">Validate Exception</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.ConstraintViolationException<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.validation.ConstraintViolationException<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.context.support.ClassPathXmlApplicationContext<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.examples.validation.api.ValidationParameter<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.examples.validation.api.ValidationService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ValidationConsumer</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> Exception <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> String config <span style="color:#719e07">=</span> ValidationConsumer<span style="color:#719e07">.</span>class<span style="color:#719e07">.</span>getPackage<span style="color:#719e07">().</span>getName<span style="color:#719e07">().</span>replace<span style="color:#719e07">(</span><span style="color:#2aa198">&#39;.&#39;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#39;/&#39;</span><span style="color:#719e07">)</span> <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;/validation-consumer.xml&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext<span style="color:#719e07">(</span>config<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> context<span style="color:#719e07">.</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> ValidationService validationService <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>ValidationService<span style="color:#719e07">)</span>context<span style="color:#719e07">.</span>getBean<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;validationService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Error |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> parameter <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ValidationParameter<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> validationService<span style="color:#719e07">.</span>save<span style="color:#719e07">(</span>parameter<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Validation ERROR&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>RpcException e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> <span style="color:#586e75">// throw RpcException |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ConstraintViolationException ve <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>ConstraintViolationException<span style="color:#719e07">)</span> e<span style="color:#719e07">.</span>getCause<span style="color:#719e07">();</span> <span style="color:#586e75">// Inside a ConstraintViolationException |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> Set<span style="color:#719e07">&lt;</span>ConstraintViolation<span style="color:#719e07">&lt;?&gt;&gt;</span> violations <span style="color:#719e07">=</span> ve<span style="color:#719e07">.</span>getConstraintViolations<span style="color:#719e07">();</span> <span style="color:#586e75">// You can get the collection of validation error details |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span>violations<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Support since <code>2.1.0</code> version. If you want to know how to use it, refer to [Sample code in dubbo project] (<a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-validation">https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-validation</a>)&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>The validation method is extensible, refer to <a href="https://dubbo.apache.org/en/docs/v2.7/dev/impls/validation">Developer Extension</a> in the developer&rsquo;s manual.&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Cache Result</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/result-cache/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/result-cache/</guid><description> |
| <p>Cache result is used to speed up access to popular data. Dubbo provides declarative caching to reduce the user work of adding cache <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>.</p> |
| <h2 id="cache-type">Cache Type</h2> |
| <ul> |
| <li><code>lru</code> Delete excess cache Based on the principle of least recently used. The hottest data is cached.</li> |
| <li><code>threadlocal</code> The current thread cache. For example, a page have a lot of portal and each portal need to check user information, you can reduce this redundant visit with this cache.</li> |
| <li><code>jcache</code> integrate with <a href="http://jcp.org/en/jsr/detail?id=107%27">JSR107</a> , you can bridge a variety of cache implementation.</li> |
| </ul> |
| <p>Caching type can be extended，refer to：<a href="https://dubbo.apache.org/en/docs/v2.7/dev/impls/cache">Cache extension</a></p> |
| <h2 id="configuration">Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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> cache=<span style="color:#2aa198">&#34;lru&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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><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;findBar&#34;</span> cache=<span style="color:#2aa198">&#34;lru&#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> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| supported in <code>2.1.0</code> or above. |
| </div> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p><a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-cache">examples</a>&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Collect Broadcast Responses</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/broadcast-resp-collect/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/broadcast-resp-collect/</guid><description> |
| <p>Applicable scenario: for any Dubbo consumer, broadcast calls multiple service providers. The consumer is able to collect responses from all of the providers.</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| support on <code>2.7.12</code> or above. |
| </div> |
| <h2 id="demo">Demo</h2> |
| <ul> |
| <li>consumer demo</li> |
| </ul> |
| <p>@Reference imports providers. Within the brackets, letting cluster = &ldquo;broadcast2&rdquo; represents doing one broadcast call that collects providers&rsquo; responses.</p> |
| <p>Broadcast calls all service providers one by one. Is able to return all service providers’ execution outcomes (success or exceptions) completely and stores |
| providers&rsquo; responses in RpcContext.</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">@RestController</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">TestServiceConsumer</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Reference</span><span style="color:#719e07">(</span>interfaceClass <span style="color:#719e07">=</span> DubboHealthService<span style="color:#719e07">.</span>class<span style="color:#719e07">,</span>cluster <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;broadcast2&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> DubboHealthService dubboHealthService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@GetMapping</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;/health&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">broadCast</span><span style="color:#719e07">(){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span><span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> dubboHealthService<span style="color:#719e07">.</span>health<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span><span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Exception e<span style="color:#719e07">){</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> String<span style="color:#719e07">&gt;</span> m <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getServerContext<span style="color:#719e07">().</span>getAttachments<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> m<span style="color:#719e07">.</span>toString<span style="color:#719e07">()+</span><span style="color:#2aa198">&#34;|&#34;</span><span style="color:#719e07">+</span><span style="color:#2aa198">&#34;fail&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> String<span style="color:#719e07">&gt;</span> m <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getServerContext<span style="color:#719e07">().</span>getAttachments<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> m<span style="color:#719e07">.</span>toString<span style="color:#719e07">()+</span><span style="color:#2aa198">&#34;|&#34;</span><span style="color:#719e07">+</span><span style="color:#2aa198">&#34;success&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li>provider demo</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Service</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DubboHealthServiceImpl</span> <span style="color:#268bd2">implements</span> DubboHealthService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">health</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// int i = 1/0; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;i am provider2&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li>execution outcome</li> |
| </ul> |
| <p>All providers succeed:</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>&gt;curl http://localhost:8081/health |
| </span></span><span style="display:flex;"><span>&gt;{broadcast.results=[{&#34;ip&#34;:&#34;10.220.47.253&#34;,&#34;port&#34;:20880,&#34;data&#34;:&#34;i am provider1&#34;},{&#34;ip&#34;:&#34;10.220.47.253&#34;,&#34;port&#34;:20881,&#34;data&#34;:&#34;i am provider2&#34;}]}|success% |
| </span></span></code></pre></div><p>Let one of the providers divide by zero:</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>&gt;curl http://localhost:8081/health |
| </span></span><span style="display:flex;"><span>&gt;{broadcast.results=[{&#34;ip&#34;:&#34;10.220.47.253&#34;,&#34;port&#34;:20880,&#34;data&#34;:&#34;i am provider1&#34;},{&#34;ip&#34;:&#34;10.220.47.253&#34;,&#34;port&#34;:20881,&#34;exceptionMsg&#34;:&#34;/ by zero&#34;}]}|success% |
| </span></span></code></pre></div></description></item><item><title>Docs: json generic invoke</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/generic-invoke-with-json/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/generic-invoke-with-json/</guid><description> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| support on <code>2.7.12</code> or above. |
| </div> |
| <p>A new method is provided for Dubbo generic invoke: directly passing on String to complete an invoke. In other words, users can directly pass on |
| parameter object&rsquo;s json String to complete a generic invoke.</p> |
| <h2 id="using-generic-invoke-through-api-method">Using generic invoke through API method</h2> |
| <p>For the following providers:</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> User <span style="color:#268bd2">setUser</span><span style="color:#719e07">(</span>User user<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> user<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Data</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">User</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> String name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> age<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>do one generic invoke:</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">class</span> <span style="color:#268bd2">GenericInvoke</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ApplicationConfig app <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;ConsumerTest&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> RegistryConfig reg <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;nacos://localhost:8848&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> DubboBootstrap bootstrap <span style="color:#719e07">=</span> DubboBootstrap<span style="color:#719e07">.</span>getInstance<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> bootstrap<span style="color:#719e07">.</span>application<span style="color:#719e07">(</span>app<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> bootstrap<span style="color:#719e07">.</span>registry<span style="color:#719e07">(</span>reg<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> bootstrap<span style="color:#719e07">.</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// config remote service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// name of the weakly typed interface |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> reference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;com.xxx.api.service.TestService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> reference<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dev&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> reference<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> reference<span style="color:#719e07">.</span>setRetries<span style="color:#719e07">(</span>0<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// set generic=gson in RpcContext |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>setAttachment<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;generic&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;gson&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// declare the interface to be generic |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> reference<span style="color:#719e07">.</span>setGeneric<span style="color:#719e07">(</span><span style="color:#cb4b16">true</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> reference<span style="color:#719e07">.</span>setCheck<span style="color:#719e07">(</span><span style="color:#cb4b16">false</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> GenericService genericService <span style="color:#719e07">=</span> ReferenceConfigCache<span style="color:#719e07">.</span>getCache<span style="color:#719e07">().</span>get<span style="color:#719e07">(</span>reference<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// pass on parameter object&#39;s json String for an invoke |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> Object res <span style="color:#719e07">=</span> genericService<span style="color:#719e07">.</span>$invoke<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;setUser&#34;</span><span style="color:#719e07">,</span> <span style="color:#719e07">new</span> String<span style="color:#719e07">[]{</span><span style="color:#2aa198">&#34;com.xxx.api.service.User&#34;</span><span style="color:#719e07">},</span> <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]{</span><span style="color:#2aa198">&#34;{&#39;name&#39;:&#39;Tom&#39;,&#39;age&#39;:24}&#34;</span><span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;result[setUser]：&#34;</span><span style="color:#719e07">+</span>res<span style="color:#719e07">);</span> <span style="color:#586e75">// response output:result[setUser]：{name=Tom, class=com.xxx.api.service.User, age=24} |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Throwable ex<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ex<span style="color:#719e07">.</span>printStackTrace<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: msgpack serialization</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/msgpack-serialization/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/msgpack-serialization/</guid><description> |
| <p>MessagePack is an efficient binary serialization format. It lets you exchange data among multiple languages like JSON. |
| But it&rsquo;s faster and smaller. Small integers are encoded into a single byte, and typical short strings require only one |
| extra byte in addition to the strings themselves.</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| support on <code>2.7.12</code> or above. |
| </div> |
| <h2 id="msgpack-demo">msgpack demo</h2> |
| <ul> |
| <li> |
| <ol> |
| <li>provider and consumer import msgpack dependencies</li> |
| </ol> |
| </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-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.msgpack<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>msgpack-core<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.8.22<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.msgpack<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>jackson-dataformat-msgpack<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.8.22<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><ul> |
| <li> |
| <ol start="2"> |
| <li>provider demo</li> |
| </ol> |
| </li> |
| </ul> |
| <p>Add the following protocol configurations into Dubbo configuration class:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ProtocolConfig <span style="color:#268bd2">msgpackProtocol</span><span style="color:#719e07">(){</span> |
| </span></span><span style="display:flex;"><span> ProtocolConfig protocolConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setId<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;msgpack&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setSerialization<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;msgpack&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> protocolConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Dubbo provider:</p> |
| <p>Add protocol declaration protocol = {&ldquo;msgpackProtocol&rdquo;} to annotations of @Service implemented by Dubbo provider interface.</p> |
| <p>Dubbo provider interface:</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">interface</span> <span style="color:#268bd2">MsgpackService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> <span style="color:#268bd2">tint</span><span style="color:#719e07">(</span><span style="color:#dc322f">int</span> i<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">long</span> <span style="color:#268bd2">tlong</span><span style="color:#719e07">(</span><span style="color:#dc322f">long</span> i<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">tlist</span><span style="color:#719e07">(</span>List<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> l<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">multiParams</span><span style="color:#719e07">(</span>String str<span style="color:#719e07">,</span> <span style="color:#dc322f">int</span> i<span style="color:#719e07">,</span> MyParam myParam<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Dubbo provider interface implement:</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">@Service</span><span style="color:#719e07">(</span>interfaceClass <span style="color:#719e07">=</span> MsgpackService<span style="color:#719e07">.</span>class<span style="color:#719e07">,</span>protocol <span style="color:#719e07">=</span> <span style="color:#719e07">{</span><span style="color:#2aa198">&#34;msgpackProtocol&#34;</span><span style="color:#719e07">})</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MsgpackServiceImpl</span> <span style="color:#268bd2">implements</span> MsgpackService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">int</span> <span style="color:#268bd2">tint</span><span style="color:#719e07">(</span><span style="color:#dc322f">int</span> i<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> i<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">long</span> <span style="color:#268bd2">tlong</span><span style="color:#719e07">(</span><span style="color:#dc322f">long</span> i<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> i<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> List<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">tlist</span><span style="color:#719e07">(</span>List<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> l<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> l<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">multiParams</span><span style="color:#719e07">(</span>String str<span style="color:#719e07">,</span> <span style="color:#dc322f">int</span> i<span style="color:#719e07">,</span> MyParam myParam<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> str <span style="color:#719e07">+</span> i <span style="color:#719e07">+</span> myParam<span style="color:#719e07">.</span>getName<span style="color:#719e07">()</span> <span style="color:#719e07">+</span> myParam<span style="color:#719e07">.</span>getAge<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Entities used:</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">@Data</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MyParam</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">int</span> age<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">MyParam</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">,</span> <span style="color:#dc322f">int</span> age<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>name <span style="color:#719e07">=</span> name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>age <span style="color:#719e07">=</span> age<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// parameterless construct function needed |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">MyParam</span><span style="color:#719e07">(){}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li> |
| <ol start="3"> |
| <li>consumer demo</li> |
| </ol> |
| </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-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#268bd2">@DubboReference</span><span style="color:#719e07">(</span>interfaceClass <span style="color:#719e07">=</span> MsgpackService<span style="color:#719e07">.</span>class<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> MsgpackService msgPackService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@GetMapping</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;/msgpack&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">testMsgpack</span><span style="color:#719e07">(){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> v1 <span style="color:#719e07">=</span> msgPackService<span style="color:#719e07">.</span>tint<span style="color:#719e07">(</span>1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">long</span> v2 <span style="color:#719e07">=</span> msgPackService<span style="color:#719e07">.</span>tlong<span style="color:#719e07">(</span>2<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> v3 <span style="color:#719e07">=</span> msgPackService<span style="color:#719e07">.</span>tlist<span style="color:#719e07">(</span>Lists<span style="color:#719e07">.</span>newArrayList<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;2&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;3&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> String v4 <span style="color:#719e07">=</span> msgPackService<span style="color:#719e07">.</span>multiParams<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;hello&#34;</span><span style="color:#719e07">,</span> 3<span style="color:#719e07">,</span> <span style="color:#719e07">new</span> MyParam<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Tom&#34;</span><span style="color:#719e07">,</span> 24<span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;msgpack&#34;</span><span style="color:#719e07">+</span>v1<span style="color:#719e07">+</span><span style="color:#2aa198">&#34; &#34;</span><span style="color:#719e07">+</span>v2<span style="color:#719e07">+</span><span style="color:#2aa198">&#34; &#34;</span><span style="color:#719e07">+</span>v3<span style="color:#719e07">+</span><span style="color:#2aa198">&#34; &#34;</span><span style="color:#719e07">+</span>v4<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li> |
| <ol start="4"> |
| <li>invoke</li> |
| </ol> |
| </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-fallback" data-lang="fallback"><span style="display:flex;"><span>&gt; curl http://localhost:8081/msgpack |
| </span></span><span style="display:flex;"><span>&gt; msgpack1 2 [1, 2, 3] hello3Tom24 |
| </span></span></code></pre></div></description></item><item><title>Docs: provider timeout release</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/provider-timeout-release/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/provider-timeout-release/</guid><description> |
| <p>Dubbo allows providers to shutdown operations based on how long the timeout lasts.</p> |
| <p>Applicable scenario: when a certain operation times out, providers can release that thread instead of simply printing out the timeout log message.</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| support on <code>2.7.12</code> or above. |
| </div> |
| <h2 id="main-logic">Main Logic</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AllChannelHandler2</span> <span style="color:#268bd2">extends</span> AllChannelHandler <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#268bd2">final</span> Timer TIME_OUT_TIMER <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashedWheelTimer<span style="color:#719e07">(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> NamedThreadFactory<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo-server-future-timeout&#34;</span><span style="color:#719e07">,</span> <span style="color:#cb4b16">true</span><span style="color:#719e07">),</span> |
| </span></span><span style="display:flex;"><span> 30<span style="color:#719e07">,</span> |
| </span></span><span style="display:flex;"><span> TimeUnit<span style="color:#719e07">.</span>MILLISECONDS<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">AllChannelHandler2</span><span style="color:#719e07">(</span>ChannelHandler handler<span style="color:#719e07">,</span> URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span><span style="color:#719e07">(</span>handler<span style="color:#719e07">,</span> url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">received</span><span style="color:#719e07">(</span>Channel channel<span style="color:#719e07">,</span> Object message<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ExecutorService executor <span style="color:#719e07">=</span> getPreferredExecutorService<span style="color:#719e07">(</span>message<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Future<span style="color:#719e07">&lt;?&gt;</span> future <span style="color:#719e07">=</span> executor<span style="color:#719e07">.</span>submit<span style="color:#719e07">(</span><span style="color:#719e07">new</span> ChannelEventRunnable<span style="color:#719e07">(</span>channel<span style="color:#719e07">,</span> handler<span style="color:#719e07">,</span> ChannelState<span style="color:#719e07">.</span>RECEIVED<span style="color:#719e07">,</span> message<span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">long</span> timeout <span style="color:#719e07">=</span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;timeout&#34;</span><span style="color:#719e07">,</span> 1000<span style="color:#719e07">)</span> <span style="color:#719e07">+</span> 90<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> TIME_OUT_TIMER<span style="color:#719e07">.</span>newTimeout<span style="color:#719e07">(</span>t <span style="color:#719e07">-&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(!</span>future<span style="color:#719e07">.</span>isDone<span style="color:#719e07">()</span> <span style="color:#719e07">&amp;&amp;</span> <span style="color:#719e07">(!</span>future<span style="color:#719e07">.</span>isCancelled<span style="color:#719e07">()))</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> future<span style="color:#719e07">.</span>cancel<span style="color:#719e07">(</span><span style="color:#cb4b16">true</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Throwable ex<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//ignore |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">},</span> timeout<span style="color:#719e07">,</span> TimeUnit<span style="color:#719e07">.</span>MILLISECONDS<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Throwable t<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(</span>message <span style="color:#719e07">instanceof</span> Request <span style="color:#719e07">&amp;&amp;</span> t <span style="color:#719e07">instanceof</span> RejectedExecutionException<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> sendFeedback<span style="color:#719e07">(</span>channel<span style="color:#719e07">,</span> <span style="color:#719e07">(</span>Request<span style="color:#719e07">)</span> message<span style="color:#719e07">,</span> t<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> ExecutionException<span style="color:#719e07">(</span>message<span style="color:#719e07">,</span> channel<span style="color:#719e07">,</span> getClass<span style="color:#719e07">()</span> <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; error when process received event .&#34;</span><span style="color:#719e07">,</span> t<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="demo">Demo</h2> |
| <ul> |
| <li>Set Dubbo ProtocolConfig thread dispatch strategy as &ldquo;all2&rdquo;.</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-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"> * Configuration Protocol |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ProtocolConfig <span style="color:#268bd2">protocolConfig</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ProtocolConfig protocolConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setPort<span style="color:#719e07">(-</span>1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setTransporter<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;netty4&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setThreadpool<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;fixed&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Set up thread dispatch strategy |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> protocolConfig<span style="color:#719e07">.</span>setDispatcher<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;all2&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> protocolConfig<span style="color:#719e07">.</span>setThreads<span style="color:#719e07">(</span>200<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> protocolConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li>provider demo</li> |
| </ul> |
| <p>When timeout, the thread will be stopped. In other words, if providers cannot return results to the consumers in time, then the thread will be stopped.</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">// Set provider timeout period as 1000ms |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">@Service</span><span style="color:#719e07">(</span>interfaceClass <span style="color:#719e07">=</span> TestService<span style="color:#719e07">.</span>class<span style="color:#719e07">,</span>timeout <span style="color:#719e07">=</span> 1000<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">TestServiceImpl</span> <span style="color:#268bd2">implements</span> TestService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Integer <span style="color:#268bd2">sum</span><span style="color:#719e07">(</span><span style="color:#dc322f">int</span> a<span style="color:#719e07">,</span> <span style="color:#dc322f">int</span> b<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> CountDownLatch latch <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> CountDownLatch<span style="color:#719e07">(</span>2<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> AtomicInteger i <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AtomicInteger<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> Thread<span style="color:#719e07">(()-&gt;{</span> |
| </span></span><span style="display:flex;"><span> i<span style="color:#719e07">.</span>incrementAndGet<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> latch<span style="color:#719e07">.</span>countDown<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}).</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> Thread<span style="color:#719e07">(()-&gt;{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> TimeUnit<span style="color:#719e07">.</span>MILLISECONDS<span style="color:#719e07">.</span>sleep<span style="color:#719e07">(</span>2000<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span><span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>InterruptedException e<span style="color:#719e07">){</span> |
| </span></span><span style="display:flex;"><span> e<span style="color:#719e07">.</span>printStackTrace<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> i<span style="color:#719e07">.</span>incrementAndGet<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> latch<span style="color:#719e07">.</span>countDown<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}).</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> latch<span style="color:#719e07">.</span>await<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> i<span style="color:#719e07">.</span>get<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span><span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>InterruptedException e<span style="color:#719e07">){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// when timeout, return the following |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> RuntimeException<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;call sum timeout&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>As for the provider demo above, when running the last try-catch, if the thread is released then catch InterruptedException and return &ldquo;call sum timeout&rdquo;.</p> |
| <ul> |
| <li>consumer demo</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-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#586e75">// Set consumer timeout period as 2000 longer than the server execution period |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@Reference</span><span style="color:#719e07">(</span>check <span style="color:#719e07">=</span> <span style="color:#cb4b16">false</span><span style="color:#719e07">,</span>interfaceClass <span style="color:#719e07">=</span> TestService<span style="color:#719e07">.</span>class<span style="color:#719e07">,</span>timeout <span style="color:#719e07">=</span> 3000<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> TestService testService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@GetMapping</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;/sum&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">consumeSum</span><span style="color:#719e07">(){</span> |
| </span></span><span style="display:flex;"><span> Integer ret <span style="color:#719e07">=</span> 0<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span><span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ret <span style="color:#719e07">=</span> testService<span style="color:#719e07">.</span>sum<span style="color:#719e07">(</span>1<span style="color:#719e07">,</span>1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span><span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Exception e<span style="color:#719e07">){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> e<span style="color:#719e07">.</span>getMessage<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> String<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span>ret<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li>execution outcome</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-fallback" data-lang="fallback"><span style="display:flex;"><span>curl http://localhost:8081/sum |
| </span></span><span style="display:flex;"><span>&gt;call sum timeout |
| </span></span></code></pre></div></description></item><item><title>Docs: Invoke provider with specified IP port</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/invoke-with-specified-ip/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/invoke-with-specified-ip/</guid><description> |
| <p>When multiple providers are registered at the register center, dynamically specifying one of the instances’ IP through RpcContext is enabled. Port does Dubbo invoke.</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| support on <code>2.7.12</code> or above. |
| </div> |
| <h2 id="demo">Demo</h2> |
| <ul> |
| <li>provider demo</li> |
| </ul> |
| <p>Assume two registered providers at the register center are provided, which are 10.220.47.253:20880;10.220.47.253:20881; respectively.</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">// 10.220.47.253:20880 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">@Service</span><span style="color:#719e07">(</span>interfaceClass <span style="color:#719e07">=</span> TestService<span style="color:#719e07">.</span>class<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">TestServiceImpl</span> <span style="color:#268bd2">implements</span> TestService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Hello &#34;</span><span style="color:#719e07">+</span>name<span style="color:#719e07">+</span><span style="color:#2aa198">&#34; i am provider1&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// 10.220.47.253:20881 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">@Service</span><span style="color:#719e07">(</span>interfaceClass <span style="color:#719e07">=</span> TestService<span style="color:#719e07">.</span>class<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">TestServiceImpl</span> <span style="color:#268bd2">implements</span> TestService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Hello &#34;</span><span style="color:#719e07">+</span>name<span style="color:#719e07">+</span><span style="color:#2aa198">&#34; i am provider2&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li>consumer demo</li> |
| </ul> |
| <p>@DubboReference introduces provider. Setting parameters = {&ldquo;router&rdquo;,&ldquo;address&rdquo;} specifies routing method.</p> |
| <p>For the instance that is going to be invoked, specify its IP, construct Address object with Port and set RpcContext key as &ldquo;address&rdquo;. Value is that object.</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">// require dependent class |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcContext<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.cluster.router.address.Address<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@RestController</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">TestServiceConsumer</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@DubboReference</span><span style="color:#719e07">(</span>interfaceClass <span style="color:#719e07">=</span> TestService<span style="color:#719e07">.</span>class<span style="color:#719e07">,</span>group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;dev&#34;</span><span style="color:#719e07">,</span>parameters <span style="color:#719e07">=</span> <span style="color:#719e07">{</span><span style="color:#2aa198">&#34;router&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;address&#34;</span><span style="color:#719e07">})</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> TestService testService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@GetMapping</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;/invokeByIpPortSpecified&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">invokeByIp</span><span style="color:#719e07">(){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// create Address instance based on provider&#39;s ip port |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> Address address <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Address<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;10.220.47.253&#34;</span><span style="color:#719e07">,</span> 20880<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>setObjectAttachment<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;address&#34;</span><span style="color:#719e07">,</span> address<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> testService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Tom&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span><span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Throwable ex<span style="color:#719e07">){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> ex<span style="color:#719e07">.</span>getMessage<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ul> |
| <li>execution outcome</li> |
| </ul> |
| <p>After running the code multiple times we can see that the same &ldquo;Hello Tom i am provider1&rdquo; is returned. In other words, we always route to the instance where port 20880 is located.</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>&gt;curl http://localhost:8081/invokeByIpPortSpecified |
| </span></span><span style="display:flex;"><span>&gt;Hello Tom i am provider1 |
| </span></span></code></pre></div></description></item><item><title>Docs: Generic Reference</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/generic-reference/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/generic-reference/</guid><description> |
| <p>Generic invocation is mainly used when the client does not have API interface or model class, all POJOs in parameters and return values are represented by <code>Map</code>.Commonly used for framework integration such as: implementing a common service testing framework, all service implementations can be invoked via <code>GenericService</code>.</p> |
| <h2 id="use-generic-invocation-via-spring">Use generic invocation via Spring</h2> |
| <p>Declared in the Spring configuration file <code>generic =&quot; true &quot;</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;barService&#34;</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> generic=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>In Java code, get <code>barService</code> and start generic invocation:</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>GenericService barService <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>GenericService<span style="color:#719e07">)</span> applicationContext<span style="color:#719e07">.</span>getBean<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;barService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>Object result <span style="color:#719e07">=</span> barService<span style="color:#719e07">.</span>$invoke<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;sayHello&#34;</span><span style="color:#719e07">,</span> <span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span> <span style="color:#719e07">{</span> <span style="color:#2aa198">&#34;java.lang.String&#34;</span> <span style="color:#719e07">},</span> <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]</span> <span style="color:#719e07">{</span> <span style="color:#2aa198">&#34;World&#34;</span> <span style="color:#719e07">});</span> |
| </span></span></code></pre></div><h2 id="use-generic-invocation-via-api">Use generic invocation via API</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.service.GenericService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// reference remote service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// The instance is very heavy, which encapsulates all the registration center and service provider connection, please cache |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// weak type service interface name |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>reference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;com.xxx.XxxService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// declared as generic service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>reference<span style="color:#719e07">.</span>setGeneric<span style="color:#719e07">(</span><span style="color:#cb4b16">true</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// service stub type is also the org.apache.dubbo.rpc.service.GenericService |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>GenericService genericService <span style="color:#719e07">=</span> reference<span style="color:#719e07">.</span>get<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// basic types and Date, List, Map, etc. do not need conversion, direct use them |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Object result <span style="color:#719e07">=</span> genericService<span style="color:#719e07">.</span>$invoke<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;sayHello&#34;</span><span style="color:#719e07">,</span> <span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span> <span style="color:#719e07">{</span><span style="color:#2aa198">&#34;java.lang.String&#34;</span><span style="color:#719e07">},</span> <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]</span> <span style="color:#719e07">{</span><span style="color:#2aa198">&#34;world&#34;</span><span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// map POJO parameters, if the return value is POJO will automatically turn into map |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> Object<span style="color:#719e07">&gt;</span> person <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> Object<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;name&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;xxx&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;password&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;yyy&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// if the return value is POJO will automatically turn into map |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Object result <span style="color:#719e07">=</span> genericService<span style="color:#719e07">.</span>$invoke<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;findPerson&#34;</span><span style="color:#719e07">,</span> <span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">{</span><span style="color:#2aa198">&#34;com.xxx.Person&#34;</span><span style="color:#719e07">},</span> <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]{</span>person<span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span></code></pre></div><h2 id="further-explanation-of-generalized-types">Further explanation of generalized types</h2> |
| <p>Consider POJO 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.xxx<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">PersonImpl</span> <span style="color:#268bd2">implements</span> Person <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String password<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">getName</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setName</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>name <span style="color:#719e07">=</span> name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">getPassword</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> password<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setPassword</span><span style="color:#719e07">(</span>String password<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>password <span style="color:#719e07">=</span> password<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>The POJO data：</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>Person person <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> PersonImpl<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;xxx&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span>setPassword<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;yyy&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><p>Data represented by <code>Map</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-java" data-lang="java"><span style="display:flex;"><span>Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> Object<span style="color:#719e07">&gt;</span> map <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> Object<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Note: If the parameter type is an interface, or List lost the generic class, you can specify the type of the class attribute |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>map<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;class&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;com.xxx.PersonImpl&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>map<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;name&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;xxx&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>map<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;password&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;yyy&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Generic Service</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/generic-service/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/generic-service/</guid><description> |
| <p>The implementation of the generic interface is mainly used when there is no API interface and model class on the server side. All POJOs in the parameters and return values are represented by the Map and are usually used for framework integration. For example, to implement a universal remote service Mock framework, handle all service requests by implementing the GenericService interface.</p> |
| <p>In Java code, implement <code>GenericService</code> interface：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.foo<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MyGenericService</span> <span style="color:#268bd2">implements</span> GenericService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">$invoke</span><span style="color:#719e07">(</span>String methodName<span style="color:#719e07">,</span> String<span style="color:#719e07">[]</span> parameterTypes<span style="color:#719e07">,</span> Object<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> GenericException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(</span><span style="color:#2aa198">&#34;sayHello&#34;</span><span style="color:#719e07">.</span>equals<span style="color:#719e07">(</span>methodName<span style="color:#719e07">))</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Welcome &#34;</span> <span style="color:#719e07">+</span> args<span style="color:#719e07">[</span>0<span style="color:#719e07">];</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="export-generic-implements-via-spring">Export generic implements via Spring</h2> |
| <p>Declared in the Spring configuration file：</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;bean</span> id=<span style="color:#2aa198">&#34;genericService&#34;</span> class=<span style="color:#2aa198">&#34;com.foo.MyGenericService&#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;com.foo.BarService&#34;</span> ref=<span style="color:#2aa198">&#34;genericService&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="export-generic-implements-via-api">Export generic implements via API</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// use org.apache.dubbo.rpc.service.GenericService can replace all implements |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>GenericService xxxService <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> XxxGenericService<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// The instance is very heavy, which encapsulates all the registration center and service provider connection, please cache |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ServiceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// weak type service interface name |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>service<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;com.xxx.XxxService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// point to a generic serivce instance |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>service<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span>xxxService<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// export service to registration center |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>service<span style="color:#719e07">.</span>export<span style="color:#719e07">();</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Echo Testing Service</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/echo-service/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/echo-service/</guid><description> |
| <p>Echo testing is used for check the service is available,Echo testing is performed according to the normal request flow and is able to test whether the entire call is unobstructed and can be used for monitoring.</p> |
| <p>All the services will be automatically implemented <code>EchoService</code> interface,just cast any service reference to <code>EchoService</code> to use it.</p> |
| <p>Spring configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;memberService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.MemberService&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>The java 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// reference the remote service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>MemberService memberService <span style="color:#719e07">=</span> ctx<span style="color:#719e07">.</span>getBean<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;memberService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// case the service reference to EchoService |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>EchoService echoService <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>EchoService<span style="color:#719e07">)</span> memberService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Echo test usability |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>String status <span style="color:#719e07">=</span> echoService<span style="color:#719e07">.</span>$echo<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;OK&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">assert</span><span style="color:#719e07">(</span>status<span style="color:#719e07">.</span>equals<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;OK&#34;</span><span style="color:#719e07">));</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Context</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/context/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/context/</guid><description> |
| <p>All environment information of during the current call will put into the context,and all configuration information will convert the parameters of <code>URL</code> instance,Ref to the column of <strong>URL parameters</strong> at the <a href="https://dubbo.apache.org/en/docs/v2.7/user/references/xml">schema configuration reference book</a></p> |
| <p><code>RpcContext</code> is a temporary status recorder of <code>ThreadLocal</code>,when accept <code>RPC</code> request or send <code>RPC</code> request,The <code>RpcContext</code> will be changed.Such as: <code>A</code> call <code>B</code> and <code>B</code> call <code>C</code>. On <code>B</code> machine,before <code>B</code> call <code>C</code>,the <code>RpcContext</code> will record the information of <code>A</code> call <code>B</code>.After <code>B</code> call <code>C</code>,the <code>RpcContext</code> record the information of <code>B</code> call <code>C</code>.</p> |
| <h2 id="at-service-consumer">At service consumer</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// remote invoke |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>xxxService<span style="color:#719e07">.</span>xxx<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// if return true,then the current side is consumer. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#dc322f">boolean</span> isConsumerSide <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>isConsumerSide<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// get the provider ip address of the last invoke. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>String serverIP <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getRemoteHost<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// because all configuration information has convert the URL&#39;s parameters,so at this place can get the application parameter value. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>String application <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getUrl<span style="color:#719e07">().</span>getParameter<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;application&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Note:every rpc invoke,then context will be changed. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>yyyService<span style="color:#719e07">.</span>yyy<span style="color:#719e07">();</span> |
| </span></span></code></pre></div><h2 id="at-service-provider">At service provider</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxServiceImpl</span> <span style="color:#268bd2">implements</span> XxxService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">xxx</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// if return true,then the current side is provider. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#dc322f">boolean</span> isProviderSide <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>isProviderSide<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// get the invoker ip |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> String clientIP <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getRemoteHost<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// because all configuration information has convert the URL&#39;s parameters,so at this place can get the application parameter value. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> String application <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getUrl<span style="color:#719e07">().</span>getParameter<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;application&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Note:every rpc invoke,then context will be changed. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> yyyService<span style="color:#719e07">.</span>yyy<span style="color:#719e07">();;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Implicit parameters</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/attachment/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/attachment/</guid><description> |
| <p>You can implicitly pass parameters between service consumers and providers via <code>setAttachment</code> and<code> getAttachment</code> on <code>RpcContext</code>. |
| <img src="https://dubbo.apache.org/imgs/user/context.png" alt="/user-guide/images/context.png"></p> |
| <h2 id="set-the-implicit-parameters-at-service-consumer-side">Set the implicit parameters at service consumer side</h2> |
| <p>Via <code>setAttachment</code> on <code>RpcContext</code> set key/value pair for implicitly pass parameters.When finished once remote invoke,will be clear,so multi-invoke must set multi-times.</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>RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>setAttachment<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;index&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;1&#34;</span><span style="color:#719e07">);</span> <span style="color:#586e75">// implicitly pass parameters,behind the remote call will implicitly send these parameters to the server side, similar to the cookie, for the framework of integration, not recommended for regular business use |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>xxxService<span style="color:#719e07">.</span>xxx<span style="color:#719e07">();</span> <span style="color:#586e75">// remote call |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// ... |
| </span></span></span></code></pre></div><h2 id="fetch-the-implicit-parameters-at-service-provider-side">Fetch the implicit parameters at service provider side</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxServiceImpl</span> <span style="color:#268bd2">implements</span> XxxService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">xxx</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// get parameters which passed by the consumer side,for the framework of integration, not recommended for regular business use |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> String index <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getAttachment<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;index&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Asynchronous Call</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/async-call/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/async-call/</guid><description> |
| <p>As dubbo is based on a non-blocking NIO network layer, the client can start parallel call to multiple remote services without explicitly starting mulithreads, which costs relatively fewer resources.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/future.jpg" alt="/user-guide/images/future.jpg"></p> |
| <p>You can config at <code>consumer.xml</code> for setup asynchronous call some remote 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> id=<span style="color:#2aa198">&#34;fooService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.foo.FooService&#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;findFoo&#34;</span> async=<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><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;barService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.bar.BarService&#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;findBar&#34;</span> async=<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><p>Configure the above configuration information,you can invoke the remote service in your 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// the invoke will return null immediately |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>fooService<span style="color:#719e07">.</span>findFoo<span style="color:#719e07">(</span>fooId<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// get current invoke Future instance,when the remote service has return result,will notify this Future instance. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Future<span style="color:#719e07">&lt;</span>Foo<span style="color:#719e07">&gt;</span> fooFuture <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getFuture<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// the invoke will return null immediately |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>barService<span style="color:#719e07">.</span>findBar<span style="color:#719e07">(</span>barId<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// get current invoke Future instance,when the remote service has return result,will notify this Future instance. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Future<span style="color:#719e07">&lt;</span>Bar<span style="color:#719e07">&gt;</span> barFuture <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getFuture<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// now the request of findFoo and findBar was executed at same time,The client not need setup multithreading for parallel call, which is NIO-based non-blocking implementation of parallel calls |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Current thread will be blocking,and wait findFoo has return. when remote service has return findFoo result,the current thread will be wake up. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Foo foo <span style="color:#719e07">=</span> fooFuture<span style="color:#719e07">.</span>get<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// same to findFoo |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Bar bar <span style="color:#719e07">=</span> barFuture<span style="color:#719e07">.</span>get<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// if findFoo expend five second for wait remote service return result,and findBar expend six second. Actually,only expend six second will get findFoo and findBar result,and proceed to the next step. |
| </span></span></span></code></pre></div><p>You can also set whether to wait for the message to be sent:</p> |
| <ul> |
| <li><code>sent=&quot;true&quot;</code> wait for the message to be send,if send failure，will throw exception.</li> |
| <li><code>sent=&quot;false&quot;</code> do not wait for the message to be send,when the message will push into io queue,will return immediately.</li> |
| </ul> |
| <p>The 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:method</span> name=<span style="color:#2aa198">&#34;findFoo&#34;</span> async=<span style="color:#2aa198">&#34;true&#34;</span> sent=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>if you only want to asynchronous call,and don&rsquo;t care the return.you can config <code>return=&quot;false&quot;</code>,To reduce the cost of creating and managing Future objects.</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;findFoo&#34;</span> async=<span style="color:#2aa198">&#34;true&#34;</span> return=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| support on <code>2.0.6</code> or above. |
| </div></description></item><item><title>Docs: Asynchronous Execution</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/async-execute-on-provider/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/async-execute-on-provider/</guid><description> |
| <p>The asynchronous execute on provider switches the blocked service from the internal thread pool of Dubbo to the service custom thread to avoid over-occupation of the Dubbo thread pool, which helps to avoid mutual influence between different services.Asynchronous-Execution is not conducive to saving resources or improving RPC responsiveness, because if business execution needs to be blocked, there is always a thread to be responsible for execution.</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| <p>Note: Asynchronous execute on provider and asynchronous execute on consumer are independent of each other. You can configure ends of any orthogonal combination.</p> |
| <ul> |
| <li>Synchronous Execution On Consumer - Synchronous Execution On Provider</li> |
| <li>Asynchronous Executio On Consumer - Synchronous Execution On Provider</li> |
| <li>Synchronous Execution On Consumer - Asynchronous Executio On Provider</li> |
| <li>Asynchronous Execution On Consumer - Asynchronous Executio On Provider</li> |
| </ul> |
| </div> |
| <h2 id="interface-that-defines-the-completablefuture-signature">Interface that defines the CompletableFuture signature</h2> |
| <p>Service interface 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Service implementation：</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">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> RpcContext savedContext <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// It is recommended to provide a custom thread pool for supplyAsync to avoid using the JDK common thread pool. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> CompletableFuture<span style="color:#719e07">.</span>supplyAsync<span style="color:#719e07">(()</span> <span style="color:#719e07">-&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span>savedContext<span style="color:#719e07">.</span>getAttachment<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;consumer-key1&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Thread<span style="color:#719e07">.</span>sleep<span style="color:#719e07">(</span>5000<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>InterruptedException e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> e<span style="color:#719e07">.</span>printStackTrace<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;async response from provider.&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>The business execution has been switched from the Dubbo thread to the business thread by <code>return CompletableFuture.supplyAsync()</code>, avoiding blocking of the Dubbo thread pool.</p> |
| <h2 id="use-asynccontext">Use AsyncContext</h2> |
| <p>Dubbo provides an asynchronous interface <code>AsyncContext</code> similar to Serverlet 3.0. It can also implement asynchronous execution of the Provider without the CompletableFuture signature interface.</p> |
| <p>Service interface 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Service export, exactly the same as ordinary 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;bean</span> id=<span style="color:#2aa198">&#34;asyncService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.governance.impl.AsyncServiceImpl&#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.governance.api.AsyncService&#34;</span> ref=<span style="color:#2aa198">&#34;asyncService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Service implementation：</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">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> AsyncContext asyncContext <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>startAsync<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> Thread<span style="color:#719e07">(()</span> <span style="color:#719e07">-&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// If you want to use context, you must do it at the very beginning |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> asyncContext<span style="color:#719e07">.</span>signalContextSwitch<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Thread<span style="color:#719e07">.</span>sleep<span style="color:#719e07">(</span>500<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>InterruptedException e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> e<span style="color:#719e07">.</span>printStackTrace<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Write to response |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> asyncContext<span style="color:#719e07">.</span>write<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, response from provider.&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}).</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#cb4b16">null</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Local Call</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/local-call/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/local-call/</guid><description> |
| <p>The local call uses the <code>injvm</code> protocol, a pseudo-protocol that does not turn on the port, does not initiate remote calls, is directly associated within the JVM, but executes the Dubbo Filter chain.</p> |
| <h2 id="configuration">Configuration</h2> |
| <p>Configure <code>injvm</code> 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;injvm&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Configure default provider</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> protocol=<span style="color:#2aa198">&#34;injvm&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Configure default 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:service</span> protocol=<span style="color:#2aa198">&#34;injvm&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Use injvm first</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> injvm=<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:provider</span> injvm=<span style="color:#2aa198">&#34;true&#34;</span> ...<span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> injvm=<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:service</span> injvm=<span style="color:#2aa198">&#34;true&#34;</span> ...<span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Note: Dubbo services are exposed locally from <code>2.2.0</code> by default. It can be referenced locally without any configuration. If you don&rsquo;t want the service to be exposed remotely, you only need to set the protocol to injvm in the provider.</p> |
| <h2 id="automatically-exposed-local-service-references">Automatically exposed, local service references</h2> |
| <p><code>2.2.0</code> or later, each service is exposed locally by default. When referring to the service, the local service is referenced by default. If you want to reference a remote service, you can use the following configuration to force a reference to a remote 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> ... scope=<span style="color:#2aa198">&#34;remote&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Callback parameter</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/callback-parameter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/callback-parameter/</guid><description> |
| <p>The parameter callback is the same as calling a local callback or listener, just declare which parameter is a callback type in Spring&rsquo;s configuration file, and Dubbo will generate a reverse proxy based on the long connection so that client logic can be called from the server.Can ref to <a href="https://github.com/dubbo/dubbo-samples/tree/master/2-advanced/dubbo-samples-callback">Sample code in the dubbo project</a>.</p> |
| <h2 id="example-of-service-interface">Example of service interface</h2> |
| <h3 id="callbackservicejava">CallbackService.java</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.callback<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">CallbackService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">addListener</span><span style="color:#719e07">(</span>String key<span style="color:#719e07">,</span> CallbackListener listener<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="callbacklistenerjava">CallbackListener.java</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.callback<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">CallbackListener</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">changed</span><span style="color:#719e07">(</span>String msg<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="example-of-service-provider-interface-implementation">Example of service provider interface implementation</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.callback.impl<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.text.SimpleDateFormat<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.Date<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.Map<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.concurrent.ConcurrentHashMap<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.callback.CallbackListener<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.callback.CallbackService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">CallbackServiceImpl</span> <span style="color:#268bd2">implements</span> CallbackService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> CallbackListener<span style="color:#719e07">&gt;</span> listeners <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> CallbackListener<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">CallbackServiceImpl</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Thread t <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Thread<span style="color:#719e07">(</span><span style="color:#719e07">new</span> Runnable<span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">run</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">while</span><span style="color:#719e07">(</span><span style="color:#cb4b16">true</span><span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span><span style="color:#719e07">(</span>Map<span style="color:#719e07">.</span>Entry<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> CallbackListener<span style="color:#719e07">&gt;</span> entry <span style="color:#719e07">:</span> listeners<span style="color:#719e07">.</span>entrySet<span style="color:#719e07">()){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> entry<span style="color:#719e07">.</span>getValue<span style="color:#719e07">().</span>changed<span style="color:#719e07">(</span>getChanged<span style="color:#719e07">(</span>entry<span style="color:#719e07">.</span>getKey<span style="color:#719e07">()));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Throwable t<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> listeners<span style="color:#719e07">.</span>remove<span style="color:#719e07">(</span>entry<span style="color:#719e07">.</span>getKey<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> Thread<span style="color:#719e07">.</span>sleep<span style="color:#719e07">(</span>5000<span style="color:#719e07">);</span> <span style="color:#586e75">// Timed trigger change notification |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Throwable t<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> <span style="color:#586e75">// Defense fault tolerance |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> t<span style="color:#719e07">.</span>printStackTrace<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> t<span style="color:#719e07">.</span>setDaemon<span style="color:#719e07">(</span><span style="color:#cb4b16">true</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> t<span style="color:#719e07">.</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">addListener</span><span style="color:#719e07">(</span>String key<span style="color:#719e07">,</span> CallbackListener listener<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> listeners<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span>key<span style="color:#719e07">,</span> listener<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> listener<span style="color:#719e07">.</span>changed<span style="color:#719e07">(</span>getChanged<span style="color:#719e07">(</span>key<span style="color:#719e07">));</span> <span style="color:#586e75">// send change notification |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String <span style="color:#268bd2">getChanged</span><span style="color:#719e07">(</span>String key<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Changed: &#34;</span> <span style="color:#719e07">+</span> <span style="color:#719e07">new</span> SimpleDateFormat<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;yyyy-MM-dd HH:mm:ss&#34;</span><span style="color:#719e07">).</span>format<span style="color:#719e07">(</span><span style="color:#719e07">new</span> Date<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="example-of-service-provider-configuration">Example of service provider configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;callbackService&#34;</span> class=<span style="color:#2aa198">&#34;com.callback.impl.CallbackServiceImpl&#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;com.callback.CallbackService&#34;</span> ref=<span style="color:#2aa198">&#34;callbackService&#34;</span> connections=<span style="color:#2aa198">&#34;1&#34;</span> callbacks=<span style="color:#2aa198">&#34;1000&#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;addListener&#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;1&#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:#586e75">&lt;!--also can via specified argument type--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!--&lt;dubbo:argument type=&#34;com.demo.CallbackListener&#34; callback=&#34;true&#34; /&gt;--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dubbo:method&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:service&gt;</span> |
| </span></span></code></pre></div><h2 id="example-of-service-consumer-configuration">Example of service consumer configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;callbackService&#34;</span> interface=<span style="color:#2aa198">&#34;com.callback.CallbackService&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="example-of-service-consumer-call">Example of service consumer call</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;classpath:consumer.xml&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>context<span style="color:#719e07">.</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>CallbackService callbackService <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>CallbackService<span style="color:#719e07">)</span> context<span style="color:#719e07">.</span>getBean<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;callbackService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>callbackService<span style="color:#719e07">.</span>addListener<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;foo.bar&#34;</span><span style="color:#719e07">,</span> <span style="color:#719e07">new</span> CallbackListener<span style="color:#719e07">(){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">changed</span><span style="color:#719e07">(</span>String msg<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;callback1:&#34;</span> <span style="color:#719e07">+</span> msg<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">});</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| support on <code>2.0.6</code> or above |
| </div></description></item><item><title>Docs: Event Notification</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/events-notify/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/events-notify/</guid><description> |
| <p>Before calling, after calling, when an exception occurs,will trigger <code>oninvoke</code>, <code>onreturn</code>, <code>onthrow</code> events.You can configure which method to notify when an event occurs.</p> |
| <h2 id="service-interface">Service Interface</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">interface</span> <span style="color:#268bd2">IDemoService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Person <span style="color:#268bd2">get</span><span style="color:#719e07">(</span><span style="color:#dc322f">int</span> id<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="service-provider-implement-the-service">Service provider implement the service.</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">class</span> <span style="color:#268bd2">NormalDemoService</span> <span style="color:#268bd2">implements</span> IDemoService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Person <span style="color:#268bd2">get</span><span style="color:#719e07">(</span><span style="color:#dc322f">int</span> id<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> Person<span style="color:#719e07">(</span>id<span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;charles`son&#34;</span><span style="color:#719e07">,</span> 4<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="service-provider-configure-the-service-which-it-provided">Service provider configure the service which it provided.</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;rpc-callback-demo&#34;</span> <span style="color:#268bd2">/&gt;</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><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.callback.implicit.NormalDemoService&#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.callback.implicit.IDemoService&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> group=<span style="color:#2aa198">&#34;cn&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="declare-the-callback-interface-at-service-consumer-side">Declare the Callback interface at service consumer-side.</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">interface</span> <span style="color:#268bd2">Notify</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onreturn</span><span style="color:#719e07">(</span>Person msg<span style="color:#719e07">,</span> Integer id<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onthrow</span><span style="color:#719e07">(</span>Throwable ex<span style="color:#719e07">,</span> Integer id<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="implement-the-callback-at-service-consumer-side">Implement the Callback at service consumer-side.</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">class</span> <span style="color:#268bd2">NotifyImpl</span> <span style="color:#268bd2">implements</span> Notify <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Map<span style="color:#719e07">&lt;</span>Integer<span style="color:#719e07">,</span> Person<span style="color:#719e07">&gt;</span> ret <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>Integer<span style="color:#719e07">,</span> Person<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Map<span style="color:#719e07">&lt;</span>Integer<span style="color:#719e07">,</span> Throwable<span style="color:#719e07">&gt;</span> errors <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>Integer<span style="color:#719e07">,</span> Throwable<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onreturn</span><span style="color:#719e07">(</span>Person msg<span style="color:#719e07">,</span> Integer id<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;onreturn:&#34;</span> <span style="color:#719e07">+</span> msg<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> ret<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span>id<span style="color:#719e07">,</span> msg<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onthrow</span><span style="color:#719e07">(</span>Throwable ex<span style="color:#719e07">,</span> Integer id<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> errors<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span>id<span style="color:#719e07">,</span> ex<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="configure-the-callback-at-service-consumer-side">Configure the Callback at service consumer-side.</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id =<span style="color:#2aa198">&#34;demoCallback&#34;</span> class = <span style="color:#2aa198">&#34;org.apache.dubbo.callback.implicit.NotifyImpl&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.callback.implicit.IDemoService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> group=<span style="color:#2aa198">&#34;cn&#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;get&#34;</span> async=<span style="color:#2aa198">&#34;true&#34;</span> onreturn = <span style="color:#2aa198">&#34;demoCallback.onreturn&#34;</span> onthrow=<span style="color:#2aa198">&#34;demoCallback.onthrow&#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><p><code>callback</code> and<code> async</code> functions are orthogonally decomposed. <code>async = true</code> means that the result is returned immediately.<code> onreturn</code> means that a callback is required.</p> |
| <p>There are several situations with the tow attributes[^2].</p> |
| <ul> |
| <li>Asynchronous callback mode:<code>async=true onreturn=&quot;xxx&quot;</code></li> |
| <li>Synchronous callback mode:<code>async=false onreturn=&quot;xxx&quot;</code></li> |
| <li>Asynchronous no callback:<code>async=true</code></li> |
| <li>Synchronous no callback:<code>async=true</code></li> |
| </ul> |
| <h2 id="testing-code">Testing code</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>IDemoService demoService <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>IDemoService<span style="color:#719e07">)</span> context<span style="color:#719e07">.</span>getBean<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demoService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>NotifyImpl notify <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>NotifyImpl<span style="color:#719e07">)</span> context<span style="color:#719e07">.</span>getBean<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demoCallback&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#dc322f">int</span> requestId <span style="color:#719e07">=</span> 2<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span>Person ret <span style="color:#719e07">=</span> demoService<span style="color:#719e07">.</span>get<span style="color:#719e07">(</span>requestId<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>Assert<span style="color:#719e07">.</span>assertEquals<span style="color:#719e07">(</span><span style="color:#cb4b16">null</span><span style="color:#719e07">,</span> ret<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">//for Test:Just used to illustrate the normal callback callback, the specific business decisions. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">for</span> <span style="color:#719e07">(</span><span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> 0<span style="color:#719e07">;</span> i <span style="color:#719e07">&lt;</span> 10<span style="color:#719e07">;</span> i<span style="color:#719e07">++)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(!</span>notify<span style="color:#719e07">.</span>ret<span style="color:#719e07">.</span>containsKey<span style="color:#719e07">(</span>requestId<span style="color:#719e07">))</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Thread<span style="color:#719e07">.</span>sleep<span style="color:#719e07">(</span>200<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">else</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">break</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span>Assert<span style="color:#719e07">.</span>assertEquals<span style="color:#719e07">(</span>requestId<span style="color:#719e07">,</span> notify<span style="color:#719e07">.</span>ret<span style="color:#719e07">.</span>get<span style="color:#719e07">(</span>requestId<span style="color:#719e07">).</span>getId<span style="color:#719e07">());</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| since <code>2.0.7+</code> version, the default value is <code>async=false</code>. |
| </div></description></item><item><title>Docs: Local Stub</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/local-stub/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/local-stub/</guid><description> |
| <p>When using rpc, the client usually only the interface, but sometimes the client also want to perform part of the logic in the client. For example: do ThreadLocal cache, verify parameters, return mock data when call fails., etc.</p> |
| <p>To solve this problem, you can configure the stub in the API, so that when the client generates the proxy instance, it passes the proxy to the <code>Stub</code> via the constructor <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>, and then you can implement your logic in the stub implementation code.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/stub.jpg" alt="/user-guide/images/stub.jpg"></p> |
| <p>Configured in the spring configuration file 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;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> stub=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> stub=<span style="color:#2aa198">&#34;com.foo.BarServiceStub&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Provide Stub implementation <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.foo<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">BarServiceStub</span> <span style="color:#268bd2">implements</span> BarService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> BarService barService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// The real remote proxy object is passed in through the constructor |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">BarServiceStub</span><span style="color:#719e07">(</span>BarService barService<span style="color:#719e07">){</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>barService <span style="color:#719e07">=</span> barService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// The following code is executed on the client. You can do local ThreadLocal caching on the client side, or verify parameters, etc. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> barService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span>name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>Exception e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// You can return the mock data. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;MockData&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>The Stub must have a constructor that can pass in the proxy.&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>BarServiceStub implements BarService ，it has a constructor passed in the remote BarService instance&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Local Mock</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/local-mock/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/local-mock/</guid><description> |
| <p>Local mock <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> is usually used for service downgrade, such as a verification service, the client does not throw an exception when the service provider hangs up all the time, but returns the authorization failed through the Mock data.</p> |
| <p>Configured in the spring configuration file 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;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> mock=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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> mock=<span style="color:#2aa198">&#34;com.foo.BarServiceMock&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Mock implementation in the project <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.foo<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">BarServiceMock</span> <span style="color:#268bd2">implements</span> BarService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// You can return mock data, this method is only executed when an RpcException is thrown. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;mock data&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>If the service consumer often needs <code>try-catch</code> to catch exceptions, 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-java" data-lang="java"><span style="display:flex;"><span>Offer offer <span style="color:#719e07">=</span> <span style="color:#cb4b16">null</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> offer <span style="color:#719e07">=</span> offerService<span style="color:#719e07">.</span>findOffer<span style="color:#719e07">(</span>offerId<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>RpcException e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> logger<span style="color:#719e07">.</span>error<span style="color:#719e07">(</span>e<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Consider changing to Mock implementation and return null in Mock implementation. If you just want to simply ignore the exception, <code>2.0.11</code> version or later version is available:</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> mock=<span style="color:#2aa198">&#34;return null&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="advanced-usage">Advanced Usage</h2> |
| <h3 id="return">return</h3> |
| <p><code>return</code> can be used to return an object&rsquo;s string representation as the mocked return value. The legal values incude:</p> |
| <ul> |
| <li><em>empty</em>: empty value, default value for primary type, and empty value for collections.</li> |
| <li><em>null</em>: <code>null</code></li> |
| <li><em>true</em>: <code>true</code></li> |
| <li><em>false</em>: <code>false</code></li> |
| <li><em>JSON format</em>: a mocked return value in JSON format, will be deserialized at runtime</li> |
| </ul> |
| <h3 id="throw">throw</h3> |
| <p><code>throw</code> can be used to throw an exception object as the mocked return value.</p> |
| <p>Throw a default RPCException when invocation gets wrong:</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> mock=<span style="color:#2aa198">&#34;throw&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Throw a specified exception when invocation gets wrong:</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> mock=<span style="color:#2aa198">&#34;throw com.foo.MockException&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="force--fail">force &amp; fail</h3> |
| <p>Since <code>2.6.6</code> and above, it is possible to use <code>fail:</code> and <code>force:</code> in Spring&rsquo;s XML configuration to define mock behavior. <code>force:</code> means the mocked value is forced to use no matter the invocation gets wrong or not, in fact, the remote invocation will not happen at all. <code>fail:</code> is consistent with the default behavior, that is, mock happens only when invocation gets wrong. Futhermore, both <code>force:</code> and <code>fail:</code> can be used together with <code>throw</code> or <code>return</code> to define the mock behavior further.</p> |
| <p>Force to return the specified value:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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> mock=<span style="color:#2aa198">&#34;force:return fake&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Force to throw the specified exception:</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> mock=<span style="color:#2aa198">&#34;force:throw com.foo.MockException&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="specify-mock-for-particular-method-only">Specify Mock For Particular Method Only</h3> |
| <p>Mock behavior can be specified on the method level. Assume there are a couple of methods on <code>com.foo.BarService</code>, we can specify the mock behavior for one particular method only, say <code>sayHello()</code>. In the example below, &ldquo;fake&rdquo; is forced to return everytime when <code>sayHello()</code> is called, but other methods will not be effected:</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> id=<span style="color:#2aa198">&#34;demoService&#34;</span> check=<span style="color:#2aa198">&#34;false&#34;</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#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;sayHello.mock&#34;</span> value=<span style="color:#2aa198">&#34;force:return fake&#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><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Mock is a subset of the Stub. If you use Stub, you may need to rely on the RpcException class. If you use Mock, you do not need to rely on RpcException, when throwing RpcException, it will callback Mock implementation class.&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>BarServiceMock implements BarService and has a no-argument constructor.&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Delay Publish</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/delay-publish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/delay-publish/</guid><description> |
| <p>If your services need time to warm up, such as: initialization cache or another reference resources has to be ready. You can use the delay feature to delay publishing services. We fine-tuned the service delay exposure logic in Dubbo 2.6.5, delaying the countdown of services that require delayed exposure until Spring initialization is complete. You won&rsquo;t be aware of this change while using Dubbo, so please be assured that use.</p> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| Prior to Dubbo-2.6.5 |
| </div> |
| <h3 id="delay-five-second-publish">Delay five second publish</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:service</span> delay=<span style="color:#2aa198">&#34;5000&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="delay-until-spring-initialization-is-complete-before-exposing-the-service">Delay until Spring initialization is complete before exposing the service</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> delay=<span style="color:#2aa198">&#34;-1&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| Dubbo-2.6.5 and later |
| </div> |
| <p>All services will be exposed after Spring initialization is complete, and you don&rsquo;t need to configure delay if you don&rsquo;t need to delay exposing the service.</p> |
| <h3 id="delay-five-second-publish-1">Delay five second publish</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:service</span> delay=<span style="color:#2aa198">&#34;5000&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="the-initialization-deadlock-problem-of-spring-2x">The initialization deadlock problem of Spring 2.x</h2> |
| <h3 id="trigger-condition">Trigger condition</h3> |
| <p>The service has already published when <code>Spring</code> parse the <code>&lt;dubbo:service /&gt;</code> element,but the <code>Spring</code> is still initializing other beans.If there is a request coming in, and the service implementation class has a call to <code>applicationContext.getBean ()</code> usage.</p> |
| <ol> |
| <li> |
| <p>Request thread applicationContext.getBean() call, the first synchronization <code>singletonObjects</code> determine whether the existence of the bean, the synchronization does not exist to initialize the <code>beanDefinitionMap</code>, and re-synchronize <code>singletonObjects</code> write Bean instance cache.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/lock-get-bean.jpg" alt="deadlock"></p> |
| </li> |
| <li> |
| <p>But the <code>Spring</code> initialization thread,because need to determine the <code>Bean</code> is exist,Directly synchronize beanDefinitionMap to initialize, and synchronize singletonObjects write Bean instance cache.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/lock-init-context.jpg" alt="/user-guide/images/lock-init-context.jpg"></p> |
| </li> |
| </ol> |
| <p>This will cause the getBean thread to lock the singletonObjects first, then lock the beanDefinitionMap, and lock the singletonObjects again.The Spring initialization thread, the first lock beanDefinitionMap, then lock singletonObjects. Reverse lock thread deadlock, can not provide services, can not start.</p> |
| <h3 id="avoid-ways">Avoid ways</h3> |
| <ol> |
| <li>It is highly recommended not to call applicationContext.getBean() in the service implementation class, all using Spring&rsquo;s beans using IoC injection.</li> |
| <li>If you really want to tune getBean(), you can put the configuration of Dubbo Spring final loading.</li> |
| <li>If you do not want to rely on the configuration order, you can use <code>&lt;dubbo:provider delay =&quot;-1&quot;/&gt;</code> to make Dubbo expose the service after the Spring container has been initialized.</li> |
| <li>If you use getBean() extensively, the equivalent of degenerating Spring to factory mode is to isolate Dubbo&rsquo;s service from a separate Spring container.</li> |
| </ol></description></item><item><title>Docs: Concurrency Control</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/concurrency-control/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/concurrency-control/</guid><description> |
| <h2 id="example-of-configuration">Example of configuration</h2> |
| <ul> |
| <li>Example 1: Control the concurrency of all method for a specified service interface at server-side</li> |
| </ul> |
| <p>Limit each method of <code>com.foo.BarService</code> to no more than 10 concurrent server-side executions (or take up thread pool threads):</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> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> executes=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li>Example 2: Control the concurrency of specified method for a specified service interface at server-side</li> |
| </ul> |
| <p>Limit the <code>sayHello</code> method of <code>com.foo.BarService</code> to no more than 10 concurrent server-side executions(or take up thread pool threads):</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> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;sayHello&#34;</span> executes=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:service&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li>Example 3: Control the concurrency of all method for a specified service interface at client-side |
| Limit each method of <code>com.foo.BarService</code> to no more than 10 concurrent client-side executions (or take up thread pool threads):</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> actives=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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> actives=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li>Example 4: Control the concurrency of specified method for a specified service interface at client-side |
| Limit the <code>sayHello</code> method of <code>com.foo.BarService</code> to no more than 10 concurrent client-side executions(or take up thread pool threads):</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;sayHello&#34;</span> actives=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:service&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;sayHello&#34;</span> actives=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:service&gt;</span> |
| </span></span></code></pre></div><p>If <code>&lt;dubbo:service&gt;</code> and <code>&lt;dubbo:reference&gt;</code> are both configured with <code>actives</code>,<code>&lt;dubbo:reference&gt;</code> is preferred.Ref to:<a href="../config-rule">Configuration coverage strategy</a>.</p> |
| <h2 id="load-balance">Load Balance</h2> |
| <p>You can config the <code>loadbalance</code> attribute with <code>leastactive</code> at server-side or client-side,then the framework will make consumer call the minimum number of concurrent one.</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> loadbalance=<span style="color:#2aa198">&#34;leastactive&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> loadbalance=<span style="color:#2aa198">&#34;leastactive&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Config connections</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/config-connections/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/config-connections/</guid><description> |
| <h2 id="control-connections-at-server-side">Control connections at server-side</h2> |
| <p>Limit server-side accept to no more than 10 connections</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> accepts=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="control-connections-at-client-side">Control connections at client-side</h2> |
| <p>Limit client-side creating connection to no more than 10 connections for interface <code>com.foo.BarService</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-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> connections=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> connections=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Warning</h4> |
| <p>If used default protocol(<code>dubbo</code> protocol), and the value of <code>connections</code> attribute is great than 0,then each service reference will has itself connection,else all service which belong to same remote server will share only one connection. In this framework,we called <code>private</code> connection or <code>share</code> connection.</p> |
| <p>If <code>&lt;dubbo:service&gt;</code> and <code>&lt;dubbo:reference&gt;</code> are both configured accepts/connections,<code>&lt;dubbo:reference&gt;</code> is preferred, refer to <a href="../../configuration/xml/">Configuration coverage strategy</a>.</p> |
| <p>Because connection is connect on Server, so configure on provider side.</p> |
| </div></description></item><item><title>Docs: Lazy Connect</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/lazy-connect/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/lazy-connect/</guid><description> |
| <p>Lazy connect can reduce the number of keep-alive connections. When a call is initiated, create a keep-alive connection.<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-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> lazy=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Note: This configuration takes effect only for dubbo protocols that use keep-alive connections.&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Stickiness Connection</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/stickiness/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/stickiness/</guid><description> |
| <p>Sticky connections are used for stateful services, as much as possible so that clients always make calls to the same provider, unless the provider hangs up and connects to the other one.</p> |
| <p>Sticky connections will automatically open <a href="../lazy-connect">Lazy Connection</a> to reduce the number of long connections.</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> id=<span style="color:#2aa198">&#34;xxxService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.XxxService&#34;</span> sticky=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Dubbo supports method-level sticky connection, and if you want more granular control, you can also configure 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;dubbo:reference</span> id=<span style="color:#2aa198">&#34;xxxService&#34;</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;sayHello&#34;</span> sticky=<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></description></item><item><title>Docs: Token Authorization</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/token-authorization/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/token-authorization/</guid><description> |
| <p>Through the token authorization control center at the registry to decide whether to issue tokens to consumers, you can prevent consumers from bypassing the registry access provider, another through the registry can flexibly change the authorization without modification or upgrade provider</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-token.jpg" alt="/user-guide/images/dubbo-token.jpg"></p> |
| <p>You can turn on token authentication globally:</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;!--Random token , generated using a UUID--&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> token=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!--Fixed token, equivalent to the password--&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> token=<span style="color:#2aa198">&#34;123456&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Of course can turn on token authentication at service level:</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;!--Random token , generated using a UUID--&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> token=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!--Fixed token, equivalent to the password--&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> token=<span style="color:#2aa198">&#34;123456&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Also can turn on token authentication at protocol level:</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;!--Random token , generated using a UUID--&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> token=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!--Fixed token, equivalent to the password--&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> token=<span style="color:#2aa198">&#34;123456&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Routing Rule</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/routing-rule/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/routing-rule/</guid><description> |
| <p>The routing rules <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> determine the target server of one service call. It has two kinds of routing rules: conditional routing rules and script routing rules. It also support extension<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup>.</p> |
| <h2 id="write-routing-rules">Write Routing Rules</h2> |
| <p>Writing routing rules to the registry is usually done by the monitoring center or the console page.</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>RegistryFactory registryFactory <span style="color:#719e07">=</span> ExtensionLoader<span style="color:#719e07">.</span>getExtensionLoader<span style="color:#719e07">(</span>RegistryFactory<span style="color:#719e07">.</span>class<span style="color:#719e07">).</span>getAdaptiveExtension<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>Registry registry <span style="color:#719e07">=</span> registryFactory<span style="color:#719e07">.</span>getRegistry<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://10.20.153.10:2181&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>register<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;route://0.0.0.0/com.foo.BarService?category=routers&amp;dynamic=false&amp;rule=&#34;</span> <span style="color:#719e07">+</span> URL<span style="color:#719e07">.</span>encode<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;host = 10.20.153.10 =&gt; host = 10.20.153.11&#34;</span><span style="color:#719e07">)));</span> |
| </span></span></code></pre></div><p>其中：</p> |
| <ul> |
| <li><code>route://</code> It indicates the type of routing rules, supports routing rules and script routing rules, and can be extended. <strong>Required</strong>。</li> |
| <li><code>0.0.0.0</code> It indicates that all IP addresses are valid. If you want to take effect for only one IP address, fill in the IP address. <strong>Required</strong>。</li> |
| <li><code>com.foo.BarService</code> It indicates that the specified service is effective. <strong>Required</strong>。</li> |
| <li><code>group=foo</code> It indicates that the specified service in specified group is effective. When absent, the specified service which dosen&rsquo;t configure group is effective.</li> |
| <li><code>version=1.0</code>It indicates that the specified service in specified version is effective. When absent, the specified service which dosen&rsquo;t configure version is effective.</li> |
| <li><code>category=routers</code> It indicates that the data is a dynamic configuration type. <strong>Required</strong>。</li> |
| <li><code>dynamic=false</code> It indicates that it is persistent data. When the registrant exits, the data is still stored in the registry. <strong>Required</strong>。</li> |
| <li><code>enabled=true</code> It indicates whether this routing rules is effective. Option, and default effective.</li> |
| <li><code>force=false</code> It indicates whether it is forced to be executed when the routing result is null. If it is not enforced, the route will be automatically invalidated. Option, and default <code>false</code>.</li> |
| <li><code>runtime=false</code> It indicates whether to execute routing rules at every call. If not, the result is only pre-executed and cached when the provider&rsquo;s address list changes. It will get routing result from cache when the service is invoked. If you use parameter routing, you must to configure it as <code>true</code>. Be careful that the configuration will affect the performance. Option, and default <code>false</code>.</li> |
| <li><code>priority=1</code> The priority of the routing rules. it is used for sorting, the greater the priority, the more front execution. Option, and default <code>0</code>。</li> |
| <li><code>rule=URL.encode(&quot;host = 10.20.153.10 =&gt; host = 10.20.153.11&quot;)</code> It indicates the content of routing rule，<strong>Required</strong>。</li> |
| </ul> |
| <h2 id="conditional-routing-rules">Conditional routing rules</h2> |
| <p>Routing rules based on conditional expressions, such as：<code>host = 10.20.153.10 =&gt; host = 10.20.153.11</code></p> |
| <h3 id="rules">Rules：</h3> |
| <ul> |
| <li>The previous of <code>=&gt;</code> is matched condition for consumer. All parameters compare with URL of consumers. When the consumer meet the condition, it will continue to execute the behind filter rules for consumer.</li> |
| <li>After the <code>=&gt;</code> aims to filter the provider address list. All the parameters are compared against the provider&rsquo;s URL, and consumer get only the filtered address list at finally.</li> |
| <li>If the previous condition for consumer is empty, it means all consumers can matched. such as : <code>=&gt; host != 10.20.153.11</code></li> |
| <li>If the filter condition for provider is empty, it means it is forbidden to visit. such as :<code>host = 10.20.153.10 =&gt;</code></li> |
| </ul> |
| <h3 id="expressions">Expressions：</h3> |
| <p>Parameter Support：</p> |
| <ul> |
| <li>Service call information, such as: method, argument etc. Parameter routing is currently not supported</li> |
| <li>URL field (On URL own), such as: protocol, host, port etc.</li> |
| <li>All parameters on the URL. such as: application, organization etc.</li> |
| </ul> |
| <p>Condition Support：</p> |
| <ul> |
| <li>Equal sign <code>=</code> indicates match. such as: <code>host = 10.20.153.10</code></li> |
| <li>Not equal sign <code>!=</code> indicates &ldquo;does not match&rdquo;. such as: <code>host != 10.20.153.10</code>.</li> |
| </ul> |
| <p>Value Support：</p> |
| <ul> |
| <li>Separate multiple values with a comma <code>,</code> . Such as：<code>host != 10.20.153.10,10.20.153.11</code></li> |
| <li>End with <code>*</code> to indicate wildcard. Such as： <code>host != 10.20.*</code></li> |
| <li>Start with <code>$</code> to indicate reference to consumer parameters. Such as: <code>host = $host</code></li> |
| </ul> |
| <h3 id="samples">Samples</h3> |
| <ol start="0"> |
| <li> |
| <p>Exclude pre-release machine：</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>=&gt; host != 172.22.3.91 |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Whitelist <sup id="fnref:3"><a href="#fn:3" class="footnote-ref" role="doc-noteref">3</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-fallback" data-lang="fallback"><span style="display:flex;"><span>register.ip != 10.20.153.10,10.20.153.11 =&gt; |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Blacklist：</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>register.ip = 10.20.153.10,10.20.153.11 =&gt; |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Service boarding application only expose part of the machine to prevent the entire cluster hanging up:</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>=&gt; host = 172.22.3.1*,172.22.3.2* |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Additional machines for important applications：</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>application != kylin =&gt; host != 172.22.3.95,172.22.3.96 |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Read and write separation：</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>method = find*,list*,get*,is* =&gt; host = 172.22.3.94,172.22.3.95,172.22.3.96 |
| </span></span><span style="display:flex;"><span>method != find*,list*,get*,is* =&gt; host = 172.22.3.97,172.22.3.98 |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Separation of Front and Background 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>application = bops =&gt; host = 172.22.3.91,172.22.3.92,172.22.3.93 |
| </span></span><span style="display:flex;"><span>application != bops =&gt; host = 172.22.3.94,172.22.3.95,172.22.3.96 |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Isolate different network segments：</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>host != 172.22.3.* =&gt; host != 172.22.3.* |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Providers and consumers deployed in the same cluster, the machine only visit the local service：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>=&gt; host = $host |
| </span></span></code></pre></div></li> |
| </ol> |
| <h2 id="script-routing-rules">Script routing rules</h2> |
| <p>Script routing rules <sup id="fnref:4"><a href="#fn:4" class="footnote-ref" role="doc-noteref">4</a></sup> support all scripts of JDK script engine. such as: javascript, jruby, groovy, etc. Configure the script type by <code>type=javascript</code>, the default is javascript.</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>&#34;script://0.0.0.0/com.foo.BarService?category=routers&amp;dynamic=false&amp;rule=&#34; + URL.encode(&#34;(function route(invokers) { ... } (invokers))&#34;) |
| </span></span></code></pre></div><p>Routing rules that base on script engine is as follow：</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-javascript" data-lang="javascript"><span style="display:flex;"><span>(<span style="color:#268bd2">function</span> route(invokers) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">var</span> result <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> java.util.ArrayList(invokers.size()); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (i <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span>; i <span style="color:#719e07">&lt;</span> invokers.size(); i <span style="color:#719e07">++</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#2aa198">&#34;10.20.153.10&#34;</span>.equals(invokers.get(i).getUrl().getHost())) { |
| </span></span><span style="display:flex;"><span> result.add(invokers.get(i)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> result; |
| </span></span><span style="display:flex;"><span>} (invokers)); <span style="color:#586e75">// Indicates that the method is executed immediately |
| </span></span></span></code></pre></div><h2 id="tag-routing-rules">Tag routing rules</h2> |
| <p>Tag routing rules <sup id="fnref:5"><a href="#fn:5" class="footnote-ref" role="doc-noteref">5</a></sup> , when the application configures the <code>TagRouter</code> , a tagged dubbo invocation can intelligently route to the service provider which has the corresponding tag.</p> |
| <h3 id="provider">Provider</h3> |
| <ol> |
| <li>configure TagRouter for the application</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-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> ApplicationConfig <span style="color:#268bd2">applicationConfig</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ApplicationConfig applicationConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> applicationConfig<span style="color:#719e07">.</span>setName<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;provider-book&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> applicationConfig<span style="color:#719e07">.</span>setQosEnable<span style="color:#719e07">(</span><span style="color:#cb4b16">false</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// instruct tag router |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span>String<span style="color:#719e07">&gt;</span> parameters <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> parameters<span style="color:#719e07">.</span>put<span style="color:#719e07">(</span>Constants<span style="color:#719e07">.</span>ROUTER_KEY<span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;tag&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> applicationConfig<span style="color:#719e07">.</span>setParameters<span style="color:#719e07">(</span>parameters<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> applicationConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ol start="2"> |
| <li>configure specfic tag for the provider</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-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> ProviderConfig <span style="color:#268bd2">providerConfig</span><span style="color:#719e07">(){</span> |
| </span></span><span style="display:flex;"><span> ProviderConfig providerConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProviderConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> providerConfig<span style="color:#719e07">.</span>setTag<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;red&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> providerConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>The application which configures no tag will be considered as the default application, and these default apps will be treated as downgrades when the invocation fails to match the provider.</p> |
| <h3 id="consumer">Consumer</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span>RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>setAttachment<span style="color:#719e07">(</span>Constants<span style="color:#719e07">.</span>TAG_KEY<span style="color:#719e07">,</span><span style="color:#2aa198">&#34;red&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><p>The scope of the <code>dubbo.tag</code> is for each invocation, using the attachment to pass the request tag. Note that the value stored in the attachment will be passed continuously in a complete remote invocation, thanks to this feature, we only need to set the tag at the beginning of a invocation.</p> |
| <blockquote> |
| <p>Currently, only <strong>hardcoding</strong> is supported to set dubboTag. Note that RpcContext is thread-bound, elegantly using the TagRouter feature, it is recommended to set the request tag via a servlet filter (in the web environment) or a custom dubbo SPI filter.</p> |
| </blockquote> |
| <h3 id="rules-1">Rules:</h3> |
| <ol> |
| <li> |
| <p><code>dubbo.tag=red</code> will firstlt choose the provider which configures as <code>tag=red</code>. If there is no service corresponding to the request tag in the cluster, it will downgrade to <code>tag=null</code> provider, seen as default provider。</p> |
| </li> |
| <li> |
| <p>when <code>dubbo.tag=null</code>, only <code>tag=null</code> provider will be matched. Even if there are services available in the cluster, the tags do not match, they cannot be called. This is different from rule 1. Tagged invocation can be downgraded to untagged services, but invocations that do not carry tags/carry other types of tags can never be accessed other tag services.</p> |
| </li> |
| </ol> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Support since <code>2.2.0</code>&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>Routing Rules Extension Point: <a href="https://dubbo.apache.org/en/docs/v2.7/dev/impls/router/">Route Extension</a>&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:3"> |
| <p>Note: A service can only have one whitelist rule, otherwise the two rules will be filtered out.&#160;<a href="#fnref:3" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:4"> |
| <p>Note: Scripts have no sandbox constraints, can execute arbitrary code, and poses a backdoor risk.&#160;<a href="#fnref:4" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:5"> |
| <p>Support since <code>2.7.0</code>&#160;<a href="#fnref:5" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Configure rule</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/config-rule/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/config-rule/</guid><description> |
| <p>Write then dynamic configuration to the registry center,This feature is usually done by the monitoring center or the center&rsquo;s page.</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>RegistryFactory registryFactory <span style="color:#719e07">=</span> ExtensionLoader<span style="color:#719e07">.</span>getExtensionLoader<span style="color:#719e07">(</span>RegistryFactory<span style="color:#719e07">.</span>class<span style="color:#719e07">).</span>getAdaptiveExtension<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>Registry registry <span style="color:#719e07">=</span> registryFactory<span style="color:#719e07">.</span>getRegistry<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://10.20.153.10:2181&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>register<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;override://0.0.0.0/com.foo.BarService?category=configurators&amp;dynamic=false&amp;application=foo&amp;timeout=1000&#34;</span><span style="color:#719e07">));</span> |
| </span></span></code></pre></div><p>In the config override url：</p> |
| <ul> |
| <li><code>override://</code> Indicates that the data is overwritten,support <code>override</code> and <code>absent</code>，can extends，<strong>Required</strong>.</li> |
| <li><code>0.0.0.0</code> Indicates that the configurations is valid for all IP addresses，If only want to overwritten specified ip data,you can replace that specified ip address.<strong>Required</strong>.</li> |
| <li><code>com.foo.BarService</code> Indicates that is valid for specified service,<strong>Required</strong>.</li> |
| <li><code>category=configurators</code> Indicates that the data is dynamic configuration,<strong>Required</strong>。</li> |
| <li><code>dynamic=false</code> Indicates that the data is persistent,When the registered party withdraws,the data is still stored in the registry <strong>Required</strong>。</li> |
| <li><code>enabled=true</code> override strategy is enable,can absent,if absent,then enable.</li> |
| <li><code>application=foo</code> Indicates that is valid for specified application,can absent,if absent,then valid for all application.</li> |
| <li><code>timeout=1000</code> Indicates that the value of the <code>timeout</code> parameter that satisfies the above conditions is overwritten by 1000,if want to override another parameters, add directly to the <code>override</code> URL parameter.</li> |
| </ul> |
| <p>Example：</p> |
| <ol> |
| <li> |
| <p>Disable service provider.(Usually used to temporarily kick off a provider machine, similar to the prohibition of consumer access, please use the routing rules)</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>override://10.20.153.10/com.foo.BarService?category=configurators&amp;dynamic=false&amp;disbaled=true |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Adjustment weight:(Usually used to capacity assessment,default is 100)</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>override://10.20.153.10/com.foo.BarService?category=configurators&amp;dynamic=false&amp;weight=200 |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Adjustment load balance strategy.(default random)</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>override://10.20.153.10/com.foo.BarService?category=configurators&amp;dynamic=false&amp;loadbalance=leastactive |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Service downgrade:(Usually used to temporarily mask an error of non-critical 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-fallback" data-lang="fallback"><span style="display:flex;"><span>override://0.0.0.0/com.foo.BarService?category=configurators&amp;dynamic=false&amp;application=foo&amp;mock=force:return+null |
| </span></span></code></pre></div></li> |
| </ol> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Notice</h4> |
| supported on <code>2.2.0</code> or above. |
| </div></description></item><item><title>Docs: Service Downgrade</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/service-downgrade/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/service-downgrade/</guid><description> |
| <p>You can temporarily shield a non-critical service through the service downgrade and define the return policy for it.</p> |
| <p>Publish dynamic configuration rule to the registry:</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>RegistryFactory registryFactory <span style="color:#719e07">=</span> ExtensionLoader<span style="color:#719e07">.</span>getExtensionLoader<span style="color:#719e07">(</span>RegistryFactory<span style="color:#719e07">.</span>class<span style="color:#719e07">).</span>getAdaptiveExtension<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>Registry registry <span style="color:#719e07">=</span> registryFactory<span style="color:#719e07">.</span>getRegistry<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://10.20.153.10:2181&#34;</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>register<span style="color:#719e07">(</span>URL<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;override://0.0.0.0/com.foo.BarService?category=configurators&amp;dynamic=false&amp;application=foo&amp;mock=force:return+null&#34;</span><span style="color:#719e07">));</span> |
| </span></span></code></pre></div><ul> |
| <li> |
| <p>The configuration <code>mock=force:return+null</code> means that all calls of this service will return null value directly,without making remote calls.Usually used to reduce the effect of some slow non-critical services.</p> |
| </li> |
| <li> |
| <p>Also you can change that configuration to <code>mock=fail:return+null</code>.Then you will get null value after a failed call.Consumer will try to make a remote call to get the truely result if succeed,and if the call failed you will get null value.Usually used to tolerate some non-critical services.</p> |
| </li> |
| </ul></description></item><item><title>Docs: Graceful Shutdown</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/graceful-shutdown/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/graceful-shutdown/</guid><description> |
| <p>Dubbo is graceful shutdown through the <code>ShutdownHook</code> of the JDK, so graceful shutdowns are not performed if you force shutdown the command, such as <code>kill -9 PID</code>, and will only be executed if <code>kill PID</code> is passed.</p> |
| <h2 id="howto">Howto</h2> |
| <h3 id="service-provider">Service provider</h3> |
| <ul> |
| <li>When stop, first marked as not receiving new requests, the new request directly return the error, so that the client retries other machines.</li> |
| <li>Then check thread pool thread is running, if any, waiting for all threads to complete execution, unless overtime, then forced to close.</li> |
| </ul> |
| <h3 id="service-consumer">Service consumer</h3> |
| <ul> |
| <li>When stop, No longer initiate a new request, all request on the client that got an error.</li> |
| <li>Then check the request has not returned the response, waiting for the response to return, unless overtime, then forced to close.</li> |
| </ul> |
| <h2 id="configuration-shutdown-wait-time">Configuration shutdown wait time</h2> |
| <p>Set graceful shutdown timeout, the default timeout is 10 seconds, if the overtime is forced to close.</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"># dubbo.properties</span> |
| </span></span><span style="display:flex;"><span>dubbo.service.shutdown.wait<span style="color:#719e07">=</span><span style="color:#2aa198">15000</span> |
| </span></span></code></pre></div><p>If ShutdownHook does not take effect, you can call it yourself, <strong>in tomcat, it is recommended by extending the ContextListener and call the following code for graceful shutdown</strong>：</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>DubboShutdownHook<span style="color:#719e07">.</span>destroyAll<span style="color:#719e07">();</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Hostname Binding</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/hostname-binding/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/hostname-binding/</guid><description> |
| <h2 id="lookup-order">Lookup order</h2> |
| <p>Default host IP lookup order：</p> |
| <ul> |
| <li>Get local address via <code>LocalHost.getLocalHost()</code>.</li> |
| <li>If it is <code>127. *</code> loopback address, then scan the network for host IP</li> |
| </ul> |
| <h2 id="host-configuration">Host configuration</h2> |
| <p>Registered address if it is not correct, such as the need to register public address, you can do this:</p> |
| <ol> |
| <li> |
| <p>edit <code>/etc/hosts</code> : add machinename and public ip, 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-fallback" data-lang="fallback"><span style="display:flex;"><span>test1 205.182.23.201 |
| </span></span></code></pre></div></li> |
| <li> |
| <p>in <code>dubbo.xml</code> add host address configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> host=<span style="color:#2aa198">&#34;205.182.23.201&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span></code></pre></div></li> |
| <li> |
| <p>or config that 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-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.protocol.host<span style="color:#719e07">=</span><span style="color:#2aa198">205.182.23.201</span> |
| </span></span></code></pre></div></li> |
| </ol> |
| <h2 id="port-configuration">Port configuration</h2> |
| <p>The default port and protocol:</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Protocol</th> |
| <th>Port</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>dubbo</td> |
| <td>20880</td> |
| </tr> |
| <tr> |
| <td>rmi</td> |
| <td>1099</td> |
| </tr> |
| <tr> |
| <td>http</td> |
| <td>80</td> |
| </tr> |
| <tr> |
| <td>hessian</td> |
| <td>80</td> |
| </tr> |
| <tr> |
| <td>webservice</td> |
| <td>80</td> |
| </tr> |
| <tr> |
| <td>memcached</td> |
| <td>11211</td> |
| </tr> |
| <tr> |
| <td>redis</td> |
| <td>6379</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>You can configure the port as follows:</p> |
| <ol> |
| <li> |
| <p>in <code>dubbo.xml</code> add port configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo: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></li> |
| <li> |
| <p>or config that 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-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.protocol.dubbo.port<span style="color:#719e07">=</span><span style="color:#2aa198">20880</span> |
| </span></span></code></pre></div></li> |
| </ol></description></item><item><title>Docs: Logger Strategy</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/logger-strategy/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/logger-strategy/</guid><description> |
| <p><code>2.2.1</code> or later, dubbo support log4j、slf4j、jcl、jdk adapters <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>, you can also explicitly configure the log output policy in the following ways:</p> |
| <ol> |
| <li> |
| <p>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>java -Ddubbo.application.logger<span style="color:#719e07">=</span>log4j |
| </span></span></code></pre></div></li> |
| <li> |
| <p>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-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.application.logger<span style="color:#719e07">=</span><span style="color:#2aa198">log4j</span> |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Configure in <code>dubbo.xml</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:application</span> logger=<span style="color:#2aa198">&#34;log4j&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></li> |
| </ol> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Custom Extensions: <a href="https://dubbo.apache.org/en/docs/v2.7/dev/impls/logger-adapter">logger-adapter</a>&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs: Access Log</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/accesslog/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/accesslog/</guid><description> |
| <p>If you want to log the access information for each provide service,you can turn on the <code>accesslog</code> switch,which like the access log of <code>Apache</code>.</p> |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Warning</h4> |
| The size of the access log maybe too much,please check the disk capacity. Now I will show you how to config the access log. |
| </div> |
| <h2 id="logging-by-logging-framework">Logging by logging framework</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> accesslog=<span style="color:#2aa198">&#34;true&#34;</span> ...<span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>The above configuration will turn on <code>accesslog</code> switch for all provide services,and logging the access log with logging framework(log4j/logback/slf4j&hellip;).You can config the logging framework of <code>logger</code> and <code>appender</code> for logging the access log.The simplest way is config logger name with <code>dubbo.accesslog</code>. The 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;appender</span> name=<span style="color:#2aa198">&#34;accesslogAppender&#34;</span> class=<span style="color:#2aa198">&#34;ch.qos.logback.core.rolling.RollingFileAppender&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;file&gt;</span>${loggingRoot}/accesslog/logging.log<span style="color:#268bd2">&lt;/file&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;encoding&gt;</span>${loggingCharset}<span style="color:#268bd2">&lt;/encoding&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;append&gt;</span>true<span style="color:#268bd2">&lt;/append&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;rollingPolicy</span> class=<span style="color:#2aa198">&#34;ch.qos.logback.core.rolling.TimeBasedRollingPolicy&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;FileNamePattern&gt;</span>${loggingRoot}/accesslog/%d{yyyyMMdd}/logging.log.%d{yyyyMMdd}%i.gz |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/FileNamePattern&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;MaxHistory&gt;</span>15<span style="color:#268bd2">&lt;/MaxHistory&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;TimeBasedFileNamingAndTriggeringPolicy</span> class=<span style="color:#2aa198">&#34;ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;MaxFileSize&gt;</span>1024MB<span style="color:#268bd2">&lt;/MaxFileSize&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/TimeBasedFileNamingAndTriggeringPolicy&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/rollingPolicy&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;layout</span> class=<span style="color:#2aa198">&#34;ch.qos.logback.classic.PatternLayout&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;pattern&gt;</span><span style="color:#719e07">&lt;![CDATA[%level|%d{yyyy-MM-dd HH:mm:ss}|%m%n}]]&gt;</span><span style="color:#268bd2">&lt;/pattern&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/layout&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/appender&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;logger</span> name=<span style="color:#2aa198">&#34;dubbo.accesslog&#34;</span> level=<span style="color:#2aa198">&#34;INFO&#34;</span> additivity=<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;appender-ref</span> ref=<span style="color:#2aa198">&#34;accesslogAppender&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/logger&gt;</span> |
| </span></span></code></pre></div><p>The above is the demonstration of logback framework.Other logging framework is same too. It will logging the access log of all provide services into single file(<code>accesslog/logging.log</code>). And you can also config the access log of each provide service to logging separately,Only change <code>name</code> attribute of the <code>logger</code> tag,set the <code>name</code> attribute to <code>dubbo.accesslog.serviceInterfaceClassFullName</code>.The 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;logger</span> name=<span style="color:#2aa198">&#34;dubbo.accesslog.com.dubbo.FooServiceInterface&#34;</span> level=<span style="color:#2aa198">&#34;INFO&#34;</span> additivity=<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;appender-ref</span> ref=<span style="color:#2aa198">&#34;fooServiceAccesslogAppender&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/logger&gt;</span> |
| </span></span></code></pre></div><p>If you only want logging the access log of specified provide service,but not all services, it&rsquo;s supported too.The 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:service</span> accesslog=<span style="color:#2aa198">&#34;true&#34;</span> ...<span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="logging-by-specified-file-path">Logging by specified file path</h2> |
| <p>You can specify the file path with the <code>accesslog</code> attribute.The 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> accesslog=<span style="color:#2aa198">&#34;/home/admin/logs/service/accesslog.log&#34;</span> ...<span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>OR</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> accesslog=<span style="color:#2aa198">&#34;/home/admin/logs/service/accesslog.log&#34;</span> ...<span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Service Container</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/service-container/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/service-container/</guid><description> |
| <p>The service container is a standalone launcher because the backend service does not require the functionality of a Web container ,such as Tomcat or JBoss. If you insist on using web containers to load service providers, that increase complexity and is waste of resources.</p> |
| <p>The service container is just a simple Main method and loads a simple Spring container to expose the service.</p> |
| <p>The content of Service container can be extended, built-in spring, jetty, log4j etc.. This can be expanded with <a href="https://dubbo.apache.org/en/docs/v2.7/dev/impls/container/">Container Extension Points</a>. Configure it with the -D parameter in the java command or <code>dubbo.properties</code>.</p> |
| <h2 id="container-type">Container type</h2> |
| <h3 id="spring-container">Spring Container</h3> |
| <ul> |
| <li> |
| <p>Automatically load all spring configurations in the <code>META-INF/spring</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-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.spring.config<span style="color:#719e07">=</span><span style="color:#2aa198">classpath*:META-INF/spring/*.xml</span> |
| </span></span></code></pre></div></li> |
| </ul> |
| <h3 id="jetty-container">Jetty Container</h3> |
| <ul> |
| <li>Start an embedded Jetty for reporting status.</li> |
| <li>Configure: |
| <ul> |
| <li><code>dubbo.jetty.port=8080</code>: configure jetty start up port</li> |
| <li><code>dubbo.jetty.directory=/foo/bar</code>: static file that can be visited by jetty directly.</li> |
| <li><code>dubbo.jetty.page=log,status,system</code>: configure the displayed page, loading all pages by default</li> |
| </ul> |
| </li> |
| </ul> |
| <h3 id="log4j-container">Log4j Container</h3> |
| <ul> |
| <li>Automatic configuration log4j configuration. At the start of the multi-process, log files automatically by process sub-directory.</li> |
| <li>Configure: |
| <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 log sub directory for multi-process startup and avoiding conflict</li> |
| </ul> |
| </li> |
| </ul> |
| <h2 id="container-startup">Container startup</h2> |
| <p>load spring 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>Load the container that passed in by the main method</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>Load the container that passed in by the JVM option.</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>Load the container that passed in by <code>dubbo.properties</code> in 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>Docs: ReferenceConfig Cache</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/reference-config-cache/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/reference-config-cache/</guid><description> |
| <p>The instance of <code>ReferenceConfig</code> is heavy. It encapsulates the connection to the registry and the connection to the provider, so it need to be cached. Otherwise, repeatedly generating <code>ReferenceConfig</code> may cause performance problems , memory and connection leaks. This problem is easy to ignored when programming in API mode.</p> |
| <p>Therefore, since <code>2.4.0</code>, dubbo provides a simple utility ReferenceConfigCache for caching instances of <code>ReferenceConfig</code>.</p> |
| <p>Use 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>ReferenceConfig<span style="color:#719e07">&lt;</span>XxxService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>XxxService<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>XxxService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">......</span> |
| </span></span><span style="display:flex;"><span>ReferenceConfigCache cache <span style="color:#719e07">=</span> ReferenceConfigCache<span style="color:#719e07">.</span>getCache<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// cache.get will cache the instance of Reference ，and call ReferenceConfig.get method to start ReferenceConfig |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>XxxService xxxService <span style="color:#719e07">=</span> cache<span style="color:#719e07">.</span>get<span style="color:#719e07">(</span>reference<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Note: Cache will hold ReferenceConfig, do not call destroy method of ReferenceConfig outside. If you do this, it will invalidate ReferenceConfig in Cache! |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// Use xxxService instance |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>xxxService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">();</span> |
| </span></span></code></pre></div><p>Destroy <code>ReferenceConfig</code> in the Cache, it also remove <code>ReferenceConfig</code> and release the corresponding resources。</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>ReferenceConfigCache cache <span style="color:#719e07">=</span> ReferenceConfigCache<span style="color:#719e07">.</span>getCache<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>cache<span style="color:#719e07">.</span>destroy<span style="color:#719e07">(</span>reference<span style="color:#719e07">);</span> |
| </span></span></code></pre></div><p>By default ,<code>ReferenceConfigCache</code> caches one <code> ReferenceConfig</code> for the same service Group, interface, version. The key of <code>ReferenceConfigCache</code> is from the group of service Group, interface, and the version.</p> |
| <p>You can modify the strategy. Define an instance of KeyGenerator, pass it as parameter of getCache method. Refer to <code>ReferenceConfigCache</code> for information。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>KeyGenerator keyGenerator <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> <span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span>ReferenceConfigCache cache <span style="color:#719e07">=</span> ReferenceConfigCache<span style="color:#719e07">.</span>getCache<span style="color:#719e07">(</span>keyGenerator <span style="color:#719e07">);</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Register Only</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/registry-only/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/registry-only/</guid><description> |
| <p>You have two mirroring environments, two registries. |
| You have deployed one service at only one of the registries, another registries have not had time to deploy, and other applications at both registries need to rely on the service. |
| At this time, the service provider registers service to another registrar, but the service consumers do not consume the service from another registrar.</p> |
| <p>Disable subscription configuration</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;hzRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.153.10:9090&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;qdRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090&#34;</span> subscribe=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;hzRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.153.10:9090&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;qdRegistry&#34;</span> address=<span style="color:#2aa198">&#34;10.20.141.150:9090?subscribe=false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Distributed transaction</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/distributed-transaction/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/distributed-transaction/</guid><description> |
| <p>Distributed transactions are based on the JTA / XA specification(this feature has not yet been implemented)</p> |
| <p>Two-phase commit:</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/jta-xa.jpg" alt="/user-guide/images/jta-xa.jpg"></p> |
| <p>In Dubbo, <a href="https://dubbo.apache.org/en/blog/2019/01/17/how-to-use-seata-to-ensure-consistency-between-dubbo-microservices/">Seate</a> can be used to support distributed transactions.</p></description></item><item><title>Docs: Thread Dump</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/dump/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/dump/</guid><description> |
| <p>When the business thread pool is full, we need to know what resources/conditions are waiting for the thread , to find the bottleneck point of the system or abnormal point. <code>dubbo</code> automatically export thread stack through <code>Jstack</code> to keep the scene for easy to troubleshoot the problem.</p> |
| <p>Default policy:</p> |
| <ul> |
| <li>Export file path，user.home directory</li> |
| <li>Export interval，The shortest interval allows you to export every 10 minutes</li> |
| </ul> |
| <p>Specified export file path:</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"># dubbo.properties</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.dump.directory<span style="color:#719e07">=</span><span style="color:#2aa198">/tmp</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:application</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;dump.directory&#34;</span> value=<span style="color:#2aa198">&#34;/tmp&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:application&gt;</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Netty4</title><link>https://dubbo.apache.org/en/docs/v2.7/user/examples/netty4/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/user/examples/netty4/</guid><description> |
| <p>Add support for netty4 communication module in 2.5.6 version of dubbo, enabled as follows:</p> |
| <p>provider：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> server=<span style="color:#2aa198">&#34;netty4&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> server=<span style="color:#2aa198">&#34;netty4&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>consumer：</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> client=<span style="color:#2aa198">&#34;netty4&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div> |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Warning</h4> |
| <ol> |
| <li> |
| <p>If provider need to use different communication layer framework for different protocols , please configure multiple protocols separately.</p> |
| </li> |
| <li> |
| <p>consumer configuration as follow：</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> client=<span style="color:#2aa198">&#34;netty&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:consumer&gt;</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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:consumer</span> client=<span style="color:#2aa198">&#34;netty4&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:consumer&gt;</span> |
| </span></span></code></pre></div></li> |
| </ol> |
| <p>Next we will continue to do something：We will provide a reference data on the performance test indicators and performance test comparison with the version of netty 3.</p> |
| </div></description></item></channel></rss> |
