| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – 快速入门</title><link>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/</link><description>Recent content in 快速入门 on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>zh-cn</language><atom:link href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/index.xml" rel="self" type="application/rss+xml"/><item><title>Overview: 1 - 零基础快速部署一个微服务应用</title><link>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/brief/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/brief/</guid><description> |
| <h2 id="背景">背景</h2> |
| <p><img src="https://dubbo.apache.org/imgs/architecture.png" alt="arch-service-discovery"></p> |
| <p>Dubbo 作为一款微服务框架,最重要的是向用户提供跨进程的 RPC 远程调用能力。如上图所示,Dubbo 的服务消费者(Consumer)通过一系列的工作将请求发送给服务提供者(Provider)。</p> |
| <p>为了实现这样一个目标,Dubbo 引入了注册中心(Registry)组件,通过注册中心,服务消费者可以感知到服务提供者的连接方式,从而将请求发送给正确的服务提供者。</p> |
| <h2 id="目标">目标</h2> |
| <p>了解微服务调用的方式以及 Dubbo 的能力</p> |
| <h2 id="难度">难度</h2> |
| <p>低</p> |
| <h2 id="环境要求">环境要求</h2> |
| <ul> |
| <li> |
| <p>系统:Windows、Linux、MacOS</p> |
| </li> |
| <li> |
| <p>JDK 8 及以上(推荐使用 JDK17)</p> |
| </li> |
| <li> |
| <p>Git</p> |
| </li> |
| <li> |
| <p>Docker (可选)</p> |
| </li> |
| </ul> |
| <h2 id="动手实践">动手实践</h2> |
| <p>本章将通过几个简单的命令,一步一步教你如何部署并运行一个最简单的 Dubbo 用例。</p> |
| <h3 id="1-获取测试工程">1. 获取测试工程</h3> |
| <p>在开始整个教程之前,我们需要先获取测试工程的代码。Dubbo 的所有测试用例代码都存储在 <a href="https://github.com/apache/dubbo-samples">apache/dubbo-samples</a> 这个仓库中,以下这个命令可以帮你获取 Samples 仓库的所有代码。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span></code></pre></div><h3 id="2-认识-dubbo-samples-项目结构">2. 认识 Dubbo Samples 项目结构</h3> |
| <p>在将 <a href="https://github.com/apache/dubbo-samples">apache/dubbo-samples</a> 这个仓库 clone 到本地以后,本小节将就仓库的具体组织方式做说明。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span><span style="color:#719e07">.</span> |
| </span></span><span style="display:flex;"><span>├── codestyle <span style="color:#719e07">//</span> 开发使用的 style 配置文件 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>├── <span style="color:#2aa198">1</span><span style="color:#719e07">-</span>basic <span style="color:#719e07">//</span> 基础的入门用例 |
| </span></span><span style="display:flex;"><span>├── <span style="color:#2aa198">2</span><span style="color:#719e07">-</span>advanced <span style="color:#719e07">//</span> 高级用法 |
| </span></span><span style="display:flex;"><span>├── <span style="color:#2aa198">3</span><span style="color:#719e07">-</span>extensions <span style="color:#719e07">//</span> 扩展使用示例 |
| </span></span><span style="display:flex;"><span>├── <span style="color:#2aa198">4</span><span style="color:#719e07">-</span>governance <span style="color:#719e07">//</span> 服务治理用例 |
| </span></span><span style="display:flex;"><span>├── <span style="color:#2aa198">10</span><span style="color:#719e07">-</span>task <span style="color:#719e07">//</span> Dubbo 学习系列示例 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>├── <span style="color:#2aa198">99</span><span style="color:#719e07">-</span>integration <span style="color:#719e07">//</span> 集成测试使用 |
| </span></span><span style="display:flex;"><span>├── test <span style="color:#719e07">//</span> 集成测试使用 |
| </span></span><span style="display:flex;"><span>└── tools <span style="color:#719e07">//</span> 三方组件快速启动工具 |
| </span></span></code></pre></div><p>如上表所示,<a href="https://github.com/apache/dubbo-samples">apache/dubbo-samples</a> 主要由三个部分组成:代码风格文件、测试代码、集成测试。</p> |
| <ol> |
| <li> |
| <p>代码风格文件是开发 Dubbo 代码的时候可以使用,其中包括了 IntelliJ IDEA 的配置文件。</p> |
| </li> |
| <li> |
| <p>测试代码即本教材所需要的核心内容。目前包括了 5 个部分的内容:面向初学者的 basic 入门用例、面向开发人员的 advanced 高级用法、面向中间件维护者的 extensions Dubbo 周边扩展使用示例、面向生产的 governance 服务治理用例以及 Dubbo 学习系列。本文将基于 basic 入门用例中最简单的 Dubbo API 使用方式进行讲解。</p> |
| </li> |
| <li> |
| <p>集成测试是 Dubbo 的质量保证体系中重要的一环,Dubbo 的每个版本都会对所有的 samples 进行回归验证,保证 Dubbo 的所有变更都不会影响 samples 的使用。</p> |
| </li> |
| </ol> |
| <h3 id="3-启动一个简易的注册中心">3. 启动一个简易的注册中心</h3> |
| <p>从这一小节开始,将正式通过三个命令部署一个微服务应用。</p> |
| <p>从 <a href="#%E8%83%8C%E6%99%AF">背景</a> 一节中可知,运行起 Dubbo 应用的一个大前提是部署一个注册中心,为了让本教程更易于上手,我们提供了一个基于 Apache Zookeeper 注册中心的简易启动器,如果您需要在生产环境部署注册中心,请参考<a href="https://dubbo.apache.org/">生产环境初始化</a>一文部署高可用的注册中心。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>注:需要开一个独立的 terminal 运行,命令将会保持一直执行的状态。 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Docker: |
| </span></span><span style="display:flex;"><span>docker run --name some-zookeeper -p 2181:2181 --restart always -d zookeeper |
| </span></span></code></pre></div><p>在执行完上述命令以后,等待一会出现如下图所示的日志即代表注册中心启动完毕,可以继续执行后续任务。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-19-15-55-23-image.png" alt="registry"></p> |
| <h3 id="4-启动服务提供者">4. 启动服务提供者</h3> |
| <p>在启动了注册中心之后,下一步是启动一个对外提供服务的服务提供者。在 dubbo-samples 中也提供了对应的示例,可以通过以下命令快速拉起。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl 1-basic/dubbo-samples-api -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.provider.Application&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl 1-basic/dubbo-samples-api -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.provider.Application&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>注:需要开一个独立的 terminal 运行,命令将会保持一直执行的状态。 |
| </span></span></code></pre></div><p>在执行完上述命令以后,等待一会出现如下图所示的日志(<code>DubboBootstrap awaiting</code>)即代表服务提供者启动完毕,标志着该服务提供者可以对外提供服务了。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-19-15-56-09-image.png" alt="provider"></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>[19/01/23 03:55:49:049 CST] org.apache.dubbo.samples.provider.Application.main() INFO bootstrap.DubboBootstrap: [DUBBO] DubboBootstrap awaiting ..., dubbo version: 3.2.0-beta.3, current host: 169.254.44.42 |
| </span></span></code></pre></div><h3 id="5-启动服务消费者">5. 启动服务消费者</h3> |
| <p>最后一步是启动一个服务消费者来调用服务提供者,也即是 RPC 调用的核心,为服务消费者提供调用服务提供者的桥梁。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl 1-basic/dubbo-samples-api -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.client.Application&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl 1-basic/dubbo-samples-api -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.client.Application&#34;</span> |
| </span></span></code></pre></div><p>在执行完上述命令以后,等待一会出现如下图所示的日志(<code>hi, dubbo</code>),打印出的数据就是服务提供者处理之后返回的,标志着一次服务调用的成功。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-19-16-30-14-image.png" alt="consumer"></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>Receive result ======&gt; hi, dubbo |
| </span></span></code></pre></div><h2 id="延伸阅读">延伸阅读</h2> |
| <h3 id="1-消费端是怎么找到服务端的">1. 消费端是怎么找到服务端的?</h3> |
| <p>在本用例中的步骤 3 启动了一个 Zookeeper 的注册中心,服务提供者会向注册中心中写入自己的地址,供服务消费者获取。</p> |
| <p>Dubbo 会在 Zookeeper 的 <code>/dubbo/interfaceName</code> 和 <code>/services/appName</code> 下写入服务提供者的连接信息。</p> |
| <p>如下所示是 Zookeeper 上的数据示例:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span>[zk: localhost:<span style="color:#2aa198">2181</span>(CONNECTED) <span style="color:#2aa198">5</span>] ls <span style="color:#719e07">/</span>dubbo<span style="color:#719e07">/</span>org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>samples<span style="color:#719e07">.</span>api<span style="color:#719e07">.</span>GreetingsService<span style="color:#719e07">/</span>providers |
| </span></span><span style="display:flex;"><span>[dubbo<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A<span style="color:#719e07">%</span><span style="color:#2aa198">2</span>F<span style="color:#719e07">%</span><span style="color:#2aa198">2</span>F30<span style="color:#719e07">.</span><span style="color:#2aa198">221.146</span><span style="color:#719e07">.</span><span style="color:#2aa198">35</span><span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A20880<span style="color:#719e07">%</span><span style="color:#2aa198">2</span>Forg<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>samples<span style="color:#719e07">.</span>api<span style="color:#719e07">.</span>GreetingsService<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Fanyhost<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dtrue<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>application<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dfirst<span style="color:#719e07">-</span>dubbo<span style="color:#719e07">-</span>provider<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>background<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dfalse<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>deprecated<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dfalse<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>dubbo<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>D2<span style="color:#719e07">.</span><span style="color:#2aa198">0.2</span><span style="color:#719e07">%</span><span style="color:#2aa198">26</span>dynamic<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dtrue<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>environment<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dproduct<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>generic<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dfalse<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>interface<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dorg<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>samples<span style="color:#719e07">.</span>api<span style="color:#719e07">.</span>GreetingsService<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>ipv6<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dfd00<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A1<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A5<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A5200<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A3218<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A774a<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A4f67<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>A2341<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>methods<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>DsayHi<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>pid<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>D85639<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>release<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>D3<span style="color:#719e07">.</span><span style="color:#2aa198">1.4</span><span style="color:#719e07">%</span><span style="color:#2aa198">26</span>service<span style="color:#719e07">-</span>name<span style="color:#719e07">-</span>mapping<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dtrue<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>side<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>Dprovider<span style="color:#719e07">%</span><span style="color:#2aa198">26</span>timestamp<span style="color:#719e07">%</span><span style="color:#2aa198">3</span>D1674960780647] |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>[zk: localhost:<span style="color:#2aa198">2181</span>(CONNECTED) <span style="color:#2aa198">2</span>] ls <span style="color:#719e07">/</span>services<span style="color:#719e07">/</span>first<span style="color:#719e07">-</span>dubbo<span style="color:#719e07">-</span>provider |
| </span></span><span style="display:flex;"><span>[<span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">146.35</span>:<span style="color:#2aa198">20880</span>] |
| </span></span><span style="display:flex;"><span>[zk: localhost:<span style="color:#2aa198">2181</span>(CONNECTED) <span style="color:#2aa198">3</span>] get <span style="color:#719e07">/</span>services<span style="color:#719e07">/</span>first<span style="color:#719e07">-</span>dubbo<span style="color:#719e07">-</span>provider<span style="color:#719e07">/</span><span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">146.35</span>:<span style="color:#2aa198">20880</span> |
| </span></span><span style="display:flex;"><span>{<span style="color:#2aa198">&#34;name&#34;</span>:<span style="color:#2aa198">&#34;first-dubbo-provider&#34;</span>,<span style="color:#2aa198">&#34;id&#34;</span>:<span style="color:#2aa198">&#34;30.221.146.35:20880&#34;</span>,<span style="color:#2aa198">&#34;address&#34;</span>:<span style="color:#2aa198">&#34;30.221.146.35&#34;</span>,<span style="color:#2aa198">&#34;port&#34;</span>:<span style="color:#2aa198">20880</span>,<span style="color:#2aa198">&#34;sslPort&#34;</span>:null,<span style="color:#2aa198">&#34;payload&#34;</span>:{<span style="color:#2aa198">&#34;@class&#34;</span>:<span style="color:#2aa198">&#34;org.apache.dubbo.registry.zookeeper.ZookeeperInstance&#34;</span>,<span style="color:#2aa198">&#34;id&#34;</span>:<span style="color:#2aa198">&#34;30.221.146.35:20880&#34;</span>,<span style="color:#2aa198">&#34;name&#34;</span>:<span style="color:#2aa198">&#34;first-dubbo-provider&#34;</span>,<span style="color:#2aa198">&#34;metadata&#34;</span>:{<span style="color:#2aa198">&#34;dubbo.endpoints&#34;</span>:<span style="color:#2aa198">&#34;[{</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">port</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:20880,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">protocol</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">dubbo</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">}]&#34;</span>,<span style="color:#2aa198">&#34;dubbo.metadata-service.url-params&#34;</span>:<span style="color:#2aa198">&#34;{</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">connections</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">1</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">version</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">1.0.0</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">dubbo</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">2.0.2</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">release</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">3.1.4</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">side</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">provider</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">ipv6</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">fd00:1:5:5200:3218:774a:4f67:2341</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">port</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">20880</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">,</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">protocol</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">:</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">dubbo</span><span style="color:#cb4b16">\&#34;</span><span style="color:#2aa198">}&#34;</span>,<span style="color:#2aa198">&#34;dubbo.metadata.revision&#34;</span>:<span style="color:#2aa198">&#34;871fbc9cb2730caea9b0d858852d5ede&#34;</span>,<span style="color:#2aa198">&#34;dubbo.metadata.storage-type&#34;</span>:<span style="color:#2aa198">&#34;local&#34;</span>,<span style="color:#2aa198">&#34;ipv6&#34;</span>:<span style="color:#2aa198">&#34;fd00:1:5:5200:3218:774a:4f67:2341&#34;</span>,<span style="color:#2aa198">&#34;timestamp&#34;</span>:<span style="color:#2aa198">&#34;1674960780647&#34;</span>}},<span style="color:#2aa198">&#34;registrationTimeUTC&#34;</span>:<span style="color:#2aa198">1674960781893</span>,<span style="color:#2aa198">&#34;serviceType&#34;</span>:<span style="color:#2aa198">&#34;DYNAMIC&#34;</span>,<span style="color:#2aa198">&#34;uriSpec&#34;</span>:null} |
| </span></span></code></pre></div><p>更多关于 Dubbo 服务发现模型的细节,可以参考<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/concepts-and-architecture/service-discovery/">服务发现</a>一文。</p> |
| <h3 id="2-消费端是如何发起请求的">2. 消费端是如何发起请求的?</h3> |
| <p>在 Dubbo 的调用模型中,起到连接服务消费者和服务提供者的桥梁是接口。</p> |
| <p>服务提供者通过对指定接口进行实现,服务消费者通过 Dubbo 去订阅这个接口。服务消费者调用接口的过程中 Dubbo 会将请求封装成网络请求,然后发送到服务提供者进行实际的调用。</p> |
| <p>在本用例中,定义了一个 <code>GreetingsService</code> 的接口,这个接口有一个名为 <code>sayHi</code> 的方法。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// 1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/api/GreetingsService.java</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.api; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GreetingsService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHi</span>(String name); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>服务消费者通过 Dubbo 的 API 可以获取这个 <code>GreetingsService</code> 接口的代理,然后就可以按照普通的接口调用方式进行调用。<strong>得益于 Dubbo 的动态代理机制,这一切都像本地调用一样。</strong></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// 1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/client/Application.java</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// 获取订阅到的 Stub</span> |
| </span></span><span style="display:flex;"><span>GreetingsService service <span style="color:#719e07">=</span> reference.get(); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// 像普通的 java 接口一样调用</span> |
| </span></span><span style="display:flex;"><span>String message <span style="color:#719e07">=</span> service.sayHi(<span style="color:#2aa198">&#34;dubbo&#34;</span>); |
| </span></span></code></pre></div><h3 id="3-服务端可以部署多个吗">3. 服务端可以部署多个吗?</h3> |
| <p>可以,本小节将演示如何启动一个服务端<strong>集群</strong>。</p> |
| <p>1)启动一个注册中心,可以参考动手实践中第 3 小节的<a href="#3-%E5%90%AF%E5%8A%A8%E4%B8%80%E4%B8%AA%E7%AE%80%E6%98%93%E7%9A%84%E6%B3%A8%E5%86%8C%E4%B8%AD%E5%BF%83">教程</a></p> |
| <p>2)修改服务提供者返回的数据,让第一个启动的服务提供者返回 <code>hi, dubbo. I am provider 1.</code></p> |
| <p>修改 <code>1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/provider/GreetingsServiceImpl.java</code> 文件的第 25 行如下所示。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// 1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/provider/GreetingsServiceImpl.java</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.api.GreetingsService; |
| </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">GreetingsServiceImpl</span> <span style="color:#268bd2">implements</span> GreetingsService { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHi</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;hi, &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;. I am provider 1.&#34;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>3)启动第一个服务提供者,可以参考动手实践中第 4 小节的<a href="#4-%E5%90%AF%E5%8A%A8%E6%9C%8D%E5%8A%A1%E6%8F%90%E4%BE%9B%E8%80%85">教程</a></p> |
| <p>4)修改服务提供者返回的数据,让第二个启动的服务提供者返回 <code>hi, dubbo. I am provider 2.</code></p> |
| <p>修改 <code>1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/provider/GreetingsServiceImpl.java</code> 文件的第 25 行如下所示。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// 1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/provider/GreetingsServiceImpl.java</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.api.GreetingsService; |
| </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">GreetingsServiceImpl</span> <span style="color:#268bd2">implements</span> GreetingsService { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHi</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;hi, &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;. I am provider 2.&#34;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>4)启动第二个服务提供者,可以参考动手实践中第 4 小节的<a href="#4-%E5%90%AF%E5%8A%A8%E6%9C%8D%E5%8A%A1%E6%8F%90%E4%BE%9B%E8%80%85">教程</a></p> |
| <p>5)启动服务消费者,可以参考动手实践中第 5 小节的<a href="#5-%E5%90%AF%E5%8A%A8%E6%9C%8D%E5%8A%A1%E6%B6%88%E8%B4%B9%E8%80%85">教程</a>。多次启动消费者可以看到返回的结果是不一样的。</p> |
| <p>在 dubbo-samples 中也提供了一个会定时发起调用的消费端应用<code>org.apache.dubbo.samples.client.AlwaysApplication</code>,可以通过以下命令启动。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl 1-basic/dubbo-samples-api -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.client.AlwaysApplication&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl 1-basic/dubbo-samples-api -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.client.AlwaysApplication&#34;</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-fallback" data-lang="fallback"><span style="display:flex;"><span>Sun Jan 29 11:23:37 CST 2023 Receive result ======&gt; hi, dubbo. I am provider 1. |
| </span></span><span style="display:flex;"><span>Sun Jan 29 11:23:38 CST 2023 Receive result ======&gt; hi, dubbo. I am provider 2. |
| </span></span><span style="display:flex;"><span>Sun Jan 29 11:23:39 CST 2023 Receive result ======&gt; hi, dubbo. I am provider 2. |
| </span></span><span style="display:flex;"><span>Sun Jan 29 11:23:40 CST 2023 Receive result ======&gt; hi, dubbo. I am provider 1. |
| </span></span><span style="display:flex;"><span>Sun Jan 29 11:23:41 CST 2023 Receive result ======&gt; hi, dubbo. I am provider 1. |
| </span></span></code></pre></div><h3 id="4-这个用例复杂吗">4. 这个用例复杂吗?</h3> |
| <p>不,Dubbo 只需要简单的配置就可以实现稳定、高效的远程调用。</p> |
| <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:#586e75">// 1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/provider/Application.java</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>ServiceConfig<span style="color:#719e07">&lt;</span>GreetingsService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span>service.setInterface(GreetingsService.class); |
| </span></span><span style="display:flex;"><span>service.setRef(<span style="color:#719e07">new</span> GreetingsServiceImpl()); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// 启动 Dubbo</span> |
| </span></span><span style="display:flex;"><span>DubboBootstrap.getInstance() |
| </span></span><span style="display:flex;"><span> .application(<span style="color:#2aa198">&#34;first-dubbo-provider&#34;</span>) |
| </span></span><span style="display:flex;"><span> .registry(<span style="color:#719e07">new</span> RegistryConfig(ZOOKEEPER_ADDRESS)) |
| </span></span><span style="display:flex;"><span> .protocol(<span style="color:#719e07">new</span> ProtocolConfig(<span style="color:#2aa198">&#34;dubbo&#34;</span>, <span style="color:#719e07">-</span>1)) |
| </span></span><span style="display:flex;"><span> .service(service) |
| </span></span><span style="display:flex;"><span> .start(); |
| </span></span></code></pre></div><p>以下是一个服务消费者的简单示例,通过定义若干个配置启动后就可以获取到对应的代理对象,之后用户完全不需要感知这个对象背后的复杂实现,<strong>一切只需要和本地调用一样就行了</strong>。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// 1-basic/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/client/Application.java</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>ReferenceConfig<span style="color:#719e07">&lt;</span>GreetingsService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span>reference.setInterface(GreetingsService.class); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// 启动 Dubbo</span> |
| </span></span><span style="display:flex;"><span>DubboBootstrap.getInstance() |
| </span></span><span style="display:flex;"><span> .application(<span style="color:#2aa198">&#34;first-dubbo-consumer&#34;</span>) |
| </span></span><span style="display:flex;"><span> .registry(<span style="color:#719e07">new</span> RegistryConfig(ZOOKEEPER_ADDRESS)) |
| </span></span><span style="display:flex;"><span> .reference(reference) |
| </span></span><span style="display:flex;"><span> .start(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// 获取订阅到的 Stub</span> |
| </span></span><span style="display:flex;"><span>GreetingsService service <span style="color:#719e07">=</span> reference.get(); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// 像普通的 java 接口一样调用</span> |
| </span></span><span style="display:flex;"><span>String message <span style="color:#719e07">=</span> service.sayHi(<span style="color:#2aa198">&#34;dubbo&#34;</span>); |
| </span></span></code></pre></div><h2 id="更多">更多</h2> |
| <p>本用例介绍了一个 RPC 远程调用的基础流程,通过启动注册中心、服务提供者、服务消费者三个节点来模拟一个微服务的部署架构。</p> |
| <p>下一个教程中,将就服务提供者和服务消费者分别都做了什么配置进行讲解,<a href="../api/">从零告诉你如何搭建一个微服务应用</a>。</p></description></item><item><title>Overview: 2 - 基于 Dubbo API 开发微服务应用</title><link>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/api/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/api/</guid><description> |
| <h2 id="目标">目标</h2> |
| <p>从零上手开发基于 Dubbo 的微服务</p> |
| <h2 id="难度">难度</h2> |
| <p>低</p> |
| <h2 id="环境要求">环境要求</h2> |
| <ul> |
| <li> |
| <p>系统:Windows、Linux、MacOS</p> |
| </li> |
| <li> |
| <p>JDK 8 及以上(推荐使用 JDK17)</p> |
| </li> |
| <li> |
| <p>Git</p> |
| </li> |
| <li> |
| <p>IntelliJ IDEA(可选)</p> |
| </li> |
| <li> |
| <p>Docker (可选)</p> |
| </li> |
| </ul> |
| <h2 id="动手实践">动手实践</h2> |
| <p>本章将通过手把手的教程一步一步教你如何从零开发一个微服务应用。</p> |
| <h3 id="1-启动注册中心">1. 启动注册中心</h3> |
| <p>对于一个微服务化的应用来说,注册中心是不可或缺的一个组件。只有通过注册中心,消费端才可以成功发现服务端的地址信息,进而进行调用。</p> |
| <p>为了让本教程更易于上手,我们提供了一个基于 Apache Zookeeper 注册中心的简易启动器,如果您需要在生产环境部署注册中心,请参考<a href="https://dubbo.apache.org/">生产环境初始化</a>一文部署高可用的注册中心。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span><span style="display:flex;"><span><span style="color:#b58900">cd</span> dubbo-samples |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span><span style="display:flex;"><span><span style="color:#b58900">cd</span> dubbo-samples |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Docker: |
| </span></span><span style="display:flex;"><span>docker run --name some-zookeeper --restart always -d zookeeper |
| </span></span></code></pre></div><h3 id="2-初始化项目">2. 初始化项目</h3> |
| <p>从本小节开始,将基于 IntelliJ IDEA 进行工程的搭建以及测试。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-10-50-33-image.png" alt="img"></p> |
| <p>如上图所示,可以建立一个基础的项目。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-15-42-11-image.png" alt="img"></p> |
| <p>在初始化完项目之后,需要在 <code>src/main/java</code> 目录下创建 <code>org.apache.dubbo.samples.api</code> 、<code>org.apache.dubbo.samples.client</code> 和 <code>org.apache.dubbo.samples.provider</code> 三个 package。</p> |
| <p>后续我们将在 <code>api</code> 下创建对应的接口,在 <code>client</code> 下创建对应客户端订阅服务的功能,在 <code>provider</code> 下创建对应服务端的实现以及发布服务的功能。</p> |
| <p>上述三个 package 分别对应了应用共同依赖的 api、消费端应用的模块、服务端应用的模块。在实际部署中需要拆成三个工程,消费端和服务的共同依赖 api 模块。从简单出发,本教程将在同一个工程中进行开发,区分多个启动类。</p> |
| <h3 id="3-添加-maven-依赖">3. 添加 Maven 依赖</h3> |
| <p>在初始化完项目以后,我们需要先添加 Dubbo 相关的 maven 依赖。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-10-51-06-image.png" alt="img"></p> |
| <p>编辑 <code>pom.xml</code> 这个文件,添加下列配置。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>3.2.0-beta.4<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.curator<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>curator-x-discovery<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>4.3.0<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.zookeeper<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>zookeeper<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>3.8.0<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;exclusions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;exclusion&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.netty<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>netty-handler<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/exclusion&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;exclusion&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.netty<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>netty-transport-native-epoll<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/exclusion&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/exclusions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependencies&gt;</span> |
| </span></span></code></pre></div><p>在这份配置中,定义了 dubbo 和 zookeeper(以及对应的连接器 curator)的依赖。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-16-06-15-image.png" alt="img"></p> |
| <p>添加了上述的配置以后,可以通过 IDEA 的 <code>Maven - Reload All Maven Projects</code> 刷新依赖。</p> |
| <h3 id="4-定义服务接口">4. 定义服务接口</h3> |
| <p>服务接口 Dubbo 中沟通消费端和服务端的桥梁。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-15-42-43-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.api</code> 下建立 <code>GreetingsService</code> 接口,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.api; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GreetingsService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHi</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>GreetingsService</code> 中,定义了 <code>sayHi</code> 这个方法。后续服务端发布的服务,消费端订阅的服务都是围绕着 <code>GreetingsService</code> 接口展开的。</p> |
| <h3 id="5-定义服务端的实现">5. 定义服务端的实现</h3> |
| <p>定义了服务接口之后,可以在服务端这一侧定义对应的实现,这部分的实现相对于消费端来说是远端的实现,本地没有相关的信息。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-15-43-34-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.provider</code> 下建立 <code>GreetingsServiceImpl</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.api.GreetingsService; |
| </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">GreetingsServiceImpl</span> <span style="color:#268bd2">implements</span> GreetingsService { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHi</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;hi, &#34;</span> <span style="color:#719e07">+</span> name; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>GreetingsServiceImpl</code> 中,实现了 <code>GreetingsService</code> 接口,对于 <code>sayHi</code> 方法返回 <code>hi, name</code>。</p> |
| <h3 id="6-服务端发布服务">6. 服务端发布服务</h3> |
| <p>在实现了服务之后,本小节将通过 Dubbo 的 API 在网络上发布这个服务。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-15-44-22-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.provider</code> 下建立 <code>Application</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ProtocolConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ServiceConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.api.GreetingsService; |
| </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">Application</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 定义具体的服务</span> |
| </span></span><span style="display:flex;"><span> ServiceConfig<span style="color:#719e07">&lt;</span>GreetingsService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> service.setInterface(GreetingsService.class); |
| </span></span><span style="display:flex;"><span> service.setRef(<span style="color:#719e07">new</span> GreetingsServiceImpl()); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// 启动 Dubbo</span> |
| </span></span><span style="display:flex;"><span> DubboBootstrap.getInstance() |
| </span></span><span style="display:flex;"><span> .application(<span style="color:#2aa198">&#34;first-dubbo-provider&#34;</span>) |
| </span></span><span style="display:flex;"><span> .registry(<span style="color:#719e07">new</span> RegistryConfig(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>)) |
| </span></span><span style="display:flex;"><span> .protocol(<span style="color:#719e07">new</span> ProtocolConfig(<span style="color:#2aa198">&#34;dubbo&#34;</span>, <span style="color:#719e07">-</span>1)) |
| </span></span><span style="display:flex;"><span> .service(service) |
| </span></span><span style="display:flex;"><span> .start() |
| </span></span><span style="display:flex;"><span> .await(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>org.apache.dubbo.samples.provider.Application</code> 中做了两部分的功能:首先是基于 <code>ServiceConfig</code> 定义了发布的服务信息,包括接口的信息以及对应的实现类对象;然后是配置 Dubbo 启动器,传入了应用名,注册中心地址,协议的信息以及服务的信息等。</p> |
| <p>注:DubboBootstrap 中的<code>registry</code> 、<code>protocol</code> 和 <code>service</code> 可以多次传入。</p> |
| <h3 id="7-消费端订阅并调用">7. 消费端订阅并调用</h3> |
| <p>对于消费端,可以通过 Dubbo 的 API 可以进行消费端订阅。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-15-55-09-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.client</code> 下建立 <code>Application</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.client; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.io.IOException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ReferenceConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.api.GreetingsService; |
| </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">Application</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) <span style="color:#268bd2">throws</span> IOException { |
| </span></span><span style="display:flex;"><span> ReferenceConfig<span style="color:#719e07">&lt;</span>GreetingsService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> reference.setInterface(GreetingsService.class); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> DubboBootstrap.getInstance() |
| </span></span><span style="display:flex;"><span> .application(<span style="color:#2aa198">&#34;first-dubbo-consumer&#34;</span>) |
| </span></span><span style="display:flex;"><span> .registry(<span style="color:#719e07">new</span> RegistryConfig(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>)) |
| </span></span><span style="display:flex;"><span> .reference(reference); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> GreetingsService service <span style="color:#719e07">=</span> reference.get(); |
| </span></span><span style="display:flex;"><span> String message <span style="color:#719e07">=</span> service.sayHi(<span style="color:#2aa198">&#34;dubbo&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Receive result ======&gt; &#34;</span> <span style="color:#719e07">+</span> message); |
| </span></span><span style="display:flex;"><span> System.in.read(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>org.apache.dubbo.samples.client.Application</code> 中做了三部分的功能:</p> |
| <p>首先是基于 <code>ReferenceConfig</code> 定义了订阅的服务信息,包括接口的信息。</p> |
| <p>其次是配置 Dubbo 启动器,传入了应用名,注册中心地址,协议的信息以及服务的信息等。</p> |
| <p>最后是获取到动态代理的对象并进行调用。</p> |
| <p>注:DubboBootstrap 中支持 <code>service</code> 和 <code>reference</code> 可以同时传入,意味着一个应用可以同时即是消费端、也是服务端。</p> |
| <h3 id="8-启动应用">8. 启动应用</h3> |
| <p>截止第 7 步,代码就已经开发完成了,本小节将启动整个项目并进行验证。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-15-52-26-image.png" alt="img"></p> |
| <p>首先是启动 <code>org.apache.dubbo.samples.provider.Application</code> ,等待一会出现如下图所示的日志(<code>DubboBootstrap awaiting</code>)即代表服务提供者启动完毕,标志着该服务提供者可以对外提供服务了。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>[DUBBO] DubboBootstrap awaiting ..., dubbo version: 3.2.0-beta.4, current host: 169.254.44.42 |
| </span></span></code></pre></div><p>然后是启动<code>org.apache.dubbo.samples.client.Application</code> ,等待一会出现如下图所示的日志(<code>hi, dubbo</code> )即代表服务消费端启动完毕并调用到服务端成功获取结果。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-01-31-15-54-42-image.png" alt="img"></p> |
| <div class="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>Receive result ======&gt; hi, dubbo |
| </span></span></code></pre></div><h2 id="延伸阅读">延伸阅读</h2> |
| <h3 id="1-dubbo-的配置介绍">1. Dubbo 的配置介绍</h3> |
| <p>Dubbo 的主要配置入口有<code>ReferenceConfig</code> 、<code>ServiceConfig</code> 和 <code>DubboBootstrap</code> ,更多的细节可以参考 <a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/api/">API 配置 | Apache Dubbo</a> 一文。</p> |
| <h3 id="2-除了-api-方式其他的使用方式">2. 除了 API 方式其他的使用方式</h3> |
| <p>Dubbo 除了 API 方式还支持 Spring XML、Annotation、Spring Boot 等配置方式,在下一个教程中将就 Spring Boot 配置方式讲解如何进行快速开发。</p> |
| <p>关于 XML 和 Annotation 的细节可以参考 <a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/xml/">XML 配置 | Apache Dubbo</a>、<a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/annotation/">Annotation 配置 | Apache Dubbo</a> 疑问。</p> |
| <h2 id="更多">更多</h2> |
| <p>本教程介绍了如何基于 Dubbo 的纯 API 开发一个微服务应用。下一个教程中,将介绍<a href="../spring-boot/">如何基于 Spring Boot 开发微服务项目</a>。</p></description></item><item><title>Overview: 3 - 基于 Spring Boot Starter 开发微服务应用</title><link>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/spring-boot/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/spring-boot/</guid><description> |
| <h2 id="目标">目标</h2> |
| <p>从零上手开发基于 dubbo-spring-boot-starter 开发微服务,了解 Dubbo x Spring Boot 配置方式。</p> |
| <h2 id="难度">难度</h2> |
| <p>低</p> |
| <h2 id="环境要求">环境要求</h2> |
| <ul> |
| <li> |
| <p>系统:Windows、Linux、MacOS</p> |
| </li> |
| <li> |
| <p>JDK 8 及以上(推荐使用 JDK17)</p> |
| </li> |
| <li> |
| <p>Git</p> |
| </li> |
| <li> |
| <p>IntelliJ IDEA(可选)</p> |
| </li> |
| <li> |
| <p>Docker (可选)</p> |
| </li> |
| </ul> |
| <h2 id="项目介绍">项目介绍</h2> |
| <p>在本任务中,将分为 3 个子模块进行独立开发,模拟生产环境下的部署架构。</p> |
| <div class="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>. // apache/dubbo-samples/1-basic/dubbo-samples-spring-boot |
| </span></span><span style="display:flex;"><span>├── dubbo-samples-spring-boot-interface // 共享 API 模块 |
| </span></span><span style="display:flex;"><span>├── dubbo-samples-spring-boot-consumer // 消费端模块 |
| </span></span><span style="display:flex;"><span>└── dubbo-samples-spring-boot-provider // 服务端模块 |
| </span></span></code></pre></div><p>如上所示,共有 3 个模块,其中 <code>interface</code> 模块被 <code>consumer</code> 和 <code>provider</code> 两个模块共同依赖,存储 RPC 通信使用的 API 接口。</p> |
| <div class="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>. // apache/dubbo-samples/1-basic/dubbo-samples-spring-boot |
| </span></span><span style="display:flex;"><span>├── dubbo-samples-spring-boot-interface // 共享 API 模块 |
| </span></span><span style="display:flex;"><span>│ ├── pom.xml |
| </span></span><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>│ └── org |
| </span></span><span style="display:flex;"><span>│ └── apache |
| </span></span><span style="display:flex;"><span>│ └── dubbo |
| </span></span><span style="display:flex;"><span>│ └── springboot |
| </span></span><span style="display:flex;"><span>│ └── demo |
| </span></span><span style="display:flex;"><span>│ └── DemoService.java // API 接口 |
| </span></span><span style="display:flex;"><span>├── dubbo-samples-spring-boot-consumer // 消费端模块 |
| </span></span><span style="display:flex;"><span>│ ├── pom.xml |
| </span></span><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>│ │ │ └── org |
| </span></span><span style="display:flex;"><span>│ │ │ └── apache |
| </span></span><span style="display:flex;"><span>│ │ │ └── dubbo |
| </span></span><span style="display:flex;"><span>│ │ │ └── springboot |
| </span></span><span style="display:flex;"><span>│ │ │ └── demo |
| </span></span><span style="display:flex;"><span>│ │ │ └── consumer |
| </span></span><span style="display:flex;"><span>│ │ │ ├── ConsumerApplication.java // 消费端启动类 |
| </span></span><span style="display:flex;"><span>│ │ │ └── Task.java // 消费端模拟调用任务 |
| </span></span><span style="display:flex;"><span>│ │ └── resources |
| </span></span><span style="display:flex;"><span>│ │ └── application.yml // Spring Boot 配置文件 |
| </span></span><span style="display:flex;"><span>├── dubbo-samples-spring-boot-provider // 服务端模块 |
| </span></span><span style="display:flex;"><span>│ ├── pom.xml |
| </span></span><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>│ │ └── org |
| </span></span><span style="display:flex;"><span>│ │ └── apache |
| </span></span><span style="display:flex;"><span>│ │ └── dubbo |
| </span></span><span style="display:flex;"><span>│ │ └── springboot |
| </span></span><span style="display:flex;"><span>│ │ └── demo |
| </span></span><span style="display:flex;"><span>│ │ └── provider |
| </span></span><span style="display:flex;"><span>│ │ ├── DemoServiceImpl.java // 服务端实现类 |
| </span></span><span style="display:flex;"><span>│ │ └── ProviderApplication.java // 服务端启动类 |
| </span></span><span style="display:flex;"><span>│ └── resources |
| </span></span><span style="display:flex;"><span>│ └── application.yml // Spring Boot 配置文件 |
| </span></span><span style="display:flex;"><span>└── pom.xml |
| </span></span></code></pre></div><p>如上为本教程接下来会使用到的项目的文件结构。</p> |
| <h2 id="快速部署基于-samples-直接启动">快速部署(基于 Samples 直接启动)</h2> |
| <p>本章将通过几个简单的命令,一步一步教你如何部署并运行一个基于 Dubbo x Spring Boot 的用例。</p> |
| <p>注:本章部署的代码细节可以在 <a href="https://github.com/apache/dubbo-samples">apache/dubbo-samples</a> 这个仓库中 <code>1-basic/dubbo-samples-spring-boot</code> 中找到,在下一章中也将展开进行讲解。</p> |
| <h3 id="1-获取测试工程">1. 获取测试工程</h3> |
| <p>在开始整个教程之前,我们需要先获取测试工程的代码。Dubbo 的所有测试用例代码都存储在 <a href="https://github.com/apache/dubbo-samples">apache/dubbo-samples</a> 这个仓库中,以下这个命令可以帮你获取 Samples 仓库的所有代码。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span></code></pre></div><h3 id="2-启动一个简易的注册中心">2. 启动一个简易的注册中心</h3> |
| <p>对于一个微服务化的应用来说,注册中心是不可或缺的一个组件。只有通过注册中心,消费端才可以成功发现服务端的地址信息,进而进行调用。</p> |
| <p>为了让本教程更易于上手,我们提供了一个基于 Apache Zookeeper 注册中心的简易启动器,如果您需要在生产环境部署注册中心,请参考<a href="https://dubbo.apache.org/">生产环境初始化</a>一文部署高可用的注册中心。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Docker: |
| </span></span><span style="display:flex;"><span>docker run --name some-zookeeper -p 2181:2181 --restart always -d zookeeper |
| </span></span></code></pre></div><h3 id="3-本地打包-api-模块">3. 本地打包 API 模块</h3> |
| <p>为了成功编译服务端、消费端模块,需要先在本地打包安装 <code>dubbo-samples-spring-boot-interface</code> 模块。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>./mvnw clean install -pl 1-basic/dubbo-samples-spring-boot |
| </span></span><span style="display:flex;"><span>./mvnw clean install -pl 1-basic/dubbo-samples-spring-boot/dubbo-samples-spring-boot-interface |
| </span></span></code></pre></div><h3 id="4-启动服务提供者">4. 启动服务提供者</h3> |
| <p>在启动了注册中心之后,下一步是启动一个对外提供服务的服务提供者。在 dubbo-samples 中也提供了对应的示例,可以通过以下命令快速拉起。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl 1-basic/dubbo-samples-spring-boot/dubbo-samples-spring-boot-provider -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.springboot.demo.provider.ProviderApplication&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl 1-basic/dubbo-samples-spring-boot/dubbo-samples-spring-boot-provider -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.springboot.demo.provider.ProviderApplication&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>注:需要开一个独立的 terminal 运行,命令将会保持一直执行的状态。 |
| </span></span></code></pre></div><p>在执行完上述命令以后,等待一会出现如下所示的日志(<code>Current Spring Boot Application is await</code>)即代表服务提供者启动完毕,标志着该服务提供者可以对外提供服务了。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>2023-02-08 17:13:00.357 INFO 80600 --- [lication.main()] o.a.d.c.d.DefaultApplicationDeployer : [DUBBO] Dubbo Application[1.1](dubbo-springboot-demo-provider) is ready., dubbo version: 3.2.0-beta.4, current host: 30.221.128.96 |
| </span></span><span style="display:flex;"><span>2023-02-08 17:13:00.369 INFO 80600 --- [lication.main()] o.a.d.s.d.provider.ProviderApplication : Started ProviderApplication in 9.114 seconds (JVM running for 26.522) |
| </span></span><span style="display:flex;"><span>2023-02-08 17:13:00.387 INFO 80600 --- [pool-1-thread-1] .b.c.e.AwaitingNonWebApplicationListener : [Dubbo] Current Spring Boot Application is await... |
| </span></span></code></pre></div><h3 id="5-启动服务消费者">5. 启动服务消费者</h3> |
| <p>最后一步是启动一个服务消费者来调用服务提供者,也即是 RPC 调用的核心,为服务消费者提供调用服务提供者的桥梁。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl 1-basic/dubbo-samples-spring-boot/dubbo-samples-spring-boot-consumer -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.springboot.demo.consumer.ConsumerApplication&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl 1-basic/dubbo-samples-spring-boot/dubbo-samples-spring-boot-consumer -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.springboot.demo.consumer.ConsumerApplication&#34;</span> |
| </span></span></code></pre></div><p>在执行完上述命令以后,等待一会出现如下所示的日志(<code>Hello world</code>),打印出的数据就是服务提供者处理之后返回的,标志着一次服务调用的成功。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>2023-02-08 17:14:33.045 INFO 80740 --- [lication.main()] o.a.d.s.d.consumer.ConsumerApplication : Started ConsumerApplication in 11.052 seconds (JVM running for 31.62) |
| </span></span><span style="display:flex;"><span>Receive result ======&gt; Hello world |
| </span></span><span style="display:flex;"><span>2023-02-08 17:14:33.146 INFO 80740 --- [pool-1-thread-1] .b.c.e.AwaitingNonWebApplicationListener : [Dubbo] Current Spring Boot Application is await... |
| </span></span><span style="display:flex;"><span>Wed Feb 08 17:14:34 CST 2023 Receive result ======&gt; Hello world |
| </span></span><span style="display:flex;"><span>Wed Feb 08 17:14:35 CST 2023 Receive result ======&gt; Hello world |
| </span></span><span style="display:flex;"><span>Wed Feb 08 17:14:36 CST 2023 Receive result ======&gt; Hello world |
| </span></span><span style="display:flex;"><span>Wed Feb 08 17:14:37 CST 2023 Receive result ======&gt; Hello world |
| </span></span></code></pre></div><h2 id="动手实践从零代码开发版">动手实践(从零代码开发版)</h2> |
| <p>本章将通过手把手的教程一步一步教你如何从零开发一个微服务应用。</p> |
| <h3 id="1-启动注册中心">1. 启动注册中心</h3> |
| <p>对于一个微服务化的应用来说,注册中心是不可或缺的一个组件。只有通过注册中心,消费端才可以成功发现服务端的地址信息,进而进行调用。</p> |
| <p>为了让本教程更易于上手,我们提供了一个基于 Apache Zookeeper 注册中心的简易启动器,如果您需要在生产环境部署注册中心,请参考<a href="https://dubbo.apache.org/">生产环境初始化</a>一文部署高可用的注册中心。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span><span style="display:flex;"><span><span style="color:#b58900">cd</span> dubbo-samples |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span><span style="display:flex;"><span><span style="color:#b58900">cd</span> dubbo-samples |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Docker: |
| </span></span><span style="display:flex;"><span>docker run --name some-zookeeper -p 2181:2181 --restart always -d zookeeper |
| </span></span></code></pre></div><h3 id="2-初始化项目">2. 初始化项目</h3> |
| <p>从本小节开始,将基于 IntelliJ IDEA 进行工程的搭建以及测试。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-25-27-image.png" alt="img"></p> |
| <p>如上图所示,可以建立一个基础的项目。</p> |
| <p>搭建了基础项目之后,我们还需要创建 <code>dubbo-spring-boot-demo-interface</code> 、<code>dubbo-spring-boot-demo-provider</code> 和 <code>dubbo-spring-boot-demo-consumer</code> 三个子模块。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-27-17-image.png" alt="img"></p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-26-57-image.png" alt="img"></p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-27-45-image.png" alt="img"></p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-28-26-image.png" alt="img"></p> |
| <p>创建了三个子模块之后,需要创建一下几个文件夹:</p> |
| <ol> |
| <li> |
| <p>在 <code>dubbo-spring-boot-demo-consumer/src/main/java</code> 下创建 <code>org.apache.dubbo.springboot.demo.consumer</code> package</p> |
| </li> |
| <li> |
| <p>在 <code>dubbo-spring-boot-demo-interface/src/main/java</code> 下创建 <code>org.apache.dubbo.springboot.demo</code> package</p> |
| </li> |
| <li> |
| <p>在 <code>dubbo-spring-boot-demo-provider/src/main/java</code> 下创建 <code>org.apache.dubbo.springboot.demo.provider</code> package</p> |
| </li> |
| </ol> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-32-50-image.png" alt="img"></p> |
| <p>最终的文件夹参考如上图所示。</p> |
| <h3 id="3-添加-maven-依赖">3. 添加 Maven 依赖</h3> |
| <p>在初始化完项目以后,我们需要先添加 Dubbo 相关的 maven 依赖。</p> |
| <p>对于多模块项目,首先需要在父项目的 <code>pom.xml</code> 里面配置依赖信息。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-53-18-image.png" alt="img"></p> |
| <p>编辑 <code>./pom.xml</code> 这个文件,添加下列配置。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;properties&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo.version&gt;</span>3.2.0-beta.4<span style="color:#268bd2">&lt;/dubbo.version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;spring-boot.version&gt;</span>2.7.8<span style="color:#268bd2">&lt;/spring-boot.version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;maven.compiler.source&gt;</span>17<span style="color:#268bd2">&lt;/maven.compiler.source&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;maven.compiler.target&gt;</span>17<span style="color:#268bd2">&lt;/maven.compiler.target&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;project.build.sourceEncoding&gt;</span>UTF-8<span style="color:#268bd2">&lt;/project.build.sourceEncoding&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/properties&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependencyManagement&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Spring Boot --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.springframework.boot<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>spring-boot-dependencies<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${spring-boot.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;scope&gt;</span>import<span style="color:#268bd2">&lt;/scope&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Dubbo --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-bom<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;scope&gt;</span>import<span style="color:#268bd2">&lt;/scope&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-dependencies-zookeeper-curator5<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependencyManagement&gt;</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">&lt;build&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;pluginManagement&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;plugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.springframework.boot<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>spring-boot-maven-plugin<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${spring-boot.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/plugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/pluginManagement&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/build&gt;</span> |
| </span></span></code></pre></div><p>然后在 <code>dubbo-spring-boot-consumer</code> 和 <code>dubbo-spring-boot-provider</code> 两个模块 <code>pom.xml</code> 中进行具体依赖的配置。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-52-53-image.png" alt="img"></p> |
| <p>编辑 <code>./dubbo-spring-boot-consumer/pom.xml</code> 和 <code>./dubbo-spring-boot-provider/pom.xml</code> 这两文件,都添加下列配置。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-samples-spring-boot-interface<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${project.parent.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- dubbo --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-spring-boot-starter<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-dependencies-zookeeper-curator5<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;exclusions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;exclusion&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>slf4j-reload4j<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.slf4j<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/exclusion&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/exclusions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- spring boot starter --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.springframework.boot<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>spring-boot-starter<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependencies&gt;</span> |
| </span></span></code></pre></div><p>在这份配置中,定义了 dubbo 和 zookeeper(以及对应的连接器 curator)的依赖。</p> |
| <p>添加了上述的配置以后,可以通过 IDEA 的 <code>Maven - Reload All Maven Projects</code> 刷新依赖。</p> |
| <h3 id="4-定义服务接口">4. 定义服务接口</h3> |
| <p>服务接口 Dubbo 中沟通消费端和服务端的桥梁。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-57-29-image.png" alt="img"></p> |
| <p>在 <code>dubbo-spring-boot-demo-interface</code> 模块的 <code>org.apache.dubbo.samples.api</code> 下建立 <code>DemoService</code> 接口,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.springboot.demo; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">DemoService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHello</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>DemoService</code> 中,定义了 <code>sayHello</code> 这个方法。后续服务端发布的服务,消费端订阅的服务都是围绕着 <code>DemoService</code> 接口展开的。</p> |
| <h3 id="5-定义服务端的实现">5. 定义服务端的实现</h3> |
| <p>定义了服务接口之后,可以在服务端这一侧定义对应的实现,这部分的实现相对于消费端来说是远端的实现,本地没有相关的信息。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-17-59-46-image.png" alt="img"></p> |
| <p>在<code>dubbo-spring-boot-demo-provider</code> 模块的 <code>org.apache.dubbo.samples.provider</code> 下建立 <code>DemoServiceImpl</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.springboot.demo.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.annotation.DubboService; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.springboot.demo.DemoService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@DubboService</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceImpl</span> <span style="color:#268bd2">implements</span> DemoService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>DemoServiceImpl</code> 中,实现了 <code>DemoService</code> 接口,对于 <code>sayHello</code> 方法返回 <code>Hello name</code>。</p> |
| <p>注:在<code>DemoServiceImpl</code> 类中添加了 <code>@DubboService</code> 注解,通过这个配置可以基于 Spring Boot 去发布 Dubbo 服务。</p> |
| <h3 id="6-配置服务端-yaml-配置文件">6. 配置服务端 Yaml 配置文件</h3> |
| <p>从本步骤开始至第 7 步,将会通过 Spring Boot 的方式配置 Dubbo 的一些基础信息。</p> |
| <p>首先,我们先创建服务端的配置文件。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-18-00-24-image.png" alt="img"></p> |
| <p>在 <code>dubbo-spring-boot-demo-provider</code> 模块的 <code>resources</code> 资源文件夹下建立 <code>application.yml</code> 文件,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">dubbo</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: dubbo-springboot-demo-provider |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protocol</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: dubbo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">port</span>: -<span style="color:#2aa198">1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registry</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">address</span>: zookeeper://${zookeeper.address:127.0.0.1}:2181 |
| </span></span></code></pre></div><p>在这个配置文件中,定义了 Dubbo 的应用名、Dubbo 协议信息、Dubbo 使用的注册中心地址。</p> |
| <h3 id="7-配置消费端-yaml-配置文件">7. 配置消费端 Yaml 配置文件</h3> |
| <p>同样的,我们需要创建消费端的配置文件。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-18-01-03-image.png" alt="img"></p> |
| <p>在 <code>dubbo-spring-boot-demo-consumer</code> 模块的 <code>resources</code> 资源文件夹下建立 <code>application.yml</code> 文件,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#268bd2">dubbo</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">application</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: dubbo-springboot-demo-consumer |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protocol</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">name</span>: dubbo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">port</span>: -<span style="color:#2aa198">1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registry</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">address</span>: zookeeper://${zookeeper.address:127.0.0.1}:2181 |
| </span></span></code></pre></div><p>在这个配置文件中,定义了 Dubbo 的应用名、Dubbo 协议信息、Dubbo 使用的注册中心地址。</p> |
| <h3 id="8-基于-spring-配置服务端启动类">8. 基于 Spring 配置服务端启动类</h3> |
| <p>除了配置 Yaml 配置文件之外,我们还需要创建基于 Spring Boot 的启动类。</p> |
| <p>首先,我们先创建服务端的启动类。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-18-01-38-image.png" alt="img"></p> |
| <p>在 <code>dubbo-spring-boot-demo-provider</code> 模块的 <code>org.apache.dubbo.springboot.demo.provider</code> 下建立 <code>Application</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.springboot.demo.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.spring.context.annotation.EnableDubbo; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.boot.SpringApplication; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.boot.autoconfigure.SpringBootApplication; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@SpringBootApplication</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderApplication</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) { |
| </span></span><span style="display:flex;"><span> SpringApplication.run(ProviderApplication.class, args); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在这个启动类中,配置了一个 <code>ProviderApplication</code> 去读取我们前面第 6 步中定义的 <code>application.yml</code> 配置文件并启动应用。</p> |
| <h3 id="9-基于-spring-配置消费端启动类">9. 基于 Spring 配置消费端启动类</h3> |
| <p>同样的,我们需要创建消费端的启动类。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-18-02-11-image.png" alt="img"></p> |
| <p>在 <code>dubbo-spring-boot-demo-consumer</code> 模块的 <code>org.apache.dubbo.springboot.demo.consumer</code> 下建立 <code>Application</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.springboot.demo.consumer; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.spring.context.annotation.EnableDubbo; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.boot.SpringApplication; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.boot.autoconfigure.SpringBootApplication; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@SpringBootApplication</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ConsumerApplication</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) { |
| </span></span><span style="display:flex;"><span> SpringApplication.run(ConsumerApplication.class, args); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在这个启动类中,配置了一个 <code>ConsumerApplication</code> 去读取我们前面第 7 步中定义的 <code>application.yml</code> 配置文件并启动应用。</p> |
| <h3 id="10-配置消费端请求任务">10. 配置消费端请求任务</h3> |
| <p>除了配置消费端的启动类,我们在 Spring Boot 模式下还可以基于 <code>CommandLineRunner</code>去创建</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-18-02-33-image.png" alt="img"></p> |
| <p>在 <code>dubbo-spring-boot-demo-consumer</code> 模块的 <code>org.apache.dubbo.springboot.demo.consumer</code> 下建立 <code>Task</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.springboot.demo.consumer; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.Date; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.annotation.DubboReference; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.springboot.demo.DemoService; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.boot.CommandLineRunner; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.stereotype.Component; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Component</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">Task</span> <span style="color:#268bd2">implements</span> CommandLineRunner { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@DubboReference</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> DemoService demoService; |
| </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:#dc322f">void</span> <span style="color:#268bd2">run</span>(String... args) <span style="color:#268bd2">throws</span> Exception { |
| </span></span><span style="display:flex;"><span> String result <span style="color:#719e07">=</span> demoService.sayHello(<span style="color:#2aa198">&#34;world&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Receive result ======&gt; &#34;</span> <span style="color:#719e07">+</span> result); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> Thread(()<span style="color:#719e07">-&gt;</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">while</span> (<span style="color:#cb4b16">true</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep(1000); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#719e07">new</span> Date() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; Receive result ======&gt; &#34;</span> <span style="color:#719e07">+</span> demoService.sayHello(<span style="color:#2aa198">&#34;world&#34;</span>)); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (InterruptedException e) { |
| </span></span><span style="display:flex;"><span> e.printStackTrace(); |
| </span></span><span style="display:flex;"><span> Thread.currentThread().interrupt(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }).start(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>Task</code> 类中,通过<code>@DubboReference</code> 从 Dubbo 获取了一个 RPC 订阅,这个 <code>demoService</code> 可以像本地调用一样直接调用。在 <code>run</code>方法中创建了一个线程进行调用。</p> |
| <h3 id="11-启动应用">11. 启动应用</h3> |
| <p>截止第 10 步,代码就已经开发完成了,本小节将启动整个项目并进行验证。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-18-03-59-image.png" alt="img"></p> |
| <p>首先是启动 <code>org.apache.dubbo.samples.provider.Application</code> ,等待一会出现如下图所示的日志(<code>Current Spring Boot Application is await</code>)即代表服务提供者启动完毕,标志着该服务提供者可以对外提供服务了。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>[Dubbo] Current Spring Boot Application is await... |
| </span></span></code></pre></div><p>然后是启动<code>org.apache.dubbo.samples.client.Application</code> ,等待一会出现如下图所示的日志(<code>Hello world</code> )即代表服务消费端启动完毕并调用到服务端成功获取结果。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-18-05-02-image.png" alt="img"></p> |
| <div class="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>Receive result ======&gt; Hello world |
| </span></span></code></pre></div><h2 id="延伸阅读">延伸阅读</h2> |
| <h3 id="1-dubbo-的-spring-配置介绍">1. Dubbo 的 Spring 配置介绍</h3> |
| <p>Dubbo 的主要配置入口有 yaml 的配置内容、<code>@DubboReference</code> 和<code>@DubboService</code> 等,更多的细节可以参考 <a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/annotation/">Annotation 配置 | Apache Dubbo</a> 一文。</p> |
| <h2 id="更多">更多</h2> |
| <p>本教程介绍了如何基于 Dubbo x Spring Boot 开发一个微服务应用。在下一节中,将介绍<a href="../spring-xml/">另外一种 Dubbo 的配置方式 —— Dubbo x Spring XML</a>。</p></description></item><item><title>Overview: 4 - 基于 Spring XML 开发微服务应用</title><link>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/spring-xml/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/spring-xml/</guid><description> |
| <h2 id="目标">目标</h2> |
| <p>从零上手开发基于 Dubbo x Spring XML 的微服务开发,了解 Dubbo x Spring XML 配置方式。</p> |
| <h2 id="难度">难度</h2> |
| <p>低</p> |
| <h2 id="环境要求">环境要求</h2> |
| <ul> |
| <li> |
| <p>系统:Windows、Linux、MacOS</p> |
| </li> |
| <li> |
| <p>JDK 8 及以上(推荐使用 JDK17)</p> |
| </li> |
| <li> |
| <p>Git</p> |
| </li> |
| <li> |
| <p>IntelliJ IDEA(可选)</p> |
| </li> |
| <li> |
| <p>Docker (可选)</p> |
| </li> |
| </ul> |
| <h2 id="快速部署基于-samples-直接启动">快速部署(基于 Samples 直接启动)</h2> |
| <p>本章将通过几个简单的命令,一步一步教你如何部署并运行一个基于 Dubbo x Spring XML 的用例。</p> |
| <p>注:本章部署的代码细节可以在 <a href="https://github.com/apache/dubbo-samples">apache/dubbo-samples</a> 这个仓库中 <code>1-basic/dubbo-samples-spring-xml</code> 中找到,在下一章中也将展开进行讲解。</p> |
| <h3 id="1-获取测试工程">1. 获取测试工程</h3> |
| <p>在开始整个教程之前,我们需要先获取测试工程的代码。Dubbo 的所有测试用例代码都存储在 <a href="https://github.com/apache/dubbo-samples">apache/dubbo-samples</a> 这个仓库中,以下这个命令可以帮你获取 Samples 仓库的所有代码。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span></code></pre></div><h3 id="2-启动一个简易的注册中心">2. 启动一个简易的注册中心</h3> |
| <p>对于一个微服务化的应用来说,注册中心是不可或缺的一个组件。只有通过注册中心,消费端才可以成功发现服务端的地址信息,进而进行调用。</p> |
| <p>为了让本教程更易于上手,我们提供了一个基于 Apache Zookeeper 注册中心的简易启动器,如果您需要在生产环境部署注册中心,请参考<a href="https://dubbo.apache.org/">生产环境初始化</a>一文部署高可用的注册中心。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Docker: |
| </span></span><span style="display:flex;"><span>docker run --name some-zookeeper -p 2181:2181 --restart always -d zookeeper |
| </span></span></code></pre></div><h3 id="3-启动服务提供者">3. 启动服务提供者</h3> |
| <p>在启动了注册中心之后,下一步是启动一个对外提供服务的服务提供者。在 dubbo-samples 中也提供了对应的示例,可以通过以下命令快速拉起。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl 1-basic/dubbo-samples-spring-xml -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.provider.Application&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl 1-basic/dubbo-samples-spring-xml -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.provider.Application&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>注:需要开一个独立的 terminal 运行,命令将会保持一直执行的状态。 |
| </span></span></code></pre></div><p>在执行完上述命令以后,等待一会出现如下所示的日志(<code>Dubbo Application[1.1](demo-provider) is ready.</code>)即代表服务提供者启动完毕,标志着该服务提供者可以对外提供服务了。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span>[<span style="color:#2aa198">08</span><span style="color:#719e07">/</span><span style="color:#2aa198">02</span><span style="color:#719e07">/</span><span style="color:#2aa198">23</span> <span style="color:#2aa198">03</span>:<span style="color:#2aa198">26</span>:<span style="color:#2aa198">52</span>:<span style="color:#2aa198">052</span> CST] org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>samples<span style="color:#719e07">.</span>provider<span style="color:#719e07">.</span>Application<span style="color:#719e07">.</span>main() INFO metadata<span style="color:#719e07">.</span>ConfigurableMetadataServiceExporter: [DUBBO] The MetadataService exports urls : [dubbo:<span style="color:#719e07">//</span><span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">128.96</span>:<span style="color:#2aa198">20880</span><span style="color:#719e07">/</span>org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>metadata<span style="color:#719e07">.</span>MetadataService?anyhost<span style="color:#719e07">=</span><span style="color:#268bd2">true</span><span style="color:#719e07">&amp;</span>application<span style="color:#719e07">=</span>demo<span style="color:#719e07">-</span>provider<span style="color:#719e07">&amp;</span>background<span style="color:#719e07">=</span><span style="color:#268bd2">false</span><span style="color:#719e07">&amp;</span>bind<span style="color:#719e07">.</span>ip<span style="color:#719e07">=</span><span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">128.96</span><span style="color:#719e07">&amp;</span>bind<span style="color:#719e07">.</span>port<span style="color:#719e07">=</span><span style="color:#2aa198">20880</span><span style="color:#719e07">&amp;</span>connections<span style="color:#719e07">=</span><span style="color:#2aa198">1</span><span style="color:#719e07">&amp;</span>corethreads<span style="color:#719e07">=</span><span style="color:#2aa198">2</span><span style="color:#719e07">&amp;</span>delay<span style="color:#719e07">=</span><span style="color:#2aa198">0</span><span style="color:#719e07">&amp;</span>deprecated<span style="color:#719e07">=</span><span style="color:#268bd2">false</span><span style="color:#719e07">&amp;</span>dubbo<span style="color:#719e07">=</span><span style="color:#2aa198">2.0</span><span style="color:#719e07">.</span><span style="color:#2aa198">2</span><span style="color:#719e07">&amp;</span>dynamic<span style="color:#719e07">=</span><span style="color:#268bd2">true</span><span style="color:#719e07">&amp;</span>executes<span style="color:#719e07">=</span><span style="color:#2aa198">100</span><span style="color:#719e07">&amp;</span>generic<span style="color:#719e07">=</span><span style="color:#268bd2">false</span><span style="color:#719e07">&amp;</span>getAndListenInstanceMetadata<span style="color:#719e07">.</span><span style="color:#2aa198">1.</span>callback<span style="color:#719e07">=</span><span style="color:#268bd2">true</span><span style="color:#719e07">&amp;</span>getAndListenInstanceMetadata<span style="color:#719e07">.</span><span style="color:#719e07">return</span><span style="color:#719e07">=</span><span style="color:#268bd2">true</span><span style="color:#719e07">&amp;</span>getAndListenInstanceMetadata<span style="color:#719e07">.</span>sent<span style="color:#719e07">=</span><span style="color:#268bd2">true</span><span style="color:#719e07">&amp;</span>group<span style="color:#719e07">=</span>demo<span style="color:#719e07">-</span>provider<span style="color:#719e07">&amp;</span>interface<span style="color:#719e07">=</span>org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>metadata<span style="color:#719e07">.</span>MetadataService<span style="color:#719e07">&amp;</span>ipv6<span style="color:#719e07">=</span>fd00:<span style="color:#2aa198">1</span>:<span style="color:#2aa198">5</span>:<span style="color:#2aa198">5200</span>:<span style="color:#2aa198">4</span>d53:<span style="color:#2aa198">9</span>f5:a545:<span style="color:#2aa198">804</span>d<span style="color:#719e07">&amp;</span>methods<span style="color:#719e07">=</span>exportInstanceMetadata,getAndListenInstanceMetadata,getExportedServiceURLs,getExportedURLs,getExportedURLs,getExportedURLs,getExportedURLs,getExportedURLs,getInstanceMetadataChangedListenerMap,getMetadataInfo,getMetadataInfos,getMetadataURL,getServiceDefinition,getServiceDefinition,getSubscribedURLs,isMetadataService,serviceName,toSortedStrings,toSortedStrings,version<span style="color:#719e07">&amp;</span>pid<span style="color:#719e07">=</span><span style="color:#2aa198">70803</span><span style="color:#719e07">&amp;</span>register<span style="color:#719e07">=</span><span style="color:#268bd2">false</span><span style="color:#719e07">&amp;</span>release<span style="color:#719e07">=</span><span style="color:#2aa198">3.1</span><span style="color:#719e07">.</span><span style="color:#2aa198">6</span><span style="color:#719e07">&amp;</span>revision<span style="color:#719e07">=</span><span style="color:#2aa198">3.1</span><span style="color:#719e07">.</span><span style="color:#2aa198">6</span><span style="color:#719e07">&amp;</span>side<span style="color:#719e07">=</span>provider<span style="color:#719e07">&amp;</span>threadpool<span style="color:#719e07">=</span>cached<span style="color:#719e07">&amp;</span>threads<span style="color:#719e07">=</span><span style="color:#2aa198">100</span><span style="color:#719e07">&amp;</span>timestamp<span style="color:#719e07">=</span><span style="color:#2aa198">1675841212727</span><span style="color:#719e07">&amp;</span>version<span style="color:#719e07">=</span><span style="color:#2aa198">1.0</span><span style="color:#719e07">.</span><span style="color:#2aa198">0</span>], dubbo version: <span style="color:#2aa198">3.1</span><span style="color:#719e07">.</span><span style="color:#2aa198">6</span>, current host: <span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">128.96</span> |
| </span></span><span style="display:flex;"><span>[<span style="color:#2aa198">08</span><span style="color:#719e07">/</span><span style="color:#2aa198">02</span><span style="color:#719e07">/</span><span style="color:#2aa198">23</span> <span style="color:#2aa198">03</span>:<span style="color:#2aa198">26</span>:<span style="color:#2aa198">52</span>:<span style="color:#2aa198">052</span> CST] org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>samples<span style="color:#719e07">.</span>provider<span style="color:#719e07">.</span>Application<span style="color:#719e07">.</span>main() INFO metadata<span style="color:#719e07">.</span>ServiceInstanceMetadataUtils: [DUBBO] Start registering instance address to registry<span style="color:#719e07">.</span>, dubbo version: <span style="color:#2aa198">3.1</span><span style="color:#719e07">.</span><span style="color:#2aa198">6</span>, current host: <span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">128.96</span> |
| </span></span><span style="display:flex;"><span>[<span style="color:#2aa198">08</span><span style="color:#719e07">/</span><span style="color:#2aa198">02</span><span style="color:#719e07">/</span><span style="color:#2aa198">23</span> <span style="color:#2aa198">03</span>:<span style="color:#2aa198">26</span>:<span style="color:#2aa198">52</span>:<span style="color:#2aa198">052</span> CST] org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>samples<span style="color:#719e07">.</span>provider<span style="color:#719e07">.</span>Application<span style="color:#719e07">.</span>main() INFO metadata<span style="color:#719e07">.</span>MetadataInfo: [DUBBO] metadata revision changed: null <span style="color:#719e07">-&gt;</span> <span style="color:#2aa198">602</span>d44cc6d653b9cd42ab23c3948b5ab, app: demo<span style="color:#719e07">-</span>provider, services: <span style="color:#2aa198">1</span>, dubbo version: <span style="color:#2aa198">3.1</span><span style="color:#719e07">.</span><span style="color:#2aa198">6</span>, current host: <span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">128.96</span> |
| </span></span><span style="display:flex;"><span>[<span style="color:#2aa198">08</span><span style="color:#719e07">/</span><span style="color:#2aa198">02</span><span style="color:#719e07">/</span><span style="color:#2aa198">23</span> <span style="color:#2aa198">03</span>:<span style="color:#2aa198">26</span>:<span style="color:#2aa198">52</span>:<span style="color:#2aa198">052</span> CST] org<span style="color:#719e07">.</span>apache<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>samples<span style="color:#719e07">.</span>provider<span style="color:#719e07">.</span>Application<span style="color:#719e07">.</span>main() INFO deploy<span style="color:#719e07">.</span>DefaultApplicationDeployer: [DUBBO] Dubbo Application[<span style="color:#2aa198">1.1</span>](demo<span style="color:#719e07">-</span>provider) is ready<span style="color:#719e07">.</span>, dubbo version: <span style="color:#2aa198">3.1</span><span style="color:#719e07">.</span><span style="color:#2aa198">6</span>, current host: <span style="color:#2aa198">30.221</span><span style="color:#719e07">.</span><span style="color:#2aa198">128.96</span> |
| </span></span></code></pre></div><h3 id="4-启动服务消费者">4. 启动服务消费者</h3> |
| <p>最后一步是启动一个服务消费者来调用服务提供者,也即是 RPC 调用的核心,为服务消费者提供调用服务提供者的桥梁。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl 1-basic/dubbo-samples-spring-xml -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.client.Application&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl 1-basic/dubbo-samples-spring-xml -Dexec.mainClass<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;org.apache.dubbo.samples.client.Application&#34;</span> |
| </span></span></code></pre></div><p>在执行完上述命令以后,等待一会出现如下所示的日志(<code>hi, dubbo</code>),打印出的数据就是服务提供者处理之后返回的,标志着一次服务调用的成功。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>[08/02/23 03:28:23:023 CST] org.apache.dubbo.samples.client.Application.main() INFO deploy.DefaultApplicationDeployer: [DUBBO] Dubbo Application[1.1](demo-consumer) is ready., dubbo version: 3.1.6, current host: 30.221.128.96 |
| </span></span><span style="display:flex;"><span>Receive result ======&gt; hi, dubbo |
| </span></span></code></pre></div><h2 id="动手实践从零代码开发版">动手实践(从零代码开发版)</h2> |
| <p>本章将通过手把手的教程一步一步教你如何从零开发一个微服务应用。</p> |
| <h3 id="1-启动注册中心">1. 启动注册中心</h3> |
| <p>对于一个微服务化的应用来说,注册中心是不可或缺的一个组件。只有通过注册中心,消费端才可以成功发现服务端的地址信息,进而进行调用。</p> |
| <p>为了让本教程更易于上手,我们提供了一个基于 Apache Zookeeper 注册中心的简易启动器,如果您需要在生产环境部署注册中心,请参考<a href="https://dubbo.apache.org/">生产环境初始化</a>一文部署高可用的注册中心。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>Windows: |
| </span></span><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span><span style="display:flex;"><span><span style="color:#b58900">cd</span> dubbo-samples |
| </span></span><span style="display:flex;"><span>./mvnw.cmd clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Linux / MacOS: |
| </span></span><span style="display:flex;"><span>git clone --depth<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> --branch master git@github.com:apache/dubbo-samples.git |
| </span></span><span style="display:flex;"><span><span style="color:#b58900">cd</span> dubbo-samples |
| </span></span><span style="display:flex;"><span>./mvnw clean compile exec:java -pl tools/embedded-zookeeper |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Docker: |
| </span></span><span style="display:flex;"><span>docker run --name some-zookeeper -p 2181:2181 --restart always -d zookeeper |
| </span></span></code></pre></div><h3 id="2-初始化项目">2. 初始化项目</h3> |
| <p>从本小节开始,将基于 IntelliJ IDEA 进行工程的搭建以及测试。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-32-16-image.png" alt="img"></p> |
| <p>如上图所示,可以建立一个基础的项目。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-33-20-image.png" alt="img"></p> |
| <p>在初始化完项目之后,需要在 <code>src/main/java</code> 目录下创建 <code>org.apache.dubbo.samples.api</code> 、<code>org.apache.dubbo.samples.client</code> 和 <code>org.apache.dubbo.samples.provider</code> 三个 package。</p> |
| <p>后续我们将在 <code>api</code> 下创建对应的接口,在 <code>client</code> 下创建对应客户端订阅服务的功能,在 <code>provider</code> 下创建对应服务端的实现以及发布服务的功能。</p> |
| <p>上述三个 package 分别对应了应用共同依赖的 api、消费端应用的模块、服务端应用的模块。在实际部署中需要拆成三个工程,消费端和服务的共同依赖 api 模块。从简单出发,本教程将在同一个工程中进行开发,区分多个启动类。</p> |
| <h3 id="3-添加-maven-依赖">3. 添加 Maven 依赖</h3> |
| <p>在初始化完项目以后,我们需要先添加 Dubbo 相关的 maven 依赖。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-36-57-image.png" alt="img"></p> |
| <p>编辑 <code>pom.xml</code> 这个文件,添加下列配置。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>3.1.6<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.springframework<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>spring-context<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>5.3.25<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.curator<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>curator-x-discovery<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>5.2.0<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.zookeeper<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>zookeeper<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>3.8.0<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependencies&gt;</span> |
| </span></span></code></pre></div><p>在这份配置中,定义了 dubbo 和 zookeeper(以及对应的连接器 curator)的依赖。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-36-31-image.png" alt="img"></p> |
| <p>添加了上述的配置以后,可以通过 IDEA 的 <code>Maven - Reload All Maven Projects</code> 刷新依赖。</p> |
| <h3 id="4-定义服务接口">4. 定义服务接口</h3> |
| <p>服务接口 Dubbo 中沟通消费端和服务端的桥梁。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-37-31-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.api</code> 下建立 <code>GreetingsService</code> 接口,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.api; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GreetingsService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHi</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>GreetingsService</code> 中,定义了 <code>sayHi</code> 这个方法。后续服务端发布的服务,消费端订阅的服务都是围绕着 <code>GreetingsService</code> 接口展开的。</p> |
| <h3 id="5-定义服务端的实现">5. 定义服务端的实现</h3> |
| <p>定义了服务接口之后,可以在服务端这一侧定义对应的实现,这部分的实现相对于消费端来说是远端的实现,本地没有相关的信息。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-38-04-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.provider</code> 下建立 <code>GreetingsServiceImpl</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.api.GreetingsService; |
| </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">GreetingsServiceImpl</span> <span style="color:#268bd2">implements</span> GreetingsService { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHi</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;hi, &#34;</span> <span style="color:#719e07">+</span> name; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在 <code>GreetingsServiceImpl</code> 中,实现了 <code>GreetingsService</code> 接口,对于 <code>sayHi</code> 方法返回 <code>hi, name</code>。</p> |
| <h3 id="6-配置服务端-xml-配置文件">6. 配置服务端 XML 配置文件</h3> |
| <p>从本步骤开始至第 7 步,将会通过 Spring XML 的方式配置 Dubbo 服务的信息。</p> |
| <p>首先,我们先创建服务端的配置文件。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-40-07-image.png" alt="img"></p> |
| <p>在 <code>resources</code> 资源文件夹下建立 <code>dubbo-demo-provider.xml</code> 文件,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> xmlns:context=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/context&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;context:property-placeholder/&gt;</span> |
| </span></span><span style="display:flex;"><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:application</span> name=<span style="color:#2aa198">&#34;demo-provider&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></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:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- 定义实现类对应的 bean --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;greetingsService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.provider.GreetingsServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- 定义服务信息,引用上面的 bean --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.api.GreetingsService&#34;</span> ref=<span style="color:#2aa198">&#34;greetingsService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><p>在这个配置文件中,定义了 Dubbo 的应用名、Dubbo 使用的注册中心地址、发布服务的 spring bean 以及通过 Dubbo 去发布这个 bean。</p> |
| <h3 id="7-配置消费端-xml-配置文件">7. 配置消费端 XML 配置文件</h3> |
| <p>同样的,我们需要创建消费端的配置文件。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-40-59-image.png" alt="img"></p> |
| <p>在 <code>resources</code> 资源文件夹下建立 <code>dubbo-demo-consumer.xml</code> 文件,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> xmlns:context=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/context&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;context:property-placeholder/&gt;</span> |
| </span></span><span style="display:flex;"><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:application</span> name=<span style="color:#2aa198">&#34;demo-provider&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></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:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- 定义订阅信息,Dubbo 会在 Spring Context 中创建对应的 bean --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;greetingsService&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.api.GreetingsService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><p>在这个配置文件中,定义了 Dubbo 的应用名、Dubbo 使用的注册中心地址、订阅的服务信息。</p> |
| <h3 id="8-基于-spring-配置服务端启动类">8. 基于 Spring 配置服务端启动类</h3> |
| <p>除了配置 XML 配置文件之外,我们还需要创建基于 Spring Context 的启动类。</p> |
| <p>首先,我们先创建服务端的启动类。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-46-49-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.provider</code> 下建立 <code>Application</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.concurrent.CountDownLatch; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.context.support.ClassPathXmlApplicationContext; |
| </span></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">Application</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) <span style="color:#268bd2">throws</span> InterruptedException { |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(<span style="color:#2aa198">&#34;dubbo-demo-provider.xml&#34;</span>); |
| </span></span><span style="display:flex;"><span> context.start(); |
| </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">new</span> CountDownLatch(1).await(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>在这个启动类中,配置了一个 <code>ClassPathXmlApplicationContext</code> 去读取我们前面第 6 步中定义的 <code>dubbo-demo-provider.xml</code> 配置文件。</p> |
| <h3 id="9-基于-spring-配置消费端启动类">9. 基于 Spring 配置消费端启动类</h3> |
| <p>同样的,我们需要创建消费端的启动类。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-15-48-26-image.png" alt="img"></p> |
| <p>在 <code>org.apache.dubbo.samples.client</code> 下建立 <code>Application</code> 类,定义如下:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.samples.client; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.io.IOException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.samples.api.GreetingsService; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.context.support.ClassPathXmlApplicationContext; |
| </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">Application</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) <span style="color:#268bd2">throws</span> IOException { |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(<span style="color:#2aa198">&#34;dubbo-demo-consumer.xml&#34;</span>); |
| </span></span><span style="display:flex;"><span> context.start(); |
| </span></span><span style="display:flex;"><span> GreetingsService greetingsService <span style="color:#719e07">=</span> (GreetingsService) context.getBean(<span style="color:#2aa198">&#34;greetingsService&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String message <span style="color:#719e07">=</span> greetingsService.sayHi(<span style="color:#2aa198">&#34;dubbo&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Receive result ======&gt; &#34;</span> <span style="color:#719e07">+</span> message); |
| </span></span><span style="display:flex;"><span> System.in.read(); |
| </span></span><span style="display:flex;"><span> System.exit(0); |
| </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>在这个启动类中,主要执行了三个功能:</p> |
| <ol> |
| <li> |
| <p>配置了一个 <code>ClassPathXmlApplicationContext</code> 去读取我们前面第 7 步中定义的 <code>dubbo-demo-consumer.xml</code> 配置文件</p> |
| </li> |
| <li> |
| <p>从 Spring Context 中获取名字为 <code>greetingsService</code> 的由 Dubbo 创建的 bean</p> |
| </li> |
| <li> |
| <p>通过这个 bean 对远端发起调用</p> |
| </li> |
| </ol> |
| <h3 id="10-启动应用">10. 启动应用</h3> |
| <p>截止第 9 步,代码就已经开发完成了,本小节将启动整个项目并进行验证。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-16-01-29-image.png" alt="img"></p> |
| <p>首先是启动 <code>org.apache.dubbo.samples.provider.Application</code> ,等待一会出现如下图所示的日志(<code>Dubbo Application[1.1](demo-provider) is ready</code>)即代表服务提供者启动完毕,标志着该服务提供者可以对外提供服务了。</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>[DUBBO] Dubbo Application[1.1](demo-provider) is ready., dubbo version: 3.1.6, current host: 30.221.128.96 |
| </span></span></code></pre></div><p>然后是启动<code>org.apache.dubbo.samples.client.Application</code> ,等待一会出现如下图所示的日志(<code>hi, dubbo</code> )即代表服务消费端启动完毕并调用到服务端成功获取结果。</p> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/quickstart/2023-02-08-16-02-50-image.png" alt="img"></p> |
| <div class="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>Receive result ======&gt; hi, dubbo |
| </span></span></code></pre></div><h2 id="延伸阅读">延伸阅读</h2> |
| <h3 id="1-dubbo-的-xml-配置介绍">1. Dubbo 的 XML 配置介绍</h3> |
| <p>Dubbo 的主要配置入口有<code>dubbo:application</code> 、<code>dubbo:registry</code> 、 <code>dubbo:reference</code> 和 <code>dubbo:service</code> 等,更多的细节可以参考 <a href="https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/config/xml/">XML 配置 | Apache Dubbo</a> 一文。</p> |
| <h2 id="更多">更多</h2> |
| <p>本教程介绍了如何基于 Dubbo x Spring XML 开发一个微服务应用。至此,Dubbo 基于 API、Spring Boot、Spring XML 三种主要的启动方式都已经介绍完毕。</p> |
| <p>在下一节中,将介绍<a href="../idl/">基于 Protobuf IDL 配置的微服务开发方式</a>。</p></description></item><item><title>Overview: 5 - IDL 定义跨语言服务</title><link>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/idl/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/zh-cn/overview/mannual/java-sdk/quick-start/idl/</guid><description> |
| <p>使用 IDL 定义服务具有更好的跨语言友好性,对于 Dubbo3 新用户而言,我们推荐使用这种方式。 |
| 然而 Triple 协议并不是和 IDL 强绑定的,也可以使用 Java Interface + Pojo 的方式定义服务并启用 Triple 协议,具体可参见<a href="https://github.com/apache/dubbo-samples/tree/master/3-extensions/protocol/dubbo-samples-triple/src/main/java/org/apache/dubbo/sample/tri/pojo">示例</a>。</p> |
| <p>更多 Triple 和 IDL 使用方式,请参考<a href="https://github.com/apache/dubbo-samples/tree/master/3-extensions/protocol/dubbo-samples-triple">官方示例</a></p> |
| <h3 id="前置条件">前置条件</h3> |
| <ul> |
| <li><a href="https://jdk.java.net/">JDK</a> 版本 &gt;= 8</li> |
| <li>已安装 <a href="https://maven.apache.org/">Maven</a></li> |
| </ul> |
| <h3 id="创建工程">创建工程</h3> |
| <ol> |
| <li> |
| <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>$ mvn archetype:generate \ |
| </span></span><span style="display:flex;"><span> -DgroupId=org.apache.dubbo \ |
| </span></span><span style="display:flex;"><span> -DartifactId=tri-stub-demo \ |
| </span></span><span style="display:flex;"><span> -DarchetypeArtifactId=maven-archetype-quickstart \ |
| </span></span><span style="display:flex;"><span> -DarchetypeVersion=1.4 \ |
| </span></span><span style="display:flex;"><span> -DarchetypeGroupId=org.apache.maven.archetypes \ |
| </span></span><span style="display:flex;"><span> -Dversion=1.0-SNAPSHOT |
| </span></span></code></pre></div></li> |
| <li> |
| <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-fallback" data-lang="fallback"><span style="display:flex;"><span>$ cd tri-stub-demo |
| </span></span></code></pre></div></li> |
| <li> |
| <p>在 <code>pom.xml</code> 中设置 JDK 版本,添加 Dubbo 依赖和插件</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-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;properties&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;project.build.sourceEncoding&gt;</span>UTF-8<span style="color:#268bd2">&lt;/project.build.sourceEncoding&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;maven.compiler.source&gt;</span>1.8<span style="color:#268bd2">&lt;/maven.compiler.source&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;maven.compiler.target&gt;</span>1.8<span style="color:#268bd2">&lt;/maven.compiler.target&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo.version&gt;</span>3.1.7<span style="color:#268bd2">&lt;/dubbo.version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/properties&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>junit<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>junit<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>4.13<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;scope&gt;</span>test<span style="color:#268bd2">&lt;/scope&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-dependencies-zookeeper-curator5<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;type&gt;</span>pom<span style="color:#268bd2">&lt;/type&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.google.protobuf<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>protobuf-java<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>3.19.4<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependencies&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;build&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;extensions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;extension&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>kr.motd.maven<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>os-maven-plugin<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>1.6.1<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/extension&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/extensions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;plugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.xolstice.maven.plugins<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>protobuf-maven-plugin<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.6.1<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;configuration&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;protocArtifact&gt;</span>com.google.protobuf:protoc:3.19.4:exe:${os.detected.classifier}<span style="color:#268bd2">&lt;/protocArtifact&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;protocPlugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;protocPlugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;id&gt;</span>dubbo<span style="color:#268bd2">&lt;/id&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-compiler<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>${dubbo.version}<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;mainClass&gt;</span>org.apache.dubbo.gen.tri.Dubbo3TripleGenerator<span style="color:#268bd2">&lt;/mainClass&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/protocPlugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/protocPlugins&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/configuration&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;executions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;execution&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;goals&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;goal&gt;</span>compile<span style="color:#268bd2">&lt;/goal&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/goals&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/execution&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/executions&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/plugins&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/build&gt;</span> |
| </span></span></code></pre></div></li> |
| <li> |
| <p>添加接口定义文件<code>src/main/proto/hello.proto</code>,Dubbo 使用 <a href="https://developers.google.com/protocol-buffers">Protobuf</a> 作为 IDL</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-protobuf" data-lang="protobuf"><span style="display:flex;"><span>syntax <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;proto3&#34;</span>; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">option</span> java_multiple_files <span style="color:#719e07">=</span> <span style="color:#cb4b16">true</span>; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">option</span> java_package <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;org.apache.dubbo.hello&#34;</span>; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">option</span> java_outer_classname <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;HelloWorldProto&#34;</span>; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">option</span> objc_class_prefix <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;HLW&#34;</span>; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">package</span> helloworld; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">message</span> <span style="color:#268bd2">HelloRequest</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">string</span> name <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span>; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">message</span> <span style="color:#268bd2">HelloReply</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">string</span> <span style="color:#268bd2">message</span> <span style="color:#719e07">=</span> <span style="color:#2aa198">1</span>; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">service</span> Greeter{ |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">rpc</span> greet(HelloRequest) <span style="color:#719e07">returns</span> (HelloReply); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></li> |
| <li> |
| <p>编译 IDL</p> |
| <div class="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>$ mvn clean install |
| </span></span></code></pre></div><p>编译成功后,可以看到<code>target/generated-sources/protobuf/java</code> 目录下生成了代码文件</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>$ ls org/apache/dubbo/hello/ |
| </span></span><span style="display:flex;"><span>DubboGreeterTriple.java HelloReply.java HelloRequest.java HelloWorldProto.java |
| </span></span><span style="display:flex;"><span>Greeter.java HelloReplyOrBuilder.java HelloRequestOrBuilder.java |
| </span></span></code></pre></div></li> |
| <li> |
| <p>添加服务端接口实现<code>src/main/java/org/apache/dubbo/GreeterImpl.java</code></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.hello.DubboGreeterTriple; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.hello.HelloReply; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.hello.HelloRequest; |
| </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">GreeterImpl</span> <span style="color:#268bd2">extends</span> DubboGreeterTriple.GreeterImplBase { |
| </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> HelloReply <span style="color:#268bd2">greet</span>(HelloRequest request) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> HelloReply.newBuilder() |
| </span></span><span style="display:flex;"><span> .setMessage(<span style="color:#2aa198">&#34;Hello,&#34;</span> <span style="color:#719e07">+</span> request.getName() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;!&#34;</span>) |
| </span></span><span style="display:flex;"><span> .build(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></li> |
| <li> |
| <p>添加服务端启动类 <code>src/main/java/org/apache/dubbo/MyDubboServer.java</code></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.constants.CommonConstants; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ProtocolConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ServiceConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.hello.Greeter; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.io.IOException; |
| </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">MyDubboServer</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) <span style="color:#268bd2">throws</span> IOException { |
| </span></span><span style="display:flex;"><span> ServiceConfig<span style="color:#719e07">&lt;</span>Greeter<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> service.setInterface(Greeter.class); |
| </span></span><span style="display:flex;"><span> service.setRef(<span style="color:#719e07">new</span> GreeterImpl()); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> DubboBootstrap bootstrap <span style="color:#719e07">=</span> DubboBootstrap.getInstance(); |
| </span></span><span style="display:flex;"><span> bootstrap.application(<span style="color:#719e07">new</span> ApplicationConfig(<span style="color:#2aa198">&#34;tri-stub-server&#34;</span>)) |
| </span></span><span style="display:flex;"><span> .registry(<span style="color:#719e07">new</span> RegistryConfig(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>)) |
| </span></span><span style="display:flex;"><span> .protocol(<span style="color:#719e07">new</span> ProtocolConfig(CommonConstants.TRIPLE, 50051)) |
| </span></span><span style="display:flex;"><span> .service(service) |
| </span></span><span style="display:flex;"><span> .start(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Dubbo triple stub server started&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.in.read(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></li> |
| <li> |
| <p>添加客户端启动类<code>src/main/java/org/apache/dubbo/MyDubboClient.java</code></p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.constants.CommonConstants; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ApplicationConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.ReferenceConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.RegistryConfig; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.config.bootstrap.DubboBootstrap; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.hello.Greeter; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.hello.HelloReply; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.hello.HelloRequest; |
| </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">MyDubboClient</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">main</span>(String<span style="color:#719e07">[]</span> args) { |
| </span></span><span style="display:flex;"><span> DubboBootstrap bootstrap <span style="color:#719e07">=</span> DubboBootstrap.getInstance(); |
| </span></span><span style="display:flex;"><span> ReferenceConfig<span style="color:#719e07">&lt;</span>Greeter<span style="color:#719e07">&gt;</span> ref <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> ref.setInterface(Greeter.class); |
| </span></span><span style="display:flex;"><span> ref.setProtocol(CommonConstants.TRIPLE); |
| </span></span><span style="display:flex;"><span> ref.setProxy(CommonConstants.NATIVE_STUB); |
| </span></span><span style="display:flex;"><span> ref.setTimeout(3000); |
| </span></span><span style="display:flex;"><span> bootstrap.application(<span style="color:#719e07">new</span> ApplicationConfig(<span style="color:#2aa198">&#34;tri-stub-client&#34;</span>)) |
| </span></span><span style="display:flex;"><span> .registry(<span style="color:#719e07">new</span> RegistryConfig(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>)) |
| </span></span><span style="display:flex;"><span> .reference(ref) |
| </span></span><span style="display:flex;"><span> .start(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Greeter greeter <span style="color:#719e07">=</span> ref.get(); |
| </span></span><span style="display:flex;"><span> HelloRequest request <span style="color:#719e07">=</span> HelloRequest.newBuilder().setName(<span style="color:#2aa198">&#34;Demo&#34;</span>).build(); |
| </span></span><span style="display:flex;"><span> HelloReply reply <span style="color:#719e07">=</span> greeter.greet(request); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Received reply:&#34;</span> <span style="color:#719e07">+</span> reply); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></li> |
| <li> |
| <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-fallback" data-lang="fallback"><span style="display:flex;"><span>$ mvn clean install |
| </span></span></code></pre></div></li> |
| <li> |
| <p>启动服务端</p> |
| </li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>$ mvn org.codehaus.mojo:exec-maven-plugin:3.0.0:java -Dexec.mainClass=&#34;org.apache.dubbo.MyDubboServer&#34; |
| </span></span><span style="display:flex;"><span>Dubbo triple stub server started |
| </span></span></code></pre></div><ol start="11"> |
| <li>打开新的终端,启动客户端</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>$ mvn org.codehaus.mojo:exec-maven-plugin:3.0.0:java -Dexec.mainClass=&#34;org.apache.dubbo.MyDubboClient&#34; |
| </span></span><span style="display:flex;"><span>Received reply:message: &#34;Hello,Demo!&#34; |
| </span></span></code></pre></div></description></item></channel></rss> |