| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Configuration Framework and Service Behavior</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/</link><description>Recent content in Configuration Framework and Service Behavior on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs3-V2: Check at startup</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/preflight-check/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/preflight-check/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>By default, Dubbo will check whether the dependent service is available at startup, and will throw an exception when it is unavailable, preventing Spring initialization from completing, so that problems can be detected early when going online. The default <code>check=&quot;true&quot;</code>.</p> |
| <p>Checking can be turned off by <code>check=&quot;false&quot;</code>. For example, when testing, some services do not care, or there is a circular dependency, and one of them must be started first.</p> |
| <p>In addition, if your Spring container is lazy-loaded, or if you delay the reference service through API programming, please turn off check, otherwise when the service is temporarily unavailable, an exception will be thrown and a null reference will be obtained. If <code>check=&quot;false&quot;</code>, always Yes, it will return the reference, and when the service is restored, it can be connected automatically.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <ul> |
| <li>One-way dependency: with dependency (recommended default setting) and without dependency (check=false can be set)</li> |
| <li>Interdependence: that is, circular dependency, (it is not recommended to set check=false)</li> |
| <li>Lazy loading handling</li> |
| </ul> |
| <blockquote> |
| <p>check is only used to check at startup, if there is no corresponding dependency at runtime, an error will still be reported.</p> |
| </blockquote> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="via-spring-configuration-file">via spring configuration file</h3> |
| <p>Turn off startup checks for a service</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.foo.BarService&#34;</span> check=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Turn off startup checks for all services</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:consumer</span> check=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Turn off registry checks at startup</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> check=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="via-dubboproperties">via dubbo.properties</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.reference.com.foo.BarService.check<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span><span style="display:flex;"><span>dubbo.consumer.check<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.check<span style="color:#719e07">=</span><span style="color:#2aa198">false</span> |
| </span></span></code></pre></div><h3 id="via-the--d-parameter">via the -D parameter</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>java -Ddubbo.reference.com.foo.BarService.check<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span><span style="display:flex;"><span>java -Ddubbo.consumer.check<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span><span style="display:flex;"><span>java -Ddubbo.registry.check<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span></code></pre></div><h2 id="meaning-of-configuration">Meaning of configuration</h2> |
| <p><code>dubbo.reference.com.foo.BarService.check</code>, overrides the check value of the reference of <code>com.foo.BarService</code>, even if there is a statement in the configuration, it will be overwritten.</p> |
| <p><code>dubbo.consumer.check=false</code> is the default value of <code>check</code> for setting reference. If there is an explicit statement in the configuration, such as: <code>&lt;dubbo:reference check=&quot;true&quot;/&gt;</code>, it will not be affected influences.</p> |
| <p><code>dubbo.registry.check=false</code>, the first two means that the subscription is successful, but whether the provider list is empty or whether an error is reported, if the registration subscription fails, it is also allowed to start, you need to use this option, and will retry periodically in the background .</p></description></item><item><title>Docs3-V2: Distributed Transactions</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/transaction/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/transaction/</guid><description> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="first-step"><strong>First step</strong></h3> |
| <p>First visit: <a href="https://seata.io/zh-cn/blog/download.html">https://seata.io/zh-cn/blog/download.html</a></p> |
| <p>Download the seata1.5.2 service we need to use</p> |
| <h3 id="second-step"><strong>Second step</strong></h3> |
| <ol> |
| <li>Add the undo_log table to your database participating in global transactions (TCC, SAGA, XA can skip this step)</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sql" data-lang="sql"><span style="display:flex;"><span><span style="color:#586e75">-- for AT mode you must to init this sql for you business database. the seata server not need it. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>undo_log<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>(<span style="color:#2aa198">20</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;branch transaction id&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">100</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;global transaction id&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>context<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;undo_log context, such as serialization&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>rollback_info<span style="color:#719e07">`</span> LONGBLOB <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;rollback info&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_status<span style="color:#719e07">`</span> <span style="color:#b58900">INT</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;0: normal status,1: defense status&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_created<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;create datetime&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_modified<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> <span style="color:#719e07">COMMENT</span> <span style="color:#2aa198">&#39;modify datetime&#39;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">UNIQUE</span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>ux_undo_log<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span>, <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> AUTO_INCREMENT <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8 <span style="color:#719e07">COMMENT</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">&#39;AT transaction mode undo table&#39;</span>; |
| </span></span></code></pre></div><ol start="2"> |
| <li>Create a library named seata in your mysql database, and use the following sql</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sql" data-lang="sql"><span style="display:flex;"><span><span style="color:#586e75">-- -------------------------------- The script used when storeMode is &#39;db&#39; ------- ------------------------- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">-- the table to store GlobalSession data |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>global_table<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>status<span style="color:#719e07">`</span> TINYINT <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>application_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_service_group<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_name<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>timeout<span style="color:#719e07">`</span> <span style="color:#b58900">INT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>begin_time<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>application_data<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">2000</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_create<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_gmt_modified_status<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span>, <span style="color:#719e07">`</span>status<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_transaction_id<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">-- the table to store BranchSession data |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>branch_table<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>resource_group_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>resource_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">256</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_type<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">8</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>status<span style="color:#719e07">`</span> TINYINT, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>client_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">64</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>application_data<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">2000</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_create<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span> DATETIME(<span style="color:#2aa198">6</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_xid<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">-- the table to store lock data |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>lock_table<span style="color:#719e07">`</span> |
| </span></span><span style="display:flex;"><span>( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>row_key<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">96</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>transaction_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span> <span style="color:#b58900">BIGINT</span> <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>resource_id<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">256</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span><span style="color:#719e07">table_name</span><span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">32</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>pk<span style="color:#719e07">`</span> <span style="color:#b58900">VARCHAR</span>(<span style="color:#2aa198">36</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_create<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>gmt_modified<span style="color:#719e07">`</span> DATETIME, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>row_key<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>idx_branch_id<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE <span style="color:#719e07">=</span> InnoDB |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">DEFAULT</span> CHARSET <span style="color:#719e07">=</span> utf8; |
| </span></span></code></pre></div><h3 id="third-step"><strong>third step</strong></h3> |
| <p>Introduce seata dependency into your project</p> |
| <p>spring-boot application:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span> &lt;dependency&gt; |
| </span></span><span style="display:flex;"><span> &lt;groupId&gt;io.seata&lt;/groupId&gt; |
| </span></span><span style="display:flex;"><span> &lt;artifactId&gt;seata-spring-boot-starter&lt;/artifactId&gt; |
| </span></span><span style="display:flex;"><span> &lt;version&gt;1.5.2&lt;/version&gt; |
| </span></span><span style="display:flex;"><span> &lt;/dependency&gt; |
| </span></span></code></pre></div><p>spring application:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span> &lt;dependency&gt; |
| </span></span><span style="display:flex;"><span> &lt;groupId&gt;io.seata&lt;/groupId&gt; |
| </span></span><span style="display:flex;"><span> &lt;artifactId&gt;seata-all&lt;/artifactId&gt; |
| </span></span><span style="display:flex;"><span> &lt;version&gt;1.5.2&lt;/version&gt; |
| </span></span><span style="display:flex;"><span> &lt;/dependency&gt; |
| </span></span></code></pre></div><h3 id="the-fourth-step"><strong>the fourth step</strong></h3> |
| <p>spring-boot application:</p> |
| <p>Reference <a href="https://github.com/seata/seata/tree/develop/script/client/spring">seata/script/client/spring at develop seata/seata (github.com)</a></p> |
| <p>Add it to your project&rsquo;s application.yml.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">seata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">enabled</span>: <span style="color:#cb4b16">true</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application-id</span>: applicationName |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">tx-service-group</span>: my_test_tx_group |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">enable-auto-data-source-proxy</span>: <span style="color:#cb4b16">true</span> <span style="color:#586e75">#Only AT and XA modes need to be true, and the data source will be automatically proxied after opening</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">data-source-proxy-mode</span>: AT <span style="color:#586e75">#Optional AT&amp;XA</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">config</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">serverAddr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">data-id</span>: seata.properties |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registry</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: seata-server |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">server-addr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: <span style="color:#2aa198">&#34;nacos&#34;</span> |
| </span></span></code></pre></div><p>spring application:</p> |
| <p>Add <a href="https://github.com/seata/seata/tree/develop/script/client/conf">seata/script/client/conf at develop · seata/seata (github.com)</a> under registry.conf, because High-availability deployment uses a third-party configuration center, so file.conf is not required</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>registry { |
| </span></span><span style="display:flex;"><span> # file, nacos, eureka, redis, zk, consul, etcd3, sofa, custom |
| </span></span><span style="display:flex;"><span> type = &#34;nacos&#34; |
| </span></span><span style="display:flex;"><span> nacos { |
| </span></span><span style="display:flex;"><span> application = &#34;seata-server&#34; |
| </span></span><span style="display:flex;"><span> serverAddr = &#34;127.0.0.1:8848&#34; |
| </span></span><span style="display:flex;"><span> group = &#34;SEATA_GROUP&#34; |
| </span></span><span style="display:flex;"><span> namespace = &#34;&#34; |
| </span></span><span style="display:flex;"><span> username = &#34;&#34; |
| </span></span><span style="display:flex;"><span> password = &#34;&#34; |
| </span></span><span style="display:flex;"><span> ##if use MSE Nacos with auth, mutex with username/password attribute |
| </span></span><span style="display:flex;"><span> #accessKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> #secretKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> ##if use Nacos naming meta-data for SLB service registry, specify nacos address pattern rules here |
| </span></span><span style="display:flex;"><span> #slbPattern = &#34;&#34; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>config { |
| </span></span><span style="display:flex;"><span> # file, nacos, apollo, zk, consul, etcd3, springCloudConfig, custom |
| </span></span><span style="display:flex;"><span> type = &#34;nacos&#34; |
| </span></span><span style="display:flex;"><span> nacos { |
| </span></span><span style="display:flex;"><span> serverAddr = &#34;127.0.0.1:8848&#34; |
| </span></span><span style="display:flex;"><span> namespace = &#34;&#34; |
| </span></span><span style="display:flex;"><span> group = &#34;SEATA_GROUP&#34; |
| </span></span><span style="display:flex;"><span> username = &#34;&#34; |
| </span></span><span style="display:flex;"><span> password = &#34;&#34; |
| </span></span><span style="display:flex;"><span> ##if use MSE Nacos with auth, mutex with username/password attribute |
| </span></span><span style="display:flex;"><span> #accessKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> #secretKey = &#34;&#34; |
| </span></span><span style="display:flex;"><span> dataId = &#34;seata.properties&#34; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="the-fifth-step"><strong>the fifth step</strong></h3> |
| <p>Run the nacos you downloaded, and refer to [https://github.com/seata/seata/tree/develop/script/config-center](<a href="https://gitee.com/link?target=https%3A%2F%25">https://gitee.com/link?target=https%3A%2F%</a> 2Fgithub.com%2Fseata%2Fseata%2Ftree%2Fdevelop%2Fscript%2Fconfig-center) and modify the config.txt</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75">#Only used by client</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">#The transaction group is called my_test_tx_group and the corresponding seata-server cluster is default</span> |
| </span></span><span style="display:flex;"><span>service.vgroupMapping.my_test_tx_group<span style="color:#719e07">=</span><span style="color:#2aa198">default</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">#The following are only used by server</span> |
| </span></span><span style="display:flex;"><span>store.mode<span style="color:#719e07">=</span><span style="color:#2aa198">db</span> |
| </span></span><span style="display:flex;"><span>store.db.datasource<span style="color:#719e07">=</span><span style="color:#2aa198">druid</span> |
| </span></span><span style="display:flex;"><span>store.db.dbType<span style="color:#719e07">=</span><span style="color:#2aa198">mysql</span> |
| </span></span><span style="display:flex;"><span>store.db.driverClassName<span style="color:#719e07">=</span><span style="color:#2aa198">com.mysql.jdbc.Driver</span> |
| </span></span><span style="display:flex;"><span>store.db.url<span style="color:#719e07">=</span><span style="color:#2aa198">jdbc:mysql://127.0.0.1:3306/seata?useUnicode=true</span> |
| </span></span><span style="display:flex;"><span>store.db.user<span style="color:#719e07">=</span><span style="color:#2aa198">username</span> |
| </span></span><span style="display:flex;"><span>store.db.password<span style="color:#719e07">=</span><span style="color:#2aa198">password</span> |
| </span></span><span style="display:flex;"><span>store.db.minConn<span style="color:#719e07">=</span><span style="color:#2aa198">5</span> |
| </span></span><span style="display:flex;"><span>store.db.maxConn<span style="color:#719e07">=</span><span style="color:#2aa198">30</span> |
| </span></span><span style="display:flex;"><span>store.db.globalTable<span style="color:#719e07">=</span><span style="color:#2aa198">global_table</span> |
| </span></span><span style="display:flex;"><span>store.db.branchTable<span style="color:#719e07">=</span><span style="color:#2aa198">branch_table</span> |
| </span></span><span style="display:flex;"><span>store.db.queryLimit<span style="color:#719e07">=</span><span style="color:#2aa198">100</span> |
| </span></span><span style="display:flex;"><span>store.db.lockTable<span style="color:#719e07">=</span><span style="color:#2aa198">lock_table</span> |
| </span></span><span style="display:flex;"><span>store.db.maxWait<span style="color:#719e07">=</span><span style="color:#2aa198">5000</span> |
| </span></span></code></pre></div><p>Open the nacos console, create a configuration whose dataId is seata.properties under the corresponding namespace, fill in the group as SEATA_GROUP, and fill in the above content and select the type as properties to save |
| <img src="https://dubbo.apache.org/imgs/blog/Dingtalk_20220724021635.jpg" alt="Dingtalk_20220724021635.jpg.png" style="zoom:50%;" /></p> |
| <h3 id="step-6"><strong>Step 6</strong></h3> |
| <p>Change application.yml in server</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">server</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">port</span>: <span style="color:#2aa198">7091</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">spring</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: seata-server |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">record</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">config</span>: classpath:logback-spring.xml |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">file</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">path</span>: ${user.home}/logs/seata |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">console</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">user</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: seata |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: seata |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">seata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">config</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75"># support: nacos, consul, apollo, zk, etcd3</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">server-addr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">##if use MSE Nacos with auth, mutex with username/password attribute</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#access-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#secret-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">data-id</span>: seata.properties |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registry</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75"># support: nacos, eureka, redis, zk, consul, etcd3, sofa</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">type</span>: nacos |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">nacos</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: seata-server |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">server-addr</span>: <span style="color:#2aa198">127.0.0.1</span>:<span style="color:#2aa198">8848</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">group</span>: SEATA_GROUP |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">namespace</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">cluster</span>: default |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#namespace: If the configuration is created in a non-default namespace, please fill in the id of the namespace here</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">##if use MSE Nacos with auth, mutex with username/password attribute</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#access-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">#secret-key: &#34;&#34;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># server:</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># service-port: 8091 #If not configured, the default is &#39;${server.port} + 1000&#39;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">security</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">secretKey</span>: SeataSecretKey0c382ef121d778043159209298fd40bf3850a017 |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">tokenValidityInMilliseconds</span>: <span style="color:#2aa198">1800000</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">ignore</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">urls</span>: /,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*. png, /**/*.ico, /console-fe/public/**, /api/v1/auth/login |
| </span></span></code></pre></div><h3 id="step-seven"><strong>Step Seven</strong></h3> |
| <p>An example of adding @GlobalTransactional to the interface of the global transaction caller (the service that initiates the global transaction) is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@GetMapping</span><span style="color:#719e07">(</span>value <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;testCommit&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@GlobalTransactional</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> Object <span style="color:#268bd2">testCommit</span><span style="color:#719e07">(</span><span style="color:#268bd2">@RequestParam</span><span style="color:#719e07">(</span>name <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;id&#34;</span><span style="color:#719e07">,</span>defaultValue <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1&#34;</span><span style="color:#719e07">)</span> Integer id<span style="color:#719e07">,</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@RequestParam</span><span style="color:#719e07">(</span>name <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;sum&#34;</span><span style="color:#719e07">,</span> defaultValue <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1&#34;</span><span style="color:#719e07">)</span> Integer sum<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Boolean ok <span style="color:#719e07">=</span> productService<span style="color:#719e07">.</span> <span style="color:#268bd2">reduceStock</span><span style="color:#719e07">(</span>id<span style="color:#719e07">,</span> sum<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(</span>ok<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> LocalDateTime now <span style="color:#719e07">=</span> LocalDateTime<span style="color:#719e07">.</span>now<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> Orders orders <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Orders<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> orders<span style="color:#719e07">.</span>setCreateTime<span style="color:#719e07">(</span>now<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> orders<span style="color:#719e07">.</span>setProductId<span style="color:#719e07">(</span>id<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> orders<span style="color:#719e07">.</span> <span style="color:#268bd2">setReplaceTime</span><span style="color:#719e07">(</span>now<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> orders<span style="color:#719e07">.</span> <span style="color:#268bd2">setSum</span><span style="color:#719e07">(</span>sum<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> orderService<span style="color:#719e07">.</span> <span style="color:#268bd2">save</span><span style="color:#719e07">(</span>orders<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;ok&#34;</span><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">return</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><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Spring applications need to manually proxy the data source to select the transaction mode and initialize the transaction scanner when using AT or XA mode</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Primary</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Bean</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dataSource&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> DataSource <span style="color:#268bd2">dataSource</span><span style="color:#719e07">(</span>DataSource druidDataSource<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//AT agent choose one of the two |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> DataSourceProxy<span style="color:#719e07">(</span>druidDataSource<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//XA Proxy |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> DataSourceProxyXA<span style="color:#719e07">(</span>druidDataSource<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">@Bean</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> GlobalTransactionScanner <span style="color:#268bd2">globalTransactionScanner</span><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> GlobalTransactionScanner<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;application name&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;my_test_tx_group&#34;</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 you use tcc mode, you need to additionally define two-stage try and confirm(commit) cancel(rollback) in the serviceimpl of the corresponding provider</p> |
| <p>The spring-boot application needs to close the data source proxy</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">seata</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">enable-auto-data-source-proxy</span>: <span style="color:#cb4b16">false</span> |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Define two-phase commit name = the bean name of the tcc, globally unique commitMethod = commit is the two-phase confirmation method rollbackMethod = rollback is the two-phase cancellation method |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * useTCCFence=true is to enable anti-hanging |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * BusinessActionContextParameter annotation to pass parameters to the second stage |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param params - input parameters |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return String |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@TwoPhaseBusinessAction</span><span style="color:#719e07">(</span>name <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;beanName&#34;</span><span style="color:#719e07">,</span> commitMethod <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;commit&#34;</span><span style="color:#719e07">,</span> rollbackMethod <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;rollback&#34;</span><span style="color:#719e07">,</span> useTCCFence <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:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">insert</span><span style="color:#719e07">(</span><span style="color:#268bd2">@BusinessActionContextParameter</span><span style="color:#719e07">(</span>paramName <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;params&#34;</span><span style="color:#719e07">)</span> Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> String<span style="color:#719e07">&gt;</span> params<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> logger<span style="color:#719e07">.</span>info<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;You can reserve resources here, or use the characteristics of tcc to mix with AT. In the second stage, use the messages stored here in the first stage and send them out through the second stage, such as redis, mq and other operations&#34;</span><span 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">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * The confirmation method can be named otherwise, but it must be consistent with the commitMethod. The context can pass the parameters of the try method |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param context context |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return boolean |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">commit</span><span style="color:#719e07">(</span>BusinessActionContext context<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> logger<span style="color:#719e07">.</span>info<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Reserved resources are actually processed, or send mq messages and redis storage&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Two-stage cancellation method |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param context context |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return boolean |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">rollback</span><span style="color:#719e07">(</span>BusinessActionContext context<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> logger<span style="color:#719e07">.</span>info<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Release reserved resources, or clear the message cache sent when the first phase is ready to be submitted by the second phase&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>linux/macos</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#b58900">cd</span> bin |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>sh seata-server.sh |
| </span></span></code></pre></div><p>windows</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#b58900">cd</span> bin |
| </span></span><span style="display:flex;"><span>./seata-server.bat |
| </span></span></code></pre></div><p>Run seata-server, after success, run your own service dubbo provider&amp;consumer</p> |
| <h3 id="the-eighth-step-is-to-build-a-highly-available-seata-server"><strong>The eighth step is to build a highly available Seata-server</strong></h3> |
| <p>Since seata-server supports the separation mode of computing and storage, and supports exposing service addresses to multiple registration centers, it only needs to be configured according to the sixth step and then expanded horizontally</p> |
| <p>For details, please visit: <a href="https://seata.io/">https://seata.io/</a></p></description></item><item><title>Docs3-V2: Group Aggregation</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/group-merger/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/group-merger/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Aggregate the results by grouping and return the aggregated results, such as menu service, use group to distinguish multiple implementations of the same interface, now the consumer needs to call once from each group and return the result, and return the result after merging, so You can implement aggregated menu items.</p> |
| <p>For relevant codes, please refer to <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-merge">Samples in the dubbo project</a></p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Service Grouping and Multiple Versions</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="search-all-groups">Search all groups</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span> merger=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="merge-specified-groups">Merge specified groups</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;aaa,bbb&#34;</span> merger=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="specify-method-merge">Specify method merge</h3> |
| <p>Combine the results of the specified method, and other unspecified methods will only call one Group</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;getMenuItems&#34;</span> merger=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><h3 id="a-method-is-not-merged">A method is not merged</h3> |
| <p>One method does not combine results, others combine results</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span> merger=<span style="color:#2aa198">&#34;true&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;getMenuItems&#34;</span> merger=<span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><h3 id="specify-merge-strategy">Specify merge strategy</h3> |
| <p>Specify the merge strategy, the default is to automatically match according to the return value type, if there are two combiners of the same type, you need to specify the name of the combiner [Merge result extension](../../../reference-manual/spi/ description/merger)</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;getMenuItems&#34;</span> merger=<span style="color:#2aa198">&#34;mymerge&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><h3 id="specify-merge-method">Specify merge method</h3> |
| <p>Specify the merge method to merge the specified method that returns the result of the call. The parameter type of the merge method must be the return result type itself</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> interface=<span style="color:#2aa198">&#34;com.xxx.MenuService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;getMenuItems&#34;</span> merger=<span style="color:#2aa198">&#34;.addAll&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><h4 id="hint">hint:</h4> |
| <p>Supported since <code>2.1.0</code> version</p></description></item><item><title>Docs3-V2: Port Protocol Multiplexing</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/port-unification/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/port-unification/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>By configuring the protocol, dubbo3 can support port protocol multiplexing. |
| For example, after using the Triple protocol to enable port multiplexing, you can add |
| Dubbo protocol support, and Qos protocol support. These protocols are identified by a unified port multiplexing |
| It can be used for service protocol migration, which is processed by the server, and can save ports and related resources and reduce the complexity of operation and maintenance.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/pu-server/pu-server-flow.png" alt="pu-server-image1"></p> |
| <ul> |
| <li> |
| <p>In the service creation phase, different Protocol objects are created for export by obtaining the protocol configuration exported by the service from the Config layer. in the process of exporting |
| In , if it is not the first time to create a server with port multiplexing, the Exchanger will save the data passed by the protocol layer to the server for subsequent processing of messages of this protocol type.</p> |
| </li> |
| <li> |
| <p>When the client&rsquo;s message is delivered, it will first be passed to the ProtocolDetector through the server. If the identification is completed, the client will be marked as the corresponding protocol. And configure the corresponding processing logic through WireProtocol, and finally hand it over to ChannelOperator to complete the binding of the underlying IO framework and the processing logic of the corresponding Dubbo framework.</p> |
| </li> |
| <li> |
| <p>After the above protocol identification is completed, the Channel has determined how to process the remote client message, and it can be processed through the corresponding ServerPipeline (the processing thread of the message will also be determined according to the configuration information during the processing).</p> |
| </li> |
| </ul> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p>[https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-port-unification](<a href="https://github.com/apache/dubbo-samples/tree/master/3-extensions/">https://github.com/apache/dubbo-samples/tree/master/3-extensions/</a> protocol/dubbo-samples-port-unification)</p> |
| <h2 id="configuration-method">configuration method</h2> |
| <p>For the configuration method supported by Dubbo, please refer to <a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/">Configuration Instructions</a></p> |
| <h3 id="service-multi-protocol-export">Service multi-protocol export</h3> |
| <p>The ext-protocol parameter supports configuring multiple different protocols, and the protocols are separated by &ldquo;,&rdquo;.</p> |
| <h4 id="xml-configuration">xml configuration</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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;-1&#34;</span> ext-protocol=<span style="color:#2aa198">&#34;tri,&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;greetingService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.provider.GreetingServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> delay=<span style="color:#2aa198">&#34;5000&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> group=<span style="color:#2aa198">&#34;greeting&#34;</span> timeout=<span style="color:#2aa198">&#34;5000&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.GreetingService&#34;</span> ref=<span style="color:#2aa198">&#34;greetingService&#34;</span> protocol=<span style="color:#2aa198">&#34;dubbo&#34;</span><span style="color:#268bd2">/ &gt;</span> |
| </span></span></code></pre></div><h4 id="api-configuration">API configuration</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ProtocolConfig config <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">(</span>CommonConstants<span style="color:#719e07">.</span>TRIPLE<span style="color:#719e07">,</span> <span style="color:#719e07">-</span>1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>config<span style="color:#719e07">.</span>setExtProtocol<span style="color:#719e07">(</span>CommonConstants<span style="color:#719e07">.</span>DUBBO<span style="color:#719e07">+</span><span style="color:#2aa198">&#34;,&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><h4 id="yaml-configuration">yaml configuration</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">dubbo</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: dubbo-springboot-demo-provider |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protocol</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: tri |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">port</span>: -<span style="color:#2aa198">1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">ext-protocol</span>: dubbo, |
| </span></span></code></pre></div><h4 id="properties-configuration">properties configuration</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">tri</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.ext-protocol<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo,</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">20880</span> |
| </span></span></code></pre></div><h3 id="qos-access">Qos access</h3> |
| <h4 id="qos-module-import">Qos module import</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-qos<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>After importing the Qos module, related configuration items can be configured by referring to <a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/qos/overview/">Qos Operation Manual</a> .</p> |
| <p>By default, the Qos service based on port multiplexing is started after the module is imported.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="qos-used">Qos used</h3> |
| <p>When the Qos protocol is connected to the port multiplexing scenario, after the connection is established, the client needs to send a message to the server first. Compared with the Qos protocol that provides services through a single port, the port multiplexing version of the Qos protocol handles the telnet connection. In some cases, the user needs to perform some operations to complete the protocol identification (choose one of the two).</p> |
| <ol> |
| <li> |
| <p>Call the command directly</p> |
| <p>The recognition can also be completed by directly calling the commands supported by telnet. If the user is not familiar with it, the help command can be called to complete the recognition.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/pu-server/qos-telnet-directcall.png" alt="pu-server-image2"></p> |
| </li> |
| <li> |
| <p>Send telnet command to identify</p> |
| <p>After establishing a connection through the telnet command, perform the following steps:</p> |
| <ol> |
| <li>Use crtl + &ldquo;]&rdquo; to enter the telnet interactive interface (telnet default escape character)</li> |
| <li>Call &ldquo;send ayt&rdquo; to send a special identification field to the server (a special field of the telnet protocol)</li> |
| <li>Press Enter to complete the message sending and enter the interactive interface of dubbo</li> |
| </ol> |
| <p><img src="https://dubbo.apache.org/imgs/blog/pu-server/qos-telnet-sendayt.png" alt="pu-server-imgs3"></p> |
| </li> |
| </ol> |
| <h3 id="service-reference">Service reference</h3> |
| <p>Based on the example in <a href="https://github.com/apache/dubbo-samples/tree/master/3-extensions/protocol/dubbo-samples-port-unification">dubbo-samples-port-unification</a>, quote The configuration of services of different protocols and non-port multiplexing is consistent. Next, the URL information in the calling process is output through the InvokerListener on the Consumer side.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ReferenceConfig<span style="color:#719e07">&lt;</span>GreetingService<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>reference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>GreetingService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setListener<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;consumer&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setProtocol<span style="color:#719e07">(</span><span style="color:#719e07">this</span><span style="color:#719e07">.</span>protocol<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// reference.setProtocol(CommonConstants.DUBBO); |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// reference.setProtocol(CommonConstants.TRIPLE); |
| </span></span></span></code></pre></div><p><img src="https://dubbo.apache.org/imgs/blog/pu-server/reference-service.png" alt="pu-server-imgs4"></p></description></item><item><title>Docs3-V2: Reactive Programming</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/reactive/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/reactive/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>This feature is implemented based on the Triple protocol and Project Reactor, and is supported in versions above <code>3.1.0</code>. Users only need to write the IDL file and specify the corresponding Generator of the protobuf plug-in to generate and use the Stub code that supports the responsive API.</p> |
| <p>There are four call modes, namely OneToOne, OneToMany, ManyToOne, and ManyToMany, corresponding to Unary calls, server streams, client streams, and bidirectional streams. In the implementation of Reactor, One corresponds to Mono, and Many corresponds to Flux.</p> |
| <h4 id="background">background</h4> |
| <p>Reactive Stream provides a set of standard asynchronous stream processing APIs. While allowing applications to write event-driven programs, it also ensures node stability through BackPressure. The Triple protocol adds support for streaming scenarios to the Dubbo framework at the communication protocol level. On this basis, it can realize the business requirements of the upper layer including large file transmission and push mechanisms.</p> |
| <p>The combined mode of Dubbo + Reactive Stream Stub can bring users the most convenient way of streaming and improve the asynchronous performance of the whole link.</p> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p>[https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-triple-reactor](<a href="https://github.com/apache/dubbo-samples/tree/master/3-extensions/">https://github.com/apache/dubbo-samples/tree/master/3-extensions/</a> protocol/dubbo-samples-triple-reactor)</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>The system needs to handle a large number of concurrent requests without overloading any servers. Systems with large numbers of users providing real-time data and want to ensure that the system can handle the load without crashing or slowing down.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <p>For Triple usage and configuration, please refer to <a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/protocol/triple/idl/">Using Triple in IDL</a>, and ensure that the Dubbo version&gt; = 3.1.0.</p> |
| <h3 id="add-the-necessary-dependencies">Add the necessary dependencies</h3> |
| <p>To use Reactor Triple, you need to add the following additional dependencies.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.reactivestreams<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>reactive-streams<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.projectreactor<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>reactor-core<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><h3 id="setup-protobuf-maven-plugin">Setup protobuf Maven plugin</h3> |
| <p>Just change mainClass to <code>org.apache.dubbo.gen.tri.reactive.ReactorDubbo3TripleGenerator</code> and make sure <code>${compiler.version}</code> &gt;= 3.1.0</p> |
| <div class="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;build&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;plugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.xolstice.maven.plugins<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>protobuf-maven-plugin<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.6.1<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;configuration&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;protocArtifact&gt;</span>com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier} |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/protocArtifact&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;pluginId&gt;</span>grpc-java<span style="color:#268bd2">&lt;/pluginId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;pluginArtifact&gt;</span>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier} |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/pluginArtifact&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;protocPlugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;protocPlugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;id&gt;</span>dubbo<span style="color:#268bd2">&lt;/id&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-compiler<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${compiler.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;mainClass&gt;</span>org.apache.dubbo.gen.tri.reactive.ReactorDubbo3TripleGenerator<span style="color:#268bd2">&lt;/mainClass&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/protocPlugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/protocPlugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/configuration&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;executions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;execution&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;goals&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;goal&gt;</span>compile<span style="color:#268bd2">&lt;/goal&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/goals&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/execution&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/executions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/plugins&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/build&gt;</span> |
| </span></span></code></pre></div><h3 id="write-and-compile-the-idl-file">Write and compile the IDL file</h3> |
| <p>The writing of the IDL file is completely consistent with the native Triple protocol, and the corresponding code will be seen in the <code>target/generated-sources/protobuf/java</code> directory by default after compilation.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-protobuf" data-lang="protobuf"><span style="display:flex;"><span>syntax <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;proto3&#34;</span>; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">option</span> java_multiple_files <span style="color:#719e07">=</span> <span style="color:#cb4b16">true</span>; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">package</span> org<span style="color:#719e07">.</span>apache.dubbo.samples.triple.reactor; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// The request message containing the user&#39;s name. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">message</span> <span style="color:#268bd2">GreeterRequest</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">string</span> name <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span>; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// The response message containing the greetings |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">message</span> <span style="color:#268bd2">GreeterReply</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">string</span> <span style="color:#268bd2">message</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span>; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">service</span> GreeterService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">rpc</span> greetOneToOne(GreeterRequest) <span style="color:#719e07">returns</span> (GreeterReply); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">rpc</span> greetOneToMany(GreeterRequest) <span style="color:#719e07">returns</span> (stream GreeterReply); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">rpc</span> greetManyToOne(stream GreeterRequest) <span style="color:#719e07">returns</span> (GreeterReply); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">rpc</span> greetManyToMany(stream GreeterRequest) <span style="color:#719e07">returns</span> (stream GreeterReply); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="use">use</h3> |
| <ol> |
| <li>Add server interface implementation</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:#719e07">package</span> org.apache.dubbo.samples.triple.reactor.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> org.apache.dubbo.samples.triple.reactor.DubboGreeterServiceTriple<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.triple.reactor.GreeterReply<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.triple.reactor.GreeterRequest<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.slf4j.Logger<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.slf4j.LoggerFactory<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> reactor.core.publisher.Flux<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">GreeterServiceImpl</span> <span style="color:#268bd2">extends</span> DubboGreeterServiceTriple<span style="color:#719e07">.</span>GreeterServiceImplBase <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">static</span> <span style="color:#268bd2">final</span> Logger LOGGER <span style="color:#719e07">=</span> LoggerFactory<span style="color:#719e07">.</span> <span style="color:#268bd2">getLogger</span><span style="color:#719e07">(</span>GreeterServiceImpl<span style="color:#719e07">.</span> class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Flux<span style="color:#719e07">&lt;</span>GreeterReply<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">greetManyToMany</span><span style="color:#719e07">(</span>Flux<span style="color:#719e07">&lt;</span>GreeterRequest<span style="color:#719e07">&gt;</span> request<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> request<span style="color:#719e07">.</span>doOnNext<span style="color:#719e07">(</span>req <span style="color:#719e07">-&gt;</span> LOGGER<span style="color:#719e07">.</span>info<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;greetManyToMany get data: {}&#34;</span><span style="color:#719e07">,</span> req<span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>map<span style="color:#719e07">(</span>req <span style="color:#719e07">-&gt;</span> GreeterReply<span style="color:#719e07">.</span> <span style="color:#268bd2">newBuilder</span><span style="color:#719e07">().</span> setMessage<span style="color:#719e07">(</span>req<span style="color:#719e07">.</span> <span style="color:#268bd2">getName</span><span style="color:#719e07">()</span> <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; -&gt; server get&#34;</span><span style="color:#719e07">).</span> build<span style="color:#719e07">())</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>doOnNext<span style="color:#719e07">(</span>res <span style="color:#719e07">-&gt;</span> LOGGER<span style="color:#719e07">.</span>info<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;greetManyToMany response data: {}&#34;</span><span style="color:#719e07">,</span> res<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><ol start="2"> |
| <li>Add the server interface startup class</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:#719e07">package</span> org.apache.dubbo.samples.triple.reactor<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.common.constants.CommonConstants<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ProtocolConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ServiceConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.triple.reactor.impl.GreeterServiceImpl<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">ReactorServer</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> <span style="color:#268bd2">static</span> <span style="color:#268bd2">final</span> <span style="color:#dc322f">int</span> PORT <span style="color:#719e07">=</span> 50052<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">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> ServiceConfig<span style="color:#719e07">&lt;</span>GreeterService<span style="color:#719e07">&gt;</span> reactorService <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> reactorService<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>GreeterService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> reactorService<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> GreeterServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> DubboBootstrap bootstrap <span style="color:#719e07">=</span> DubboBootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">getInstance</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> bootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">application</span><span style="color:#719e07">(</span><span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;tri-reactor-stub-server&#34;</span><span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>registry<span style="color:#719e07">(</span><span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>protocol<span style="color:#719e07">(</span><span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">(</span>CommonConstants<span style="color:#719e07">.</span>TRIPLE<span style="color:#719e07">,</span> PORT<span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>service<span style="color:#719e07">(</span>reactorService<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">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ol start="3"> |
| <li>Add client startup class and consumer program</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:#719e07">package</span> org.apache.dubbo.samples.triple.reactor<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.common.constants.CommonConstants<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ReferenceConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.slf4j.Logger<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.slf4j.LoggerFactory<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> reactor.core.publisher.Flux<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> reactor.core.publisher.Mono<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.io.IOException<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">ReactorConsumer</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> <span style="color:#268bd2">static</span> <span style="color:#268bd2">final</span> Logger LOGGER <span style="color:#719e07">=</span> LoggerFactory<span style="color:#719e07">.</span> <span style="color:#268bd2">getLogger</span><span style="color:#719e07">(</span>ReactorConsumer<span style="color:#719e07">.</span> class<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> GreeterService greeterService<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">ReactorConsumer</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ReferenceConfig<span style="color:#719e07">&lt;</span>GreeterService<span style="color:#719e07">&gt;</span> referenceConfig <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> referenceConfig<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>GreeterService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> referenceConfig<span style="color:#719e07">.</span>setProtocol<span style="color:#719e07">(</span>CommonConstants<span style="color:#719e07">.</span>TRIPLE<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> referenceConfig<span style="color:#719e07">.</span>setProxy<span style="color:#719e07">(</span>CommonConstants<span style="color:#719e07">.</span>NATIVE_STUB<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> referenceConfig<span style="color:#719e07">.</span>setTimeout<span style="color:#719e07">(</span>10000<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> DubboBootstrap bootstrap <span style="color:#719e07">=</span> DubboBootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">getInstance</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> bootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">application</span><span style="color:#719e07">(</span><span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;tri-reactor-stub-server&#34;</span><span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>registry<span style="color:#719e07">(</span><span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>reference<span style="color:#719e07">(</span>referenceConfig<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> GreeterService greeterService <span style="color:#719e07">=</span> referenceConfig<span style="color:#719e07">.</span> <span style="color:#268bd2">get</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:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span><span style="color:#719e07">(</span>String<span style="color:#719e07">[]</span> args<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> IOException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ReactorConsumer reactorConsumer <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReactorConsumer<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> reactorConsumer<span style="color:#719e07">.</span>consumeManyToMany<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>in<span style="color:#719e07">.</span>read<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">consumeManyToMany</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> greeterService<span style="color:#719e07">.</span> <span style="color:#268bd2">greetManyToMany</span><span style="color:#719e07">(</span>Flux<span style="color:#719e07">.</span> <span style="color:#268bd2">range</span><span style="color:#719e07">(</span>1<span style="color:#719e07">,</span> 10<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>map<span style="color:#719e07">(</span>num<span style="color:#719e07">-&gt;</span> |
| </span></span><span style="display:flex;"><span> GreeterRequest<span style="color:#719e07">.</span>newBuilder<span style="color:#719e07">().</span>setName<span style="color:#719e07">(</span>String<span style="color:#719e07">.</span>valueOf<span style="color:#719e07">(</span>num<span style="color:#719e07">)).</span>build<span style="color:#719e07">())</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>doOnNext<span style="color:#719e07">(</span>req <span style="color:#719e07">-&gt;</span> LOGGER<span style="color:#719e07">.</span>info<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;consumeManyToMany request data: {}&#34;</span><span style="color:#719e07">,</span> req<span style="color:#719e07">)))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>subscribe<span style="color:#719e07">(</span>res <span style="color:#719e07">-&gt;</span> LOGGER<span style="color:#719e07">.</span>info<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;consumeManyToMany get response: {}&#34;</span><span style="color:#719e07">,</span> res<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><ol start="4"> |
| <li> |
| <p>Start the server</p> |
| </li> |
| <li> |
| <p>Start the consumer</p> |
| </li> |
| </ol></description></item><item><title>Docs3-V2: Service Version</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/multi-versions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/multi-versions/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p><strong>Follow the steps below for version migration</strong></p> |
| <ol> |
| <li>During low-stress periods, first upgrade half of the providers to the new version</li> |
| <li>Upgrade all consumers to the new version</li> |
| <li>Then upgrade the remaining half of the providers to the new version</li> |
| </ol> |
| <h4 id="configuration">Configuration</h4> |
| <ul> |
| <li>Old and new versions of service providers</li> |
| <li>New and old version service consumers</li> |
| </ul> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>When an interface is implemented and an incompatible upgrade occurs, the version number can be used for transition, and services with different version numbers do not refer to each other.</p> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p><a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-version">https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-version</a></p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="service-provider">service provider</h3> |
| <p>Old version 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 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><h3 id="service-consumer">Service Consumer</h3> |
| <p>Old version 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 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><h3 id="does-not-distinguish-between-versions">Does not distinguish between versions</h3> |
| <p>If you don&rsquo;t need to distinguish between versions, you can configure it in the following way</p> |
| <div class="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></description></item><item><title>Docs3-V2: Cluster Fault Tolerance</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/fault-tolerent-strategy/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/fault-tolerent-strategy/</guid><description> |
| <p>When the cluster call fails, Dubbo provides a variety of fault tolerance schemes, and the default is failover retry.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/cluster.jpg" alt="cluster"></p> |
| <p>Each node relationship:</p> |
| <ul> |
| <li>Here <code>Invoker</code> is an abstraction of <code>Provider</code> that can call <code>Service</code>, <code>Invoker</code> encapsulates <code>Provider</code> address and <code>Service</code> interface information</li> |
| <li><code>Directory</code> represents multiple <code>Invoker</code>, which can be regarded as <code>List&lt;Invoker&gt;</code>, but different from <code>List</code>, its value may change dynamically, such as the registration center pushing changes</li> |
| <li><code>Cluster</code> disguises multiple <code>Invoker</code> in <code>Directory</code> as an <code>Invoker</code>, which is transparent to the upper layer. The masquerading process includes fault-tolerant logic. After the call fails, try another one</li> |
| <li><code>Router</code> is responsible for selecting subsets from multiple <code>Invoker</code> according to routing rules, 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>s for this call. The selection process includes a load balancing algorithm. After the call fails, it needs to be re-selected</li> |
| </ul> |
| <h2 id="cluster-fault-tolerance-mode">Cluster fault tolerance mode</h2> |
| <p>You can expand the cluster fault-tolerant strategy by yourself, see: <a href="../../../reference-manual/spi/description/cluster/">Cluster Expansion</a></p> |
| <h3 id="failover-cluster">Failover Cluster</h3> |
| <p>Automatic switching on failure, when a failure occurs, retry other servers. Usually used for read operations, but retries can introduce longer delays. The number of retries can be set by <code>retries=&quot;2&quot;</code> (excluding the first time).</p> |
| <p>The number 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> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Prompt</h4> |
| This configuration is the default configuration |
| </div> |
| <h3 id="failfast-cluster">Failfast Cluster</h3> |
| <p>Fail fast, only one call is made, and an error will be reported immediately if it fails. Usually used for non-idempotent write operations, such as adding new records.</p> |
| <h3 id="failsafe-cluster">Failsafe Cluster</h3> |
| <p>Fail safe, when an exception occurs, just ignore it. Typically used for operations such as writing to audit logs.</p> |
| <h3 id="failback-cluster">Failback Cluster</h3> |
| <p>The failure is automatically recovered, and the failed request is recorded in the background and resent at regular intervals. Typically used for message notification operations.</p> |
| <h3 id="forking-cluster">Forking Cluster</h3> |
| <p>Call multiple servers in parallel, and return as long as one succeeds. It is usually used for read operations with high real-time requirements, but more service resources need to be wasted. The maximum parallelism can be set by <code>forks=&quot;2&quot;</code>.</p> |
| <h3 id="broadcast-cluster">Broadcast Cluster</h3> |
| <p>Broadcast calls all providers one by one, and if any one reports an error, it will report an error. Usually used to notify all providers to update local resource information such as cache or logs.</p> |
| <p>Now in the broadcast call, you can configure the failure ratio of the node call through broadcast.fail.percent. When this ratio is reached, the BroadcastClusterInvoker |
| No other nodes will be called, and an exception will be thrown directly. broadcast.fail.percent ranges from 0 to 100. By default, an exception is 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 (if any node reports an error, it will report an error). broadcast.fail.percent parameter |
| 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> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Prompt</h4> |
| <code>2.1.0</code> started to support |
| </div> |
| <h3 id="available-cluster">Available Cluster</h3> |
| <p>Calls the currently available instance (only one is called), or throws an exception if no instance is currently available. Usually used in scenarios that do not require load balancing.</p> |
| <h3 id="mergeable-cluster">Mergeable Cluster</h3> |
| <p>Aggregate the call results in the cluster and return the result, usually used together with group. Aggregate the results by grouping and return the aggregated results, such as menu services, use group to distinguish multiple implementations of the same interface, now the consumer needs to call once from each group and return the results, and return the results after merging, so that You can implement aggregated menu items.</p> |
| <h3 id="zoneaware-cluster">ZoneAware Cluster</h3> |
| <p>In the scenario of multi-registry subscription, load balancing between registry clusters. There are four strategies for address selection between multiple registries:</p> |
| <ol> |
| <li>Specify the priority: <code>preferred=&quot;true&quot;</code>The address of the registration center will be selected first</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span> preferred=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ol start="2"> |
| <li>Same center priority: check the area to which the current request belongs, and give priority to registration centers with the same area</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span> zone=<span style="color:#2aa198">&#34;beijing&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ol start="3"> |
| <li>Weight polling: distribute traffic according to the weight of each registry</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;beijing&#34;</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span> weight=<span style="color:#2aa198">&#34;100&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;shanghai&#34;</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2182&#34;</span> weight=<span style="color:#2aa198">&#34;10&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ol start="4"> |
| <li>Default: Select an available registry</li> |
| </ol> |
| <h2 id="cluster-mode-configuration">Cluster mode configuration</h2> |
| <p>Follow the example below to configure cluster mode on the service provider and 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: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>Docs3-V2: Parameter Validation</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/parameter-validation/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/parameter-validation/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The parameter verification function is implemented based on <a href="https://jcp.org/en/jsr/detail?id=303">JSR303</a>, users only need to identify the verification annotation of the JSR303 standard, and realize the verification by declaring the filter.</p> |
| <h4 id="maven-dependencies">Maven dependencies</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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="scenes-to-be-used">scenes to be used</h2> |
| <p>When the server provides interface services to the outside, it solves various interface parameter verification problems.</p> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p><a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-validation">https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-validation</a></p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="parameter-annotation-example">Parameter annotation example</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">// not allowed to be null |
| </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">// length or size 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 empty when saving, and it is allowed to be empty when updating, indicating that the field will not be 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">// minimum 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">// maximum 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="group-verification-example">Group verification example</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, validation scenarios can be distinguished by service interface, such as: @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 interface with the same name as the method, the first letter is capitalized, used to distinguish validation scenarios, such as: @NotNull(groups = ValidationService.Save.class), optional |
| </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="association-validation-example">Association Validation Example</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">// Verify 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="parameter-validation-example">Parameter validation example</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">// validation parameter is not empty |
| </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">// directly verify the basic type parameters |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h3 id="validate-parameters-on-the-client-side">Validate parameters on the client side</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-parameters-on-the-server-side">Validate parameters on the server side</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><blockquote> |
| <p><strong>Dubbo supports hibernate-validator version &lt;=6.x by default, if you use hibernate-validator 7.x version, please declare the validation parameter as jvalidatorNew</strong></p> |
| </blockquote> |
| <h3 id="verify-exception-information">Verify exception information</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.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> <span style="color:#268bd2">start</span><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> <span style="color:#268bd2">save</span><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">// What is thrown is 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">// A ConstraintViolationException is embedded in it |
| </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 a collection of verification 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><blockquote> |
| <p><strong>The validation method can be extended, see <a href="../../../reference-manual/spi/description/validation">Validation Extension</a> in the developer manual for the extension method</strong></p> |
| </blockquote></description></item><item><title>Docs3-V2: Service Group</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/service-group/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/service-group/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The same interface can use service grouping to distinguish different implementation methods for different business scenarios, different usage requirements, or different functional modules. At the same time, the services provided by these different implementations can coexist and support mutual calls.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>When an interface has multiple implementations, it can be distinguished by group.</p> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p><a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-group">https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-group</a></p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="annotation-configuration">Annotation configuration</h3> |
| <h4 id="service-provider-annotation-configuration">Service provider (annotation configuration)</h4> |
| <p>Use @DubboService annotation, add group parameter</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@DubboService</span><span style="color:#719e07">(</span>group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#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">@DubboService</span><span style="color:#719e07">(</span>group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;demo2&#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">Demo2ServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService <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>Start the Dubbo service, and you can see services with the same service name and different groups in the registry. Taking Nacos as the registry as an example, the following content is displayed:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/service-group-1.png" alt="image-service-group-1.png"></p> |
| <h4 id="service-consumer-annotation-configuration">Service consumer (annotation configuration)</h4> |
| <p>Use @DubboReference annotation to add group parameter</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@DubboReference</span><span style="color:#719e07">(</span>group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">private</span> DemoService demoService<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@DubboReference</span><span style="color:#719e07">(</span>group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;demo2&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">private</span> DemoService demoService2<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">//group value is *, the identifier matches any service group |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">@DubboReference</span><span style="color:#719e07">(</span>group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;*&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">private</span> DemoService demoService2<span style="color:#719e07">;</span> |
| </span></span></code></pre></div><p>After starting the Dubbo service, you can see the references of the same service name in different groups in the registration center. Taking Nacos as the registration center as an example, the following content is displayed: |
| <img src="https://dubbo.apache.org/imgs/blog/service-group-2.png" alt="image-service-group-2.png"></p> |
| <h3 id="xml-configuration">xml configuration</h3> |
| <h4 id="service-provider-xml-configuration">Service provider (xml configuration)</h4> |
| <p>Use &lt;dubbo:service /&gt; tag, add group parameter</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://www.springframework.org/schema/beans/spring-beans-4.3.xsd |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.example.service.DemoService&#34;</span> group=<span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.example.service.DemoService&#34;</span> group=<span style="color:#2aa198">&#34;demo2&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><p>Start the Dubbo service, and you can see services with the same service name and different groups in the registry. Taking Nacos as the registry as an example, the following content is displayed:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/service-group-1.png" alt="image-service-group-1.png"></p> |
| <h4 id="service-consumer-xml-configuration">Service consumer (xml configuration)</h4> |
| <p>Use <a href="dubbo:reference/">dubbo:reference/</a> annotation to add group parameter</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://www.springframework.org/schema/beans/spring-beans-4.3.xsd |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> ... |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- reference service interface --&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.example.service.DemoService&#34;</span> group=<span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService2&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.example.service.DemoService&#34;</span> group=<span style="color:#2aa198">&#34;demo2&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- The group value is *, and the identifier matches any service group --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService3&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.example.service.DemoService&#34;</span> group=<span style="color:#2aa198">&#34;*&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> ... |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><p>After starting the Dubbo service, you can see the references of the same service name in different groups in the registration center. Taking Nacos as the registration center as an example, the following content is displayed:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/service-group-2.png" alt="image-service-group-2.png"></p> |
| <h3 id="api-configuration">API configuration</h3> |
| <h4 id="service-provider-api-configuration">Service provider (API configuration)</h4> |
| <p>Use org.apache.dubbo.config.ServiceConfig class, add group parameter</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// ServiceConfig is a heavy object, which internally encapsulates the connection with the registration center and opens the service port |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// Please cache by yourself, otherwise it may cause memory and connection leaks |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ServiceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ServiceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> service2 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo2&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span></code></pre></div><p>Start the Dubbo service, and you can see services with the same service name and different groups in the registry. Taking Nacos as the registry as an example, the following content is displayed:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/service-group-1.png" alt="image-service-group-1.png"></p> |
| <h4 id="service-consumer-api-configuration">Service consumer (API configuration)</h4> |
| <p>Use org.apache.dubbo.config.ReferenceConfig, add group parameter</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// ReferenceConfig is a heavy object, which internally encapsulates the connection with the registration center and opens the service port |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// Please cache by yourself, otherwise it may cause memory and connection leaks |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>reference<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> reference2 <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>reference2<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>reference2<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demo2&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> reference3 <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>reference3<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>reference3<span style="color:#719e07">.</span>setGroup<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;*&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">...</span> |
| </span></span></code></pre></div><p>After starting the Dubbo service, you can see the references of the same service name in different groups in the registration center. Taking Nacos as the registration center as an example, the following content is displayed: |
| <img src="https://dubbo.apache.org/imgs/blog/service-group-2.png" alt="image-service-group-2.png"></p> |
| <blockquote> |
| <p>Always <em>call</em>* only one available group implementation</p> |
| </blockquote></description></item><item><title>Docs3-V2: Asynchronous call</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/async-call/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/async-call/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <h4 id="background">background</h4> |
| <p>Starting from 2.7.0, all asynchronous programming interfaces of Dubbo are based on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html">CompletableFuture</a></p> |
| <p>Based on NIO&rsquo;s non-blocking implementation of parallel calls, the client does not need to start multi-threads to complete parallel calls to multiple remote services, and the overhead of multi-threading is relatively small.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/future.jpg" alt="/user-guide/images/future.jpg"></p> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p><a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-async">https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-async</a></p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Send the user request content to the target request. When the target request encounters high traffic or needs to be processed for a long time, the asynchronous call function will allow the response to be returned to the user immediately, while the target request continues to process the request in the background. When the target request returns the result, the content will be sent displayed to the user.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="interface-signed-with-completablefuture">Interface signed with CompletableFuture</h3> |
| <p>For services that require service providers to define CompletableFuture signatures in advance, the interface definition guidelines are as follows:</p> |
| <p>The asynchronous execution of the provider side switches the blocked business from Dubbo&rsquo;s internal thread pool to the business-defined thread, avoiding excessive occupation of the Dubbo thread pool, and helping to avoid the mutual influence between different services. Asynchronous execution is tantamount to saving resources or improving RPC response performance, because if business execution needs to be blocked, there is always a thread to be responsible for execution.</p> |
| <blockquote> |
| <p><strong>Provider-side asynchronous execution and Consumer-side asynchronous call are independent of each other, any orthogonal combination of two configurations</strong></p> |
| <ul> |
| <li>Consumer Synchronization - Provider Synchronization</li> |
| <li>Consumer asynchronous - Provider synchronous</li> |
| <li>Consumer synchronous - Provider asynchronous</li> |
| <li>Consumer asynchronous - Provider asynchronous</li> |
| </ul> |
| </blockquote> |
| <h3 id="define-the-interface-of-completablefuture-signature">Define the interface of CompletableFuture signature</h3> |
| <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 realization</p> |
| <div class="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> <span style="color:#719e07">return</span> CompletableFuture<span style="color:#719e07">.</span> <span style="color:#268bd2">supplyAsync</span><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>name<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> <span style="color:#268bd2">sleep</span><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>Through <code>return CompletableFuture.supplyAsync()</code>, the business execution has been switched from the Dubbo thread to the business thread, avoiding the blocking of the Dubbo thread pool.</p> |
| <h3 id="using-asynccontext">Using AsyncContext</h3> |
| <p>Dubbo provides an asynchronous interface <code>AsyncContext</code> similar to Servlet 3.0, which can also implement asynchronous execution on the Provider side 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 exposure, exactly the same as ordinary services</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;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 realization</p> |
| <div class="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> <span style="color:#268bd2">startAsync</span><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 the context, it must be executed in the first sentence |
| </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> <span style="color:#268bd2">sleep</span><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 back the 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><p>Note that the return type of the interface is <code>CompletableFuture&lt;String&gt;</code>.</p> |
| <p>XML Reference 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;asyncService&#34;</span> timeout=<span style="color:#2aa198">&#34;10000&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.api.AsyncService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>call 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// The call directly returns CompletableFuture |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> asyncService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;async call request&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// add callback |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>future<span style="color:#719e07">.</span> <span style="color:#268bd2">whenComplete</span><span style="color:#719e07">((</span>v<span style="color:#719e07">,</span> t<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:#719e07">if</span> <span style="color:#719e07">(</span>t <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span><span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> t<span style="color:#719e07">.</span> <span style="color:#268bd2">printStackTrace</span><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> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Response: &#34;</span> <span style="color:#719e07">+</span> v<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">// earlier than the result output |
| </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><span style="color:#2aa198">&#34;Executed before response return.&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><h3 id="using-rpccontext">Using RpcContext</h3> |
| <p>Configure in consumer.xml</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;asyncService&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.governance.api.AsyncService&#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> 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>calling 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">// this call returns null immediately |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>asyncService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;world&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Get the Future reference of the call, when the result is returned, it will be notified and set to this Future |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> helloFuture <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getServiceContext<span style="color:#719e07">().</span>getCompletableFuture<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// add callback for Future |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>helloFuture<span style="color:#719e07">.</span> <span style="color:#268bd2">whenComplete</span><span style="color:#719e07">((</span>retValue<span style="color:#719e07">,</span> exception<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:#719e07">if</span> <span style="color:#719e07">(</span>exception <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span><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>retValue<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> exception<span style="color:#719e07">.</span> <span style="color:#268bd2">printStackTrace</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>Alternatively, it is also possible to do this asynchronously by calling</p> |
| <div class="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>CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getServiceContext<span style="color:#719e07">().</span>asyncCall<span style="color:#719e07">(</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">()</span> <span style="color:#719e07">-&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> asyncService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;oneway call request1&#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></span><span style="display:flex;"><span>future<span style="color:#719e07">.</span> <span style="color:#268bd2">get</span><span style="color:#719e07">();</span> |
| </span></span></code></pre></div><p><strong>Asynchronous always does not wait for return</strong>, you can also set whether to wait for the message to be sent</p> |
| <ul> |
| <li><code>sent=&quot;true&quot;</code> waits for the message to be sent, and an exception will be thrown if the message fails to be sent.</li> |
| <li><code>sent=&quot;false&quot;</code> does not wait for the message to be sent, puts the message in the IO queue, and returns immediately.</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: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 just want to be asynchronous and completely ignore the return value, you can configure <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></description></item><item><title>Docs3-V2: Service Downgrade</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/service-downgrade/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/service-downgrade/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>It is recommended to use relevant current limiting and downgrading components (such as <a href="https://sentinelguard.io/zh-cn/docs/open-source-framework-integrations.html">Sentinel</a>) to achieve the best experience. Reference example practice: <a href="https://dubbo.apache.org/zh-cn/overview/tasks/ecosystem/rate-limit/">Microservice Governance/Limit and Downgrade</a></p> |
| <p>Service degradation refers to the emergency treatment of service degradation under abnormal circumstances.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <ul> |
| <li>When the load of a certain service or interface exceeds the maximum carrying capacity range, downgrade emergency treatment is required to avoid system crash</li> |
| <li>When a non-critical service or interface called is temporarily unavailable, simulated data or null is returned, and the business can continue to be available</li> |
| <li>Downgrade non-core business services or interfaces, free up system resources, and try to ensure the normal operation of core business</li> |
| <li>When an upstream basic service times out or is unavailable, execute a downgrade plan that can respond quickly to avoid the overall avalanche of services</li> |
| </ul> |
| <h2 id="how-to-use">How to use</h2> |
| <p>Take xml configuration as an example: (configuration through annotations is similar)</p> |
| <h3 id="1-configure-mocktrue">1. Configure <code>mock=&quot;true&quot;</code></h3> |
| <p>example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>This method requires an implementation class with the class name + <code>Mock</code> suffix under the same package, that is, there is a <code>DemoServiceMock</code> class under the <code>com.xxx.service</code> package.</p> |
| <h3 id="2-configure-mockcomxxxservicedemoservicemock">2. Configure <code>mock=&quot;com.xxx.service.DemoServiceMock&quot;</code></h3> |
| <p>example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;com.xxx.service.DemoServiceMock&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>This method specifies the full path of the Mock class.</p> |
| <h3 id="3-configure-mockfailforcereturnthrow-xxx">3. Configure <code>mock=&quot;[fail|force]return|throw xxx&quot;</code></h3> |
| <ul> |
| <li>The fail or force keyword is optional, indicating that the call fails or does not call to enforce the mock method, if no keyword is specified, the default is fail</li> |
| <li>return indicates the specified return result, and throw indicates that the specified exception is thrown</li> |
| <li>xxx is parsed according to the return type of the interface, you can specify the return value or throw a custom exception</li> |
| </ul> |
| <p>example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;return&#34;</span> <span style="color:#268bd2">/&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:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;return null&#34;</span> <span style="color:#268bd2">/&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:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;fail:return aaa&#34;</span> <span style="color:#268bd2">/&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:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;force:return true&#34;</span> <span style="color:#268bd2">/&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:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;fail:throw&#34;</span> <span style="color:#268bd2">/&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:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;com.xxx.service.DemoService&#34;</span> mock=<span style="color:#2aa198">&#34;force:throw java.lang.NullPointException&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="4-use-with-dubbo-admin">4. Use with dubbo-admin</h3> |
| <ul> |
| <li> |
| <p>Introduce <a href="https://github.com/apache/dubbo-spi-extensions/tree/master/dubbo-mock-extensions" target="_blank"><code>dubbo-mock-admin</code>&lt; /a&gt;dependency</p> |
| </li> |
| <li> |
| <p>Set the JVM parameters when the application consumer starts, <code>-Denable.dubbo.admin.mock=true</code></p> |
| </li> |
| <li> |
| <p>Start dubbo-admin, set the Mock rule under the service Mock-&gt;rule configuration menu</p> |
| </li> |
| </ul> |
| <p>Set rules in the dimension of service methods, set return mock data, and dynamically enable/disable rules</p> |
| <h2 id="precautions">Precautions</h2> |
| <p>When Dubbo starts, it will check the configuration. When the configuration of the mock attribute value is wrong, it will fail to start. You can troubleshoot according to the error message</p> |
| <ul> |
| <li> |
| <p>The configuration format is wrong, such as <code>return+null</code> will report an error, and it will be treated as a mock type. <code>return</code> can be omitted or followed by a space followed by the return value</p> |
| </li> |
| <li> |
| <p>Type not found error, such as custom mock class, throw custom exception, please check if the type exists or if there is a typo</p> |
| </li> |
| </ul></description></item><item><title>Docs3-V2: Generalization call (client generalization)</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/generic-reference/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/generic-reference/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Generalized call refers to calling the server without the API (SDK) provided by the server, and the call result can be obtained normally.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>The generalization call is mainly used to implement a general remote service mock framework, which can handle all service requests by implementing the GenericService interface. For example, the following scenario:</p> |
| <ol> |
| <li> |
| <p>Gateway service: If you want to build a gateway service, then the service gateway should be the calling end of all RPC services. However, the gateway itself should not depend on the interface API of the service provider (this will cause the code of the gateway to be modified and redeployed every time a new service is released), so support for generalization calls is required.</p> |
| </li> |
| <li> |
| <p>Test platform: If you want to build a platform that can test RPC calls, the user can test the corresponding RPC service by inputting information such as group name, interface, method name, etc. Then, for the same reason (that is, every time a new service is released, the code of the gateway needs to be modified and redeployed), the platform itself should not depend on the interface API of the service provider. So support for generalized calls is needed.</p> |
| </li> |
| </ol> |
| <h2 id="how-to-use">How to use</h2> |
| <p>The demo can be seen <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-generic">sample code in the dubbo project</a></p> |
| <p>The API part uses this demo as an example to explain how to use it.</p> |
| <h3 id="service-definition">Service definition</h3> |
| <h4 id="service-interface">Service interface</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">HelloService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><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></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHelloAsync</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>Person<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHelloAsyncComplex</span><span style="color:#719e07">(</span>String name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>GenericType<span style="color:#719e07">&lt;</span>Person<span style="color:#719e07">&gt;&gt;</span> <span style="color:#268bd2">sayHelloAsyncGenericComplex</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><h4 id="service-implementation-class">Service implementation class</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">HelloServiceImpl</span> <span style="color:#268bd2">implements</span> HelloService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">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;sayHello: &#34;</span> <span style="color:#719e07">+</span> name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></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">sayHelloAsync</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> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> CompletableFuture<span style="color:#719e07">&lt;&gt;();</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:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Thread<span style="color:#719e07">.</span> <span style="color:#268bd2">sleep</span><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> future<span style="color:#719e07">.</span>complete<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;sayHelloAsync: &#34;</span> <span style="color:#719e07">+</span> name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}).</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> future<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">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> CompletableFuture<span style="color:#719e07">&lt;</span>Person<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHelloAsyncComplex</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> Person person <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Person<span style="color:#719e07">(</span>1<span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;sayHelloAsyncComplex: &#34;</span> <span style="color:#719e07">+</span> name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>Person<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> CompletableFuture<span style="color:#719e07">&lt;&gt;();</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:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Thread<span style="color:#719e07">.</span> <span style="color:#268bd2">sleep</span><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> future<span style="color:#719e07">.</span> <span style="color:#268bd2">complete</span><span style="color:#719e07">(</span>person<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></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> future<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">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> CompletableFuture<span style="color:#719e07">&lt;</span>GenericType<span style="color:#719e07">&lt;</span>Person<span style="color:#719e07">&gt;&gt;</span> <span style="color:#268bd2">sayHelloAsyncGenericComplex</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> Person person <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Person<span style="color:#719e07">(</span>1<span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;sayHelloAsyncGenericComplex: &#34;</span> <span style="color:#719e07">+</span> name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> GenericType<span style="color:#719e07">&lt;</span>Person<span style="color:#719e07">&gt;</span> genericType <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> GenericType<span style="color:#719e07">&lt;&gt;(</span>person<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>GenericType<span style="color:#719e07">&lt;</span>Person<span style="color:#719e07">&gt;&gt;</span> future <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> CompletableFuture<span style="color:#719e07">&lt;&gt;();</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:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Thread<span style="color:#719e07">.</span> <span style="color:#268bd2">sleep</span><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> future<span style="color:#719e07">.</span> <span style="color:#268bd2">complete</span><span style="color:#719e07">(</span>genericType<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></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> future<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="using-generic-calls-through-the-api">Using generic calls through the API</h3> |
| <h4 id="service-initiator">Service initiator</h4> |
| <ol> |
| <li> |
| <p>When setting <code>ServiceConfig</code>, use <code>setGeneric(&quot;true&quot;)</code> to enable generic calls</p> |
| </li> |
| <li> |
| <p>When setting <code>ServiceConfig</code>, when using setRef to specify the implementation class, you must set a <code>GenericService</code> object. instead of the real service implementation class object</p> |
| </li> |
| <li> |
| <p>Other settings are consistent with normal Api service startup</p> |
| </li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#268bd2">static</span> String zookeeperAddress <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;zookeeper://&#34;</span> <span style="color:#719e07">+</span> System<span style="color:#719e07">.</span>getProperty<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper.address&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;127.0.0.1&#34;</span><span style="color:#719e07">)</span> <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;:2181&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#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> <span style="color:#719e07">new</span> Embedded <span style="color:#268bd2">ZooKeeper</span><span style="color:#719e07">(</span>2181<span style="color:#719e07">,</span> <span style="color:#cb4b16">false</span><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> <span style="color:#586e75">//Create ApplicationConfig |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></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;generic-impl-provider&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Create registry configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> RegistryConfig registryConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> registryConfig<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span>zookeeperAddress<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Create a new service implementation class, pay attention to use GenericService to receive |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> GenericService helloService <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> GenericImplOfHelloService<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Create service related configuration |
| </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;&gt;();</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setApplication<span style="color:#719e07">(</span>applicationConfig<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRegistry<span style="color:#719e07">(</span>registryConfig<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.generic.call.api.HelloService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span>helloService<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Key point: set to generalization call |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// Note: it is no longer recommended to use the setGeneric function whose parameter is a Boolean value |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">//should use referenceConfig.setGeneric(&#34;true&#34;) instead |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> service<span style="color:#719e07">.</span>setGeneric<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;true&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> service<span style="color:#719e07">.</span> <span style="color:#268bd2">export</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> System<span style="color:#719e07">.</span>out<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo service started&#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">new</span> CountDownLatch<span style="color:#719e07">(</span>1<span style="color:#719e07">).</span> await<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><h4 id="generalizing-the-caller">Generalizing the caller</h4> |
| <p>step:</p> |
| <ol> |
| <li> |
| <p>When setting <code>ReferenceConfig</code>, use <code>setGeneric(&quot;true&quot;)</code> to enable generic calls</p> |
| </li> |
| <li> |
| <p>After configuring <code>ReferenceConfig</code>, use <code>referenceConfig.get()</code> to get the instance of the <code>GenericService</code> class</p> |
| </li> |
| <li> |
| <p>Use its <code>$invoke</code> method to get the result</p> |
| </li> |
| <li> |
| <p>Other settings are consistent with normal Api service startup</p> |
| </li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#586e75">//Define generalized call service class |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">static</span> GenericService genericService<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> <span style="color:#586e75">//Create ApplicationConfig |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></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;generic-call-consumer&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Create registry configuration |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> RegistryConfig registryConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> registryConfig<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Create service reference configuration |
| </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> referenceConfig <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">//Set the interface |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> referenceConfig<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.generic.call.api.HelloService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> applicationConfig<span style="color:#719e07">.</span>setRegistry<span style="color:#719e07">(</span>registryConfig<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> referenceConfig<span style="color:#719e07">.</span>setApplication<span style="color:#719e07">(</span>applicationConfig<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Key point: set to generalization call |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// Note: it is no longer recommended to use the setGeneric function whose parameter is a Boolean value |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">//should use referenceConfig.setGeneric(&#34;true&#34;) instead |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> referenceConfig<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 style="color:#586e75">//Set asynchronous, not necessary, it depends on the business. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> referenceConfig<span style="color:#719e07">.</span>setAsync<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:#586e75">//Set the timeout |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> referenceConfig<span style="color:#719e07">.</span>setTimeout<span style="color:#719e07">(</span>7000<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Get the service, because it is a generalized call, so it must be of the GenericService type |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> genericService <span style="color:#719e07">=</span> referenceConfig<span style="color:#719e07">.</span> <span style="color:#268bd2">get</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Using the $invoke method of the GenericService class object can be used instead of the original method |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">//The first parameter is the name of the method to call |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">//The second parameter is the parameter type array of the method to be called, which is a String array, and the full class name of the parameter is stored in it. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">//The third parameter is the parameter array of the method to be called, which is an Object array, and the required parameters are stored in it. |
| </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> <span style="color:#268bd2">$invoke</span><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:#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:#2aa198">&#34;world&#34;</span><span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Use CountDownLatch, if you use synchronous calls, you don&#39;t need to do this. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> CountDownLatch latch <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> CountDownLatch<span style="color:#719e07">(</span>1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Get the result |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getContext<span style="color:#719e07">().</span>getCompletableFuture<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> future<span style="color:#719e07">.</span> <span style="color:#268bd2">whenComplete</span><span style="color:#719e07">((</span>value<span style="color:#719e07">,</span> t<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>err<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;invokeSayHello(whenComplete): &#34;</span> <span style="color:#719e07">+</span> value<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> latch<span style="color:#719e07">.</span> <span style="color:#268bd2">countDown</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">// print the result |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> System<span style="color:#719e07">.</span>err<span style="color:#719e07">.</span>println<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;invokeSayHello(return): &#34;</span> <span style="color:#719e07">+</span> result<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> latch<span style="color:#719e07">.</span> <span style="color:#268bd2">await</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="using-generic-calls-with-spring">Using generic calls with Spring</h3> |
| <p>There are many ways to use service exposure and service discovery in Spring, such as xml and annotations. Take xml as an example here. |
| step:</p> |
| <ol> |
| <li> |
| <p>There is no need to change the producer side</p> |
| </li> |
| <li> |
| <p>Add the attribute of <code>generic=true</code> to the original <code>dubbo:reference</code> tag on the consumer side.</p> |
| </li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;helloService&#34;</span> generic = <span style="color:#2aa198">&#34;true&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.generic.call.api.HelloService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ol start="3"> |
| <li> |
| <p>Get the Bean container, and get the <code>GenericService</code> instance through the Bean container.</p> |
| </li> |
| <li> |
| <p>Call the <code>$invoke</code> method to get the result</p> |
| </li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">static</span> GenericService 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> <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> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;spring/generic-impl-consumer.xml&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> context<span style="color:#719e07">.</span> <span style="color:#268bd2">start</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//The name of the bean corresponding to the service is determined by the id of the xml tag |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> genericService <span style="color:#719e07">=</span> context<span style="color:#719e07">.</span> <span style="color:#268bd2">getBean</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;helloService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//Get the result |
| </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> <span style="color:#268bd2">$invoke</span><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:#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:#2aa198">&#34;world&#34;</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="protobuf-object-generalization-call">Protobuf object generalization call</h3> |
| <p>General generalization calls can only be used when the generated service parameters are POJOs, while GoogleProtobuf objects are abnormal POJOs generated based on Builder, which can be generalized and called through protobuf-json.</p> |
| <p>GoogleProtobuf serialization-related Demo can refer to <a href="https://github.com/apache/dubbo-samples/tree/master/3-extensions/serialization/dubbo-samples-protobuf">protobuf-demo</a></p> |
| <h4 id="generic-calls-to-google-protobuf-objects-through-spring">Generic calls to Google Protobuf objects through Spring</h4> |
| <p>Configure the declaration generic = &ldquo;protobuf-json&rdquo; in Spring</p> |
| <div class="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;protobuf-json&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Get barService in Java code and start generalizing calls:</p> |
| <div class="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> <span style="color:#268bd2">getBean</span><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:#2aa198">&#34;org.apache.dubbo.protobuf.GooglePbBasic$CDubboGooglePBRequestType&#34;</span><span style="color:#719e07">},</span> <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]{</span><span style="color:#2aa198">&#34;{\&#34;double\&#34;:0.0,\&#34;float \&#34;:0.0,\&#34;bytesType\&#34;:\&#34;Base64String\&#34;,\&#34;int32\&#34;:0}&#34;</span><span style="color:#719e07">});</span> |
| </span></span></code></pre></div><h4 id="generalized-calls-to-google-protobuf-objects-through-api">Generalized calls to Google Protobuf objects through API</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>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">// Weakly typed 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>GenericService<span style="color:#719e07">.</span>class<span style="color:#719e07">.</span>getName<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><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><span style="color:#586e75">// Declare as Protobuf-json |
| </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>Constants<span style="color:#719e07">.</span>GENERIC_SERIALIZATION_PROTOBUF<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>GenericService genericService <span style="color:#719e07">=</span> reference<span style="color:#719e07">.</span> <span style="color:#268bd2">get</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>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> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;fixed64&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;int64&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;0&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Referring to Google&#39;s official protobuf 3 syntax, only one POJO object is transmitted in each method of the service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// The generalized call of protobuf only allows passing a json object of type String to represent the request parameter |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>String requestString <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Gson<span style="color:#719e07">().</span>toJson<span style="color:#719e07">(</span>person<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// The return object is the json string of the GoolgeProtobuf response object. |
| </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> <span style="color:#268bd2">$invoke</span><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></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;com.xxx.XxxService.GooglePbBasic$CDubboGooglePBRequestType&#34;</span><span style="color:#719e07">},</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]</span> <span style="color:#719e07">{</span>requestString<span style="color:#719e07">});</span> |
| </span></span></code></pre></div><h4 id="processing-of-googleprotobuf-objects">Processing of GoogleProtobuf objects</h4> |
| <p>The GoogleProtobuf object is generated by the Protocol contract. For related knowledge, please refer to <a href="https://developers.google.com/protocol-buffers/?hl=zh-CN">ProtocolBuffers Documentation</a>. If there is the following Protobuf contract</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-proto" data-lang="proto"><span style="display:flex;"><span>syntax <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;proto3&#34;</span>; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">package</span> com<span style="color:#719e07">.</span>xxx.XxxService.GooglePbBasic.basic; |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">message</span> <span style="color:#268bd2">CDubboGooglePBRequestType</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">double</span> <span style="color:#dc322f">double</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">float</span> <span style="color:#dc322f">float</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">2</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int32</span> <span style="color:#dc322f">int32</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">3</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">bool</span> <span style="color:#dc322f">bool</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">13</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">string</span> <span style="color:#dc322f">string</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">14</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">bytes</span> bytesType <span style="color:#719e07">=</span> <span style="color:#2aa198">15</span>; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">message</span> <span style="color:#268bd2">CDubboGooglePBResponseType</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">string</span> msg <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span>; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">service</span> CDubboGooglePBService { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">rpc</span> sayHello (CDubboGooglePBRequestType) <span style="color:#719e07">returns</span> (CDubboGooglePBResponseType); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Then the corresponding request is constructed according to the following 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-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> person <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>person<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;double&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;1.000&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;float&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;1.00&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;int32&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;1&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;bool&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;false&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">//String objects need to be base64 encoded |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>person<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;string&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;someBaseString&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>person<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;bytesType&#34;</span><span style="color:#719e07">,</span><span style="color:#2aa198">&#34;150&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><h4 id="googleprotobuf-service-metadata-analysis">GoogleProtobuf service metadata analysis</h4> |
| <p>Google Protobuf objects lack standard JSON formatting and the resulting service metadata information is incorrect. Please add the following dependencies that depend on metadata parsing.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-metadata-definition-protobuf<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>It is also relatively easy to construct generalized call objects from service metadata.</p> |
| <h2 id="precautions">Precautions</h2> |
| <ol> |
| <li> |
| <p>If the parameter is a basic type or Date, List, Map, etc., there is no need to convert it, just call it directly.</p> |
| </li> |
| <li> |
| <p>If the parameter is another POJO, use Map instead.</p> |
| </li> |
| </ol> |
| <p>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><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">Student</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></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> <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 style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Should be converted to:</p> |
| <div class="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> student <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>student<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><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>student<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;age&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;xxx&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><ol start="3"> |
| <li>For other serialization formats, special configuration is required</li> |
| </ol></description></item><item><title>Docs3-V2: Stream Communication</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/streaming/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/streaming/</guid><description> |
| <p>TBD</p></description></item><item><title>Docs3-V2: Thread Pool Isolation</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/isolation-executor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/isolation-executor/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>A new thread pool management method enables the thread pools of each service in the provider application to be isolated and independent from each other. The exhaustion of the thread pool resources of a certain service will not affect other normal services. Support thread pool configurable, manually specified by the user.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <h2 id="how-to-use">How to use</h2> |
| <p>Currently, it can be configured in the form of API, XML, and Annotation</p> |
| <p><strong>Configuration parameters</strong></p> |
| <ul> |
| <li><code>ApplicationConfig</code> adds <code>String executor-management-mode</code> parameter, the configuration values are <code>default</code> and <code>isolation</code>, and the default is <code>default</code>. |
| <ul> |
| <li><code>executor-management-mode = default</code> use the original <strong>thread pool management mode with the protocol port as the granularity and sharing between services</strong></li> |
| <li><code>executor-management-mode = isolation</code> uses the newly added thread pool management method with <strong>service triplet as granularity and isolation between services</strong></li> |
| </ul> |
| </li> |
| <li><code>ServiceConfig</code> adds <code>Executor executor</code> parameter, <strong>thread pool for isolation between services</strong>, can be configured by the user to provide the thread pool you want, if not specified, it will be configured according to the protocol (<code> ProtocolConfig</code>) information to build a default thread pool for service isolation.</li> |
| </ul> |
| <blockquote> |
| <p><code>ServiceConfig</code> adds the <code>Executor executor</code> configuration parameter to take effect only if <code>executor-management-mode = isolation</code> is specified.</p> |
| </blockquote> |
| <h3 id="apis">APIs</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:#dc322f">void</span> <span style="color:#268bd2">test</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// provider app |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> DubboBootstrap providerBootstrap <span style="color:#719e07">=</span> DubboBootstrap<span style="color:#719e07">.</span> <span style="color:#268bd2">newInstance</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> ServiceConfig serviceConfig1 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> serviceConfig1<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>DemoService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> serviceConfig1<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> DemoServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> serviceConfig1<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span>version1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// set executor1 for serviceConfig1, max threads is 10 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> NamedThreadFactory threadFactory1 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> NamedThreadFactory<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;DemoService-executor&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> ExecutorService executor1 <span style="color:#719e07">=</span> Executors<span style="color:#719e07">.</span> <span style="color:#268bd2">newFixedThreadPool</span><span style="color:#719e07">(</span>10<span style="color:#719e07">,</span> threadFactory1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> serviceConfig1<span style="color:#719e07">.</span>setExecutor<span style="color:#719e07">(</span>executor1<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> ServiceConfig serviceConfig2 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> serviceConfig2<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>HelloService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> serviceConfig2<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> HelloServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> serviceConfig2<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span>version2<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// set executor2 for serviceConfig2, max threads is 100 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> NamedThreadFactory threadFactory2 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> NamedThreadFactory<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;HelloService-executor&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> ExecutorService executor2 <span style="color:#719e07">=</span> Executors<span style="color:#719e07">.</span> <span style="color:#268bd2">newFixedThreadPool</span><span style="color:#719e07">(</span>100<span style="color:#719e07">,</span> threadFactory2<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> serviceConfig2<span style="color:#719e07">.</span>setExecutor<span style="color:#719e07">(</span>executor2<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> ServiceConfig serviceConfig3 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> serviceConfig3<span style="color:#719e07">.</span>setInterface<span style="color:#719e07">(</span>HelloService<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> serviceConfig3<span style="color:#719e07">.</span>setRef<span style="color:#719e07">(</span><span style="color:#719e07">new</span> HelloServiceImpl<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> serviceConfig3<span style="color:#719e07">.</span>setVersion<span style="color:#719e07">(</span>version3<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Because executor is not set for serviceConfig3, the default executor of serviceConfig3 is built using |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">// the threadpool parameter of the protocolConfig ( FixedThreadpool , max threads is 200) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> serviceConfig3<span style="color:#719e07">.</span>setExecutor<span style="color:#719e07">(</span><span style="color:#cb4b16">null</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// It takes effect only if [executor-management-mode=isolation] is configured |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> ApplicationConfig applicationConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;provider-app&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> applicationConfig<span style="color:#719e07">.</span>setExecutorManagementMode<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;isolation&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> providerBootstrap |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>application<span style="color:#719e07">(</span>applicationConfig<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>registry<span style="color:#719e07">(</span>registryConfig<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// export with tri and dubbo protocol |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>protocol<span style="color:#719e07">(</span><span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;tri&#34;</span><span style="color:#719e07">,</span> 20001<span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>protocol<span style="color:#719e07">(</span><span style="color:#719e07">new</span> ProtocolConfig<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;dubbo&#34;</span><span style="color:#719e07">,</span> 20002<span style="color:#719e07">))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>service<span style="color:#719e07">(</span>serviceConfig1<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>service<span style="color:#719e07">(</span>serviceConfig2<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>service<span style="color:#719e07">(</span>serviceConfig3<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> providerBootstrap<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></code></pre></div><h3 id="xml">XML</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;beans</span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </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 |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- NOTE: we need config executor-management-mode=&#34;isolation&#34; --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;demo-provider&#34;</span> executor-management-mode=<span style="color:#2aa198">&#34;isolation&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dubbo:application&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:config-center</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:metadata-report</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;dubbo:registry</span> id=<span style="color:#2aa198">&#34;registry1&#34;</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181?registry-type=service&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;-1&#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;tri&#34;</span> port=<span style="color:#2aa198">&#34;-1&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- expose three service with dubbo and tri protocol--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoServiceV1&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.impl.DemoServiceImpl&#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;helloServiceV2&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.impl.HelloServiceImpl&#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;helloServiceV3&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.impl.HelloServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- customized thread pool --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;executor-demo-service&#34;</span> |
| </span></span><span style="display:flex;"><span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.isolation.spring.support.DemoServiceExecutor&#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;executor-hello-service&#34;</span> |
| </span></span><span style="display:flex;"><span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.isolation.spring.support.HelloServiceExecutor&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- this service use [executor=&#34;executor-demo-service&#34;] as isolated thread pool--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> executor=<span style="color:#2aa198">&#34;executor-demo-service&#34;</span> |
| </span></span><span style="display:flex;"><span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.api.DemoService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> group=<span style="color:#2aa198">&#34;Group1&#34;</span> |
| </span></span><span style="display:flex;"><span> timeout=<span style="color:#2aa198">&#34;3000&#34;</span> ref=<span style="color:#2aa198">&#34;demoServiceV1&#34;</span> registry=<span style="color:#2aa198">&#34;registry1&#34;</span> protocol=<span style="color:#2aa198">&#34;dubbo,tri&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- this service use [executor=&#34;executor-hello-service&#34;] as isolated thread pool--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> executor=<span style="color:#2aa198">&#34;executor-hello-service&#34;</span> |
| </span></span><span style="display:flex;"><span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;2.0.0&#34;</span> group=<span style="color:#2aa198">&#34;Group2&#34;</span> |
| </span></span><span style="display:flex;"><span> timeout=<span style="color:#2aa198">&#34;5000&#34;</span> ref=<span style="color:#2aa198">&#34;helloServiceV2&#34;</span> registry=<span style="color:#2aa198">&#34;registry1&#34;</span> protocol=<span style="color:#2aa198">&#34;dubbo,tri&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- not set executor for this service, the default executor built using threadpool parameter of the protocolConfig --&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.config.spring.api.HelloService&#34;</span> version=<span style="color:#2aa198">&#34;3.0.0&#34;</span> group=<span style="color:#2aa198">&#34;Group3&#34;</span> |
| </span></span><span style="display:flex;"><span> timeout=<span style="color:#2aa198">&#34;5000&#34;</span> ref=<span style="color:#2aa198">&#34;helloServiceV3&#34;</span> registry=<span style="color:#2aa198">&#34;registry1&#34;</span> protocol=<span style="color:#2aa198">&#34;dubbo,tri&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h3 id="annotation">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:#268bd2">@Configuration</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span><span style="color:#719e07">(</span>scanBasePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;org.apache.dubbo.config.spring.isolation.spring.annotation.provider&#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">ProviderConfiguration</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> RegistryConfig <span style="color:#268bd2">registryConfig</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> RegistryConfig registryConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> registryConfig<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> registryConfig<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">// NOTE: we need config executor-management-mode=&#34;isolation&#34; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></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 style="color:#2aa198">&#34;provider-app&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> applicationConfig<span style="color:#719e07">.</span>setExecutorManagementMode<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;isolation&#34;</span><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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// expose services with dubbo protocol |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></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">dubbo</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 style="color:#2aa198">&#34;dubbo&#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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// expose services with tri protocol |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></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">tri</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 style="color:#2aa198">&#34;tri&#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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// customized thread pool |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@Bean</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;executor-demo-service&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Executor <span style="color:#268bd2">demoServiceExecutor</span><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> DemoServiceExecutor<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">// customized thread pool |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">@Bean</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;executor-hello-service&#34;</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Executor <span style="color:#268bd2">helloServiceExecutor</span><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> HelloServiceExecutor<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// customized thread pool |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceExecutor</span> <span style="color:#268bd2">extends</span> ThreadPoolExecutor <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">DemoServiceExecutor</span><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>10<span style="color:#719e07">,</span> 10<span style="color:#719e07">,</span> 60<span style="color:#719e07">,</span> TimeUnit<span style="color:#719e07">.</span> SECONDS<span style="color:#719e07">,</span> <span style="color:#719e07">new</span> LinkedBlockingDeque<span style="color:#719e07">&lt;&gt;(),</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;DemoServiceExecutor&#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><div class="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">// customized thread pool |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">HelloServiceExecutor</span> <span style="color:#268bd2">extends</span> ThreadPoolExecutor <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">HelloServiceExecutor</span><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>100<span style="color:#719e07">,</span> 100<span style="color:#719e07">,</span> 60<span style="color:#719e07">,</span> TimeUnit<span style="color:#719e07">.</span> SECONDS<span style="color:#719e07">,</span> <span style="color:#719e07">new</span> LinkedBlockingDeque<span style="color:#719e07">&lt;&gt;(),</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;HelloServiceExecutor&#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><div class="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">// &#34;executor-hello-service&#34; is beanName |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">@DubboService</span><span style="color:#719e07">(</span>executor <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;executor-demo-service&#34;</span><span style="color:#719e07">,</span> version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">,</span> group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;Group1&#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">DemoServiceImplV1</span> <span style="color:#268bd2">implements</span> DemoService <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayName</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;server name&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Box <span style="color:#268bd2">getBox</span><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:#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><div class="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">// not set executor for this service, the default executor built using threadpool parameter of the protocolConfig |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#268bd2">@DubboService</span><span style="color:#719e07">(</span>version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;3.0.0&#34;</span><span style="color:#719e07">,</span> group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;Group3&#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">HelloServiceImplV2</span> <span style="color:#268bd2">implements</span> HelloService <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> Logger logger <span style="color:#719e07">=</span> LoggerFactory<span style="color:#719e07">.</span>getLogger<span style="color:#719e07">(</span>HelloServiceImplV2<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">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;server hello&#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><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@DubboService</span><span style="color:#719e07">(</span>executor <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;executor-hello-service&#34;</span><span style="color:#719e07">,</span> version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;2.0.0&#34;</span><span style="color:#719e07">,</span> group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;Group2&#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">HelloServiceImplV3</span> <span style="color:#268bd2">implements</span> HelloService <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> Logger logger <span style="color:#719e07">=</span> LoggerFactory<span style="color:#719e07">.</span>getLogger<span style="color:#719e07">(</span>HelloServiceImplV3<span style="color:#719e07">.</span>class<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">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;server hello&#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>Docs3-V2: Call link to pass implicit parameters</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/attachment/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/attachment/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Parameters can be implicitly passed between the service consumer and the provider through <code>setAttachment</code> and <code>getAttachment</code> on <code>RpcContext</code>.</p> |
| <h4 id="background">background</h4> |
| <p>Context information is a very important function of the RPC framework. Using RpcContext can specify different configurations for a single call. For example, in the distributed link tracking scenario, the implementation principle is to maintain a traceId in the context of the entire link. The Consumer and Provider connect an RPC call by passing the traceId. After reporting the logs respectively, they can be connected in series in the tracking system and display the complete call. process. In this way, it is easier to find abnormalities and locate problems. |
| RpcContext in Dubbo is a ThreadLocal temporary state recorder. When RPC requests are received or RPC requests are initiated, the state of RpcContext will change. For example: **A tunes B, B tunes C, then on machine B, before B tunes C, RpcContext records the information of A and B, after B tunes C, RpcContext records the information of B and C. **</p> |
| <p>In Dubbo 3, RpcContext is split into four major modules (ServerContext, ClientAttachment, ServerAttachment and ServiceContext).</p> |
| <p>They bear different accusations respectively:</p> |
| <ul> |
| <li>ServiceContext: Used internally by Dubbo to pass parameter information on the call link, such as invoker objects, etc.</li> |
| <li>ClientAttachment: Used on the client side, the parameters written in ClientAttachment will be passed to the server side</li> |
| <li>ServerAttachment: Used on the Server side, the parameters read from ServerAttachment are passed from the Client</li> |
| <li>ServerContext: It is used on both the client side and the server side, and is used to pass back from the server side to the client side. The parameters written by the server side to the ServerContext can be obtained from the ServerContext on the client side after the call ends</li> |
| </ul> |
| <p><img src="https://dubbo.apache.org/imgs/v3/concepts/rpccontext.png" alt="/imgs/v3/concepts/rpccontext.png"></p> |
| <p>As shown in the figure above, when the consumer initiates an invocation, it can directly initiate a call to the remote service through Method Invoke, and at the same time, the data written by the consumer to RpcClientAttachment will be written into Invocation together with the parameter information of Invoke. |
| The Invocation on the consumer side is serialized and sent to the server through network transmission. The server parses the Invocation to generate the parameters of Method Invoke and RpcServerAttachment, and then initiates the real call. |
| After the processing on the server end, the Method Response result together with the RpcServiceContext will generate a Result object. |
| The Result object on the server is serialized and sent back to the consumer through network transmission. The consumer parses the Result to generate a Method Response result and RpcServiceContext, and returns the actual call result and context to the consumer.</p> |
| <blockquote> |
| <p>path, group, version, dubbo, token, timeout several keys are reserved fields, please use other values.</p> |
| </blockquote> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>How to transparently transmit traceId to the service provider when the internal system calls through Dubbo.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <blockquote> |
| <p>The KV pair set by <code>setAttachment</code> will be cleared after the following remote call is completed, that is, multiple remote calls need to be set multiple times.</p> |
| </blockquote> |
| <h3 id="set-implicit-parameters-on-the-service-consumer-side">Set implicit parameters on the service consumer side</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>getClientAttachment<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">// Implicit parameter passing, subsequent remote calls will implicitly send these parameters to the server, similar to cookies, used for framework integration, not recommended 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><h3 id="obtain-implicit-parameters-on-the-service-provider-side">Obtain implicit parameters on the service provider side</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">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">// Obtain the parameters implicitly passed in by the client for framework integration, not recommended for general 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>getServerAttachment<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><h3 id="write-return-parameters-in-the-service-provider">Write return parameters in the service provider</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">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> String index <span style="color:#719e07">=</span> xxx<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> RpcContext<span style="color:#719e07">.</span>getServerContext<span style="color:#719e07">().</span>setAttachment<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;result&#34;</span><span style="color:#719e07">,</span> index<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="obtain-the-return-parameters-on-the-consumer-side">Obtain the return parameters on the consumer side</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>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>String result <span style="color:#719e07">=</span> RpcContext<span style="color:#719e07">.</span>getServerContext<span style="color:#719e07">().</span>getAttachment<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;result&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">//... |
| </span></span></span></code></pre></div><h2 id="parameter-transparent-transmission-problem">Parameter transparent transmission problem</h2> |
| <p>In Dubbo 2.7, after the parameters set on the A side are called, if B continues to call C, the parameters originally set in A will also be brought to the C side, causing the problem of parameter pollution. |
| Dubbo 3 has refactored RpcContext to support optional parameter transparent transmission, and parameter transparent transmission is enabled by default.</p> |
| <p>The following SPI is provided in Dubbo 3. There is no implementation by default. Users can define their own implementation. The result of <code>select</code> (you can get all the current parameters from RpcClientAttachment) will be passed to the next hop as a key-value pair that needs to be transparently transmitted. If Returning null means that parameters are not transparently passed.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">PenetrateAttachmentSelector</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Select some attachments to pass to next hop. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * These attachments can fetch from {@link RpcContext#getServerAttachment()} or user defined. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return attachment pass to next hop |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><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> <span style="color:#268bd2">select</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Direct Connection Provider</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/explicit-target/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/explicit-target/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>This document is no longer maintained. You are currently viewing a snapshot version. If you want to view the latest version of the documentation, see <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/specify-ip/">Latest Version</a>.</p> |
| </div> |
| <p>In the development and testing environment, it is often necessary to bypass the registration center and only test the specified service provider. At this time, point-to-point direct connection may be required. The point-to-point direct connection method will use the service interface as the unit and ignore the provider list of the registration center. A The point-to-point interface configuration does not affect the B interface to obtain the list from the registration center.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-directly.jpg" alt="/user-guide/images/dubbo-directly.jpg"></p> |
| <h2 id="configuration-via-xml">Configuration via XML</h2> |
| <p>If the online demand needs point-to-point, you can configure the url to point to the provider in <code>&lt;dubbo:reference&gt;</code>, which will bypass the registration center. Multiple addresses are separated by semicolons, and the configuration is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Prompt</h4> |
| <code>1.0.6</code> and above version support |
| </div> |
| <h2 id="specified-by--d-parameter">Specified by -D parameter</h2> |
| <p>Add the -D parameter mapping service address to the JVM startup parameters, 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-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> |
| <div class="alert alert-primary" role="alert"> |
| <h4 class="alert-heading">Prompt</h4> |
| The key is the service name, and the value is the service provider url. This configuration has the highest priority and is supported by <code>1.0.15</code> and above versions |
| </div> |
| <h2 id="by-file-mapping">By file mapping</h2> |
| <p>If there are many services, you can also use file mapping, use <code>-Ddubbo.resolve.file</code> to specify the mapping file path, this configuration has a higher priority than the configuration [^3] in <code>&lt;dubbo:reference&gt;</code>, 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-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 to the mapping file <code>xxx.properties</code>, where the key is the service name and the 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">Prompt</h4> |
| <code>1.0.15</code> and above versions support, <code>2.0</code> and above versions automatically load the ${user.home}/dubbo-resolve.properties file, no configuration required |
| </div> |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Attention</h4> |
| In order to avoid complicating the online environment, do not use this feature online, it should only be used during the testing phase. |
| </div></description></item><item><title>Docs3-V2: Dynamic IP call</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/specify-ip/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/specify-ip/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Use the extension of Dubbo to realize the specified IP call.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>When initiating a request, you need to specify the server for this call, such as message callback, traffic isolation, etc.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="plugin-dependencies">Plugin dependencies</h3> |
| <p>Adapt to Dubbo 3 version</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo.extensions<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-cluster-specify-address-dubbo3<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<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><p>Adapt to Dubbo 2 version</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo.extensions<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-cluster-specify-address-dubbo2<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<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><h3 id="call-example">call example</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>ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> referenceConfig <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">// ...init |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>DemoService demoService <span style="color:#719e07">=</span> referenceConfig<span style="color:#719e07">.</span> <span style="color:#268bd2">get</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// for invoke |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// 1. find 10.10.10.10:20880 exist |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// 2. if not exist, create a invoker to 10.10.10.10:20880 if `needToCreate` is true (only support in Dubbo 3.x&#39;s implementation) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>UserSpecifiedAddressUtil<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#719e07">new</span> Address<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;10.10.10.10&#34;</span><span style="color:#719e07">,</span> 20880<span style="color:#719e07">,</span> <span style="color:#cb4b16">true</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span>demoService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;world&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// for invoke |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// 1. find 10.10.10.10:any exist |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// 2. if not exist, create a invoker to 10.10.10.10:20880 if `needToCreate` is true (only support in Dubbo 3.x&#39;s implementation) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>UserSpecifiedAddressUtil<span style="color:#719e07">.</span>setAddress<span style="color:#719e07">(</span><span style="color:#719e07">new</span> Address<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;10.10.10.10&#34;</span><span style="color:#719e07">,</span> 0<span style="color:#719e07">,</span> <span style="color:#cb4b16">true</span><span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span>demoService<span style="color:#719e07">.</span>sayHello<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;world&#34;</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><h3 id="parameter-description">Parameter Description</h3> |
| <p>Parameters specifying an IP call wrap around an <code>Address</code> object. The parameter type reference is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.rpc.cluster.specifyaddress<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">Address</span> <span style="color:#268bd2">implements</span> Serializable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ip - priority: 3 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">private</span> String ip<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ip+port - priority: 2 |
| </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> port<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// address - priority: 1 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#268bd2">private</span> URL urlAddress<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:#dc322f">boolean</span> needToCreate <span style="color:#719e07">=</span> <span style="color:#cb4b16">false</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ignore setter and getter |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><ol> |
| <li><code>urlAddress</code> is the highest priority, if the URL address of the target is specified, it will be used first. (no longer matches follow-up)</li> |
| <li>ip + port (non-0 port) is the second priority, and will be matched from the addresses that have been pushed by the registration center. (no longer matches follow-up)</li> |
| <li>IP is the third priority, and it will be matched from the addresses that have been pushed by the registration center.</li> |
| </ol> |
| <p>In particular, if <code>needToCreate</code> is specified as <code>true</code>, an invoker will be automatically built according to the parameters passed in. For addresses specified by specifying ip ( + port ), |
| It will automatically use the parameter of the first address in the registry to create the template; if there is no address, it will be automatically created based on the Dubbo protocol. |
| To customize the logic of creating invoker, please implement <code>org.apache.dubbo.rpc.cluster.specifyaddress.UserSpecifiedServiceAddressBuilder</code> SPI interface. (This function is only supported by <strong>Dubbo 3 implementation</strong>)</p> |
| <p>Pass the <code>UserSpecifiedAddressUtil</code> tool class to the Dubbo framework before constructing the <code>Address</code> parameter for each request.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.rpc.cluster.specifyaddress<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">UserSpecifiedAddressUtil</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:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">setAddress</span><span style="color:#719e07">(</span>Address address<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> <span style="color:#719e07">...</span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><blockquote> |
| <p><strong>Must be set every time, and the call must be initiated immediately after setting</strong>, if there is an interceptor error (remove this value in the Dubbo framework is performed during the address selection process), it is recommended to set null to avoid ThreadLocal memory leaks that will affect the follow-up transfer.</p> |
| </blockquote></description></item><item><title>Docs3-V2: Consistent Hash Site Selection</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/consistent-hash/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/consistent-hash/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>[Analysis of Dubbo Consistent Hash Load Balancing Implementation](/zh-cn/blog/2019/05/01/dubbo-%E4%B8%80%E8%87%B4%E6%80%A7hash%E8%B4%9F%E8 %BD%BD%E5%9D%87%E8%A1%A1%E5%AE%9E%E7%8E%B0%E5%89%96%E6%9E%90/)</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>When there are multiple servers, the server is selected according to the consistent hashing of the request parameters.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <p>There are many ways to configure consistent hashing, the most common are:</p> |
| <h3 id="annotation-configuration">Annotation configuration</h3> |
| <blockquote> |
| <p>@DubboReference(loadbalance = &ldquo;consistenthash&rdquo;)</p> |
| </blockquote> |
| <h3 id="api-configuration">API configuration</h3> |
| <blockquote> |
| <p>referenceConfig.setLoadBalance(&ldquo;consistenthash&rdquo;);</p> |
| </blockquote> |
| <h3 id="properties-configuration">Properties configuration</h3> |
| <blockquote> |
| <p>dubbo.reference.loadbalance=consistenthash</p> |
| </blockquote> |
| <h3 id="xml-configuration">XML configuration</h3> |
| <blockquote> |
| <p>&lt;dubbo:reference loadbalance=&ldquo;consistenthash&rdquo; /&gt;</p> |
| </blockquote> |
| <p>By default, the first parameter is used as the hash key. If you need to switch parameters, you can specify the <code>hash.arguments</code> property</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;</span> referenceConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>DemoService<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// ...init |
| </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;</span>String<span style="color:#719e07">,</span> String<span style="color:#719e07">&gt;();</span> |
| </span></span><span style="display:flex;"><span>parameters<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;hash. arguments&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;1&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>parameters<span style="color:#719e07">.</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;sayHello. hash. arguments&#34;</span><span style="color:#719e07">,</span> <span style="color:#2aa198">&#34;0,1&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>referenceConfig<span style="color:#719e07">.</span>setParameters<span style="color:#719e07">(</span>parameters<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>referenceConfig<span style="color:#719e07">.</span>setLoadBalance<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;consistenthash&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>referenceConfig<span style="color:#719e07">.</span> <span style="color:#268bd2">get</span><span style="color:#719e07">();</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: RPC call context</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/context/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/context/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The context stores the environment information needed in the current calling process. All configuration information will be converted to URL parameters, see the <strong>corresponding URL parameters</strong> column in <a href="../../../reference-manual/config/properties/">schema configuration reference manual</a>.</p> |
| <p>RpcContext is a temporary state recorder for ThreadLocal. When RPC requests are received or RPC requests are initiated, the state of RpcContext will change. For example: A tunes B, B then tunes C, then on machine B, before B tunes C, RpcContext records the information of A&rsquo;s tune to B, after B tunes C, RpcContext records the information of B&rsquo;s tune to C.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Global link tracking and hiding parameters.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="service-consumer">Service 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><span style="color:#586e75">// remote call |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>xxxService<span style="color:#719e07">.</span> <span style="color:#268bd2">xxx</span><span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Whether this end is a consumer end, here will return true |
| </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>getServiceContext<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 call |
| </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>getServiceContext<span style="color:#719e07">().</span>getRemoteHost<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Get the current service configuration information, all configuration information will be converted into URL parameters |
| </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>getServiceContext<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 time an RPC call is initiated, the context state will change |
| </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><h3 id="service-provider">Service Provider</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">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">// Whether this end is the provider end, here will return true |
| </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>getServiceContext<span style="color:#719e07">().</span>isProviderSide<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Get the IP address of the caller |
| </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>getServiceContext<span style="color:#719e07">().</span>getRemoteHost<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Get the current service configuration information, all configuration information will be converted into URL parameters |
| </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>getServiceContext<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 time an RPC call is initiated, the context state will change |
| </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:#586e75">// At this point, the local end becomes the consumer end, and false will be returned here |
| </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>getServiceContext<span style="color:#719e07">().</span>isProviderSide<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Subscription Only</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/subscribe-only/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/subscribe-only/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>In order to facilitate development and testing, a registration center that is available for all services is often shared offline. At this time, if a service provider under development registers, it may affect the normal operation of consumers.</p> |
| <p>The service provider developer can only subscribe to the service (the developed service may depend on other services), without registering the service under development, and test the service under development through direct connection.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/subscribe-only.jpg" alt="/user-guide/images/subscribe-only.jpg"></p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="disable-registration-configuration">Disable registration configuration</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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><strong>or</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-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>Docs3-V2: Call trigger event notification</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/events-notify/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/events-notify/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Before calling, after calling, and when an exception occurs, three events <code>oninvoke</code>, <code>onreturn</code>, and <code>onthrow</code> will be triggered. You can configure which method of which class to notify when an event occurs.</p> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p><a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-notify">https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-notify</a></p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Before calling the service method, we can record the start time, and after the call ends, we can count the entire call cost. When an exception occurs, we can warn or print error logs, or record request logs and response logs before and after calling the service.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="service-provider-and-consumer-share-service-interface">Service provider and consumer share service interface</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">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><h3 id="service-provider-implementation">Service provider implementation</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">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><h3 id="service-provider-configuration">Service provider configuration</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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><h3 id="service-consumer-callback-interface">Service consumer Callback interface</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">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><h3 id="service-consumer-callback-implementation">Service consumer Callback implementation</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">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> <span style="color:#268bd2">put</span><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> <span style="color:#268bd2">put</span><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><h3 id="service-consumer-callback-configuration">Service consumer Callback configuration</h3> |
| <p>There are the following combinations of the two:</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 without callback: <code>async=true</code></li> |
| <li>Synchronous without callback: <code>async=false</code></li> |
| </ul> |
| <p><code>callback</code> and <code>async</code> function are decomposed orthogonally, <code>async=true</code> indicates whether the result is returned immediately, <code>async=false</code> is the default, <code>onreturn</code> indicates whether a callback is required.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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><h3 id="test-code">Test code</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>IDemoService demoService <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>IDemoService<span style="color:#719e07">)</span> context<span style="color:#719e07">.</span> <span style="color:#268bd2">getBean</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;demoService&#34;</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span>NotifyImpl notify <span style="color:#719e07">=</span> <span style="color:#719e07">(</span>NotifyImpl<span style="color:#719e07">)</span> context<span style="color:#719e07">.</span> <span style="color:#268bd2">getBean</span><span style="color:#719e07">(</span><span style="color:#2aa198">&#34;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> <span style="color:#268bd2">get</span><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: It is only used to illustrate that the callback is called normally, and the specific implementation of the business is determined by itself. |
| </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> <span style="color:#268bd2">sleep</span><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></description></item><item><title>Docs3-V2: Multi-protocol</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/multi-protocols/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/multi-protocols/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Dubbo allows multi-protocol configuration, supports different protocols on different services or supports multiple protocols on the same service at the same time.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="different-protocols-for-different-services">Different protocols for different services</h3> |
| <p>Different services apply different protocols for transmission in terms of performance. For example, short connection protocols are used for large data, and long connection protocols are used for small data and large concurrency.</p> |
| <div class="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;!-- Multi-protocol configuration --&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 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.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><h3 id="multi-protocol-exposed-services">Multi-protocol exposed services</h3> |
| <p>Needed to interoperate with http clients</p> |
| <div class="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;!-- Multi-protocol configuration --&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;!-- Exposing services using 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>Docs3-V2: The server makes a callback to the client</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/callback-parameter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/callback-parameter/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The parameter callback method is the same as calling a local callback or listener, you only need to declare which parameter is the callback type in the Spring configuration file. Dubbo will generate a reverse proxy based on the persistent connection, so that the client logic can be invoked from the server. You can refer to <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-callback">sample code in the dubbo project</a>.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>The callback function notifies the client of the execution result, or sends a notification. When the method execution time is relatively long, it is similar to an asynchronous call, and the client approval result is called back in the approval workflow.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="service-interface-example">Service interface example</h3> |
| <p>CallbackService.java</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> 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><p>CallbackListener.java</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> 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><h3 id="service-provider-interface-implementation-example">Service provider interface implementation example</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.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> <span style="color:#268bd2">remove</span><span style="color:#719e07">(</span>entry<span style="color:#719e07">.</span> <span style="color:#268bd2">getKey</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> Thread<span style="color:#719e07">.</span>sleep<span style="color:#719e07">(</span>5000<span style="color:#719e07">);</span> <span style="color:#586e75">// Timely 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">// defensive fault tolerance |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> t<span style="color:#719e07">.</span> <span style="color:#268bd2">printStackTrace</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> <span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> t<span style="color:#719e07">.</span> <span style="color:#268bd2">setDaemon</span><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> <span style="color:#268bd2">start</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:#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> <span style="color:#268bd2">put</span><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><h3 id="service-provider-configuration-example">Service provider configuration example</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;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;!--You can also specify the 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><h3 id="service-consumer-configuration-example">Service consumer configuration example</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;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><h3 id="service-consumer-call-example">Service consumer call example</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>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> <span style="color:#268bd2">start</span><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> <span style="color:#268bd2">getBean</span><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></description></item><item><title>Docs3-V2: Local Masquerade</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/local-mock/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/local-mock/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>There is a mechanism in Dubbo3 to achieve lightweight service degradation, which is local masquerade<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Local masquerading is often used for service degradation. For example, for a verification service, when all the service providers hang up, if the service consumer initiates a remote call at this time, the call will fail and an <code>RpcException</code> will be thrown.</p> |
| <p>In order to avoid such a situation where an exception is thrown directly, the client can use local masquerade to provide Mock data and return authorization failure.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="enable-mock-configuration">Enable mock configuration</h3> |
| <p>Configured in the following way in the Spring XML 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;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>Provide 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 fake fault-tolerant data, this method is only executed when RpcException occurs |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;fault tolerance 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><h3 id="use-the-return-keyword-to-mock-the-return-value">Use the return keyword to mock the return value</h3> |
| <p>Use <code>return</code> to return an object represented by a string as the return value of the Mock. Legal strings can be:</p> |
| <ul> |
| <li><em>empty</em>: stands for empty, returns the default value of the basic type, the empty value of the collection class, and the empty object of the custom entity class <sup id="fnref:3"><a href="#fn:3" class="footnote-ref" role="doc-noteref">3</a></sup></li> |
| <li><em>null</em>: return <code>null</code></li> |
| <li><em>true</em>: returns <code>true</code></li> |
| <li><em>false</em>: return <code>false</code></li> |
| <li><em>JSON string</em>: returns the object obtained after deserializing the JSON string</li> |
| </ul> |
| <p>For example, if the consumer of the service often needs try-catch 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><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoService</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> Offer <span style="color:#268bd2">findOffer</span><span style="color:#719e07">(</span>String offerId<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><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> <span style="color:#268bd2">findOffer</span><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> <span style="color:#268bd2">error</span><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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> offer<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>Then consider changing to a Mock implementation, and <code>return null</code> in the Mock implementation. If you just want to simply ignore exceptions, it is available in <code>2.0.11</code> and above:</p> |
| <div class="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><h3 id="use-the-throw-keyword-mock-to-throw-an-exception">Use the throw keyword Mock to throw an exception</h3> |
| <p>Use <code>throw</code> to return an Exception object as the return value of the Mock.</p> |
| <p>A default RPCException is thrown when the call fails:</p> |
| <div class="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></span><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>When an error occurs in the call, throw the specified Exception <sup id="fnref:4"><a href="#fn:4" class="footnote-ref" role="doc-noteref">4</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></span><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="use-the-force-and-fail-keywords-to-configure-the-behavior-of-the-mock">Use the force and fail keywords to configure the behavior of the Mock</h3> |
| <p><code>force:</code> means to force the use of Mock behavior, in which case no remote calls will be made.</p> |
| <p><code>fail:</code> Consistent with the default behavior, the mock behavior is only used when an error occurs in the remote call. That is to say, it is actually possible not to use the <code>fail</code> keyword when configuring, but to use <code>throw</code> or <code>return</code> directly.</p> |
| <p>Both <code>force:</code> and <code>fail:</code> are supported in combination with <code>throw</code> or <code>return</code>.</p> |
| <p>Force a specified value to be returned:</p> |
| <div class="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></span><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 the specified exception to be thrown:</p> |
| <div class="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></span><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><p>The specified value is returned when the call fails:</p> |
| <div class="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></span><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;fail:return fake&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- Equivalent to the following writing --&gt;</span> |
| </span></span><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 fake&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>An exception is thrown when the call fails</p> |
| <div class="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></span><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;fail:throw com.foo.MockException&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- Equivalent to the following writing --&gt;</span> |
| </span></span><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="configure-mock-at-method-level">Configure Mock at method level</h3> |
| <p>Mock can be specified at the method level, assuming there are several methods on <code>com.foo.BarService</code>, we can specify Mock behavior for the <code>sayHello()</code> method separately.</p> |
| <p>The specific configuration is as follows. In this example, whenever <code>sayHello()</code> is called, it is forced to return &ldquo;fake&rdquo;:</p> |
| <div class="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></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> check=<span style="color:#2aa198">&#34;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><h2 id="precautions">Precautions</h2> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Mock is a subset of Stub, which is convenient for service providers to implement fault-tolerant logic on the client side. Because it is often necessary to perform fault-tolerant when RpcException (such as network failure, timeout, etc.) occurs, and when business exceptions (such as login Wrong username and password) does not require fault tolerance. If you use Stub, you may need to catch and rely on the RpcException class, but you can use Mock without relying on RpcException, because its agreement is to execute only when RpcException occurs.&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>Next to the interface, put a Mock implementation that implements the BarService interface and has a no-argument constructor. At the same time, if the Mock class is not explicitly specified in the configuration file, then it is necessary to ensure that the fully qualified class name of the Mock class is in the form of <code>original fully qualified class name+Mock</code>, such as <code>com.foo.BarServiceMock</code>, otherwise it will be Mock will fail.&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:3"> |
| <p>If the return value is an entity class, then it will return an empty object with default values instead of <code>null</code>.&#160;<a href="#fnref:3" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:4"> |
| <p>Custom exceptions must have a constructor with <code>String</code> as the input parameter, which will be used to receive exception information.&#160;<a href="#fnref:4" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs3-V2: Multiple Registries</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/multi-registry/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/multi-registry/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>Dubbo supports the simultaneous registration of the same service to multiple registries, or the registration of different services to different registries, or even references to services with the same name registered on different registries at the same time. In addition, the registry is <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup> that supports custom extensions.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="multi-registry-registration">Multi-registry registration</h3> |
| <p>For example: Some services of the Chinese website are too late to be deployed in Qingdao, and are only deployed in Hangzhou, while other applications in Qingdao need to reference this service, so the service can be registered to two registration centers 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-registry configuration --&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;!-- Register with 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><h3 id="different-services-use-different-registries">Different services use different registries</h3> |
| <p>For example: some CRM services are specially designed for international websites, and some services are specially designed for Chinese websites.</p> |
| <div class="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-registry configuration --&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;!-- Register with the Chinese Station Registration Center --&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;!-- Register with the International Station Registration Center --&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><h3 id="multiple-registry-references">Multiple Registry References</h3> |
| <p>For example: CRM needs to call the PC2 service of the Chinese station and the international station at the same time. PC2 is deployed in both the Chinese station and the international station. The interface and version number are the same, but the connected databases are 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-registry configuration --&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;!-- Quote 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>If only the test environment temporarily needs to connect to two different registration centers, use vertical symbols to separate multiple different registration center 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;!-- Multi-registry configuration, separated by a vertical sign means connecting to multiple different registries at the same time, and multiple cluster addresses of the same registrant 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;!-- Reference service --&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>You can extend the registry by yourself, see: <a href="../../../reference-manual/spi/description/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>Docs3-V2: Local Stub</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/local-stub/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/local-stub/</guid><description> |
| <h2 id="feature-description">Feature description:</h2> |
| <p>After the remote service, the client usually only has the interface, and the implementation is all on the server side, but the provider sometimes wants to execute some logic on the client side.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/stub.jpg" alt="/user-guide/images/stub.jpg"></p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Do ThreadLocal cache, verify parameters in advance, forge fault-tolerant data after call failure, etc. At this time, you need to bring a Stub in the API, and the client generates a Proxy instance, which will pass the Proxy to the Stub through the constructor <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>, and then pass the The Stub is exposed to the user, and the Stub can decide whether to call the Proxy.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="spring-configuration-file-configuration">spring configuration file configuration</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:consumer</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:consumer</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><h3 id="provide-stub-implementation-2">Provide Stub implementation <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></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.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 constructor passes in the real remote proxy object |
| </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">// This code is executed on the client side, you can do ThreadLocal local cache on the client side, or pre-verify whether the parameters are legal, 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 are fault tolerant and can do any AOP interception |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;fault tolerance 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><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>Stub must have a constructor that can be passed to Proxy.&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p>Next to the interface put a Stub implementation that implements the BarService interface and has a constructor that passes 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>Docs3-V2: Echo Test</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/echo-service/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/echo-service/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The echo test is used to detect whether the service is available. The echo test is performed according to the normal request process. It can test whether the entire call is smooth and can be used for monitoring.</p> |
| <h2 id="reference-use-case">Reference use case</h2> |
| <p><a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-echo">https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-echo</a></p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <h2 id="how-to-use">How to use</h2> |
| <p>All services automatically implement the <code>EchoService</code> interface, just cast any service reference to <code>EchoService</code> to use it.</p> |
| <h3 id="spring-configuration">Spring configuration</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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><h3 id="code">code</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:#586e75">// remote service reference |
| </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> <span style="color:#268bd2">getBean</span><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></span><span style="display:flex;"><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 style="color:#586e75">// Mandatory transformation to EchoService |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// echo test availability |
| </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> <span style="color:#268bd2">$echo</span><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> <span style="color:#268bd2">equals</span><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>Docs3-V2: Call Information Record</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/accesslog/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/accesslog/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The log in dubbo3 is divided into log adaptation and access log. If you want to record each request information, you can enable the access log, which is similar to the apache access log.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>Based on audit needs, etc. similar to nginx accesslog output, etc.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="log4j-log">log4j log</h3> |
| <p>Output access logs to the current application&rsquo;s log4j log</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-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><h3 id="specify-the-file">specify the file</h3> |
| <p>Output the access log to the specified 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;dubbo:protocol</span> accesslog=<span style="color:#2aa198">&#34;http://10.20.160.198/wiki/display/dubbo/foo/bar.log&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><blockquote> |
| <p>The log volume is relatively large, please pay attention to the disk capacity.</p> |
| </blockquote></description></item><item><title>Docs3-V2: Achieving generalization (server-side generalization)</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/generic-service/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/generic-service/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The universal interface implementation method is mainly used when there is no API interface and model classifier on the server side. All POJOs in the parameters and return values are represented by Map, which is usually used for framework integration. For example, to implement a general remote service Mock framework, you can All service requests are handled by implementing the GenericService interface.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <h2 id="how-to-use">How to use</h2> |
| <p>Implement the <code>GenericService</code> interface in 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:#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><h3 id="exposing-generic-implementations-via-spring">Exposing generic implementations via Spring</h3> |
| <p>Declare the implementation of the service in the 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;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><h3 id="expose-the-generalization-implementation-through-the-api">Expose the generalization implementation through the API</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">...</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Use org.apache.dubbo.rpc.service.GenericService to replace all interface implementations |
| </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">// This instance is very heavy, and it encapsulates all connections with the registry and service providers, 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">// Weakly typed 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 service implementation |
| </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">// expose and register services |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>service<span style="color:#719e07">.</span> <span style="color:#268bd2">export</span><span style="color:#719e07">();</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Asynchronous execution</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/async-execute-on-provider/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/async-execute-on-provider/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>This document is no longer maintained. You are currently viewing a snapshot version. If you want to see the latest version of the documentation, see <a href="https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/attachment/">Latest Version</a>.</p> |
| </div> |
| <p>The asynchronous execution of the provider side switches the blocked business from Dubbo&rsquo;s internal thread pool to the business-defined thread, avoiding excessive occupation of the Dubbo thread pool, and helping to avoid the mutual influence between different services. Asynchronous execution is tantamount to saving resources or improving RPC response performance, because if business execution needs to be blocked, there is always a thread to be responsible for execution.</p> |
| <div class="alert alert-warning" role="alert"> |
| <h4 class="alert-heading">Attention</h4> |
| <p>The asynchronous execution on the Provider side and the asynchronous call on the Consumer side are independent of each other, and you can configure both ends in any orthogonal combination</p> |
| <ul> |
| <li>Consumer Synchronization - Provider Synchronization</li> |
| <li>Consumer asynchronous - Provider synchronous</li> |
| <li>Consumer synchronous - Provider asynchronous</li> |
| <li>Consumer asynchronous - Provider asynchronous</li> |
| </ul> |
| </div> |
| <h2 id="define-the-interface-of-completablefuture-signature">Define the interface of 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> <span style="color:#268bd2">getContext</span><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 and avoid using the JDK public 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> <span style="color:#268bd2">supplyAsync</span><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> <span style="color:#268bd2">sleep</span><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>Through <code>return CompletableFuture.supplyAsync()</code>, the business execution has been switched from the Dubbo thread to the business thread, avoiding the blocking of the Dubbo thread pool.</p> |
| <h2 id="using-asynccontext">Using AsyncContext</h2> |
| <p>Dubbo provides an asynchronous interface <code>AsyncContext</code> similar to Servlet 3.0, which can also implement asynchronous execution on the Provider side 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 exposure is exactly the same as ordinary services:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;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> <span style="color:#268bd2">startAsync</span><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 the context, it must be executed in the first sentence |
| </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> <span style="color:#268bd2">sleep</span><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 back the 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>Docs3-V2: Local call</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/local-call/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/local-call/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>The local call uses the injvm protocol, which is a pseudo-protocol. It does not open ports, does not initiate remote calls, and is only directly associated in the JVM, but executes Dubbo&rsquo;s Filter chain.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <p>When we need to call a remote service, the remote service has not been developed yet, and similar services are implemented locally using the injvm protocol. When calling this service, we can call our local implementation service.</p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="define-the-injvm-protocol">Define the injvm protocol</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:protocol</span> name=<span style="color:#2aa198">&#34;injvm&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="set-the-default-protocol">Set the default protocol</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:provider</span> protocol=<span style="color:#2aa198">&#34;injvm&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="set-service-protocol">Set service protocol</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> protocol=<span style="color:#2aa198">&#34;injvm&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="prioritize-the-use-of-injvm">Prioritize the use of injvm</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: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><strong>or</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-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><h4 id="notice">Notice:</h4> |
| <p>Dubbo from <code>2.2.0</code>, each service will be exposed locally by default, and can be referenced locally without any configuration. If you do not want the service to be exposed remotely, you only need to set the protocol to injvm in the provider. **</p> |
| <h3 id="automatic-exposure">Automatic exposure</h3> |
| <p>Starting with <code>2.2.0</code>, every service is exposed locally by default. When referencing services, local services are preferred by default. If you want to reference remote services, you can use the following configuration to force references to remote services.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> ... scope=<span style="color:#2aa198">&#34;remote&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="dynamic-configuration-call-behavior">Dynamic configuration call behavior</h3> |
| <p>Starting with&rsquo; 3.2&rsquo;, the api provided by Dubbo allows users to dynamically configure whether a single call is a local call or a remote call, and when it is not configured, the local service will be referenced first by default.</p> |
| <p><strong>Configure a single call as a remote call.</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>RpcContext<span style="color:#719e07">.</span>getServiceContext<span style="color:#719e07">().</span>setLocalInvoke<span style="color:#719e07">(</span><span style="color:#cb4b16">false</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div><p><strong>Configure a single call as a local call.</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>RpcContext<span style="color:#719e07">.</span>getServiceContext<span style="color:#719e07">().</span>setLocalInvoker<span style="color:#719e07">(</span><span style="color:#cb4b16">true</span><span style="color:#719e07">);</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Delayed Exposure</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/delay-publish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/delay-publish/</guid><description> |
| <p>If your service needs warm-up time, such as initializing the cache, waiting for related resources to be in place, etc., you can use delay for delayed exposure. In Dubbo version 2.6.5, we made minor adjustments to the service delay exposure logic, and postponed the countdown action for services that require delay exposure (delay &gt; 0) until Spring initialization is complete. You will not feel this change while using Dubbo, so please feel free to use it.</p> |
| <h2 id="versions-before-dubbo-265">Versions before Dubbo 2.6.5</h2> |
| <p>Delay until Spring initialization completes before exposing services<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:service</span> delay=<span style="color:#2aa198">&#34;-1&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Expose service with 5 second delay</p> |
| <div class="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="dubbo-265-and-later-versions">Dubbo 2.6.5 and later versions</h2> |
| <p>All services will be exposed after Spring initialization is complete. If you do not need to delay exposing services, you do not need to configure delay.</p> |
| <p>Expose service with 5 second delay</p> |
| <div class="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="spring-2x-initialization-deadlock-problem">Spring 2.x initialization deadlock problem</h2> |
| <h3 id="triggering-conditions">Triggering conditions</h3> |
| <p>When Spring resolves to <code>&lt;dubbo:service /&gt;</code>, the service has been exposed, and Spring is still initializing other beans. If a request comes in at this time, and there is a usage of calling <code>applicationContext.getBean()</code> in the implementation class of the service.</p> |
| <ol> |
| <li> |
| <p>The applicationContext.getBean() call of the requesting thread first synchronizes the singletonObjects to determine whether the Bean exists, and initializes the synchronization beanDefinitionMap if it does not exist, and then synchronizes the singletonObjects again to write the Bean instance cache.</p> |
| <p><img src="https://dubbo.apache.org/imgs/user/lock-get-bean.jpg" alt="deadlock"></p> |
| </li> |
| <li> |
| <p>The Spring initialization thread, because it does not need to judge the existence of the bean, directly synchronizes the beanDefinitionMap to initialize, and synchronizes singletonObjects to write the 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> |
| <p>This causes the getBean thread to lock singletonObjects first, then beanDefinitionMap, and singletonObjects again. |
| The Spring initialization thread first locks beanDefinitionMap and then singletonObjects. The reverse lock leads to thread deadlock, unable to provide services, and unable to start.</p> |
| </li> |
| </ol> |
| <h3 id="workaround">Workaround</h3> |
| <ol> |
| <li>It is strongly recommended not to call applicationContext.getBean() in the service implementation class, and all use Spring beans by IoC injection.</li> |
| <li>If you really want to call getBean(), you can load the Dubbo configuration at the end of Spring.</li> |
| <li>If you don’t want to depend on the configuration order, you can use <code>&lt;dubbo:provider delay=”-1” /&gt;</code> to make Dubbo expose the service after the Spring container is initialized.</li> |
| <li>If you use getBean() extensively, it is equivalent to degenerating Spring into a factory mode, and you can isolate Dubbo&rsquo;s services into a separate Spring container.</li> |
| </ol> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p>Trigger exposure based on Spring&rsquo;s ContextRefreshedEvent event&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Docs3-V2: Sign Up Only</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/registry-only/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/registry-only/</guid><description> |
| <h2 id="feature-description">Feature description</h2> |
| <p>If there are two mirroring environments and two registries, one service is only deployed in one of the registries, and the other registry has not yet been deployed, and other applications in the two registries need to rely on this service. At this time, the service provider can only register the service to another registration center, but not subscribe to the service from another registration center.</p> |
| <h2 id="scenes-to-be-used">scenes to be used</h2> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="disable-subscription-configuration">Disable subscription configuration</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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><strong>or</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-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>Docs3-V2: Distributed transaction support</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/distributed-transaction/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/service/distributed-transaction/</guid><description> |
| <p>Distributed transactions are implemented based on the JTA/XA specification.</p> |
| <p><strong>two-phase commit</strong></p> |
| <p><img src="https://dubbo.apache.org/imgs/user/jta-xa.jpg" alt="/user-guide/images/jta-xa.jpg"></p> |
| <p>In Dubbo, you can use [seata](/zh-cn/blog/2019/01/17/How to use seata to ensure the consistency between dubbo microservices/) to complete the support for distributed transactions.</p></description></item></channel></rss> |
