| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – SPI 扩展实现</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/</link><description>Recent content in SPI 扩展实现 on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>zh-cn</language><atom:link href="https://dubbo.apache.org/zh-cn/docs/references/spis/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs: 协议扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/protocol/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/protocol/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/protocol/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>RPC 协议扩展，封装远程调用细节。</p> |
| <p>契约：</p> |
| <ul> |
| <li>当用户调用 <code>refer()</code> 所返回的 <code>Invoker</code> 对象的 <code>invoke()</code> 方法时，协议需相应执行同 URL 远端 <code>export()</code> 传入的 <code>Invoker</code> 对象的 <code>invoke()</code> 方法。</li> |
| <li>其中，<code>refer()</code> 返回的 <code>Invoker</code> 由协议实现，协议通常需要在此 <code>Invoker</code> 中发送远程请求，<code>export()</code> 传入的 <code>Invoker</code> 由框架实现并传入，协议不需要关心。</li> |
| </ul> |
| <p>注意：</p> |
| <ul> |
| <li>协议不关心业务接口的透明代理，以 <code>Invoker</code> 为中心，由外层将 <code>Invoker</code> 转换为业务接口。</li> |
| <li>协议不一定要是 TCP 网络通讯，比如通过共享文件，IPC 进程间通讯等。</li> |
| </ul> |
| <h2 id="扩展接口">扩展接口</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></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 暴露远程服务：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 协议在接收请求时，应记录请求来源方地址信息：RpcContext.getContext().setRemoteAddress();&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. export()必须是幂等的，也就是暴露同一个URL的Invoker两次，和暴露一次没有区别。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. export()传入的Invoker由框架实现并传入，协议不需要关心。&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; 服务的类型 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param invoker 服务的执行体 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return exporter 暴露服务的引用，用于取消暴露 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @throws RpcException 当暴露服务出错时抛出，比如端口已占用 |
| </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>(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException; |
| </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"> * 引用远程服务：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 当用户调用refer()所返回的Invoker对象的invoke()方法时，协议需相应执行同URL远端export()传入的Invoker对象的invoke()方法。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. refer()返回的Invoker由协议实现，协议通常需要在此Invoker中发送远程请求。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. 当url中有设置check=false时，连接失败不能抛出异常，需内部自动恢复。&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; 服务的类型 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param type 服务的类型 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param url 远程服务的URL地址 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return invoker 服务的本地代理 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @throws RpcException 当连接服务提供方失败时抛出 |
| </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>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RpcException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h2 id="扩展配置">扩展配置</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;!-- 声明协议，如果没有配置id，将以name为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;!-- 引用协议，如果没有配置protocol属性，将在ApplicationContext中自动扫描protocol配置 --&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;!-- 引用协议缺省值，当&lt;dubbo:service&gt;没有配置prototol属性时，使用此配置 --&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="已知扩展">已知扩展</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.support.MockProtocol</code></li> |
| </ul> |
| <h2 id="扩展示例">扩展示例</h2> |
| <p>Maven项目结构：</p> |
| <div class="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接口) |
| </span></span><span style="display:flex;"><span> |-XxxExporter.java (实现Exporter接口) |
| </span></span><span style="display:flex;"><span> |-XxxInvoker.java (实现Invoker接口) |
| </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 (纯文本文件，内容为：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></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></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></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>(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxExporter(invoker); |
| </span></span><span style="display:flex;"><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>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxInvoker(type, url); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxExporter</span>(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker) <span style="color:#268bd2">throws</span> RemotingException{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span>(invoker); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unexport</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span>.unexport(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxInvoker</span>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RemotingException{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span>(type, url); |
| </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">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> Result <span style="color:#268bd2">doInvoke</span>(Invocation invocation) <span style="color:#268bd2">throws</span> Throwable { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 调用拦截扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/filter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/filter/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/filter/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>服务提供方和服务消费方调用过程拦截，Dubbo 本身的大多功能均基于此扩展点实现，每次远程方法执行，该拦截都会被执行，请注意对性能的影响。</p> |
| <p>约定：</p> |
| <ul> |
| <li>用户自定义 filter 默认在内置 filter 之后。</li> |
| <li>特殊值 <code>default</code>，表示缺省扩展点插入的位置。比如：<code>filter=&quot;xxx,default,yyy&quot;</code>，表示 <code>xxx</code> 在缺省 filter 之前，<code>yyy</code> 在缺省 filter 之后。</li> |
| <li>特殊符号 <code>-</code>，表示剔除。比如：<code>filter=&quot;-foo1&quot;</code>，剔除添加缺省扩展点 <code>foo1</code>。比如：<code>filter=&quot;-default&quot;</code>，剔除添加所有缺省扩展点。</li> |
| <li>provider 和 service 同时配置的 filter 时，累加所有 filter，而不是覆盖。比如：<code>&lt;dubbo:provider filter=&quot;xxx,yyy&quot;/&gt;</code> 和 <code>&lt;dubbo:service filter=&quot;aaa,bbb&quot; /&gt;</code>，则 <code>xxx</code>,<code>yyy</code>,<code>aaa</code>,<code>bbb</code> 均会生效。如果要覆盖，需配置：<code>&lt;dubbo:service filter=&quot;-xxx,-yyy,aaa,bbb&quot; /&gt;</code></li> |
| </ul> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.rpc.Filter</code></p> |
| <h2 id="扩展配置">扩展配置</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:#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;!-- 消费方调用过程缺省拦截器，将拦截所有reference --&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;!-- 提供方调用过程拦截 --&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;!-- 提供方调用过程缺省拦截器，将拦截所有service --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Result; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Result <span style="color:#268bd2">invoke</span>(Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker, Invocation invocation) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// before filter ...</span> |
| </span></span><span style="display:flex;"><span> Result result <span style="color:#719e07">=</span> invoker.invoke(invocation); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// after filter ...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> result; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 引用监听扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/invoker-listener/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/invoker-listener/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/invoker-listener/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>当有服务引用时，触发该事件。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.rpc.InvokerListener</code></p> |
| <h2 id="扩展配置">扩展配置</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:#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;!-- 引用服务缺省监听器 --&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="已知扩展">已知扩展</h2> |
| <p><code>org.apache.dubbo.rpc.listener.DeprecatedInvokerListener</code></p> |
| <h2 id="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">referred</span>(Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">destroyed</span>(Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 暴露监听扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/exporter-listener/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/exporter-listener/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/exporter-listener/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>当有服务暴露时，触发该事件。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.rpc.ExporterListener</code></p> |
| <h2 id="扩展配置">扩展配置</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:#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;!-- 暴露服务缺省监听器 --&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="已知扩展">已知扩展</h2> |
| <p><code>org.apache.dubbo.registry.directory.RegistryExporterListener</code></p> |
| <h2 id="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Exporter; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">exported</span>(Exporter<span style="color:#719e07">&lt;?&gt;</span> exporter) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unexported</span>(Exporter<span style="color:#719e07">&lt;?&gt;</span> exporter) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 集群扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/cluster/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/cluster/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/cluster/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>当有多个服务提供方时，将多个服务提供方组织成一个集群，并伪装成一个提供方。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.rpc.cluster.Cluster</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值配置，如果&lt;dubbo:protocol&gt;没有配置cluster时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.cluster.support.AbstractClusterInvoker; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.cluster.Directory; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.cluster.LoadBalance; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Result; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException; |
| </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></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>(Directory<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> directory) <span style="color:#268bd2">throws</span> RpcException { |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Result <span style="color:#268bd2">doInvoke</span>(Invocation invocation, List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers, LoadBalance loadbalance) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </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: 路由扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/router/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/router/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/router/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>从多个服务提供方中选择一个进行调用。</p> |
| <h2 id="扩展接口">扩展接口</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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Router <span style="color:#268bd2">getRouter</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 负载均衡扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/load-balance/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/load-balance/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/load-balance/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>从多个服务提供方中选择一个进行调用</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.rpc.cluster.LoadBalance</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置loadbalance时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invocation; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException; |
| </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></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>(List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers, Invocation invocation) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 合并结果扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/merger/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/merger/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/merger/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>合并返回结果，用于分组聚合。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.rpc.cluster.Merger</code></p> |
| <h2 id="扩展配置">扩展配置</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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> T <span style="color:#268bd2">merge</span>(T... results) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 注册中心扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/registry/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/registry/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/registry/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>负责服务的注册与发现。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <ul> |
| <li><code>org.apache.dubbo.registry.RegistryFactory</code></li> |
| <li><code>org.apache.dubbo.registry.Registry</code></li> |
| </ul> |
| <h2 id="扩展配置">扩展配置</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:#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;!-- 引用注册中心，如果没有配置registry属性，将在ApplicationContext中自动扫描registry配置 --&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;!-- 引用注册中心缺省值，当&lt;dubbo:service&gt;没有配置registry属性时，使用此配置 --&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="扩展契约">扩展契约</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></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"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 连接注册中心需处理契约：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 当设置check=false时表示不检查连接，否则在连接不上时抛出异常。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. 支持URL上的username:password权限认证。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. 支持backup=10.20.153.10备选注册中心集群地址。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 4. 支持file=registry.cache本地磁盘文件缓存。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. 支持timeout=1000请求超时设置。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 6. 支持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 注册中心地址，不允许为空 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return 注册中心引用，总不返回空 |
| </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>(URL url); |
| </span></span><span style="display:flex;"><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:#586e75">// Registry extends RegistryService </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"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 注册需处理契约：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 当URL设置了check=false时，注册失败后不报错，在后台定时重试，否则抛出异常。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. 当URL设置了dynamic=false参数，则需持久存储，否则，当注册者出现断电等情况异常退出时，需自动删除。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. 当URL设置了category=overrides时，表示分类存储，缺省类别为providers，可按分类部分通知数据。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 4. 当注册中心重启，网络抖动，不能丢失数据，包括断线自动删除数据。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. 允许URI相同但参数不同的URL并存，不能覆盖。&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 注册信息，不允许为空，如：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>(URL url); |
| </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"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 取消注册需处理契约：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 如果是dynamic=false的持久存储数据，找不到注册数据，则抛IllegalStateException，否则忽略。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. 按全URL匹配取消注册。&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 注册信息，不允许为空，如：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>(URL url); |
| </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"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 订阅需处理契约：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 当URL设置了check=false时，订阅失败后不报错，在后台定时重试。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. 当URL设置了category=overrides，只通知指定分类的数据，多个分类用逗号分隔，并允许星号通配，表示订阅所有分类数据。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. 允许以interface,group,version,classifier作为条件查询，如：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. 并且查询条件允许星号通配，订阅所有接口的所有分组的所有版本，或：interface=*&amp;group=*&amp;version=*&amp;classifier=*&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. 当注册中心重启，网络抖动，需自动恢复订阅请求。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 6. 允许URI相同但参数不同的URL并存，不能覆盖。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 7. 必须阻塞订阅过程，等第一次通知完后再返回。&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 订阅条件，不允许为空，如：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 变更事件监听器，不允许为空 |
| </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>(URL url, NotifyListener listener); |
| </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"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 取消订阅需处理契约：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 如果没有订阅，直接忽略。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. 按全URL匹配取消订阅。&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 订阅条件，不允许为空，如：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 变更事件监听器，不允许为空 |
| </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>(URL url, NotifyListener listener); |
| </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"> * |
| </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 查询条件，不允许为空，如：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 已注册信息列表，可能为空，含义同{@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>(URL url); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><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></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"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 通知需处理契约：&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 1. 总是以服务接口和数据类型为维度全量通知，即不会通知一个服务的同类型的部分数据，用户不需要对比上一次通知结果。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 2. 订阅时的第一次通知，必须是一个服务的所有类型数据的全量通知。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 3. 中途变更时，允许不同类型的数据分开通知，比如：providers, consumers, routes, overrides，允许只通知其中一种类型，但该类型的数据必须是全量的，不是增量的。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 4. 如果一种类型的数据为空，需通知一个empty协议并带category参数的标识性URL数据。&lt;br&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * 5. 通知者(即注册中心实现)需保证通知的顺序，比如：单线程推送，队列串行化，带版本对比。&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 已注册信息列表，总不为空，含义同{@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>(List<span style="color:#719e07">&lt;</span>URL<span style="color:#719e07">&gt;</span> urls); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h2 id="已知扩展">已知扩展</h2> |
| <p><code>org.apache.dubbo.registry.support.dubbo.DubboRegistryFactory</code></p> |
| <h2 id="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </span></span><span style="display:flex;"><span> |-XxxRegistry.java (实现Registry接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.registry.Registry; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.URL; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Registry <span style="color:#268bd2">getRegistry</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxRegistry(url); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.registry.NotifyListener; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.URL; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">register</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unregister</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">subscribe</span>(URL url, NotifyListener listener) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">unsubscribe</span>(URL url, NotifyListener listener) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 监控中心扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/monitor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/monitor/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/monitor/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>负责服务调用次和调用时间的监控。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <ul> |
| <li><code>org.apache.dubbo.monitor.MonitorFactory</code></li> |
| <li><code>org.apache.dubbo.monitor.Monitor</code></li> |
| </ul> |
| <h2 id="扩展配置">扩展配置</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:#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="已知扩展">已知扩展</h2> |
| <p>org.apache.dubbo.monitor.support.dubbo.DubboMonitorFactory</p> |
| <h2 id="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </span></span><span style="display:flex;"><span> |-XxxMonitor.java (实现Monitor接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.monitor.Monitor; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.URL; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Monitor <span style="color:#268bd2">getMonitor</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxMonitor(url); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">count</span>(URL statistics) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 扩展点加载扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/extension-factory/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/extension-factory/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/extension-factory/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>扩展点本身的加载容器，可从不同容器加载扩展点。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.common.extension.ExtensionFactory</code></p> |
| <h2 id="扩展配置">扩展配置</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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">getExtension</span>(Class<span style="color:#719e07">&lt;?&gt;</span> type, String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 动态代理扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/proxy-factory/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/proxy-factory/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/proxy-factory/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>将 <code>Invoker</code> 接口转换成业务接口。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.rpc.ProxyFactory</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值配置，当&lt;dubbo:protocol&gt;没有配置proxy属性时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.Invoker; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcException; |
| </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></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>(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><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>(T proxy, Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 编译器扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/compiler/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/compiler/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/compiler/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>Java 代码编译器，用于动态生成字节码，加速调用。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.common.compiler.Compiler</code></p> |
| <h2 id="扩展配置">扩展配置</h2> |
| <p>自动加载</p> |
| <h2 id="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">getExtension</span>(Class<span style="color:#719e07">&lt;?&gt;</span> type, String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 配置中心扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/config-center/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/config-center/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/config-center/">最新版本</a>。</p> |
| </div> |
| <h2 id="设计目的">设计目的</h2> |
| <p>配置中心的核心功能是作为 Key-Value 存储，Dubbo 框架告知配置中心其关心的 key，配置中心返回该key对应的 value 值。</p> |
| <p>按照应用场景划分，配置中心在 Dubbo 框架中主要承担以下职责：</p> |
| <ul> |
| <li>作为外部化配置中心，即存储 dubbo.properties 配置文件，此时，key 值通常为文件名如 dubbo.properties，value 则为配置文件内容。</li> |
| <li>存储单个配置项，如各种开关项、常量值等。</li> |
| <li>存储服务治理规则，此时key通常按照 &ldquo;服务名+规则类型&rdquo; 的格式来组织，而 value 则为具体的治理规则。</li> |
| </ul> |
| <p>为了进一步实现对 key-value 的分组管理，Dubbo 的配置中心还加入了 namespace、group 的概念，这些概念在很多专业的第三方配置中心中都有体现，通常情况下，namespace 用来隔离不同的租户，group 用来对同一租户的key集合做分组。</p> |
| <p>当前，Dubbo 配置中心实现了对 Zookeeper、Nacos、Etcd、Consul、Apollo 的对接，接下来我们具体看一下 Dubbo 抽象的配置中心是怎么映射到具体的第三方实现中的。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <ul> |
| <li><code>org.apache.dubbo.configcenter.DynamicConfigurationFactory</code></li> |
| <li><code>org.apache.dubbo.configcenter.DynamicConfiguration</code></li> |
| </ul> |
| <h2 id="已知扩展">已知扩展</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="实现原理">实现原理</h2> |
| <h3 id="zookeeper">Zookeeper</h3> |
| <p>zookeeper提供了一个树状的存储模型，其实现原理如下：</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_model.jpg" alt="image-20190127225608553"></p> |
| <p>namespace, group, key 等分别对应不同层级的 ZNode 节点，而 value 则作为根 ZNode 节点的值存储。</p> |
| <ol> |
| <li> |
| <p>外部化配置中心 dubbo.properties</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_properties.jpg" alt="image-20190127225608553"></p> |
| <p>上图展示了两个不同作用域的 dubbo.properties 文件在 zookeeper 中的存储结构：</p> |
| <ul> |
| <li>命名空间namespace都为：dubbo</li> |
| <li>分组 group：全局级别为 dubbo，所有应用共享；应用级别为应用名 demo-provider，只对该应用生效</li> |
| <li>key：dubbo.properties</li> |
| </ul> |
| </li> |
| <li> |
| <p>单个配置项</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_singleitem.jpg" alt="image-20190127225608553"></p> |
| <p>设置优雅停机事件为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>服务治理规则</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_zk_rule.jpg" alt="image-20190127225608553"></p> |
| <p>上图展示了一条应用级别的条件路由规则：</p> |
| <ul> |
| <li>命名空间 namespace：dubbo</li> |
| <li>分组 group：dubbo</li> |
| <li>key：governance-conditionrouter-consumer.condition-router，其中 governance-conditionrouter-consumer 为应用名，condition-router 代表条件路由</li> |
| </ul> |
| <blockquote> |
| <p>注意:</p> |
| <p>Dubbo同时支持应用、服务两种粒度的服务治理规则，对于这两种粒度，其key取值规则如下：</p> |
| <ul> |
| <li>应用粒度 {应用名 + 规则后缀}。如: <code>demo-application.configurators</code>、<code>demo-application.tag-router</code>等</li> |
| <li>服务粒度 {服务接口名:[服务版本]:[服务分组] + 规则后缀}，其中服务版本、服务分组是可选的，如果它们有配置则在key中体现，没被配置则用&quot;:&ldquo;占位。如 |
| <code>org.apache.dubbo.demo.DemoService::.configurators</code>、<code>org.apache.dubbo.demo.DemoService:1.0.0:group1.configurators</code></li> |
| </ul> |
| </blockquote> |
| </li> |
| </ol> |
| <h3 id="etcd--consul">Etcd &amp; Consul</h3> |
| <p>Etcd 和 Consul 本质上也是一种类似 zookeeper 的树状存储结构，实现请参考 zookeeper。</p> |
| <h3 id="nacos">Nacos</h3> |
| <p><a href="https://nacos.io/">Nacos</a> 作为一个专业的第三方配置中心，拥有专门为配置中心设计的存储结构，包括内置的 namespace、group、dataid 等概念。并且这几个概念基本上与 Dubbo 框架抽象的配置中心是一一对应的。</p> |
| <p>与 Zookeeper 实现的对应关系如下：</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/configcenter_nacos_model.jpg" alt="image-20190127225608553"></p> |
| <p>参考上文关于 zookeeper 实现中描述的示例，这里的 dataid 可能为：</p> |
| <ul> |
| <li>外部化配置中心：dubbo.properties</li> |
| <li>单个配置项：dubbo.service.shutdown.wait</li> |
| <li>服务治理规则：org.apache.dubbo.demo.DemoService:1.0.0:group1.configurators</li> |
| </ul> |
| <h3 id="apollo">Apollo</h3> |
| <p>Apollo 与 Nacos 类似，请参考动态配置中心使用文档中关于 Apollo 部分的描述。</p></description></item><item><title>Docs: 消息派发扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/dispatcher/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/dispatcher/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/dispatcher/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>通道信息派发器，用于指定线程池模型。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.remoting.Dispatcher</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置dispatcher属性时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Group <span style="color:#268bd2">lookup</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 线程池扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/threadpool/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/threadpool/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/threadpool/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>服务提供方线程池实现策略，当服务器收到一个请求时，需要在线程池中创建一个线程去执行服务提供方业务逻辑。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.common.threadpool.ThreadPool</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置threadpool时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.concurrent.Executor; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Executor <span style="color:#268bd2">getExecutor</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 序列化扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/serialize/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/serialize/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/serialize/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>将对象转成字节流，用于网络传输，以及将字节流转为对象，用于在收到字节流数据后还原成对象。</p> |
| <h2 id="扩展接口">扩展接口</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="扩展配置">扩展配置</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:#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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置serialization时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </span></span><span style="display:flex;"><span> |-XxxObjectInput.java (实现ObjectInput接口) |
| </span></span><span style="display:flex;"><span> |-XxxObjectOutput.java (实现ObjectOutput接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.serialize.ObjectInput; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.serialize.ObjectOutput; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ObjectOutput <span style="color:#268bd2">serialize</span>(Parameters parameters, OutputStream output) <span style="color:#268bd2">throws</span> IOException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxObjectOutput(output); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ObjectInput <span style="color:#268bd2">deserialize</span>(Parameters parameters, InputStream input) <span style="color:#268bd2">throws</span> IOException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxObjectInput(input); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 网络传输扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/remoting/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/remoting/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/remoting/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>远程通讯的服务器及客户端传输实现。</p> |
| <h2 id="扩展接口">扩展接口</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="扩展配置">扩展配置</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:#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;!-- 服务器和客户端使用不同的传输实现 --&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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置transporter/server/client属性时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </span></span><span style="display:flex;"><span> |-XxxServer.java (实现Server接口) |
| </span></span><span style="display:flex;"><span> |-XxxClient.java (实现Client接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Server <span style="color:#268bd2">bind</span>(URL url, ChannelHandler handler) <span style="color:#268bd2">throws</span> RemotingException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxServer(url, handler); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Client <span style="color:#268bd2">connect</span>(URL url, ChannelHandler handler) <span style="color:#268bd2">throws</span> RemotingException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxClient(url, handler); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxServer</span>(URL url, ChannelHandler handler) <span style="color:#268bd2">throws</span> RemotingException{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span>(url, handler); |
| </span></span><span style="display:flex;"><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:#268bd2">throws</span> Throwable { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><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:#268bd2">throws</span> Throwable { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><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></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Channel <span style="color:#268bd2">getChannel</span>(InetSocketAddress remoteAddress) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxServer</span>(URL url, ChannelHandler handler) <span style="color:#268bd2">throws</span> RemotingException{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">super</span>(url, handler); |
| </span></span><span style="display:flex;"><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:#268bd2">throws</span> Throwable { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><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:#268bd2">throws</span> Throwable { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><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:#268bd2">throws</span> Throwable { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Channel <span style="color:#268bd2">getChannel</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 信息交换扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/exchanger/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/exchanger/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/exchanger/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>基于传输层之上，实现 Request-Response 信息交换语义。</p> |
| <h2 id="扩展接口">扩展接口</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="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置exchanger属性时，使用此配置 --&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="已知扩展">已知扩展</h2> |
| <p><code>org.apache.dubbo.remoting.exchange.exchanger.HeaderExchanger</code></p> |
| <h2 id="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </span></span><span style="display:flex;"><span> |-XxxExchangeServer.java (实现ExchangeServer接口) |
| </span></span><span style="display:flex;"><span> |-XxxExchangeClient.java (实现ExchangeClient接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ExchangeServer <span style="color:#268bd2">bind</span>(URL url, ExchangeHandler handler) <span style="color:#268bd2">throws</span> RemotingException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxExchangeServer(url, handler); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ExchangeClient <span style="color:#268bd2">connect</span>(URL url, ExchangeHandler handler) <span style="color:#268bd2">throws</span> RemotingException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxExchangeClient(url, handler); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><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: 对等网络节点组网器扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/page/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/page/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/page/">最新版本</a>。</p> |
| </div> |
| <h1 id="页面扩展">页面扩展</h1> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>对等网络节点组网器。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.container.page.PageHandler</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置page属性时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Group <span style="color:#268bd2">lookup</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 组网扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/networker/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/networker/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/networker/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>对等网络节点组网器。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.remoting.p2p.Networker</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置networker属性时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Group <span style="color:#268bd2">lookup</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: Telnet 命令扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/telnet-handler/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/telnet-handler/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/telnet-handler/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>所有服务器均支持 telnet 访问，用于人工干预。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.remoting.telnet.TelnetHandler</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置telnet属性时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Help</span>(parameter<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span>, summary<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span>, detail<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">telnet</span>(Channel channel, String message) <span style="color:#268bd2">throws</span> RemotingException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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="用法">用法</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: 状态检查扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/status-checker/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/status-checker/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/status-checker/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>检查服务依赖各种资源的状态，此状态检查可同时用于 telnet 的 status 命令和 hosting 的 status 页面。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.common.status.StatusChecker</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:protocol&gt;没有配置status属性时，使用此配置 --&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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Status <span style="color:#268bd2">check</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 容器扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/container/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/container/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/container/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>服务容器扩展，用于自定义加载内容。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.container.Container</code></p> |
| <h2 id="扩展配置">扩展配置</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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>org.apache.dubbo.container.Container; |
| </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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Status <span style="color:#268bd2">start</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Status <span style="color:#268bd2">stop</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 缓存扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/cache/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/cache/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/cache/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>用请求参数作为 key，缓存返回结果。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.cache.CacheFactory</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 方法级缓存 --&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:#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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Cache <span style="color:#268bd2">getCache</span>(URL url, String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> XxxCache(url, name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">Cache</span>(URL url, String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">put</span>(Object key, Object value) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">get</span>(Object key) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 验证扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/validation/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/validation/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/validation/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>参数验证扩展点。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.validation.Validation</code></p> |
| <h2 id="扩展配置">扩展配置</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;!-- 缺省值设置，当&lt;dubbo:service&gt;没有配置validation属性时，使用此配置 --&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="已知扩展">已知扩展</h2> |
| <p><code>org.apache.dubbo.validation.support.jvalidation.JValidation</code></p> |
| <h2 id="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Object <span style="color:#268bd2">getValidator</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxValidator</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">validate</span>(Invocation invocation) <span style="color:#268bd2">throws</span> Exception { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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: 日志适配扩展</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/logger-adapter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/logger-adapter/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/description/logger-adapter/">最新版本</a>。</p> |
| </div> |
| <h2 id="扩展说明">扩展说明</h2> |
| <p>日志输出适配扩展点。</p> |
| <h2 id="扩展接口">扩展接口</h2> |
| <p><code>org.apache.dubbo.common.logger.LoggerAdapter</code></p> |
| <h2 id="扩展配置">扩展配置</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>或者：</p> |
| <div class="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="已知扩展">已知扩展</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="扩展示例">扩展示例</h2> |
| <p>Maven 项目结构：</p> |
| <div class="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接口) |
| </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 (纯文本文件，内容为：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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Logger <span style="color:#268bd2">getLogger</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><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></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></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></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">XxxLogger</span>(URL url) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">info</span>(String msg) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</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></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><item><title>Docs: 扩展点开发指南</title><link>https://dubbo.apache.org/zh-cn/docs/references/spis/dubbo-spi/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/docs/references/spis/dubbo-spi/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/spi/overview/">最新版本</a>。</p> |
| </div> |
| <h2 id="1简介">1.简介</h2> |
| <p>SPI 全称为 Service Provider Interface，是一种服务发现机制。SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。正因此特性，我们可以很容易的通过 SPI 机制为我们的程序提供拓展功能。SPI 机制在第三方框架中也有所应用，比如 Dubbo 就是通过 SPI 机制加载所有的组件。不过，Dubbo 并未使用 Java 原生的 SPI 机制，而是对其进行了增强，使其能够更好的满足需求。在 Dubbo 中，SPI 是一个非常重要的模块。基于 SPI，我们可以很容易的对 Dubbo 进行拓展。 |
| Dubbo 中，SPI 主要有两种用法，一种是加载固定的扩展类，另一种是加载自适应扩展类。这两种方式会在下面详细的介绍。 |
| 需要特别注意的是: 在 Dubbo 中，基于 SPI 扩展加载的类是单例的。</p> |
| <h3 id="11-加载固定的扩展类">1.1 加载固定的扩展类</h3> |
| <p>如果让你来设计加载固定扩展类，你会怎么做了？ |
| 一种常见思路是读取特定目录下的配置文件，然后解析出全类名，通过反射机制来实例化这个类，然后将这个类放在集合中存起来，如果有需要的时候，直接从集合中取。Dubbo 中的实现也是这么一个思路。 |
| 不过在 Dubbo 中，实现的更加完善，它实现类了 IOC 和 AOP 的功能。IOC 就是说如果这个扩展类依赖其他属性，Dubbo 会自动的将这个属性进行注入。这个功能如何实现了？一个常见思路是获取这个扩展类的 setter |
| 方法，调用 setter 方法进行属性注入。AOP 指的是什么了？这个说的是 Dubbo 能够为扩展类注入其包装类。比如 DubboProtocol 是 Protocol 的扩展类，ProtocolListenerWrapper 是 DubboProtocol 的包装类。</p> |
| <h3 id="12-加载自适应扩展类">1.2 加载自适应扩展类</h3> |
| <p>先说明下自适应扩展类的使用场景。比如我们有需求，在调用某一个方法时，基于参数选择调用到不同的实现类。和工厂方法有些类似，基于不同的参数，构造出不同的实例对象。 |
| 在 Dubbo 中实现的思路和这个差不多，不过 Dubbo 的实现更加灵活，它的实现和策略模式有些类似。每一种扩展类相当于一种策略，基于 URL 消息总线，将参数传递给 ExtensionLoader，通过 ExtensionLoader 基于参数加载对应的扩展类，实现运行时动态调用到目标实例上。</p> |
| <h2 id="2-dubbo-spi-源码分析">2. Dubbo SPI 源码分析</h2> |
| <h3 id="21-加载固定的扩展类">2.1 加载固定的扩展类</h3> |
| <p>Dubbo 中，SPI 加载固定扩展类的入口是 ExtensionLoader 的 getExtension 方法，下面我们对拓展类对象的获取过程进行详细的分析。</p> |
| <div class="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> T <span style="color:#268bd2">getExtension</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (name <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">||</span> name.length() <span style="color:#719e07">==</span> 0) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;Extension name == null&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#2aa198">&#34;true&#34;</span>.equals(name)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 获取默认的拓展实现类</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> getDefaultExtension(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Holder，顾名思义，用于持有目标对象</span> |
| </span></span><span style="display:flex;"><span> Holder<span style="color:#719e07">&lt;</span>Object<span style="color:#719e07">&gt;</span> holder <span style="color:#719e07">=</span> cachedInstances.get(name); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 这段逻辑保证了只有一个线程能够创建 Holder 对象</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (holder <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> cachedInstances.putIfAbsent(name, <span style="color:#719e07">new</span> Holder<span style="color:#719e07">&lt;</span>Object<span style="color:#719e07">&gt;</span>()); |
| </span></span><span style="display:flex;"><span> holder <span style="color:#719e07">=</span> cachedInstances.get(name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> Object instance <span style="color:#719e07">=</span> holder.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 双重检查</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">synchronized</span> (holder) { |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> holder.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 创建拓展实例</span> |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> createExtension(name); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 设置实例到 holder 中</span> |
| </span></span><span style="display:flex;"><span> holder.set(instance); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> (T) instance; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>上面代码的逻辑比较简单，首先检查缓存，缓存未命中则创建拓展对象。下面我们来看一下创建拓展对象的过程是怎样的。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> T <span style="color:#268bd2">createExtension</span>(String name, <span style="color:#dc322f">boolean</span> wrap) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 从配置文件中加载所有的拓展类，可得到“配置项名称”到“配置类”的映射关系表</span> |
| </span></span><span style="display:flex;"><span> Class<span style="color:#719e07">&lt;?&gt;</span> clazz <span style="color:#719e07">=</span> getExtensionClasses().get(name); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果没有该接口的扩展，或者该接口的实现类不允许重复但实际上重复了，直接抛出异常</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (clazz <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">||</span> unacceptableExceptions.contains(name)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> findException(name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> T instance <span style="color:#719e07">=</span> (T) EXTENSION_INSTANCES.get(clazz); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 这段代码保证了扩展类只会被构造一次，也就是单例的.</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> EXTENSION_INSTANCES.putIfAbsent(clazz, clazz.getDeclaredConstructor().newInstance()); |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> (T) EXTENSION_INSTANCES.get(clazz); |
| </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> injectExtension(instance); |
| </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">// 比如我基于 Protocol 定义了 DubboProtocol 的扩展，但实际上在 Dubbo 中不是直接使用的 DubboProtocol, 而是其包装类</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ProtocolListenerWrapper</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (wrap) { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>Class<span style="color:#719e07">&lt;?&gt;&gt;</span> wrapperClassesList <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ArrayList<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (cachedWrapperClasses <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> wrapperClassesList.addAll(cachedWrapperClasses); |
| </span></span><span style="display:flex;"><span> wrapperClassesList.sort(WrapperComparator.COMPARATOR); |
| </span></span><span style="display:flex;"><span> Collections.reverse(wrapperClassesList); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 循环创建 Wrapper 实例</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (CollectionUtils.isNotEmpty(wrapperClassesList)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (Class<span style="color:#719e07">&lt;?&gt;</span> wrapperClass : wrapperClassesList) { |
| </span></span><span style="display:flex;"><span> Wrapper wrapper <span style="color:#719e07">=</span> wrapperClass.getAnnotation(Wrapper.class); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (wrapper <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">||</span> (ArrayUtils.contains(wrapper.matches(), name) <span style="color:#719e07">&amp;&amp;</span> <span style="color:#719e07">!</span>ArrayUtils.contains(wrapper.mismatches(), name))) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 将当前 instance 作为参数传给 Wrapper 的构造方法，并通过反射创建 Wrapper 实例。</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 然后向 Wrapper 实例中注入依赖，最后将 Wrapper 实例再次赋值给 instance 变量</span> |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 初始化</span> |
| </span></span><span style="display:flex;"><span> initExtension(instance); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> instance; |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable t) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Extension instance (name: &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, class: &#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> type <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;) couldn&#39;t be instantiated: &#34;</span> <span style="color:#719e07">+</span> t.getMessage(), t); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>createExtension 方法的逻辑稍复杂一下，包含了如下的步骤：</p> |
| <ol> |
| <li>通过 getExtensionClasses 获取所有的拓展类</li> |
| <li>通过反射创建拓展对象</li> |
| <li>向拓展对象中注入依赖</li> |
| <li>将拓展对象包裹在相应的 Wrapper 对象中</li> |
| <li>初始化拓展对象</li> |
| </ol> |
| <p>以上步骤中，第一个步骤是加载拓展类的关键，第三和第四个步骤是 Dubbo IOC 与 AOP 的具体实现。在接下来的章节中，将会重点分析 getExtensionClasses 方法的逻辑，以及简单介绍 Dubbo IOC 的具体实现。</p> |
| <h3 id="211-获取所有的拓展类">2.1.1 获取所有的拓展类</h3> |
| <p>我们在通过名称获取拓展类之前，首先需要根据配置文件解析出拓展项名称到拓展类的映射关系表（Map&lt;名称, 拓展类&gt;），之后再根据拓展项名称从映射关系表中取出相应的拓展类即可。相关过程的代码分析如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> getExtensionClasses() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 从缓存中获取已加载的拓展类</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> classes <span style="color:#719e07">=</span> cachedClasses.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 双重检查</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (classes <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">synchronized</span> (cachedClasses) { |
| </span></span><span style="display:flex;"><span> classes <span style="color:#719e07">=</span> cachedClasses.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (classes <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 加载拓展类</span> |
| </span></span><span style="display:flex;"><span> classes <span style="color:#719e07">=</span> loadExtensionClasses(); |
| </span></span><span style="display:flex;"><span> cachedClasses.set(classes); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> classes; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>这里也是先检查缓存，若缓存未命中，则通过 synchronized 加锁。加锁后再次检查缓存，并判空。此时如果 classes 仍为 null，则通过 loadExtensionClasses 加载拓展类。下面分析 loadExtensionClasses 方法的逻辑。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> loadExtensionClasses() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 缓存默认的 SPI 扩展名</span> |
| </span></span><span style="display:flex;"><span> cacheDefaultExtensionName(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> extensionClasses <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 基于策略来加载指定文件夹下的文件</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 目前有四种策略，分别读取 META-INF/services/ META-INF/dubbo/ META-INF/dubbo/internal/ META-INF/dubbo/external/ 这四个目录下的配置文件</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (LoadingStrategy strategy : strategies) { |
| </span></span><span style="display:flex;"><span> loadDirectory(extensionClasses, strategy.directory(), type.getName(), strategy.preferExtensionClassLoader(), strategy.overridden(), strategy.excludedPackages()); |
| </span></span><span style="display:flex;"><span> loadDirectory(extensionClasses, strategy.directory(), type.getName().replace(<span style="color:#2aa198">&#34;org.apache&#34;</span>, <span style="color:#2aa198">&#34;com.alibaba&#34;</span>), strategy.preferExtensionClassLoader(), strategy.overridden(), strategy.excludedPackages()); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> extensionClasses; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>loadExtensionClasses 方法总共做了两件事情，一是对 SPI 注解进行解析，二是调用 loadDirectory 方法加载指定文件夹配置文件。SPI 注解解析过程比较简单，无需多说。下面我们来看一下 loadDirectory 做了哪些事情。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">loadDirectory</span>(Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> extensionClasses, String dir, String type, |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">boolean</span> extensionLoaderClassLoaderFirst, <span style="color:#dc322f">boolean</span> overridden, String... excludedPackages) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// fileName = 文件夹路径 + type 全限定名 </span> |
| </span></span><span style="display:flex;"><span> String fileName <span style="color:#719e07">=</span> dir <span style="color:#719e07">+</span> type; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Enumeration<span style="color:#719e07">&lt;</span>java.net.URL<span style="color:#719e07">&gt;</span> urls <span style="color:#719e07">=</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> ClassLoader classLoader <span style="color:#719e07">=</span> findClassLoader(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// try to load from ExtensionLoader&#39;s ClassLoader first</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (extensionLoaderClassLoaderFirst) { |
| </span></span><span style="display:flex;"><span> ClassLoader extensionLoaderClassLoader <span style="color:#719e07">=</span> ExtensionLoader.class.getClassLoader(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (ClassLoader.getSystemClassLoader() <span style="color:#719e07">!=</span> extensionLoaderClassLoader) { |
| </span></span><span style="display:flex;"><span> urls <span style="color:#719e07">=</span> extensionLoaderClassLoader.getResources(fileName); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 根据文件名加载所有的同名文件</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (urls <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">||</span> <span style="color:#719e07">!</span>urls.hasMoreElements()) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (classLoader <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> urls <span style="color:#719e07">=</span> classLoader.getResources(fileName); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> urls <span style="color:#719e07">=</span> ClassLoader.getSystemResources(fileName); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (urls <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">while</span> (urls.hasMoreElements()) { |
| </span></span><span style="display:flex;"><span> java.net.URL resourceURL <span style="color:#719e07">=</span> urls.nextElement(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 加载资源</span> |
| </span></span><span style="display:flex;"><span> loadResource(extensionClasses, classLoader, resourceURL, overridden, excludedPackages); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable t) { |
| </span></span><span style="display:flex;"><span> logger.error(<span style="color:#2aa198">&#34;Exception occurred when loading extension class (interface: &#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> type <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, description file: &#34;</span> <span style="color:#719e07">+</span> fileName <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;).&#34;</span>, t); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>loadDirectory 方法先通过 classLoader 获取所有资源链接，然后再通过 loadResource 方法加载资源。我们继续跟下去，看一下 loadResource 方法的实现。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">loadResource</span>(Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> extensionClasses, ClassLoader classLoader, |
| </span></span><span style="display:flex;"><span> java.net.URL resourceURL, <span style="color:#dc322f">boolean</span> overridden, String... excludedPackages) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> (BufferedReader reader <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> BufferedReader(<span style="color:#719e07">new</span> InputStreamReader(resourceURL.openStream(), StandardCharsets.UTF_8))) { |
| </span></span><span style="display:flex;"><span> String line; |
| </span></span><span style="display:flex;"><span> String clazz <span style="color:#719e07">=</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 按行读取配置内容</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">while</span> ((line <span style="color:#719e07">=</span> reader.readLine()) <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 定位 # 字符</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> <span style="color:#dc322f">int</span> ci <span style="color:#719e07">=</span> line.indexOf(<span style="color:#2aa198">&#39;#&#39;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (ci <span style="color:#719e07">&gt;=</span> 0) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 截取 # 之前的字符串，# 之后的内容为注释，需要忽略</span> |
| </span></span><span style="display:flex;"><span> line <span style="color:#719e07">=</span> line.substring(0, ci); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> line <span style="color:#719e07">=</span> line.trim(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (line.length() <span style="color:#719e07">&gt;</span> 0) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> String name <span style="color:#719e07">=</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 以等于号 = 为界，截取键与值</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> line.indexOf(<span style="color:#2aa198">&#39;=&#39;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (i <span style="color:#719e07">&gt;</span> 0) { |
| </span></span><span style="display:flex;"><span> name <span style="color:#719e07">=</span> line.substring(0, i).trim(); |
| </span></span><span style="display:flex;"><span> clazz <span style="color:#719e07">=</span> line.substring(i <span style="color:#719e07">+</span> 1).trim(); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> clazz <span style="color:#719e07">=</span> line; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 加载类，并通过 loadClass 方法对类进行缓存</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (StringUtils.isNotEmpty(clazz) <span style="color:#719e07">&amp;&amp;</span> <span style="color:#719e07">!</span>isExcluded(clazz, excludedPackages)) { |
| </span></span><span style="display:flex;"><span> loadClass(extensionClasses, resourceURL, Class.forName(clazz, <span style="color:#cb4b16">true</span>, classLoader), name, overridden); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable t) { |
| </span></span><span style="display:flex;"><span> IllegalStateException e <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Failed to load extension class (interface: &#34;</span> <span style="color:#719e07">+</span> type <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, class line: &#34;</span> <span style="color:#719e07">+</span> line <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;) in &#34;</span> <span style="color:#719e07">+</span> resourceURL <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, cause: &#34;</span> <span style="color:#719e07">+</span> t.getMessage(), t); |
| </span></span><span style="display:flex;"><span> exceptions.put(line, e); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable t) { |
| </span></span><span style="display:flex;"><span> logger.error(<span style="color:#2aa198">&#34;Exception occurred when loading extension class (interface: &#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> type <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, class file: &#34;</span> <span style="color:#719e07">+</span> resourceURL <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;) in &#34;</span> <span style="color:#719e07">+</span> resourceURL, t); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>loadResource 方法用于读取和解析配置文件，并通过反射加载类，最后调用 loadClass 方法进行其他操作。loadClass 方法用于主要用于操作缓存，该方法的逻辑如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">loadClass</span>(Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> extensionClasses, java.net.URL resourceURL, Class<span style="color:#719e07">&lt;?&gt;</span> clazz, String name, |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">boolean</span> overridden) <span style="color:#268bd2">throws</span> NoSuchMethodException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span>type.isAssignableFrom(clazz)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Error occurred when loading extension class (interface: &#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> type <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, class line: &#34;</span> <span style="color:#719e07">+</span> clazz.getName() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;), class &#34;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">+</span> clazz.getName() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; is not subtype of interface.&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 检测目标类上是否有 Adaptive 注解</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (clazz.isAnnotationPresent(Adaptive.class)) { |
| </span></span><span style="display:flex;"><span> cacheAdaptiveClass(clazz, overridden); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> <span style="color:#719e07">if</span> (isWrapperClass(clazz)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 缓存包装类</span> |
| </span></span><span style="display:flex;"><span> cacheWrapperClass(clazz); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 进入到这里，表明只是该类只是一个普通的拓展类</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 检测 clazz 是否有默认的构造方法，如果没有，则抛出异常</span> |
| </span></span><span style="display:flex;"><span> clazz.getConstructor(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (StringUtils.isEmpty(name)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果 name 为空，则尝试从 Extension 注解中获取 name，或使用小写的类名作为 name</span> |
| </span></span><span style="display:flex;"><span> name <span style="color:#719e07">=</span> findAnnotationName(clazz); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (name.length() <span style="color:#719e07">==</span> 0) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;No such extension name for the class &#34;</span> <span style="color:#719e07">+</span> clazz.getName() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; in the config &#34;</span> <span style="color:#719e07">+</span> resourceURL); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String<span style="color:#719e07">[]</span> names <span style="color:#719e07">=</span> NAME_SEPARATOR.split(name); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (ArrayUtils.isNotEmpty(names)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果类上有 Activate 注解，则使用 names 数组的第一个元素作为键，</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 存储 name 到 Activate 注解对象的映射关系</span> |
| </span></span><span style="display:flex;"><span> cacheActivateClass(clazz, names<span style="color:#719e07">[</span>0<span style="color:#719e07">]</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (String n : names) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 存储 Class 到名称的映射关系</span> |
| </span></span><span style="display:flex;"><span> cacheName(clazz, n); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 存储 name 到 Class 的映射关系.</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果存在同一个扩展名对应多个实现类，基于 override 参数是否允许覆盖，如果不允许，则抛出异常.</span> |
| </span></span><span style="display:flex;"><span> saveInExtensionClass(extensionClasses, clazz, n, overridden); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>如上，loadClass 方法操作了不同的缓存，比如 cachedAdaptiveClass、cachedWrapperClasses 和 cachedNames 等等。除此之外，该方法没有其他什么逻辑了。</p> |
| <p>到此，关于缓存类加载的过程就分析完了。整个过程没什么特别复杂的地方，大家按部就班的分析即可，不懂的地方可以调试一下。接下来，我们来聊聊 Dubbo IOC 方面的内容。</p> |
| <h3 id="212-dubbo-ioc">2.1.2 Dubbo IOC</h3> |
| <p>Dubbo IOC 是通过 setter 方法注入依赖。Dubbo 首先会通过反射获取到实例的所有方法，然后再遍历方法列表，检测方法名是否具有 setter 方法特征。若有，则通过 ObjectFactory 获取依赖对象，最后通过反射调用 setter 方法将依赖设置到目标对象中。整个过程对应的代码如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> T <span style="color:#268bd2">injectExtension</span>(T instance) { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (objectFactory <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> instance; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 遍历目标类的所有方法</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (Method method : instance.getClass().getMethods()) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 检测方法是否以 set 开头，且方法仅有一个参数，且方法访问级别为 public</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span>isSetter(method)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">continue</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"> * 检测是否有 DisableInject 注解修饰. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (method.getAnnotation(DisableInject.class) <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">continue</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> Class<span style="color:#719e07">&lt;?&gt;</span> pt <span style="color:#719e07">=</span> method.getParameterTypes()<span style="color:#719e07">[</span>0<span style="color:#719e07">]</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (ReflectUtils.isPrimitives(pt)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">continue</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:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 获取属性名，比如 setName 方法对应属性名 name</span> |
| </span></span><span style="display:flex;"><span> String property <span style="color:#719e07">=</span> getSetterProperty(method); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 从 ObjectFactory 中获取依赖对象</span> |
| </span></span><span style="display:flex;"><span> Object object <span style="color:#719e07">=</span> objectFactory.getExtension(pt, property); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (object <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 注入</span> |
| </span></span><span style="display:flex;"><span> method.invoke(instance, object); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Exception e) { |
| </span></span><span style="display:flex;"><span> logger.error(<span style="color:#2aa198">&#34;Failed to inject via method &#34;</span> <span style="color:#719e07">+</span> method.getName() |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; of interface &#34;</span> <span style="color:#719e07">+</span> type.getName() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;: &#34;</span> <span style="color:#719e07">+</span> e.getMessage(), e); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Exception e) { |
| </span></span><span style="display:flex;"><span> logger.error(e.getMessage(), e); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> instance; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在上面代码中，objectFactory 变量的类型为 AdaptiveExtensionFactory，AdaptiveExtensionFactory 内部维护了一个 ExtensionFactory 列表，用于存储其他类型的 ExtensionFactory。Dubbo 目前提供了两种 ExtensionFactory，分别是 SpiExtensionFactory 和 SpringExtensionFactory。前者用于创建自适应的拓展，后者是用于从 Spring 的 IOC 容器中获取所需的拓展。这两个类的类的代码不是很复杂，这里就不一一分析了。</p> |
| <p>Dubbo IOC 目前仅支持 setter 方式注入，总的来说，逻辑比较简单易懂。</p> |
| <h3 id="22-加载自适应扩展类">2.2 加载自适应扩展类</h3> |
| <p>自适应扩展类的含义是说，基于参数，在运行时动态选择到具体的目标类，然后执行。 |
| 在 Dubbo 中，很多拓展都是通过 SPI 机制进行加载的，比如 Protocol、Cluster、LoadBalance 等。有时，有些拓展并不想在框架启动阶段被加载，而是希望在拓展方法被调用时，根据运行时参数进行加载。这听起来有些矛盾。拓展未被加载，那么拓展方法就无法被调用（静态方法除外）。拓展方法未被调用，拓展就无法被加载。对于这个矛盾的问题，Dubbo 通过自适应拓展机制很好的解决了。自适应拓展机制的实现逻辑比较复杂，首先 Dubbo 会为拓展接口生成具有代理功能的代码。然后通过 javassist 或 jdk 编译这段代码，得到 Class 类。最后再通过反射创建代理类，整个过程比较复杂。</p> |
| <p>加载自适应扩展类的入口是 ExtensionLoader 的 getAdaptiveExtension 方法。</p> |
| <div class="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> T <span style="color:#268bd2">getAdaptiveExtension</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 从缓存中获取自适应拓展</span> |
| </span></span><span style="display:flex;"><span> Object instance <span style="color:#719e07">=</span> cachedAdaptiveInstance.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果存在异常，则直接抛出</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (createAdaptiveInstanceError <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Failed to create adaptive instance: &#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> createAdaptiveInstanceError.toString(), |
| </span></span><span style="display:flex;"><span> createAdaptiveInstanceError); |
| </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">synchronized</span> (cachedAdaptiveInstance) { |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> cachedAdaptiveInstance.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// double check</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 创建自适应拓展</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 这里分为两种情况：一种是存在 Adaptive 类，另一个是需要生成 Adaptive 类</span> |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> createAdaptiveExtension(); |
| </span></span><span style="display:flex;"><span> cachedAdaptiveInstance.set(instance); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable t) { |
| </span></span><span style="display:flex;"><span> createAdaptiveInstanceError <span style="color:#719e07">=</span> t; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Failed to create adaptive instance: &#34;</span> <span style="color:#719e07">+</span> t.toString(), t); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> (T) instance; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>getAdaptiveExtension 方法首先会检查缓存，缓存未命中，则调用 createAdaptiveExtension 方法创建自适应拓展。下面，我们看一下 createAdaptiveExtension 方法的代码。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> T <span style="color:#268bd2">createAdaptiveExtension</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 获取自适应拓展类，并通过反射实例化</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> injectExtension((T) getAdaptiveExtensionClass().newInstance()); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Exception e) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Can not create adaptive extension ...&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>createAdaptiveExtension 方法的代码比较少，但却包含了三个逻辑，分别如下：</p> |
| <ol> |
| <li>调用 getAdaptiveExtensionClass 方法获取自适应拓展 Class 对象</li> |
| <li>通过反射进行实例化</li> |
| <li>调用 injectExtension 方法向拓展实例中注入依赖</li> |
| </ol> |
| <p>前两个逻辑比较好理解，第三个逻辑用于向自适应拓展对象中注入依赖。这个逻辑看似多余，但有存在的必要，这里简单说明一下。前面说过，Dubbo 中有两种类型的自适应拓展，一种是手工编码的，一种是自动生成的。手工编码的自适应拓展中可能存在着一些依赖，而自动生成的 Adaptive 拓展则不会依赖其他类。这里调用 injectExtension 方法的目的是为手工编码的自适应拓展注入依赖，这一点需要大家注意一下。关于 injectExtension 方法，前文已经分析过了，这里不再赘述。接下来，分析 getAdaptiveExtensionClass 方法的逻辑。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> Class<span style="color:#719e07">&lt;?&gt;</span> getAdaptiveExtensionClass() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 通过 SPI 获取所有的拓展类</span> |
| </span></span><span style="display:flex;"><span> getExtensionClasses(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 检查缓存，若缓存不为空，则直接返回缓存</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (cachedAdaptiveClass <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> cachedAdaptiveClass; |
| </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:#719e07">return</span> cachedAdaptiveClass <span style="color:#719e07">=</span> createAdaptiveExtensionClass(); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>getAdaptiveExtensionClass 方法同样包含了三个逻辑，如下：</p> |
| <ol> |
| <li>调用 getExtensionClasses 获取所有的拓展类</li> |
| <li>检查缓存，若缓存不为空，则返回缓存</li> |
| <li>若缓存为空，则调用 createAdaptiveExtensionClass 创建自适应拓展类</li> |
| </ol> |
| <p>这三个逻辑看起来平淡无奇，似乎没有多讲的必要。但是这些平淡无奇的代码中隐藏了着一些细节，需要说明一下。首先从第一个逻辑说起，getExtensionClasses 这个方法用于获取某个接口的所有实现类。比如该方法可以获取 Protocol 接口的 DubboProtocol、HttpProtocol、InjvmProtocol 等实现类。在获取实现类的过程中，如果某个实现类被 Adaptive 注解修饰了，那么该类就会被赋值给 cachedAdaptiveClass 变量。此时，上面步骤中的第二步条件成立（缓存不为空），直接返回 cachedAdaptiveClass 即可。如果所有的实现类均未被 Adaptive 注解修饰，那么执行第三步逻辑，创建自适应拓展类。相关代码如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> Class<span style="color:#719e07">&lt;?&gt;</span> createAdaptiveExtensionClass() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 构建自适应拓展代码</span> |
| </span></span><span style="display:flex;"><span> String code <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AdaptiveClassCodeGenerator(type, cachedDefaultName).generate(); |
| </span></span><span style="display:flex;"><span> ClassLoader classLoader <span style="color:#719e07">=</span> findClassLoader(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 获取编译器实现类</span> |
| </span></span><span style="display:flex;"><span> org.apache.dubbo.common.compiler.Compiler compiler <span style="color:#719e07">=</span> ExtensionLoader.getExtensionLoader(org.apache.dubbo.common.compiler.Compiler.class).getAdaptiveExtension(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 编译代码，生成 Class</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> compiler.compile(code, classLoader); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>createAdaptiveExtensionClass 方法用于生成自适应拓展类，该方法首先会生成自适应拓展类的源码，然后通过 Compiler 实例（Dubbo 默认使用 javassist 作为编译器）编译源码，得到代理类 Class 实例。接下来，我们把重点放在代理类代码生成的逻辑上，其他逻辑大家自行分析。</p> |
| <h3 id="221-自适应拓展类代码生成">2.2.1 自适应拓展类代码生成</h3> |
| <p>AdaptiveClassCodeGenerator#generate 方法生成扩展类代码</p> |
| <div class="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> String <span style="color:#268bd2">generate</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果该接口中没有方法被 @Adaptive 注解修饰，直接抛出异常</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span>hasAdaptiveMethod()) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;No adaptive method exist on extension &#34;</span> <span style="color:#719e07">+</span> type.getName() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, refuse to create the adaptive class!&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> StringBuilder code <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> StringBuilder(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 生成包名、import、方法等.</span> |
| </span></span><span style="display:flex;"><span> code.append(generatePackageInfo()); |
| </span></span><span style="display:flex;"><span> code.append(generateImports()); |
| </span></span><span style="display:flex;"><span> code.append(generateClassDeclaration()); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Method<span style="color:#719e07">[]</span> methods <span style="color:#719e07">=</span> type.getMethods(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (Method method : methods) { |
| </span></span><span style="display:flex;"><span> code.append(generateMethod(method)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> code.append(<span style="color:#2aa198">&#34;}&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (logger.isDebugEnabled()) { |
| </span></span><span style="display:flex;"><span> logger.debug(code.toString()); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> code.toString(); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h4 id="222-生成方法">2.2.2 生成方法</h4> |
| <p>上面代码中，生成方法的逻辑是最关键的，我们详细分析下。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> String <span style="color:#268bd2">generateMethod</span>(Method method) { |
| </span></span><span style="display:flex;"><span> String methodReturnType <span style="color:#719e07">=</span> method.getReturnType().getCanonicalName(); |
| </span></span><span style="display:flex;"><span> String methodName <span style="color:#719e07">=</span> method.getName(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 生成方法内容</span> |
| </span></span><span style="display:flex;"><span> String methodContent <span style="color:#719e07">=</span> generateMethodContent(method); |
| </span></span><span style="display:flex;"><span> String methodArgs <span style="color:#719e07">=</span> generateMethodArguments(method); |
| </span></span><span style="display:flex;"><span> String methodThrows <span style="color:#719e07">=</span> generateMethodThrows(method); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> String.format(CODE_METHOD_DECLARATION, methodReturnType, methodName, methodArgs, methodThrows, methodContent); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>generateMethodContent 分析</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> String <span style="color:#268bd2">generateMethodContent</span>(Method method) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 该方法上必须有 @Adaptive 注解修饰</span> |
| </span></span><span style="display:flex;"><span> Adaptive adaptiveAnnotation <span style="color:#719e07">=</span> method.getAnnotation(Adaptive.class); |
| </span></span><span style="display:flex;"><span> StringBuilder code <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> StringBuilder(512); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (adaptiveAnnotation <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 没有 @Adaptive 注解修饰，生成异常信息</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> generateUnsupported(method); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 获取 URL 在参数列表上的索引</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> urlTypeIndex <span style="color:#719e07">=</span> getUrlTypeIndex(method); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (urlTypeIndex <span style="color:#719e07">!=</span> <span style="color:#719e07">-</span>1) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果参数列表上存在 URL，生成对 URL 进行空检查</span> |
| </span></span><span style="display:flex;"><span> code.append(generateUrlNullCheck(urlTypeIndex)); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果参数列表不存在 URL 类型的参数，那么就看参数列表上参数对象中是否包含 getUrl 方法</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 有的话，生成 URL 空检查</span> |
| </span></span><span style="display:flex;"><span> code.append(generateUrlAssignmentIndirectly(method)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 解析 Adaptive 注解上的 value 属性</span> |
| </span></span><span style="display:flex;"><span> String<span style="color:#719e07">[]</span> value <span style="color:#719e07">=</span> getMethodAdaptiveValue(adaptiveAnnotation); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 如果参数列表上有 Invocation 类型的参数，生成空检查并获取 methodName.</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">boolean</span> hasInvocation <span style="color:#719e07">=</span> hasInvocationArgument(method); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> code.append(generateInvocationArgumentNullCheck(method)); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 这段逻辑主要就是为了生成 extName(也就是扩展名)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 分为多种情况：</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 1.defaultExtName 是否存在</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 2.参数中是否存在 invocation 类型参数</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 3.是否是为 protocol 生成代理</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 为什么要对 protocol 单独考虑了？因为 URL 中有获取 protocol 值的方法</span> |
| </span></span><span style="display:flex;"><span> code.append(generateExtNameAssignment(value, hasInvocation)); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// check extName == null?</span> |
| </span></span><span style="display:flex;"><span> code.append(generateExtNameNullCheck(value)); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 生成获取扩展(使用 ExtensionLoader.getExtension 方法)</span> |
| </span></span><span style="display:flex;"><span> code.append(generateExtensionAssignment()); |
| </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> code.append(generateReturnAndInvocation(method)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> code.toString(); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>上面那段逻辑主要做了如下几件事： |
| 1.检查方法上是否 Adaptive 注解修饰 |
| 2.为方法生成代码的时候，参数列表上要有 URL(或参数对象中有 URL) |
| 3.使用 ExtensionLoader.getExtension 获取扩展 |
| 4.执行对应的方法</p> |
| <h3 id="223-附一个动态生成代码后的例子">2.2.3 附一个动态生成代码后的例子</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.common.extension.adaptive; |
| </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.ExtensionLoader; |
| </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">HasAdaptiveExt$Adaptive</span> <span style="color:#268bd2">implements</span> org.apache.dubbo.common.extension.adaptive.HasAdaptiveExt { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> java.lang.String <span style="color:#268bd2">echo</span>(org.apache.dubbo.common.URL arg0, |
| </span></span><span style="display:flex;"><span> java.lang.String arg1) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// URL 空校验</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (arg0 <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;url == null&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> org.apache.dubbo.common.URL url <span style="color:#719e07">=</span> arg0; |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 获取扩展名</span> |
| </span></span><span style="display:flex;"><span> String extName <span style="color:#719e07">=</span> url.getParameter(<span style="color:#2aa198">&#34;has.adaptive.ext&#34;</span>, <span style="color:#2aa198">&#34;adaptive&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 扩展名空校验</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (extName <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException( |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;Failed to get extension (org.apache.dubbo.common.extension.adaptive.HasAdaptiveExt) name from url (&#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> url.toString() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;) use keys([has.adaptive.ext])&#34;</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> org.apache.dubbo.common.extension.adaptive.HasAdaptiveExt extension <span style="color:#719e07">=</span> (org.apache.dubbo.common.extension.adaptive.HasAdaptiveExt) ExtensionLoader.getExtensionLoader(org.apache.dubbo.common.extension.adaptive.HasAdaptiveExt.class) |
| </span></span><span style="display:flex;"><span> .getExtension(extName); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 执行对应的方法</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> extension.echo(arg0, arg1); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h2 id="3spi-扩展示例">3.SPI 扩展示例</h2> |
| <h3 id="31--加载固定扩展类">3.1 加载固定扩展类</h3> |
| <h3 id="311-编写-spi-接口及实现类">3.1.1 编写 SPI 接口及实现类</h3> |
| <p>不管是 Java SPI，还是 Dubbo 中实现的 SPI，都需要编写接口。不过 Dubbo 中的接口需要被 @SPI 注解修饰。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">DemoSpi</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">say</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">DemoSpiImpl</span> <span style="color:#268bd2">implements</span> DemoSpi { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">say</span>() { |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h4 id="312-将实现类放在特定目录下">3.1.2 将实现类放在特定目录下</h4> |
| <p>从上面的代码可知，dubbo 在加载扩展类的时候，会从四个目录中读取。我们在 META-INF/dubbo 目录下新建一个以 DemoSpi 接口名为文件名的文件，内容如下：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>demoSpiImpl = com.xxx.xxx.DemoSpiImpl(为 DemoSpi 接口实现类的全类名) |
| </span></span></code></pre></div><h4 id="313-使用">3.1.3 使用</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DubboSPITest</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Test</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">sayHello</span>() <span style="color:#268bd2">throws</span> Exception { |
| </span></span><span style="display:flex;"><span> ExtensionLoader<span style="color:#719e07">&lt;</span>DemoSpi<span style="color:#719e07">&gt;</span> extensionLoader <span style="color:#719e07">=</span> |
| </span></span><span style="display:flex;"><span> ExtensionLoader.getExtensionLoader(DemoSpi.class); |
| </span></span><span style="display:flex;"><span> DemoSpi dmeoSpi <span style="color:#719e07">=</span> extensionLoader.getExtension(<span style="color:#2aa198">&#34;demoSpiImpl&#34;</span>); |
| </span></span><span style="display:flex;"><span> optimusPrime.sayHello(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="32-加载自适应扩展类">3.2 加载自适应扩展类</h3> |
| <p>这个以 Protocol 为例进行说明</p> |
| <h3 id="321-protocol-接口抽取部分核心方法">3.2.1 Protocol 接口(抽取部分核心方法)</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span>(<span style="color:#2aa198">&#34;dubbo&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">Protocol</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</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>(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</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>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RpcException; |
| </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">DubboProtocol</span> <span style="color:#268bd2">extends</span> AbstractProtocol { |
| </span></span><span style="display:flex;"><span> ...... |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <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>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> protocolBindingRefer(type, url); |
| </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">@Override</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>(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> ...... |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> exporter; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="322-将实现类放在特定目录下">3.2.2 将实现类放在特定目录下</h3> |
| <p>在 dubbo 中，该配置路径 META-INF/dubbo/internal/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-text" data-lang="text"><span style="display:flex;"><span>dubbo=org.apache.dubbo.rpc.protocol.dubbo.DubboProtocol |
| </span></span></code></pre></div><p>需要说明一点的是，在 dubbo 中，并不是直接使用 DubboProtocol 的，而是使用的是其包装类。</p> |
| <h3 id="323-使用">3.2.3 使用</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DubboAdaptiveTest</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Test</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">sayHello</span>() <span style="color:#268bd2">throws</span> Exception { |
| </span></span><span style="display:flex;"><span> URL url <span style="color:#719e07">=</span> URL.valueOf(<span style="color:#2aa198">&#34;dubbo://localhost/test&#34;</span>); |
| </span></span><span style="display:flex;"><span> Protocol adaptiveProtocol <span style="color:#719e07">=</span> ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension(); |
| </span></span><span style="display:flex;"><span> adaptiveProtocol.refer(type, url); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></description></item></channel></rss> |
