| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – SPI Extension Implementations</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/</link><description>Recent content in SPI Extension Implementations on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs/v2.7/dev/impls/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: Protocol Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/protocol/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/protocol/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension to RPC protocol, hide details of remote call.</p> |
| <p>Contract:</p> |
| <ul> |
| <li>When user calls <code>invoke()</code> method of <code>Invoker</code> object which&rsquo;s returned from <code>refer()</code> call, the protocol needs to correspondingly execute <code>invoke()</code> method of <code>Invoker</code> object passed from remote <code>export()</code> method associated with the same URL.</li> |
| <li>Moreover, it&rsquo;s protocol&rsquo;s responsibility to implement <code>Invoker</code> which&rsquo;s returned from <code>refer()</code>. Generally speaking, protocol sends remote request in the <code>Invoker</code> implementation, but needs not to care about the <code>Invoker</code> passed into <code>export()</code> since the framework will implement the logic and pass in the instance.</li> |
| </ul> |
| <p>Notes:</p> |
| <ul> |
| <li>Protocol does not need to care about the proxy of the business interface. The upper layer of the framework will convert <code>Invoker</code> into business interface.</li> |
| <li>It is not a requirement that the protocol must use TCP for network communication. It could be file-sharing, IPC, or others.</li> |
| </ul> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.Protocol</code></li> |
| <li><code>org.apache.dubbo.rpc.Exporter</code></li> |
| <li><code>org.apache.dubbo.rpc.Invoker</code></li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">Protocol</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Export remote service: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. Should save address info for the request when the protocol receives it: RpcContext.getContext().setRemoteAddress();&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. export() must be implemented as idempotent, that is, it should not introduce side effect when the implementation gets called with the same Invoker for more than once. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. Invoker is passed by the framework, and the protocol should not care about it. &lt;br&gt; |
| </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 &lt;T&gt; Service type |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param invoker Service invoker |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return exporter The reference of service exporter, used for cancelling service export. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @throws RpcException throw when there&#39;s any error during service export, e.g. the port is occupied |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Exporter<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">export</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException<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"> * Reference remote service: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. When user calls `invoke()` method of `Invoker` object which&#39;s returned from `refer()` call, the protocol needs to correspondingly execute `invoke()` method of `Invoker` object passed from remote `export()` method associated with the same URL. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. It&#39;s protocol&#39;s responsibility to implement `Invoker` which&#39;s returned from `refer()`. Generally speaking, protocol sends remote request in the `Invoker` implementation. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. When there&#39;s check=false set in URL, the implementation must not throw exception but try to recover when connection fails. |
| </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 &lt;T&gt; Service type |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param type Service type |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param url URL address for the remote service |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return invoker service&#39;s local proxy |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @throws RpcException throw when there&#39;s any error while connecting to the service provider |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">refer</span><span style="color:#719e07">(</span>Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type<span style="color:#719e07">,</span> URL url<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- declare protocol, if id is not set, then use the value of name for id --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> id=<span style="color:#2aa198">&#34;xxx1&#34;</span> name=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- reference protocol, if protocol&#39;s attribute is not set, then protocol configuration will be scanned automatically from ApplicationContext --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> protocol=<span style="color:#2aa198">&#34;xxx1&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default value for referenced protocol, it will be used if protocol attribute is not configured in &lt;dubbo:service&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> protocol=<span style="color:#2aa198">&#34;xxx1&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-protocol">Existing Protocol</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.protocol.injvm.InjvmProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.protocol.dubbo.DubboProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.protocol.rmi.RmiProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.protocol.http.HttpProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.protocol.http.hessian.HessianProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.protocol.memcached.MemcachedProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.support.MockProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.protocol.redis.RedisProtocol</code></li> |
| <li><code>org.apache.dubbo.rpc.protocol.nativethrift.ThriftProtocol</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxProtocol.java (Protocol implementation) |
| </span></span><span style="display:flex;"><span> |-XxxExporter.java (Exporter implementation) |
| </span></span><span style="display:flex;"><span> |-XxxInvoker.java (Invoker implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.Protocol (plain text file with the content: xxx=com.xxx.XxxProtocol) |
| </span></span></code></pre></div><p>XxxProtocol.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.xxx<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.rpc.Protocol<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">XxxProtocol</span> <span style="color:#268bd2">implements</span> Protocol <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Exporter<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">export</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxExporter<span style="color:#719e07">(</span>invoker<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">refer</span><span style="color:#719e07">(</span>Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type<span style="color:#719e07">,</span> URL url<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxInvoker<span style="color:#719e07">(</span>type<span style="color:#719e07">,</span> url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxExporter.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.xxx<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.rpc.support.AbstractExporter<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">XxxExporter</span><span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">extends</span> AbstractExporter<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxExporter</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException<span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span><span style="color:#719e07">(</span>invoker<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unexport</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>unexport<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxInvoker.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.xxx<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.rpc.support.AbstractInvoker<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">XxxInvoker</span><span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">extends</span> AbstractInvoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxInvoker</span><span style="color:#719e07">(</span>Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type<span style="color:#719e07">,</span> URL url<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException<span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span><span style="color:#719e07">(</span>type<span style="color:#719e07">,</span> url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> Result <span style="color:#268bd2">doInvoke</span><span style="color:#719e07">(</span>Invocation invocation<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> Throwable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.Protocol：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxProtocol</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Filter Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/filter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/filter/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension for intercepting the invocation for both service provider and consumer, furthermore, most of functions in dubbo are implemented base on the same mechanism. Since every time when remote method is invoked, the filter extensions will be executed too, the corresponding penalty should be considered before more filters are added.</p> |
| <p>Contract:</p> |
| <ul> |
| <li>User defined filters are executed after built-in filters by default.</li> |
| <li>Special value <code>default</code> is introduced to represent the default extension location. For example: for <code>filter=&quot;xxx,default,yyy&quot;</code>, <code>xxx</code> is before default filter, and <code>yyy</code> is after the default filter.</li> |
| <li>Special value <code>-</code> means delete. For example: <code>filter=&quot;-foo1&quot;</code> excludes <code>foo1</code> extension. For example, <code>filter=&quot;-default&quot;</code> exclues all default filters.</li> |
| <li>When provider and service have filter configured at the same moment, all filters are accumulated together instead of override, for example: for <code>&lt;dubbo:provider filter=&quot;xxx,yyy&quot;/&gt;</code> and <code>&lt;dubbo:service filter=&quot;aaa,bbb&quot; /&gt;</code>，<code>xxx</code>, <code>yyy</code>, <code>aaa</code>, <code>bbb</code> are all count as filters. In order to change to override, use: <code>&lt;dubbo:service filter=&quot;-xxx,-yyy,aaa,bbb&quot; /&gt;</code></li> |
| </ul> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.rpc.Filter</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- filter for consumer --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> filter=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default filter configuration for the consumer, will intercept for all references --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:consumer</span> filter=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- filter for provider --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> filter=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default filter configuration for the provider, will intercept for all services --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> filter=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.filter.EchoFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.GenericFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.GenericImplFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.TokenFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.AccessLogFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.CountFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.ActiveLimitFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.ClassLoaderFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.ContextFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.ConsumerContextFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.ExceptionFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.ExecuteLimitFilter</code></li> |
| <li><code>org.apache.dubbo.rpc.filter.DeprecatedFilter</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxFilter.java (Filter implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.Filter (plain text file with the content: xxx=com.xxx.XxxFilter) |
| </span></span></code></pre></div><p>XxxFilter.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.xxx<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.rpc.Filter<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Result<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">XxxFilter</span> <span style="color:#268bd2">implements</span> Filter <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Result <span style="color:#268bd2">invoke</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker<span style="color:#719e07">,</span> Invocation invocation<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// before filter ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> Result result <span style="color:#719e07">=</span> invoker<span style="color:#719e07">.</span>invoke<span style="color:#719e07">(</span>invocation<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// after filter ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">return</span> result<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>META-INF/dubbo/org.apache.dubbo.rpc.Filter：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxFilter</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: InvokerListener Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/invoker-listener/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/invoker-listener/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Fire event when there&rsquo;s any service referenced.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.rpc.InvokerListener</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- 引用服务监听 --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- service reference listener --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> listener=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default service reference listener --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:consumer</span> listener=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <p><code>org.apache.dubbo.rpc.listener.DeprecatedInvokerListener</code></p> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxInvokerListener.java (InvokerListener implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.InvokerListener (plain text file with the content: xxx=com.xxx.XxxInvokerListener) |
| </span></span></code></pre></div><p>XxxInvokerListener.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.xxx<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.rpc.InvokerListener<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker<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">XxxInvokerListener</span> <span style="color:#268bd2">implements</span> InvokerListener <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">referred</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">destroyed</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.InvokerListener：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxInvokerListener</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: ExporterListener Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/exporter-listener/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/exporter-listener/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Fire events when there&rsquo;s any service exported.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.rpc.ExporterListener</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- service exporter listener --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> listener=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default exporter listener for service provider --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> listener=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <p><code>org.apache.dubbo.registry.directory.RegistryExporterListener</code></p> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxExporterListener.java (ExporterListener implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.ExporterListener (plain text file with the content: xxx=com.xxx.XxxExporterListener) |
| </span></span></code></pre></div><p>XxxExporterListener.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.xxx<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.rpc.ExporterListener<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Exporter<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></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxExporterListener</span> <span style="color:#268bd2">implements</span> ExporterListener <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">exported</span><span style="color:#719e07">(</span>Exporter<span style="color:#719e07">&lt;?&gt;</span> exporter<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unexported</span><span style="color:#719e07">(</span>Exporter<span style="color:#719e07">&lt;?&gt;</span> exporter<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.ExporterListener：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxExporterListener</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Cluster Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/cluster/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/cluster/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Group service providers in a cluster, and treat them as one single provider.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.rpc.cluster.Cluster</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> cluster=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take affect if cluster attribute is not configured in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> cluster=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extensions">Existing Extensions</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.cluster.support.wrapper.MockClusterWrapper</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.FailoverCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.FailfastCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.FailsafeCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.FailbackCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.ForkingCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.AvailableCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.MergeableCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.BroadcastCluster</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.support.registry.ZoneAwareCluster</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxCluster.java (Cluster implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.cluster.Cluster (plain text file with the content: xxx=com.xxx.XxxCluster) |
| </span></span></code></pre></div><p>XxxCluster.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.xxx<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.rpc.cluster.Cluster<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.cluster.support.AbstractClusterInvoker<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.cluster.Directory<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.cluster.LoadBalance<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Result<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">XxxCluster</span> <span style="color:#268bd2">implements</span> Cluster <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">merge</span><span style="color:#719e07">(</span>Directory<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> directory<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> AbstractClusterInvoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;(</span>directory<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Result <span style="color:#268bd2">doInvoke</span><span style="color:#719e07">(</span>Invocation invocation<span style="color:#719e07">,</span> List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers<span style="color:#719e07">,</span> LoadBalance loadbalance<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">};</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.cluster.Cluster：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxCluster</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Router Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/router/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/router/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Pick one from service providers and fire the invocation.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.cluster.RouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.Router</code></li> |
| </ul> |
| <h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.cluster.router.ScriptRouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.router.FileRouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.router.condition.config.AppRouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.CacheableRouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.router.condition.ConditionRouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.router.mock.MockRouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.router.condition.config.ServiceRouterFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.router.tag.TagRouterFactory</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxRouterFactory.java (RouterFactory implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.cluster.RouterFactory (plain text file with the content: xxx=com.xxx.XxxRouterFactory) |
| </span></span></code></pre></div><p>XxxRouterFactory.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.xxx<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.rpc.cluster.RouterFactory<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation<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">XxxRouterFactory</span> <span style="color:#268bd2">implements</span> RouterFactory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Router <span style="color:#268bd2">getRouter</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.cluster.RouterFactory：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxRouterFactory</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: LoadBalance Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/load-balance/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/load-balance/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Pick one from service providers and fire the invocation.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.rpc.cluster.LoadBalance</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> loadbalance=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect when loadbalance is not configured in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> loadbalance=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.cluster.loadbalance.RandomLoadBalance</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.loadbalance.RoundRobinLoadBalance</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.loadbalance.LeastActiveLoadBalance</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.loadbalance.ConsistentHashLoadBalance</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.loadbalance.ShortestResponseLoadBalance</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxLoadBalance.java (LoadBalance implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.cluster.LoadBalance (plain text file with the content: xxx=com.xxx.XxxLoadBalance) |
| </span></span></code></pre></div><p>XxxLoadBalance.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.xxx<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.rpc.cluster.LoadBalance<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation<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">XxxLoadBalance</span> <span style="color:#268bd2">implements</span> LoadBalance <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">select</span><span style="color:#719e07">(</span>List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers<span style="color:#719e07">,</span> Invocation invocation<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.cluster.LoadBalance：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxLoadBalance</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Merger Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/merger/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/merger/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Merge strategy for return result aggregation in group.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.rpc.cluster.Merger</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:method</span> merger=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.ArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.ListMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.SetMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.MapMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.ByteArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.CharArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.ShortArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.IntArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.LongArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.FloatArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.DoubleArrayMerger</code></li> |
| <li><code>org.apache.dubbo.rpc.cluster.merger.BooleanArrayMerger</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxMerger.java (Merger implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.cluster.Merger (plain text file with the content: xxx=com.xxx.XxxMerger) |
| </span></span></code></pre></div><p>XxxMerger.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.xxx<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.rpc.cluster.Merger<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">XxxMerger</span><span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">implements</span> Merger<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> T <span style="color:#268bd2">merge</span><span style="color:#719e07">(</span>T<span style="color:#719e07">...</span> results<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.cluster.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-properties" data-lang="properties"><span style="display:flex;"><span>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxMerger</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Registry Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/registry/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/registry/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Registry extension is used for service registration and discovery.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.registry.RegistryFactory</code></li> |
| <li><code>org.apache.dubbo.registry.Registry</code></li> |
| </ul> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- config registry server --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:registry</span> id=<span style="color:#2aa198">&#34;xxx1&#34;</span> address=<span style="color:#2aa198">&#34;xxx://ip:port&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- reference registry server, if registry attribute is not specified, then ApplicationContext will be scanned to find if there&#39;s any --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> registry=<span style="color:#2aa198">&#34;xxx1&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration for referencing registry server, it will take effect if there&#39;s no registry attribute specified in &lt;dubbo:service&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> registry=<span style="color:#2aa198">&#34;xxx1&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="extension-contract">Extension Contract</h2> |
| <p>RegistryFactory.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:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">RegistryFactory</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Connect to registry server |
| </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 contract for connecting to registry server: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. Will not check connection when check=false is set, otherwise exception will be thrown if connection fails. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. Support authorizing against username:password in the URL &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. Support registry server backup with backup=10.20.153.10 &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 4. Support cache on local disk with file=registry.cache &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. Support timeout setup with timeout=1000 &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 6. Support session expiration setup with session=60000 &lt;br&gt; |
| </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 url registry server address, null is not allowed |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return reference to registry server, never return null |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> Registry <span style="color:#268bd2">getRegistry</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>RegistryService.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:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">RegistryService</span> <span style="color:#719e07">{</span> <span style="color:#586e75">// Registry extends RegistryService |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Register service. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Contract for registering service: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. Registration failure will be ignored and kept retrying if check=false is set in URL, otherwise exception will be thrown &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. Persistence is required if dynamic=false is set in URL, otherwise, the registration info will be removed automatically when register quits accidentally &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. Persistent by category if category=overrides is set in URL, default category is providers. It is possible to notify by category. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 4. Data lost is not tolerant when registry server reboots or network jitter happens. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. It is not allowed to override each other when URLs have same URI part but different parameters &lt;br&gt; |
| </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 url registration info，null is not allowed, e.g.: dubbo://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&amp;application=kylin |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">register</span><span style="color:#719e07">(</span>URL url<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"> * Unregister service. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Contract for unregistering service: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. IllegalStateException should be thrown when registration info which&#39;s supposed to be persistent (with dynamic=false set) cannot be found, otherwise it should be ignored. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. To cancel one service, extract match on its URL will be honored &lt;br&gt; |
| </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 url registration info，null is not allowed, e.g.: dubbo://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&amp;application=kylin |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unregister</span><span style="color:#719e07">(</span>URL url<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"> * 订阅服务. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Subscribe service. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Contract for subscribing service: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. Subscription failure will be ignored and kept retrying if check=false is set in URL &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. Only the specified category will be notified if category=overrides is set in URL. Categories are seperated with comma, and all categorized data will be subscribed when wildcard &#34;*&#34; is specified. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. Allow to query by interface, group, version, classifier, e.g.: interface=com.alibaba.foo.BarService&amp;version=1.0.0&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 4. Allow to query with wildcard &#34;*&#34; to subscribe all versions under all categories for all interfaces, e.g.: interface=*&amp;group=*&amp;version=*&amp;classifier=*&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. Subscription will be automatically recoverred when registry server reboots or network jitter happens. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 6. It is not allowed to override each other when URLs have same URI part but different parameters &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 7. Subscription procedure will not return until the first notification happens. &lt;br&gt; |
| </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 url URL for subscription, null isn&#39;t allowed, e.g.: consumer://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&amp;application=kylin |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param listener notification listener, null is not allowed |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">subscribe</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> NotifyListener listener<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"> * Unsubscribe service. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Contract for unsubscribing service: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. Simply ignore if not subscribe &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. Unsubscribe with URL exact match &lt;br&gt; |
| </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 url URL for unsubscription, null is not allowed, e.g.: consumer://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&amp;application=kylin |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param listener notification listener, null is not allowed |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unsubscribe</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> NotifyListener listener<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"> * 查询注册列表，与订阅的推模式相对应，这里为拉模式，只返回一次结果。 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Lookup subscription list. Compared to push mode for subscription, this is pull mode and returns result only once. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @see org.apache.dubbo.registry.NotifyListener#notify(List) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param url URL for query, null is not allowed, e.g.: consumer://10.20.153.10/com.alibaba.foo.BarService?version=1.0.0&amp;application=kylin |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return subscription list, could be null, has the same meaning as the parameters in {@link org.apache.dubbo.registry.NotifyListener#notify(List&lt;URL&gt;)}. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>URL<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">lookup</span><span style="color:#719e07">(</span>URL url<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><p>NotifyListener.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:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">NotifyListener</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Fire event when receive service change notification. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Contract for notify: &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. Always notify with the whole data instead of partial data from the perspective of service interface and data type. In this way, user needs not compare with the previous result. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. First notification for subscription must contain the full set of data for one particular service &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. It is allowed to separate the different type of data in the upcoming notifications, e.g.: it is legal to only notify one of types among providers, consumers, routes or overrides each time, but pls. note for this particular type, the data must be a full set. &lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 4. If the data for one particular type is empty, need to notify with a special URL which has empty as its protocol and has category parameter for this particluar type. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. Notifier (usually it is monitor center) needs to guarantee the notification sequence by, for say: single thread push, queuing in order, versioning, etc. &lt;br&gt; |
| </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 urls subscription list, always not empty, equivalent to the return result of {@link org.apache.dubbo.registry.RegistryService#lookup(URL)}. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">notify</span><span style="color:#719e07">(</span>List<span style="color:#719e07">&lt;</span>URL<span style="color:#719e07">&gt;</span> urls<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <p><code>org.apache.dubbo.registry.support.dubbo.DubboRegistryFactory</code></p> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory structure:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxRegistryFactoryjava (RegistryFactory implementation) |
| </span></span><span style="display:flex;"><span> |-XxxRegistry.java (Registry implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.registry.RegistryFactory (plain text file with the content: xxx=com.xxx.XxxRegistryFactory) |
| </span></span></code></pre></div><p>XxxRegistryFactory.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.xxx<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.registry.RegistryFactory<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.registry.Registry<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.URL<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">XxxRegistryFactory</span> <span style="color:#268bd2">implements</span> RegistryFactory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Registry <span style="color:#268bd2">getRegistry</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxRegistry<span style="color:#719e07">(</span>url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxRegistry.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.xxx<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.registry.Registry<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.registry.NotifyListener<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.URL<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">XxxRegistry</span> <span style="color:#268bd2">implements</span> Registry <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">register</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unregister</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">subscribe</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> NotifyListener listener<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unsubscribe</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> NotifyListener listener<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.registry.RegistryFactory：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxRegistryFactory</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Monitor Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/monitor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/monitor/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension to monitor service invocation times and time taken for each service invocation.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.monitor.MonitorFactory</code></li> |
| <li><code>org.apache.dubbo.monitor.Monitor</code></li> |
| </ul> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- configure monitor center --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:monitor</span> address=<span style="color:#2aa198">&#34;xxx://ip:port&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <p>org.apache.dubbo.monitor.support.dubbo.DubboMonitorFactory</p> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxMonitorFactoryjava (MonitorFactory implementation) |
| </span></span><span style="display:flex;"><span> |-XxxMonitor.java (Monitor implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.monitor.MonitorFactory (plain text file with the format: xxx=com.xxx.XxxMonitorFactory) |
| </span></span></code></pre></div><p>XxxMonitorFactory.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.xxx<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.monitor.MonitorFactory<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.monitor.Monitor<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.URL<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">XxxMonitorFactory</span> <span style="color:#268bd2">implements</span> MonitorFactory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Monitor <span style="color:#268bd2">getMonitor</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxMonitor<span style="color:#719e07">(</span>url<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxMonitor.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.xxx<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.monitor.Monitor<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">XxxMonitor</span> <span style="color:#268bd2">implements</span> Monitor <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">count</span><span style="color:#719e07">(</span>URL statistics<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.monitor.MonitorFactory：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxMonitorFactory</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: ExtensionFactory Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/extension-factory/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/extension-factory/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Factory to load dubbo extensions.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.common.extension.ExtensionFactory</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:application</span> compiler=<span style="color:#2aa198">&#34;jdk&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.common.extension.factory.SpiExtensionFactory</code></li> |
| <li><code>org.apache.dubbo.config.spring.extension.SpringExtensionFactory</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxExtensionFactory.java (ExtensionFactory implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.common.extension.ExtensionFactory (plain text file with the content: xxx=com.xxx.XxxExtensionFactory) |
| </span></span></code></pre></div><p>XxxExtensionFactory.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.xxx<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.extension.ExtensionFactory<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">XxxExtensionFactory</span> <span style="color:#268bd2">implements</span> ExtensionFactory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">getExtension</span><span style="color:#719e07">(</span>Class<span style="color:#719e07">&lt;?&gt;</span> type<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">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.common.extension.ExtensionFactory：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxExtensionFactory</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: ProxyFactory Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/proxy-factory/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/proxy-factory/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Convert <code>Invoker</code> into business interface.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.rpc.ProxyFactory</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> proxy=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, it will take effect when proxy attribute is not configured in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> proxy=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.rpc.proxy.JdkProxyFactory</code></li> |
| <li><code>org.apache.dubbo.rpc.proxy.JavassistProxyFactory</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxProxyFactory.java (ProxyFactory implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.rpc.ProxyFactory (plain text file with the content: xxx=com.xxx.XxxProxyFactory) |
| </span></span></code></pre></div><p>XxxProxyFactory.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.xxx<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.rpc.ProxyFactory<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker<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></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxProxyFactory</span> <span style="color:#268bd2">implements</span> ProxyFactory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> T <span style="color:#268bd2">getProxy</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">getInvoker</span><span style="color:#719e07">(</span>T proxy<span style="color:#719e07">,</span> Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type<span style="color:#719e07">,</span> URL url<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.rpc.ProxyFactory：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxProxyFactory</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Compiler Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/compiler/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/compiler/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Java compiler, used for byte code dynamic generation for RPC invocation.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.common.compiler.Compiler</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <p>No configuration required, the extension will be automatically discovered and loaded.</p> |
| <h2 id="existing-extensions">Existing Extensions</h2> |
| <ul> |
| <li><code>org.apache.dubbo.common.compiler.support.JdkCompiler</code></li> |
| <li><code>org.apache.dubbo.common.compiler.support.JavassistCompiler</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxCompiler.java (Compiler implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.common.compiler.Compiler (plain text file with the content: xxx=com.xxx.XxxCompiler) |
| </span></span></code></pre></div><p>XxxCompiler.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.xxx<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.compiler.Compiler<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">XxxCompiler</span> <span style="color:#268bd2">implements</span> Compiler <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">getExtension</span><span style="color:#719e07">(</span>Class<span style="color:#719e07">&lt;?&gt;</span> type<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">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.common.compiler.Compiler：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxCompiler</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Dubbo Configuration Center Extensions</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/config-center/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/config-center/</guid><description> |
| <h2 id="design-purpose">Design Purpose</h2> |
| <p>The key function of CC(Configuration Center) is to act as a Key-Value store. Dubbo Framework tells CC the key it care about, CC return the corresponding value.</p> |
| <p>Divided by application scenarios, CC mainly undertake the following responsibilities in Dubbo Framework:</p> |
| <ul> |
| <li>As a external configuration center, CC store configuration files like dubbo.properties, where the key is usually file name like dubbo.properties, and value is content of the file.</li> |
| <li>Store single configuration items, like all kinds of switchs, contants, etc.</li> |
| <li>Store service governance rules, where the key is usually formated like &ldquo;ServiceName+RuleType&rdquo;, while value is the specific governance rule.</li> |
| </ul> |
| <p>Dubbo CC also introduced concepts of <code>namespace</code> and <code>group</code> to better manage Key-Value pairs by group, those concepts are already built-in in many professional third-party configuration centers. In most cases, <code>namespace</code> is used to isolate different tetants, while <code>group</code> is used to divid the key set from one tetant into groups.</p> |
| <p>Dubbo CC has currently supported Zookeeper, Nacos, Etcd, Consul, Apollo, next we will see how Dubbo CC is mapped to a specific third-party implementation.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.configcenter.DynamicConfigurationFactory</code></li> |
| <li><code>org.apache.dubbo.configcenter.DynamicConfiguration</code></li> |
| </ul> |
| <h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.configcenter.support.zookeeper.ZookeeperDynamicConfigurationFactory</code></li> |
| <li><code>org.apache.dubbo.configcenter.support.nacos.NacosDynamicConfigurationFactory</code></li> |
| <li><code>org.apache.dubbo.configcenter.support.etcd.EtcdDynamicConfigurationFactory</code></li> |
| <li><code>org.apache.dubbo.configcenter.consul.ConsulDynamicConfigurationFactory</code></li> |
| <li><code>org.apache.dubbo.configcenter.support.apollo.ApolloDynamicConfigurationFactory</code></li> |
| <li><code>org.apache.dubbo.common.config.configcenter.file.FileSystemDynamicConfigurationFactory</code></li> |
| </ul> |
| <h2 id="implementation">Implementation</h2> |
| <h3 id="zookeeper">Zookeeper</h3> |
| <p>Zookeeper provided a tree-structure storage model, the implementation is as follows:</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_model.jpg" alt="image-20190127225608553"></p> |
| <p>namespace, group, key are corresponded to different levels of ZNodes, while value is content of the key ZNode.</p> |
| <ol> |
| <li> |
| <p>External configuration cetner dubbo.properties</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_properties.jpg" alt="image-20190127225608553"></p> |
| <p>The figure above shows the storage structure of the dubbo.properties file in two different scopes in zookeeper:</p> |
| <ul> |
| <li>namespace: both are &lsquo;dubbo&rsquo;</li> |
| <li>group: &lsquo;dubbo&rsquo; is globally shared by all applications; &lsquo;demo-provider&rsquo; is application level, only affect the specific application</li> |
| <li>key: dubbo.properties</li> |
| </ul> |
| </li> |
| <li> |
| <p>Single configuration item</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_singleitem.jpg" alt="image-20190127225608553"></p> |
| <p>The figure above shows how we set the shutdown wait time to 15000:</p> |
| <ul> |
| <li>namespace: dubbo</li> |
| <li>group: dubbo</li> |
| <li>key: dubbo.service.shutdown.wait</li> |
| <li>value: 15000</li> |
| </ul> |
| </li> |
| <li> |
| <p>Service governance rule</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_rule.jpg" alt="image-20190127225608553"></p> |
| <p>The figure above shows an application-level conditional routing rule:</p> |
| <ul> |
| <li>namespace：dubbo</li> |
| <li>group：dubbo</li> |
| <li>key：governance-conditionrouter-consumer.condition-router, in wich governance-conditionrouter-consumer is application name, condition-router represents condition router.</li> |
| </ul> |
| <blockquote> |
| <p>Notice:</p> |
| <p>Dubbo support two level of governance rules: application, service. The key format are as follows:</p> |
| <ul> |
| <li>application level {application name + rule suffix}, such as: <code>demo-application.configurators</code>,<code>demo-application.tag-router</code>, etc.</li> |
| <li>service level {service interface name:[version]:[group] + rule suffix}, in which version and group are optional, such as: <code>org.apache.dubbo.demo.DemoService::.configurators</code>,<code>org.apache.dubbo.demo.DemoService:1.0.0:group1.configurators</code>, etc.</li> |
| </ul> |
| </blockquote> |
| </li> |
| </ol> |
| <h3 id="etcd--consul">Etcd &amp; Consul</h3> |
| <p>Etcd and Consul are essencially tree-structure storage like Zookeeper, see zookeeper for implementation.</p> |
| <h3 id="nacos">Nacos</h3> |
| <p>Nacos is a professional third-party configuration center, it has a storage structure designed specifically for the configuration center, including built-in concepts like namespace, group, dataid, etc. And these concepts basically correspond to the configuration center of the Dubbo framework abstraction.</p> |
| <p>The correspondence with the Zookeeper implementation is as follows：</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_nacos_model.jpg" alt="image-20190127225608553"></p> |
| <p>Refer to the example described in the zookeeper implementation above, where dataid might be:</p> |
| <ul> |
| <li>External configuration center: dubbo.properties</li> |
| <li>Single configuration item: dubbo.service.shutdown.wait</li> |
| <li>Service governance rule: org.apache.dubbo.demo.DemoService:1.0.0:group1.configurators</li> |
| </ul> |
| <h3 id="apollo">Apollo</h3> |
| <p>Apollo is similar to Nacos. Please refer to the documentation on the Apollo section.</p></description></item><item><title>Docs: Dispatcher Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/dispatcher/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/dispatcher/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Thread pool dispatch strategy.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.remoting.Dispatcher</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> dispatcher=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect if dispatcher attribute is not set in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> dispatcher=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extensions">Existing Extensions</h2> |
| <ul> |
| <li><code>org.apache.dubbo.remoting.transport.dispatcher.all.AllDispatcher</code></li> |
| <li><code>org.apache.dubbo.remoting.transport.dispatcher.direct.DirectDispatcher</code></li> |
| <li><code>org.apache.dubbo.remoting.transport.dispatcher.message.MessageOnlyDispatcher</code></li> |
| <li><code>org.apache.dubbo.remoting.transport.dispatcher.execution.ExecutionDispatcher</code></li> |
| <li><code>org.apache.dubbo.remoting.transport.dispatcher.connection.ConnectionOrderedDispatcher</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxDispatcher.java (Dispatcher implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.remoting.Dispatcher (plain text file with the content: xxx=com.xxx.XxxDispatcher) |
| </span></span></code></pre></div><p>XxxDispatcher.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.xxx<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.remoting.Dispatcher<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">XxxDispatcher</span> <span style="color:#268bd2">implements</span> Dispatcher <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Group <span style="color:#268bd2">lookup</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.remoting.Dispatcher：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxDispatcher</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: ThreadPool Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/threadpool/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/threadpool/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Thread pool strategy extension for service provider. When server receives one request, it needs a thread from thread pool to execute business logic in service provider.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.common.threadpool.ThreadPool</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> threadpool=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, it will take effect when threadpool attribute is not specified in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> threadpool=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.common.threadpool.FixedThreadPool</code></li> |
| <li><code>org.apache.dubbo.common.threadpool.CachedThreadPool</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxThreadPool.java (ThreadPool implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.common.threadpool.ThreadPool (plain text file with the content: xxx=com.xxx.XxxThreadPool) |
| </span></span></code></pre></div><p>XxxThreadPool.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.xxx<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.threadpool.ThreadPool<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.concurrent.Executor<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">XxxThreadPool</span> <span style="color:#268bd2">implements</span> ThreadPool <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Executor <span style="color:#268bd2">getExecutor</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.common.threadpool.ThreadPool：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxThreadPool</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Serialization Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/serialize/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/serialize/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension to serializing java object into byte code stream for transporting on the network, and vise versa.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.common.serialize.Serialization</code></li> |
| <li><code>org.apache.dubbo.common.serialize.ObjectInput</code></li> |
| <li><code>org.apache.dubbo.common.serialize.ObjectOutput</code></li> |
| </ul> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- protocol serialization style --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> serialization=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect if serialization is not configured in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> serialization=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.common.serialize.dubbo.DubboSerialization</code></li> |
| <li><code>org.apache.dubbo.common.serialize.hessian.Hessian2Serialization</code></li> |
| <li><code>org.apache.dubbo.common.serialize.java.JavaSerialization</code></li> |
| <li><code>org.apache.dubbo.common.serialize.java.CompactedJavaSerialization</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxSerialization.java (Serialization implementation) |
| </span></span><span style="display:flex;"><span> |-XxxObjectInput.java (ObjectInput implementation) |
| </span></span><span style="display:flex;"><span> |-XxxObjectOutput.java (ObjectOutput implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.common.serialize.Serialization (plain text file with the content: xxx=com.xxx.XxxSerialization) |
| </span></span></code></pre></div><p>XxxSerialization.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.xxx<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.serialize.Serialization<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.serialize.ObjectInput<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.serialize.ObjectOutput<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:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxSerialization</span> <span style="color:#268bd2">implements</span> Serialization <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ObjectOutput <span style="color:#268bd2">serialize</span><span style="color:#719e07">(</span>Parameters parameters<span style="color:#719e07">,</span> OutputStream output<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> IOException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxObjectOutput<span style="color:#719e07">(</span>output<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ObjectInput <span style="color:#268bd2">deserialize</span><span style="color:#719e07">(</span>Parameters parameters<span style="color:#719e07">,</span> InputStream input<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> IOException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxObjectInput<span style="color:#719e07">(</span>input<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>META-INF/dubbo/org.apache.dubbo.common.serialize.Serialization：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxSerialization</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Transporter Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/remoting/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/remoting/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Transportation extension for communication between server and client.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.remoting.Transporter</code></li> |
| <li><code>org.apache.dubbo.remoting.Server</code></li> |
| <li><code>org.apache.dubbo.remoting.Client</code></li> |
| </ul> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- server and client use the same transporter --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> transporter=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- server and client use the different transporter --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> server=<span style="color:#2aa198">&#34;xxx&#34;</span> client=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect when transport/server/client attribute is not set in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> transporter=<span style="color:#2aa198">&#34;xxx&#34;</span> server=<span style="color:#2aa198">&#34;xxx&#34;</span> client=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.remoting.transport.transporter.netty.NettyTransporter</code></li> |
| <li><code>org.apache.dubbo.remoting.transport.transporter.mina.MinaTransporter</code></li> |
| <li><code>org.apache.dubbo.remoting.transport.transporter.grizzly.GrizzlyTransporter</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxTransporter.java (Transporter implementation) |
| </span></span><span style="display:flex;"><span> |-XxxServer.java (Server implementation) |
| </span></span><span style="display:flex;"><span> |-XxxClient.java (Client implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.remoting.Transporter (plain text file with the content: xxx=com.xxx.XxxTransporter) |
| </span></span></code></pre></div><p>XxxTransporter.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.xxx<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.remoting.Transporter<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">XxxTransporter</span> <span style="color:#268bd2">implements</span> Transporter <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Server <span style="color:#268bd2">bind</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> ChannelHandler handler<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxServer<span style="color:#719e07">(</span>url<span style="color:#719e07">,</span> handler<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Client <span style="color:#268bd2">connect</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> ChannelHandler handler<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxClient<span style="color:#719e07">(</span>url<span style="color:#719e07">,</span> handler<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>XxxServer.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.xxx<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.remoting.transport.transporter.AbstractServer<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">XxxServer</span> <span style="color:#268bd2">extends</span> AbstractServer <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxServer</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> ChannelHandler handler<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException<span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span><span style="color:#719e07">(</span>url<span style="color:#719e07">,</span> handler<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">doOpen</span><span style="color:#719e07">()</span> <span style="color:#268bd2">throws</span> Throwable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">doClose</span><span style="color:#719e07">()</span> <span style="color:#268bd2">throws</span> Throwable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Collection<span style="color:#719e07">&lt;</span>Channel<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">getChannels</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Channel <span style="color:#268bd2">getChannel</span><span style="color:#719e07">(</span>InetSocketAddress remoteAddress<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxClient.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.xxx<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.remoting.transport.transporter.AbstractClient<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">XxxClient</span> <span style="color:#268bd2">extends</span> AbstractClient <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxServer</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> ChannelHandler handler<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException<span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span><span style="color:#719e07">(</span>url<span style="color:#719e07">,</span> handler<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">doOpen</span><span style="color:#719e07">()</span> <span style="color:#268bd2">throws</span> Throwable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">doClose</span><span style="color:#719e07">()</span> <span style="color:#268bd2">throws</span> Throwable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">doConnect</span><span style="color:#719e07">()</span> <span style="color:#268bd2">throws</span> Throwable <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Channel <span style="color:#268bd2">getChannel</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.remoting.Transporter：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxTransporter</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Exchanger Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/exchanger/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/exchanger/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Exchange message between request and response on network transport layer.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <ul> |
| <li><code>org.apache.dubbo.remoting.exchange.Exchanger</code></li> |
| <li><code>org.apache.dubbo.remoting.exchange.ExchangeServer</code></li> |
| <li><code>org.apache.dubbo.remoting.exchange.ExchangeClient</code></li> |
| </ul> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> exchanger=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect if exchanger attribute is not set in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> exchanger=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <p><code>org.apache.dubbo.remoting.exchange.exchanger.HeaderExchanger</code></p> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxExchanger.java (Exchanger implementation) |
| </span></span><span style="display:flex;"><span> |-XxxExchangeServer.java (ExchangeServer implementation) |
| </span></span><span style="display:flex;"><span> |-XxxExchangeClient.java (ExchangeClient implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.remoting.exchange.Exchanger (plain text file with the content: xxx=com.xxx.XxxExchanger) |
| </span></span></code></pre></div><p>XxxExchanger.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.xxx<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.remoting.exchange.Exchanger<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:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxExchanger</span> <span style="color:#268bd2">implements</span> Exchanger <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ExchangeServer <span style="color:#268bd2">bind</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> ExchangeHandler handler<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxExchangeServer<span style="color:#719e07">(</span>url<span style="color:#719e07">,</span> handler<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ExchangeClient <span style="color:#268bd2">connect</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">,</span> ExchangeHandler handler<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxExchangeClient<span style="color:#719e07">(</span>url<span style="color:#719e07">,</span> handler<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>XxxExchangeServer.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></span><span style="display:flex;"><span><span style="color:#719e07">package</span> com.xxx<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.remoting.exchange.ExchangeServer<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">XxxExchangeServer</span> impelements ExchangeServer <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxExchangeClient.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.xxx<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.remoting.exchange.ExchangeClient<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">XxxExchangeClient</span> impelments ExchangeClient <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.remoting.exchange.Exchanger：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxExchanger</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Networker Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/networker/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/networker/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension for peer to peer network grouping.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.remoting.p2p.Networker</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> networker=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, it takes effect if networker attribute is not set in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> networker=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.remoting.p2p.support.MulticastNetworker</code></li> |
| <li><code>org.apache.dubbo.remoting.p2p.support.FileNetworker</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxNetworker.java (Networker implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.remoting.p2p.Networker (plain text file with the content: xxx=com.xxx.XxxNetworker) |
| </span></span></code></pre></div><p>XxxNetworker.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.xxx<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.remoting.p2p.Networker<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">XxxNetworker</span> <span style="color:#268bd2">implements</span> Networker <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Group <span style="color:#268bd2">lookup</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.remoting.p2p.Networker：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxNetworker</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: TelnetHandler Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/telnet-handler/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/telnet-handler/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension to telnet command. All server should support telnet access for operation convenience.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.remoting.telnet.TelnetHandler</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> telnet=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect if telnet attribute is not specified in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> telnet=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.remoting.telnet.support.ClearTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.remoting.telnet.support.ExitTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.remoting.telnet.support.HelpTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.remoting.telnet.support.StatusTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.telnet.ListTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.telnet.ChangeTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.telnet.CurrentTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.telnet.InvokeTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.telnet.TraceTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.telnet.CountTelnetHandler</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.telnet.PortTelnetHandler</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxTelnetHandler.java (TelnetHandler implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.remoting.telnet.TelnetHandler (plain text file with the content: xxx=com.xxx.XxxTelnetHandler) |
| </span></span></code></pre></div><p>XxxTelnetHandler.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.xxx<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.remoting.telnet.TelnetHandler<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Help</span><span style="color:#719e07">(</span>parameter<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span><span style="color:#719e07">,</span> summary<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span><span style="color:#719e07">,</span> detail<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></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxTelnetHandler</span> <span style="color:#268bd2">implements</span> TelnetHandler <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">telnet</span><span style="color:#719e07">(</span>Channel channel<span style="color:#719e07">,</span> String message<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RemotingException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.remoting.telnet.TelnetHandler：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxTelnetHandler</span> |
| </span></span></code></pre></div><h2 id="how-to-use">How To Use</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>telnet 127.0.0.1 <span style="color:#2aa198">20880</span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; xxx args |
| </span></span></code></pre></div></description></item><item><title>Docs: StatusChecker Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/status-checker/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/status-checker/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension to check status of resources service depends on. This status checker can be used in both telnet status command and status page.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.common.status.StatusChecker</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> status=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect if no status attribute is configured in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> status=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.common.status.support.MemoryStatusChecker</code></li> |
| <li><code>org.apache.dubbo.common.status.support.LoadStatusChecker</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.status.ServerStatusChecker</code></li> |
| <li><code>org.apache.dubbo.rpc.dubbo.status.ThreadPoolStatusChecker</code></li> |
| <li><code>org.apache.dubbo.registry.directory.RegistryStatusChecker</code></li> |
| <li><code>org.apache.dubbo.rpc.config.spring.status.SpringStatusChecker</code></li> |
| <li><code>org.apache.dubbo.rpc.config.spring.status.DataSourceStatusChecker</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxStatusChecker.java (StatusChecker implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.common.status.StatusChecker (plain text file with the content: xxx=com.xxx.XxxStatusChecker) |
| </span></span></code></pre></div><p>XxxStatusChecker.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.xxx<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.status.StatusChecker<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">XxxStatusChecker</span> <span style="color:#268bd2">implements</span> StatusChecker <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Status <span style="color:#268bd2">check</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.common.status.StatusChecker：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxStatusChecker</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Container Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/container/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/container/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Service container extension, useful for loading custom contents.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.container.Container</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>java org.apache.dubbo.container.Main spring jetty log4j |
| </span></span></code></pre></div><h2 id="existing-extensions">Existing Extensions</h2> |
| <ul> |
| <li><code>org.apache.dubbo.container.spring.SpringContainer</code></li> |
| <li><code>org.apache.dubbo.container.spring.JettyContainer</code></li> |
| <li><code>org.apache.dubbo.container.spring.Log4jContainer</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxContainer.java (Container implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.container.Container (plain text file with the content: xxx=com.xxx.XxxContainer) |
| </span></span></code></pre></div><p>XxxContainer.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.xxx<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>container<span style="color:#719e07">.</span>Container<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:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxContainer</span> <span style="color:#268bd2">implements</span> Container <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Status <span style="color:#268bd2">start</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Status <span style="color:#268bd2">stop</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.container.Container：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxContainer</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: PageHandler Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/page/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/page/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension for page handler</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.container.page.PageHandler</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> page=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take effect if page attribute is not set in &lt;dubbo:protocol&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> page=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.container.page.pages.HomePageHandler</code></li> |
| <li><code>org.apache.dubbo.container.page.pages.StatusPageHandler</code></li> |
| <li><code>org.apache.dubbo.container.page.pages.LogPageHandler</code></li> |
| <li><code>org.apache.dubbo.container.page.pages.SystemPageHandler</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxPageHandler.java (PageHandler implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.container.page.PageHandler (plain text file with the content: xxx=com.xxx.XxxPageHandler) |
| </span></span></code></pre></div><p>XxxPageHandler.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.xxx<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.container.page.PageHandler<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">XxxPageHandler</span> <span style="color:#268bd2">implements</span> PageHandler <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Group <span style="color:#268bd2">lookup</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.container.page.PageHandler：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxPageHandler</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Cache Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/cache/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/cache/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Cache the return value, use request parameter as the key.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.cache.CacheFactory</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> cache=<span style="color:#2aa198">&#34;lru&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- method level cache --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service&gt;&lt;dubbo:method</span> cache=<span style="color:#2aa198">&#34;lru&#34;</span> <span style="color:#268bd2">/&gt;&lt;/dubbo:service&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- 缺省值设置，当&lt;dubbo:service&gt;没有配置cache属性时，使用此配置 --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, will take affect if cache attribute isn&#39;t configured in &lt;dubbo:service&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> cache=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extensions">Existing Extensions</h2> |
| <ul> |
| <li><code>org.apache.dubbo.cache.support.lru.LruCacheFactory</code></li> |
| <li><code>org.apache.dubbo.cache.support.threadlocal.ThreadLocalCacheFactory</code></li> |
| <li><code>org.apache.dubbo.cache.support.jcache.JCacheFactory</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxCacheFactory.java (CacheFactory implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.cache.CacheFactory (plain text file with contents: xxx=com.xxx.XxxCacheFactory) |
| </span></span></code></pre></div><p>XxxCacheFactory.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.xxx<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.cache.CacheFactory<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">XxxCacheFactory</span> <span style="color:#268bd2">implements</span> CacheFactory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Cache <span style="color:#268bd2">getCache</span><span style="color:#719e07">(</span>URL url<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:#719e07">new</span> XxxCache<span style="color:#719e07">(</span>url<span style="color:#719e07">,</span> name<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxCache.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.xxx<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.cache.Cache<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">XxxCache</span> <span style="color:#268bd2">implements</span> Cache <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">Cache</span><span style="color:#719e07">(</span>URL url<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">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">put</span><span style="color:#719e07">(</span>Object key<span style="color:#719e07">,</span> Object value<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">get</span><span style="color:#719e07">(</span>Object key<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.cache.CacheFactory：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxCacheFactory</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: Validation Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/validation/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/validation/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension for parameter validation.</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.validation.Validation</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> validation=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- default configuration, it will take effect when there&#39;s no validation attribute specified in &lt;dubbo:service&gt; --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> validation=<span style="color:#2aa198">&#34;xxx,yyy&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <p><code>org.apache.dubbo.validation.support.jvalidation.JValidation</code></p> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxValidation.java (Validation implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.validation.Validation (plain text file with the content: xxx=com.xxx.XxxValidation) |
| </span></span></code></pre></div><p>XxxValidation.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.xxx<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.validation.Validation<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">XxxValidation</span> <span style="color:#268bd2">implements</span> Validation <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">getValidator</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxValidator.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.xxx<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.validation.Validator<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">XxxValidator</span> <span style="color:#268bd2">implements</span> Validator <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxValidator</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">validate</span><span style="color:#719e07">(</span>Invocation invocation<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">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.validation.Validation：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxValidation</span> |
| </span></span></code></pre></div></description></item><item><title>Docs: LoggerAdapter Extension</title><link>https://dubbo.apache.org/en/docs/v2.7/dev/impls/logger-adapter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs/v2.7/dev/impls/logger-adapter/</guid><description> |
| <h2 id="summary">Summary</h2> |
| <p>Extension for adapting logger output</p> |
| <h2 id="extension-interface">Extension Interface</h2> |
| <p><code>org.apache.dubbo.common.logger.LoggerAdapter</code></p> |
| <h2 id="extension-configuration">Extension Configuration</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:application</span> logger=<span style="color:#2aa198">&#34;xxx&#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-sh" data-lang="sh"><span style="display:flex;"><span>-Ddubbo:application.logger<span style="color:#719e07">=</span>xxx |
| </span></span></code></pre></div><h2 id="existing-extension">Existing Extension</h2> |
| <ul> |
| <li><code>org.apache.dubbo.common.logger.slf4j.Slf4jLoggerAdapter</code></li> |
| <li><code>org.apache.dubbo.common.logger.jcl.JclLoggerAdapter</code></li> |
| <li><code>org.apache.dubbo.common.logger.log4j.Log4jLoggerAdapter</code></li> |
| <li><code>org.apache.dubbo.common.logger.log4j2.Log4j2LoggerAdapter</code></li> |
| <li><code>org.apache.dubbo.common.logger.jdk.JdkLoggerAdapter</code></li> |
| </ul> |
| <h2 id="extension-guide">Extension Guide</h2> |
| <p>Directory layout:</p> |
| <div class="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>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxLoggerAdapter.java (LoggerAdapter implementation) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-org.apache.dubbo.common.logger.LoggerAdapter (plain text file with the content: xxx=com.xxx.XxxLoggerAdapter) |
| </span></span></code></pre></div><p>XxxLoggerAdapter.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.xxx<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.logger.LoggerAdapter<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">XxxLoggerAdapter</span> <span style="color:#268bd2">implements</span> LoggerAdapter <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Logger <span style="color:#268bd2">getLogger</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>XxxLogger.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.xxx<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.logger.Logger<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">XxxLogger</span> <span style="color:#268bd2">implements</span> Logger <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxLogger</span><span style="color:#719e07">(</span>URL url<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">info</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> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ... |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>META-INF/dubbo/org.apache.dubbo.common.logger.LoggerAdapter：</p> |
| <div class="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>xxx<span style="color:#719e07">=</span><span style="color:#2aa198">com.xxx.XxxLoggerAdapter</span> |
| </span></span></code></pre></div></description></item></channel></rss> |
