| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Apache Dubbo</title><link>https://dubbo.apache.org/en/</link><description>Recent content on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/index.xml" rel="self" type="application/rss+xml"/><item><title>Blog: Serialization Protocol Security</title><link>https://dubbo.apache.org/en/blog/1/01/01/serialization-protocol-security/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/1/01/01/serialization-protocol-security/</guid><description> |
| <p>Dubbo 3 has enhanced the security aspects of serialization protocols and recommends using the Triple protocol in non-Wrapper mode. This protocol is secure by default but requires developers to write IDL files.</p> |
| <p>In the Triple protocol&rsquo;s Wrapper mode, compatibility with other serialization data is allowed, offering good compatibility. However, other protocols may have deserialization security flaws. For the Hessian2 protocol, users who require high-security attributes should enable whitelist mode according to the sample code. The framework will enable blacklist mode by default to block malicious calls.</p> |
| <p>Using other serialization protocols is not recommended. When an attacker can access the Provider interface, security flaws in other serialization protocols may lead to command execution through the Provider interface.</p> |
| <p>If you must use other serialization protocols and wish to maintain some level of security, you should enable the Token authentication mechanism. This will prevent threats to the Provider&rsquo;s security from unauthenticated and untrusted request sources. When enabling Token authentication, you should also enable the authentication feature in the registry.</p> |
| <h2 id="notice">Notice</h2> |
| <p>The following serializations are proved that not safe enough to transfer on network and not recommend to use.</p> |
| <ul> |
| <li>native-hessian</li> |
| <li>native-java (Java ObjectOutputStream and ObjectInputStream)</li> |
| </ul></description></item><item><title>Blog: Introduction to Apache Dubbo plugin for IntelliJ IDEA</title><link>https://dubbo.apache.org/en/blog/2023/10/23/introduction-to-apache-dubbo-plugin-for-intellij-idea/</link><pubDate>Mon, 23 Oct 2023 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2023/10/23/introduction-to-apache-dubbo-plugin-for-intellij-idea/</guid><description> |
| <p>The most popular Java IDE, IntelliJ IDEA, has collaborated with the open-source microservice framework Apache Dubbo community, bringing good news to microservice developers. Along with IntelliJ IDEA version 2023.2, Jetbras has officially released the new <strong>Apache Dubbo in Spring Framework</strong> plugin version.</p> |
| <p>This plugin can help developers with Dubbo project initialization and facilitate the identification of Dubbo services and their dependencies during the project development process. Developing microservices based on Apache Dubbo will become very simple.</p> |
| <h2 id="how-to-install">How to install</h2> |
| <p>Before installing the Apache Dubbo plugin, please ensure that you are using IntelliJ IDEA version 2023.2 and above.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2023/10/plugin/img.png" alt="image.png"></p> |
| <p>There are two ways to complete the installation of the Apache Dubbo plugin</p> |
| <h3 id="method-1">Method 1</h3> |
| <p>Open <a href="https://plugins.jetbrains.com/plugin/20938-apache-dubbo-in-spring-framework">the Apache Dubbo in Spring Framework plugin page</a> with browser, and in the upper right corner of the page, click the &ldquo;Install to IntelliJ IDEA 2023.2&rdquo; button to complete the plugin installation.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2023/10/plugin/img_1.png" alt="image.png"></p> |
| <h3 id="method-2">Method 2</h3> |
| <p>Open &lsquo;Preferences -&gt;Plugins&rsquo;, enter &lsquo;Apache Dubbo&rsquo; to search for plugins, and then install them.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2023/10/plugin/img_2.png" alt="image.png"></p> |
| <h2 id="create-a-new-dubbo-application">Create a new Dubbo application</h2> |
| <p>Next, let&rsquo;s take a look at how to use the plugin to create and develop an Apache Dubbo microservice application.</p> |
| <h3 id="the-new-project-pop-up-window">The &lsquo;New Project&rsquo; pop-up window</h3> |
| <p>Open the &lsquo;New Project&rsquo; window through &lsquo;File&gt;New&gt;Project&rsquo;. In the pop-up window, you can see that the Apache Dubbo plugin has appeared in the generators list on the left. Click to select it.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2023/10/plugin/img_3.png" alt="image.png"></p> |
| <p>According to the application needs, enter the project name, save path, coordinates, JDK version, and other information. Click &ldquo;Next&rdquo; to proceed to the next step.</p> |
| <h3 id="select-components">Select Components</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2023/10/plugin/img_4.png" alt="image.png"></p> |
| <p>The plugin will use dubbo spring boot starter to create a Spring Boot project, so we</p> |
| <ul> |
| <li>Firstly, you need to choose the versions of Dubbo and Spring Boot.</li> |
| <li>Secondly, select the corresponding Dubbo and business components according to the project needs</li> |
| </ul> |
| <p>Finally, click &ldquo;Create&rdquo; to complete the project creation.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2023/10/plugin/img_5.png" alt="image.png"></p> |
| <h2 id="summary">Summary</h2> |
| <p>The release of the official IntelliJ IDEA plugin greatly simplifies the cost of initializing the Dubbo project. |
| In addition to the plugin format, you can also directly open the start.dubbo.apache.org online service to quickly create Dubbo projects through a browser.</p></description></item><item><title>Blog: Advanced cloud native - Dubbo 3.2 officially released</title><link>https://dubbo.apache.org/en/blog/2023/04/15/advanced-cloud-native-dubbo-3.2-officially-released/</link><pubDate>Sat, 15 Apr 2023 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2023/04/15/advanced-cloud-native-dubbo-3.2-officially-released/</guid><description> |
| <h2 id="background-introduction">Background introduction</h2> |
| <p>Apache Dubbo is an RPC service development framework, which is used to solve service governance and communication problems under the microservice architecture. It officially provides multi-language SDK implementations such as Java and Golang. The microservices developed using Dubbo are natively capable of remote address discovery and communication with each other. Using the rich service governance features provided by Dubbo, service governance demands such as service discovery, load balancing, and traffic scheduling can be realized. Dubbo is designed to be highly scalable, and users can easily implement various custom logics for traffic interception and location selection.</p> |
| <h2 id="rest-protocol-support">Rest protocol support</h2> |
| <h3 id="1-why-rest">1. Why Rest?</h3> |
| <p>With the popularization of mobile Internet, more and more applications need to be integrated with different systems. And these systems may use different communication protocols, which requires the application program to be able to flexibly adapt to various protocols. The Rest protocol is a very flexible protocol that communicates using HTTP and can be integrated with almost any system.</p> |
| <p>In the past, RPC frameworks typically communicated using a binary protocol, which was very efficient but not flexible enough. In contrast, the Rest protocol uses HTTP for communication, which is more convenient to integrate with other systems, and also easier to integrate with modern web and mobile applications.</p> |
| <p>Besides flexibility, the Rest protocol is also readable and easy to use. Using the Rest protocol, developers can test and debug services using common HTTP tools such as cURL or Postman, without the need for specific tools. Also, since the REST protocol uses standard HTTP methods such as GET, POST, PUT, and DELETE, it becomes easier for developers to understand and use the service.</p> |
| <h3 id="2-how-to">2. How To?</h3> |
| <p>In previous Dubbo versions, Rest protocol support was also provided, but there were the following problems:</p> |
| <ul> |
| <li> |
| <p>Only supports JAX-RS annotation fields, which is more complex than the more widely adopted Spring Web annotations</p> |
| </li> |
| <li> |
| <p>It needs to rely on many external components, such as Resteasy, tomcat, jetty, etc., to work normally, which greatly increases the cost of use.</p> |
| </li> |
| </ul> |
| <p>Therefore, in Dubbo version 3.2, we introduced the support of Spring Web annotation domain and the native support of Rest protocol without relying on any external components.</p> |
| <p>The most intuitive difference is that if you upgrade to Dubbo 3.2, services published through Spring Web can also be published directly through Dubbo. All you need to do is change the @Controller annotation to @DubboService annotation.</p> |
| <p>In addition, for users who originally used Spring Boot or Spring Cloud as a service split, they can also migrate smoothly to Dubbo based on this function, and obtain the powerful capabilities of Dubbo at a very low cost.</p> |
| <h3 id="3-whats-next">3. What&rsquo;s next?</h3> |
| <p>In the future, Dubbo will continue to improve. In addition to the existing features, we will also add the following new features to better meet the needs:</p> |
| <ol> |
| <li> |
| <p>Native support for HTTP/2 and HTTP/3 protocols. This means that you can use Dubbo to communicate with other systems more easily without worrying about protocol compatibility.</p> |
| </li> |
| <li> |
| <p>Referring to Spring Web annotations, Dubbo natively provides support for Web annotations, so that users can get the same experience as using Spring Web without relying on Spring Web.</p> |
| </li> |
| <li> |
| <p>Support zero transformation of existing services and publish them with the Rest protocol. This feature allows you to manage your services more flexibly without making any changes to existing services. You can publish your services through the Rest protocol, so that your services can be used by other systems more easily.</p> |
| </li> |
| </ol> |
| <h2 id="observable-system">Observable system</h2> |
| <p>Under the microservice architecture, the business system is composed of more and more services, and the services call each other. The ensuing problem is how to quickly locate the fault and solve it in time. In order to solve this problem, we need more tools and techniques to ensure the reliability of the whole system. One of the solutions is to use logging and analytics so that you can better track how your application is doing, find potential problems and fix them in a timely manner. In addition, using visual monitoring tools can help us better understand the status of the entire system, so as to better predict and solve problems. Finally, we can also use automated testing to ensure the quality of each service, as well as the stability and reliability of the entire system, so as to better meet customer needs.</p> |
| <p>A complete observable system should include the following functions:</p> |
| <ul> |
| <li> |
| <p>Metrics indicator monitoring, used to collect and analyze various indicator data, including system performance, resource consumption, etc. Through indicator monitoring, users can keep abreast of the operation of the system, find abnormalities and take corresponding measures.</p> |
| </li> |
| <li> |
| <p>Tracing Distributed tracing, used to trace the call links between various services in the system, to help users discover and locate potential performance problems, bottlenecks, etc. Through distributed tracing, users can deeply understand the operation process of the system, identify possible problems and make effective optimization and adjustment.</p> |
| </li> |
| <li> |
| <p>Logging log management, used to record various events and operations in the system, including error logs, access logs, transaction logs, etc. Through log management, users can learn about the running status of the system, fault information, etc., and help users quickly locate problems and handle them accordingly.</p> |
| </li> |
| </ul> |
| <p>To sum up, the above three functions can not only help users quickly locate faults, improve system reliability and stability, but also help users deeply understand the operation and performance of the system, and provide users with comprehensive monitoring and protection.</p> |
| <p>In Dubbo version 3.2, we mainly enhanced Metrics and Tracing.</p> |
| <h3 id="1-metrics">1. Metrics</h3> |
| <p>In terms of metrics, we use Micrometer to greatly increase the buried points of indicators, including but not limited to core service indicators such as QPS, RT, total number of calls, number of successes, number of failures, and failure reason statistics. In order to better monitor the running status of services, Dubbo also provides monitoring of the status of core components, such as the number of thread pools, service health status, etc. In addition, Dubbo also supports the standard Prometheus Pull and Push modes, and provides several official native Grafana panels to achieve production-oriented Metrics all-weather observation.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/32-release/Untitled.png" alt="img"></p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/32-release/Untitled%201.png" alt="Untitled"></p> |
| <p>For all users, only need to upgrade to Dubbo 3.2 version and add dubbo-spring-boot-observability-starter dependency to get Metrics capability. After the application starts, relevant indicators will be exposed under the metrics command of Dubbo QoS, which can be obtained locally through <code>http://127.0.0.1:22222/metrics</code>. In addition, for users who use Spring Actuator, Dubbo will also expose these data by default.</p> |
| <h3 id="tracing">Tracing</h3> |
| <p>In terms of Tracing, we also implemented tracking of buried points during request runtime based on Micrometer. We implement this function natively through the Filter interceptor. We support exporting trace data to some mainstream implementations, such as Zipkin, Skywalking, Jaeger, etc. In this way, the analysis and visual display of the full link tracking data can be realized.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/32-release/Untitled%202.png" alt="Untitled"></p> |
| <h3 id="logging">Logging</h3> |
| <p>In addition, for Logging, Dubbo has introduced an error code mechanism since version 3.1, realizing full coverage of WARN and ERROR level logs. In abnormal scenarios, it supports quick indexing of official website resolution documents.</p> |
| <h2 id="native-image-native-support">Native Image native support</h2> |
| <p>In terms of Native Image, Dubbo will officially support Native Image based on GraalVM starting from 3.2. Starting from Dubbo3.0, Dubbo has already explored some Native Image support, but the ease of use and support are not ideal. From 3.2 Starting from version 1, Dubbo will simplify the way users access Native Image. It can be mainly divided into three aspects:</p> |
| <ol> |
| <li>Compile plugin configuration upgrade: from the original native-image-maven-plugin to dubbo-maven-plugin +native-maven-plugin, which distinguishes the native image configuration officially provided by Graalvm from the native image configuration required by Dubbo, simplifying The native image configuration that users need to care about</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.graalvm.nativeimage<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>native-image-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>21.0.0.2<span style="color:#268bd2">&lt;/version&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>native-image<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;phase&gt;</span>package<span style="color:#268bd2">&lt;/phase&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;configuration&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;skip&gt;</span>false<span style="color:#268bd2">&lt;/skip&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;imageName&gt;</span>demo-native-provider<span style="color:#268bd2">&lt;/imageName&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;mainClass&gt;</span>org.apache.dubbo.demo.graalvm.provider.Application<span style="color:#268bd2">&lt;/mainClass&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;buildArgs&gt;</span> |
| </span></span><span style="display:flex;"><span> --no-fallback |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.MDC |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.LoggerFactory |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.impl.StaticLoggerBinder |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.helpers.Loader |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.Logger |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.helpers.LogLog |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.LogManager |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.spi.LoggingEvent |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.impl.Log4jLoggerFactory |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.impl.Log4jLoggerAdapter |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.eclipse.collections.api.factory.Sets |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.Epoll |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.Native |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.EpollEventLoop |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.EpollEventArray |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.DefaultFileRegion |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.kqueue.KQueueEventArray |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.kqueue.KQueueEventLoop |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.kqueue.Native |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.Errors |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.IovArray |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.Limits |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.util.internal.logging.Log4JLogger |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.Socket |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.ChannelHandlerMask |
| </span></span><span style="display:flex;"><span> --report-unsupported-elements-at-runtime |
| </span></span><span style="display:flex;"><span> --allow-incomplete-classpath |
| </span></span><span style="display:flex;"><span> --enable-url-protocols=http |
| </span></span><span style="display:flex;"><span> -H:+ReportExceptionStackTraces |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/buildArgs&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;/plugin&gt;</span> |
| </span></span></code></pre></div><p>becomes：</p> |
| <div class="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;plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.graalvm.buildtools<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>native-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.9.20<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;classesDirectory&gt;</span>${project.build.outputDirectory}<span style="color:#268bd2">&lt;/classesDirectory&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;metadataRepository&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;enabled&gt;</span>true<span style="color:#268bd2">&lt;/enabled&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/metadataRepository&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;requiredVersion&gt;</span>22.3<span style="color:#268bd2">&lt;/requiredVersion&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;mainClass&gt;</span>org.apache.dubbo.demo.graalvm.provider.Application<span style="color:#268bd2">&lt;/mainClass&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;/plugin&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.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-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>${project.version}<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;mainClass&gt;</span>org.apache.dubbo.demo.graalvm.provider.Application<span style="color:#268bd2">&lt;/mainClass&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;phase&gt;</span>process-sources<span style="color:#268bd2">&lt;/phase&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>dubbo-process-aot<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></code></pre></div><ol> |
| <li>In the old version, users were required to manually generate and complete the unique Adaptive code in Dubbo. Users of the new version do not need to care about these details.</li> |
| <li>The configuration file under META-INF.native-image generated by the Dubbo framework in the old version will be directly generated in the user&rsquo;s project directory, and the new version 3.2 will be compiled into the target without affecting the user&rsquo;s project structure. In addition, the Dubbo framework will no longer use the method of manually completing the native image, but will automatically detect and generate the required configuration files, which simplifies the experience of Dubbo developers. This can also reduce the size of the final compiled binary package and improve compilation speed.</li> |
| </ol> |
| <p>In addition to improving ease of use, Dubbo will support API, annotations, and XML configuration methods in native image scenarios in version 3.2, and support compatibility with native in SpringBoot3.</p> |
| <h2 id="other">other</h2> |
| <h3 id="jdk-17--spring-boot-3-native-support">JDK 17 &amp; Spring Boot 3 native support</h3> |
| <p>JDK 17 is the latest LTS version of Java after JDK 11, including many new features and improvements, such as Sealed classes, garbage collector improvements, and more.</p> |
| <p>Since JDK 16 began to restrict Java internal class reflection, Dubbo&rsquo;s serialization and dynamic proxy have been affected to a certain extent. In Dubbo 3.2, we solved the compatibility problem from the bottom through the optimization of Fastjson2 and Javassist. At present, Dubbo can run perfectly on JDK17, and all unit tests and most integration tests have also been tested on the JDK 17 platform.</p> |
| <p>For the upcoming JDK 21 LTS, Dubbo is intensively adapting it. We will add support for JDK 21 and Dubbo coroutines (Project Loom) in version 3.3.</p> |
| <h3 id="rpc-performance-greatly-improved">RPC performance greatly improved</h3> |
| <p>In version 3.2, we have optimized the performance of RPC calls, and the optimized content is as follows.</p> |
| <ul> |
| <li> |
| <p>Eliminates synchronization lock contention and blocking code (<code>triple</code>)</p> |
| <ol> |
| <li>When creating an HTTP/2 Stream Channel in version 3.1, the method of synchronously blocking user threads is used to wait for the Stream Channel to be created, and the remote call is initiated after the creation is completed. In 3.2, we will create the behavior of HTTP/2 Stream Channel <code>asynchronous</code> and ensure that the request is initiated after the creation is completed, so as to <code>reduce unnecessary waiting for user threads</code>.</li> |
| <li>In version 3.1, there is a synchronization lock competition between the user thread and the Netty I/O thread. The IO thread will check the Socket availability for each write request, and the Socket availability check method is also used in the user thread, but the Socket availability in the JDK The implementation of the check uses <code>synchronized</code> to ensure concurrency safety. In order to reduce this part of the time-consuming, we remove the user thread check and eliminate this part of the time-consuming.</li> |
| </ol> |
| </li> |
| <li> |
| <p>Reduced request response delay with synchronous blocking calls (<code>dubbo</code>, <code>triple</code>)</p> |
| <p>In the RPC call in SYNC mode in version 3.1, we use a blocking queue to wait for the response written back by the remote service. When the response is written back, it will be added to the queue and wake up the blocked user thread. In 3.2, we replaced the blocking queue with a concurrent queue, and used its CAS mechanism to greatly reduce the number of threads entering blocking, improve CPU utilization and reduce response processing delay</p> |
| </li> |
| <li> |
| <p>Reduced the number of thread switches (<code>triple</code>)</p> |
| <p>In version 3.1, the RPC call in SYNC mode uses a consumer thread pool for processing when receiving the response, and wakes up the user thread to receive the response after the processing is completed. However, through the analysis of the consumer thread pool in SYNC mode is unnecessary, an additional layer of consumer thread pool processing not only wastes server resources but also reduces performance, so we removed the consumer thread pool in SYNC mode in version 3.2 , the interaction model changed from <code>NettyEventLoop → ConsumerThread → UserThread</code> to <code>NettyEventLoop → UserThread</code>, so as to reduce the waste of server resources and improve performance</p> |
| </li> |
| <li> |
| <p>Optimized I/O performance (<code>dubbo</code>, <code>triple</code>)</p> |
| <p>In version 3.1, we used the Netty framework to achieve network communication, but every time we wrote a message to the peer, we directly flashed it to the peer, resulting in a very high number of system calls and reducing the communication performance. For this reason, we have optimized it in version 3.2. Every time a message is sent, the message is first submitted to a write queue, and multiple messages are written out at the right time, thereby improving I/O Utilization rate greatly improves RPC communication performance.</p> |
| </li> |
| <li> |
| <p>Support serialization of messages on user threads (<code>dubbo</code>, <code>triple</code>)</p> |
| <p>In version 3.1, the deserialization of messages in RPC communication is performed in a single I/O thread, which makes it impossible to take advantage of the advantages of multi-core CPUs. For this reason, in version 3.2, we support time-consuming tasks such as deserialization on user threads, and evenly distribute the pressure of I/O threads to multiple CPU cores, thereby improving the performance of large packets. `Scenario RPC performance.</p> |
| </li> |
| </ul> |
| <p>The performance improvement of 3.2 compared with 3.1 is as follows:</p> |
| <p>Triple protocol: In the scenarios of createUser, existUser, and getUser with small packets, the improvement rate is about <code>40-45%</code>, and the improved performance is basically the same as that of gRPC in the same scenario. The increase of about <code>17%</code> in the large message scenario listUser, compared to <code>11%</code> lower than that of gRPC in the same scenario.</p> |
| <p>Dubbo protocol: The improvement rate is about <code>180%</code> in the case of createUser and getUser in small message scenarios. The improvement rate of the very small message existUser (only one boolean value) is about <code>24%</code>, while the improvement rate of the larger message listUser is the highest, reaching <code>1000%</code>!</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/32-release/Untitled%203.png" alt="Untitled"></p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/32-release/Untitled%204.png" alt="Untitled"></p> |
| <h2 id="how-to-upgrade-to-dubbo-32">How to upgrade to Dubbo 3.2</h2> |
| <h3 id="pom-upgrade">Pom upgrade</h3> |
| <p>The latest Dubbo Maven coordinates are:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo<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<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><h3 id="compatibility">Compatibility</h3> |
| <p>For the vast majority of users, upgrading to Dubbo 3.2.0 is completely smooth, and only needs to modify the version of the dependent package.</p> |
| <ol> |
| <li> |
| <p>Enhancement of serialization verification logic (<strong>important</strong>)</p> |
| <p>As mentioned above, in Dubbo 3.2.0 version, Dubbo will enable the strong verification of the serialization whitelist by default to improve the security of Dubbo and avoid the problem of remote command execution. The current mechanism automatically trusts some classes through the package name recursive mechanism, but for some users who use generics and may have incomplete scanning, we recommend that you upgrade to Dubbo 3.1.9 or add <code>-Ddubbo.application.serialize- check-status=WARN</code> configuration. After observing for a period of time (via logs and QoS commands), if no security alarm is triggered, you can configure the strong check mode.</p> |
| <p>For the configuration of custom whitelist, please refer to <code>Documentation/SDK Manual/Java SDK/Advanced Features and Usage/Improve Security/Class Inspection Mechanism</code> on the official website for configuration.</p> |
| </li> |
| <li> |
| <p>Modification of default serialization</p> |
| <p>Starting from version 3.2.0 of Dubbo, the default serialization method is switched from <code>hessian2</code> to <code>fastjson2</code>. For applications upgraded to 3.2.0, Dubbo will automatically try to use <code>fastjson2</code> for serialization. Please note that whether it is the client or the server, as long as one end has not been upgraded to 3.2.0, it will be downgraded to <code>hessian2</code> serialization to ensure compatibility.</p> |
| </li> |
| <li> |
| <p>Push short protection is disabled by default</p> |
| <p>The purpose of push empty protection is that when the registration center fails and actively pushes empty addresses, Dubbo keeps the last batch of provider information to ensure service availability. However, in most cases, even if the registry fails, empty addresses will not be pushed, only in some special cases. If push short protection is turned on, it will have a greater impact on Dubbo&rsquo;s Fallback logic, heartbeat logic, etc., and bring troubles to developers when using Dubbo.</p> |
| <p>If you need to enable empty protection in the production environment to achieve high availability, you can configure <code>dubbo.application.enable-empty-protection</code> to <code>true</code>. However, please note that it is known that turning on the push protection will cause the server application to roll back to the original version after upgrading from <code>2.6.x</code> and <code>2.7.x</code> versions that only support interface-level service discovery to <code>3.x</code> An exception occurs, which may cause the service call to fail in extreme cases.</p> |
| </li> |
| </ol> |
| <h2 id="summarize">Summarize</h2> |
| <p>Dubbo 3.2 is a very important version, it brings many new features and improvements, making Dubbo more powerful and easy to use. We are very grateful for the support and contributions of the community, and hope that everyone can experience Dubbo 3.2 as soon as possible and enjoy the convenience and advantages it brings.</p></description></item><item><title>Blog: How to proxy Dubbo service in Apache ShenYu Gateway</title><link>https://dubbo.apache.org/en/blog/2022/05/04/how-to-proxy-dubbo-service-in-apache-shenyu-gateway/</link><pubDate>Wed, 04 May 2022 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2022/05/04/how-to-proxy-dubbo-service-in-apache-shenyu-gateway/</guid><description> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/ApacheShenYu-Dubbo-en.png" alt="img"></p> |
| <h2 id="1-introduction">1. Introduction</h2> |
| <ul> |
| <li>Apache ShenYu</li> |
| </ul> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/shenyu.png" alt="img"></p> |
| <p><a href="https://shenyu.apache.org/docs/index">Apache ShenYu(Incubating)</a> is an asynchronous, high-performance, cross-language, responsive <code>API</code> gateway. Compatible with a variety of mainstream framework systems, support for hot-plugging, users can customize the development to meet the current and future needs of users in a variety of scenarios, experienced large-scale scenarios hammered.</p> |
| <p>In May 2021, <code>ShenYu</code> was donated to the <code>Apache</code> Software Foundation, and the Apache Foundation voted unanimously to enter the incubator.</p> |
| <ul> |
| <li>Apache Dubbo</li> |
| </ul> |
| <p><code>Apache Dubbo</code> is a microservice development framework that provides two key capabilities, <code>RPC</code> communication and microservice governance. This means that microservices developed with <code>Dubbo</code> will have the ability to discover and communicate with each other remotely, and take advantage of the rich service governance capabilities provided by Dubbo to achieve service governance requirements such as service discovery, load balancing, traffic scheduling, and so on. At the same time <code>Dubbo</code> is highly scalable, users can customize their own implementation at almost any point to change the default behavior of the framework to meet their business needs.</p> |
| <h2 id="2-quick-start-with-dubbo">2. Quick Start with Dubbo</h2> |
| <p>This section describes how to connect the <code>Dubbo</code> service to the <code>Shenyu</code> gateway. You can find the [sample code] for this section directly under the project (<a href="https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-dubbo">https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-dubbo</a> -examples-dubbo/shenyu-examples-apache-dubbo-service).</p> |
| <h3 id="21-start-shenyu-admin">2.1 Start shenyu-admin</h3> |
| <p><code>shenyu-admin</code> is the <code>Apache ShenYu</code> backend management system, there are various ways to start it, this article is started by <code>[local deployment](https://shenyu.apache.org/docs/deployment/deployment-local)</code> way. After successful startup, you need to set the <code>dubbo</code> plugin to be on and set your registered address in the base configuration <code>-&gt;</code>Plugin Management&rsquo;, please make sure the registration center has been opened.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/dubbo-enable-en.png" alt="img"></p> |
| <h3 id="22-start-shenyu-gateway">2.2 Start ShenYu Gateway</h3> |
| <p>Here it is started by way of <a href="https://github.com/apache/incubator-shenyu/tree/master/shenyu-bootstrap">source</a> and runs directly <code>shenyu-bootstrap</code> in <code>shenyu-bootstrap</code>. ShenyuBootstrapApplication`.</p> |
| <p>Make sure the gateway has introduced the relevant dependencies before starting. If the client is <code>apache dubbo</code> and the registry uses <code>zookeeper</code>, please refer to the following configuration.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#719e07">&lt;!--</span> apache shenyu apache dubbo plugin start<span style="color:#719e07">--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>groupId<span style="color:#719e07">&gt;</span>org.apache.shenyu<span style="color:#719e07">&lt;/</span>groupId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>artifactId<span style="color:#719e07">&gt;</span>shenyu<span style="color:#719e07">-</span>spring<span style="color:#719e07">-</span>boot<span style="color:#719e07">-</span>starter<span style="color:#719e07">-</span>plugin<span style="color:#719e07">-</span>apache<span style="color:#719e07">-</span>dubbo<span style="color:#719e07">&lt;/</span>artifactId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>version<span style="color:#719e07">&gt;</span>${project.version}<span style="color:#719e07">&lt;/</span>version<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;/</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>groupId<span style="color:#719e07">&gt;</span>org.apache.dubbo<span style="color:#719e07">&lt;/</span>groupId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>artifactId<span style="color:#719e07">&gt;</span>dubbo<span style="color:#719e07">&lt;/</span>artifactId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>version<span style="color:#719e07">&gt;</span>2.7.5<span style="color:#719e07">&lt;/</span>version<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;/</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;!--</span> Dubbo zookeeper registry dependency start <span style="color:#719e07">--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>groupId<span style="color:#719e07">&gt;</span>org.apache.curator<span style="color:#719e07">&lt;/</span>groupId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>artifactId<span style="color:#719e07">&gt;</span>curator<span style="color:#719e07">-</span>client<span style="color:#719e07">&lt;/</span>artifactId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>version<span style="color:#719e07">&gt;</span>4.0.1<span style="color:#719e07">&lt;/</span>version<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>exclusions<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>exclusion<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>artifactId<span style="color:#719e07">&gt;</span>log4j<span style="color:#719e07">&lt;/</span>artifactId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>groupId<span style="color:#719e07">&gt;</span>log4j<span style="color:#719e07">&lt;/</span>groupId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;/</span>exclusion<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;/</span>exclusions<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;/</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>groupId<span style="color:#719e07">&gt;</span>org.apache.curator<span style="color:#719e07">&lt;/</span>groupId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>artifactId<span style="color:#719e07">&gt;</span>curator<span style="color:#719e07">-</span>framework<span style="color:#719e07">&lt;/</span>artifactId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>version<span style="color:#719e07">&gt;</span>4.0.1<span style="color:#719e07">&lt;/</span>version<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;/</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>groupId<span style="color:#719e07">&gt;</span>org.apache.curator<span style="color:#719e07">&lt;/</span>groupId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>artifactId<span style="color:#719e07">&gt;</span>curator<span style="color:#719e07">-</span>recipes<span style="color:#719e07">&lt;/</span>artifactId<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>version<span style="color:#719e07">&gt;</span>4.0.1<span style="color:#719e07">&lt;/</span>version<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;/</span>dependency<span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;!--</span> Dubbo zookeeper registry dependency end <span style="color:#719e07">--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;!--</span> apache dubbo plugin end<span style="color:#719e07">--&gt;</span> |
| </span></span></code></pre></div><h3 id="23-start-shenyu-examples-dubbo">2.3 Start shenyu-examples-dubbo</h3> |
| <p>Take the example provided on the official website <a href="https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-dubbo">shenyu-examples-dubbo</a>. Suppose the <code>dubbo</code> service is defined as follows.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> /* ...... * <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;test-dubbo-service&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;${dubbo.registry.address}&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20888&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> timeout=<span style="color:#2aa198">&#34;10000&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.shenyu.examples.dubbo.api.service.DubboTestService&#34;</span> ref=<span style="color:#2aa198">&#34;dubboTestService&#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>Declare the application service name, register the center address, use the <code>dubbo</code> protocol, declare the service interface, and the corresponding interface implementation class.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * DubboTestServiceImpl. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Service</span>(<span style="color:#2aa198">&#34;dubboTestService&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DubboTestServiceImpl</span> <span style="color:#268bd2">implements</span> DubboTestService { |
| </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">@ShenyuDubboClient</span>(path <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;/findById&#34;</span>, desc <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;Query by Id&#34;</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> DubboTest <span style="color:#268bd2">findById</span>(<span style="color:#268bd2">final</span> String id) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#719e07">new</span> DubboTest(id, <span style="color:#2aa198">&#34;hello world shenyu Apache, findById&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">//......</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>In the interface implementation class, use the annotation <code>@ShenyuDubboClient</code> to register the service with <code>shenyu-admin</code>.</p> |
| <p>Configuration information in the configuration file <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">server</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">port</span>: <span style="color:#2aa198">8011</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">address</span>: <span style="color:#2aa198">0.0.0.0</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">servlet</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">context-path</span>: / |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">spring</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">main</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">allow-bean-definition-overriding</span>: <span style="color:#cb4b16">true</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">dubbo</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://localhost:2181 <span style="color:#586e75"># The registry used by dubbo</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">shenyu</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">register</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">registerType</span>: http <span style="color:#586e75">#Registration Method</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">serverLists</span>: http://localhost:9095 <span style="color:#586e75">#Registration Address</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">props</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">username</span>: admin |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">password</span>: <span style="color:#2aa198">123456</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">client</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">dubbo</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">props</span>: |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">contextPath</span>: /dubbo |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">appName</span>: dubbo |
| </span></span></code></pre></div><p>In the configuration file, declare the registry address used by <code>dubbo</code>. The <code>dubbo</code> service registers with <code>shenyu-admin</code>, using the method <code>http</code>, and the registration address is <code>http://localhost:9095</code>.</p> |
| <p>See <code>[Application Client Access](https://shenyu.apache.org/docs/design/register-center-design/)</code> for more information on the use of the registration method.</p> |
| <h3 id="24-invoke-the-dubbo-service">2.4 Invoke the Dubbo service</h3> |
| <p>The <code>shenyu-examples-dubbo</code> project will automatically register the interface methods annotated with <code>@ShenyuDubboClient</code> to the gateway after it is successfully started.</p> |
| <p>Open <code>Plugins List -&gt; Proxy -&gt; dubbo</code> to see the list of plugin rules configuration.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/dubbo-service-list-en.png" alt="img"></p> |
| <p>Information on the selectors for successful registration.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/dubbo-selector-en.png" alt="img"></p> |
| <p>Information on the rules for successful registration.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/dubbo-rule-en.png" alt="img"></p> |
| <blockquote> |
| <p>Selectors and rules are the soul of the <code>Apache ShenYu</code> gateway. Mastering it well, you can manage any traffic. Corresponding to the matching conditions (conditions) inside the selectors and rules, we can handle various complex scenarios according to different traffic filtering rules. Traffic filtering can get data from <code>Header</code>, <code>URI</code>, <code>Query</code>, <code>Cookie</code> and so on Http requests.</p> |
| <p>Then you can use <code>Match</code>, <code>=</code>, <code>Regex</code>, <code>Groovy</code>, <code>Exclude</code> and other matching methods to match the data you expect. Multi-group match additions can use the <code>And/Or</code> matching strategy.</p> |
| <p>See: <code>[Selector and Rule Management](https://shenyu.apache.org/docs/user-guide/admin-usage/selector-and-rule)</code> for details and usage.</p> |
| </blockquote> |
| <p>Initiate a <code>GET</code> request to invoke the <code>dubbo</code> service through the <code>ShenYu</code> gateway.</p> |
| <div class="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>GET http://localhost:9195/dubbo/findById?id=100 |
| </span></span><span style="display:flex;"><span>Accept: application/json |
| </span></span></code></pre></div><p>After a successful response, the result is as follows.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> &#34;name&#34;: &#34;hello world shenyu Apache, findById&#34;, |
| </span></span><span style="display:flex;"><span> &#34;id&#34;: &#34;100&#34; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>At this point, you can successfully access the <code>dubbo</code> service via <code>http</code> requests. The <code>ShenYu</code> gateway converts the <code>http</code> protocol to the <code>dubbo</code> protocol via the <code>shenyu-plugin-dubbo</code> module.</p> |
| <h2 id="3-understanding-of-dubbo-plugin">3. Understanding of Dubbo plugin</h2> |
| <p>During the process of running the above <code>demo</code>, are there any questions about</p> |
| <ul> |
| <li>How does the <code>dubbo</code> service register with <code>shenyu-admin</code>?</li> |
| <li>How does <code>shenyu-admin</code> synchronize data to the <code>ShenYu</code> gateway?</li> |
| <li>How does the <code>DubboPlugin</code> convert the <code>http</code> protocol to the <code>dubbo</code> protocol?</li> |
| </ul> |
| <p>With these questions in mind, let&rsquo;s dive into understanding the <code>dubbo</code> plugin.</p> |
| <h3 id="31-application-client-access">3.1 Application Client Access</h3> |
| <p>Application client access refers to accessing microservices to the <code>Apache ShenYu</code> gateway, which currently supports access to <code>Http</code>, <code>Dubbo</code>, <code>Spring Cloud</code>, <code>gRPC</code>, <code>Motan</code>, <code>Sofa</code>, <code>Tars</code> and other protocols.</p> |
| <p>Accessing application clients to the <code>Apache ShenYu</code> gateway is achieved through the registry, which involves client-side registration and server-side synchronization of data. The registry supports <code>Http</code>, <code>Zookeeper</code>, <code>Etcd</code>, <code>Consul</code> and <code>Nacos</code>. The default is to register by <code>Http</code>.</p> |
| <p>Please refer to <code>[Client Access Configuration](https://shenyu.apache.org/docs/user-guide/register-center-access)</code> for client access related configuration.</p> |
| <h4 id="311-client-side-registration">3.1.1 Client-side Registration</h4> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/register-client.png" alt="img"></p> |
| <p>Declare the registry client type, such as <code>Http</code> or <code>Zookeeper</code>, in your microservice configuration. |
| Load and initialize the corresponding registry client using the <code>SPI</code> method when the application starts, and get the service interface information that needs to be registered in it by implementing the post-processor interface related to the <code>Spring Bean</code>, and put the obtained information into the <code>Disruptor</code>.</p> |
| <p>The registry client reads the data from <code>Disruptor</code> and registers the interface information to <code>shenyu-admin</code>, where <code>Disruptor</code> plays the role of decoupling data and operations, which is convenient for extension.</p> |
| <h4 id="312-server-side-registration">3.1.2 Server-side Registration</h4> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/register-server.png" alt="img"></p> |
| <p>Declare the registry server type, such as <code>Http</code> or <code>Zookeeper</code>, in the <code>shenyu-admin</code> configuration. When <code>shenyu-admin</code> starts, it will read the configuration type, load and initialize the corresponding registry server, and when the registry server receives the interface information registered by <code>shenyu-client</code>, it will put it into <code>Disruptor</code>, and then it will trigger the registration processing logic to update the service interface information and publish the synchronization event.</p> |
| <p>The <code>Disruptor</code> plays a role in decoupling data and operation, which is good for extension. It also has a data buffering role if too many registration requests lead to registration exceptions.</p> |
| <h3 id="32-data-synchronization-principle">3.2 Data Synchronization Principle</h3> |
| <p>Data synchronization refers to the policy used to synchronize data to the <code>Apache ShenYu</code> gateway after the <code>shenyu-admin</code> backend has manipulated the data. The <code>Apache ShenYu</code> gateway currently supports <code>ZooKeeper</code>, <code>WebSocket</code>, <code>Http long polling</code>, <code>Nacos</code>, <code>Etcd</code> and <code>Consul</code> for data synchronization. The default is to synchronize data via <code>WebSocket</code>.</p> |
| <p>Please refer to <code>[Data Synchronization Configuration](https://shenyu.apache.org/docs/user-guide/use-data-sync)</code> for the configuration of data synchronization.</p> |
| <h4 id="321-the-significance-of-data-synchronization">3.2.1 The Significance of Data Synchronization</h4> |
| <p>The gateway is the entry point for traffic requests and plays a very important role in the microservices architecture, and the importance of high availability of the gateway is self-evident. In the process of using the gateway, in order to meet the business requirements, it is often necessary to change the configuration, such as flow control rules, routing rules and so on. Therefore, the dynamic configuration of the gateway is an important factor to ensure the high availability of the gateway.</p> |
| <p>The current data synchronization characteristics are as follows.</p> |
| <ul> |
| <li>All configurations are cached in the <code>Apache ShenYu</code> gateway memory, and each request uses the local cache, which is very fast.</li> |
| <li>Users can change any data in the <code>shenyu-admin</code> backend and it will be synchronized to the gateway memory immediately.</li> |
| <li>Supports data synchronization of plugins, selectors, rule data, metadata, signature data, etc. for <code>Apache ShenYu</code>.</li> |
| <li>All plug-in selectors and rules are dynamically configured and take effect immediately, without restarting the service.</li> |
| <li>Data synchronization method supports <code>Zookeeper</code>, <code>Http long polling</code>, <code>Websocket</code>, <code>Nacos</code>, <code>Etcd</code> and <code>Consul</code>.</li> |
| </ul> |
| <h4 id="322-data-synchronization-principle-analysis">3.2.2 Data Synchronization Principle Analysis</h4> |
| <p>The following diagram shows the flow of <code>Apache ShenYu</code> data synchronization. The <code>Apache ShenYu</code> gateway synchronizes configuration data from the configuration service when it starts, and supports push-pull mode to get configuration change information and then update the local cache. Administrators can change user permissions, rules, plugins, traffic configuration in the administration backend (<code>shenyu-admin</code>) and synchronize the changes to the <code>Apache ShenYu</code> gateway via push-pull mode, depending on which synchronization method is used.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/data-sync.png" alt="img"></p> |
| <p>In the original version, the configuration service relied on the <code>Zookeeper</code> implementation, and the management backend <code>pushed</code> the changes to the gateway. Now we can support <code>WebSocket</code>, <code>Http long polling</code>, <code>Zookeeper</code>, <code>Nacos</code>, <code>Etcd</code> and <code>Consul</code>, by setting <code>shenyu.sync.${strategy}</code> in the configuration file to specify the corresponding synchronization strategy, the default is to use <code>webosocket</code> synchronization strategy to achieve second-level data synchronization. However, one thing to note is that the <code>Apache ShenYu</code> gateway and <code>shenyu-admin</code> must use the same synchronization strategy.</p> |
| <p>As shown in the figure below, <code>shenyu-admin</code> sends out configuration change notifications through <code>EventPublisher</code> after a user makes a configuration change, and <code>EventDispatcher</code> processes the change notification, and then synchronizes the data according to the configured synchronization policy (<code>http, weboscket, zookeeper, naocs, etcd, consul</code>). etcd, consul`), the configuration is sent to the corresponding event handler.</p> |
| <ul> |
| <li>If it is a <code>websocket</code> synchronization policy, the changed data will be actively pushed to <code>shenyu-web</code> and there will be a corresponding <code>WebsocketDataHandler</code> processor at the gateway layer to handle the data push from <code>shenyu-admin</code>.</li> |
| <li>In case of <code>zookeeper</code> synchronization policy, the change data will be updated to <code>zookeeper</code>, and <code>ZookeeperSyncCache</code> will listen to <code>zookeeper</code> data changes and process them.</li> |
| <li>In case of <code>http</code> synchronization policy, the gateway initiates a long polling request with <code>90s</code> timeout by default, if <code>shenyu-admin</code> has no data change, it will block the <code>http</code> request, if there is data change, it will respond with the changed data information, if more than <code>60s</code> there is still no data change, it will respond with empty data, after the gateway layer receives the response After receiving the response, the gateway layer continues to make <code>http</code> requests, repeating the same requests.</li> |
| </ul> |
| <h3 id="33-process-analysis">3.3 Process Analysis</h3> |
| <p>The process analysis shows the service registration process, data synchronization process and service invocation process from the source code perspective.</p> |
| <h4 id="331-service-registration-process">3.3.1 Service Registration Process</h4> |
| <ul> |
| <li>Reading dubbo services</li> |
| </ul> |
| <p>Use the annotation <code>@ShenyuDubboClient</code> to mark <code>dubbo</code> services that need to be registered to the gateway.</p> |
| <p>Annotation scanning is done via the <code>ApacheDubboServiceBeanListener</code>, which implements the <code>ApplicationListener&lt;ContextRefreshedEvent&gt;</code> interface and starts executing the event handler method when a context refresh event occurs during the <code>Spring</code> container startup <code>onApplicationEvent()</code>. In the rewritten method logic, the <code>Dubbo</code> service <code>ServiceBean</code> is read, the metadata object and the <code>URI</code> object are constructed and registered with <code>shenyu-admin</code>.</p> |
| <p>The specific registration logic is implemented by the registry, please refer to <code>[Client Access Principles](https://shenyu.apache.org/docs/design/register-center-design/)</code> .</p> |
| <ul> |
| <li>Processing registration information</li> |
| </ul> |
| <p>The metadata and <code>URI</code> data registered by the client through the registration center are processed at the <code>shenyu-admin</code> end, which is responsible for storing to the database and synchronizing to the <code>shenyu</code> gateway. The client-side registration processing logic of the <code>Dubbo</code> plugin is in the <code>ShenyuClientRegisterDubboServiceImpl</code>. The inheritance relationship is as follows.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/ShenyuClientRegisterDubboServiceImpl.png" alt="img"></p> |
| <ul> |
| <li>ShenyuClientRegisterService: client registration service, top-level interface.</li> |
| <li>FallbackShenyuClientRegisterService: registration failure, provides retry operation.</li> |
| <li>AbstractShenyuClientRegisterServiceImpl: abstract class, implements part of the public registration logic.</li> |
| <li>ShenyuClientRegisterDubboServiceImpl: implements the registration of <code>Dubbo</code> plug-ins.</li> |
| </ul> |
| <p>Registration information including selectors, rules and metadata.</p> |
| <p>The overall <code>dubbo</code> service registration process is as follows.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/dubbo-register-en.png" alt="img"></p> |
| <h4 id="332-data-synchronization-process">3.3.2 Data Synchronization Process</h4> |
| <ul> |
| <li>admin update data</li> |
| </ul> |
| <p>Suppose in the backend management system, a new selector data is added, the request goes to the <code>createSelector()</code> method in the <code>SelectorController</code> class, which is responsible for verifying the data, adding or updating the data, and returning the result information.</p> |
| <p>In the <code>SelectorServiceImpl</code> class, the <code>createOrUpdate()</code> method completes the conversion of the data, saves it to the database, publishes events, and updates the <code>upstream</code>.</p> |
| <p>Persistence of data is done in the <code>Service</code> class, i.e. saving data to the database. Publishing the changed data is done by <code>eventPublisher.publishEvent()</code>, the <code>eventPublisher</code> object is an <code>ApplicationEventPublisher</code> class, the fully qualified name of this class is <code>org.springframework. ApplicationEventPublisher</code>, the function of publishing data is exactly what is done through <code>Spring</code> related functions.</p> |
| <p>When the event is published, it automatically goes to the <code>onApplicationEvent()</code> method in the <code>DataChangedEventDispatcher</code> class, which handles the event according to the different data types and data synchronization methods.</p> |
| <ul> |
| <li>Gateway data synchronization</li> |
| </ul> |
| <p>At startup, the gateway loads different configuration classes and initializes data synchronization-related classes according to the specified data synchronization method.</p> |
| <p>After receiving the data, it performs deserialization operation to read the data type and operation type. Different data types have different data processing methods, so there are different implementation classes. But they also have the same processing logic between them, so they can be implemented by template method design pattern. The same logic is put in the <code>handle()</code> method in the abstract class <code>AbstractDataHandler</code>, and the different logic is given to the respective implementation classes.</p> |
| <p>Adding a new selector data is a new operation that goes to the <code>SelectorDataHandler.doUpdate()</code> concrete data processing logic.</p> |
| <p>In the common plugin data subscriber <code>CommonPluginDataSubscriber</code>, which is responsible for handling all plugin, selector and rule information</p> |
| <p>Saves data to the gateway&rsquo;s memory, <code>BaseDataCache</code> is the class that ultimately caches the data, implemented through the singleton pattern. The selector data is then stored in <code>SELECTOR_MAP</code>, a <code>Map</code>. In the subsequent use, the data is also taken from here.</p> |
| <p>The above logic is represented in a flowchart as follows.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/data-sync-seq-en.png" alt="img"></p> |
| <h4 id="333-service-invocation-process">3.3.3 Service Invocation Process</h4> |
| <p>In the <code>Dubbo</code> plugin system, the class extends relationship is as follows.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/ApacheDubboPlugin.png" alt="img"></p> |
| <blockquote> |
| <p>ShenyuPlugin: top-level interface, defining interface methods.</p> |
| <p>AbstractShenyuPlugin: abstract class that implements the common logic of the plugin; &gt; AbstractShenyuPlugin: abstract class that implements the common logic of the plugin.</p> |
| <p>AbstractDubboPlugin: dubbo plug-in abstract class, implementing <code>dubbo</code> common logic (ShenYu gateway supports ApacheDubbo and AlibabaDubbo).</p> |
| <p>ApacheDubboPlugin: ApacheDubbo plugin.</p> |
| </blockquote> |
| <ul> |
| <li>org.apache.shenyu.web.handler.ShenyuWebHandler.DefaultShenyuPluginChain#execute()</li> |
| </ul> |
| <p>After passing the <code>ShenYu</code> gateway proxy, the request entry is <code>ShenyuWebHandler</code>, which implements the <code>org.springframework.web.server.WebHandler</code> interface and connects all plugins through the chain-of-responsibility design pattern.</p> |
| <ul> |
| <li>org.apache.shenyu.plugin.base.AbstractShenyuPlugin#execute()</li> |
| </ul> |
| <p>Determining whether a plugin is executed when a request is made to the gateway is done by the specified matching logic. The matching logic for selectors and rules is executed in the <code>execute()</code> method.</p> |
| <ul> |
| <li>org.apache.shenyu.plugin.global.GlobalPlugin#execute()</li> |
| </ul> |
| <p>The first to be executed is the <code>GlobalPlugin</code> , which is a global plugin that constructs contextual information in the <code>execute()</code> method.</p> |
| <ul> |
| <li>org.apache.shenyu.plugin.base.RpcParamTransformPlugin#execute()</li> |
| </ul> |
| <p>Next to be executed is the <code>RpcParamTransformPlugin</code>, which is responsible for reading the parameters from the <code>http</code> request, saving them in the <code>exchange</code> and passing them to the <code>rpc</code> service. In the <code>execute()</code> method, the core logic of the plugin is executed: it gets the request information from <code>exchange</code> and processes the parameters according to the form of the content passed in the request.</p> |
| <ul> |
| <li>org.apache.shenyu.plugin.dubbo.common.AbstractDubboPlugin</li> |
| </ul> |
| <p>Then what gets executed is the <code>DubboPlugin</code> . In the <code>doExecute()</code> method, the main focus is on checking metadata and parameters. In the <code>doDubboInvoker()</code> method, special context information is set and then the generalized invocation of <code>dubbo</code> is started.</p> |
| <p>In the <code>genericInvoker()</code> method.</p> |
| <ul> |
| <li>Gets the <code>ReferenceConfig</code> object.</li> |
| <li>obtains the generalization service <code>GenericService</code> object.</li> |
| <li>Constructs the request parameter <code>pair</code> object.</li> |
| <li>Initiate an asynchronous generalization invocation.</li> |
| </ul> |
| <p>The generalization call enables you to call the <code>dubbo</code> service at the gateway.</p> |
| <p>The <code>ReferenceConfig</code> object is the key object that supports generalization calls, and its initialization is done during data synchronization.</p> |
| <ul> |
| <li>org.apache.shenyu.plugin.response.ResponsePlugin#execute()</li> |
| </ul> |
| <p>The last one to be executed is <code>ResponsePlugin</code>, which unifies the response result messages of the gateway. The processing type is determined by the <code>MessageWriter</code>, and the class extends relationship is as follows.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/MessageWriter.png" alt="img"></p> |
| <blockquote> |
| <p>MessageWriter: interface that defines message processing methods.</p> |
| <p>NettyClientMessageWriter: Handles the results of <code>Netty</code> calls.</p> |
| <p>RPCMessageWriter: processing the results of <code>RPC</code> calls.</p> |
| <p>WebClientMessageWriter: processing the results of <code>WebClient</code> calls;</p> |
| </blockquote> |
| <p>The <code>Dubbo</code> service is called and the result of processing is the <code>RPCMessageWriter</code>.</p> |
| <ul> |
| <li>org.apache.shenyu.plugin.response.strategy.RPCMessageWriter#writeWith()</li> |
| </ul> |
| <p>Process the response results in the <code>writeWith()</code> method, get the results or handle exceptions.</p> |
| <p>At this point in the analysis, the source code analysis of the <code>Dubbo</code> plugin is complete, and the analysis flowchart is as follows.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/shenyu-dubbo/dubbo-execute-en.png" alt="img"></p> |
| <h2 id="4-summary">4. Summary</h2> |
| <p>This article analyzes the proxy process of <code>ShenYu</code> gateway to Dubbo service from a practical case. The main knowledge points involved are as follows.</p> |
| <ul> |
| <li>Implementing plug-ins through the chain-of-responsibility design pattern.</li> |
| <li>implementing <code>AbstractShenyuPlugin</code> using the template method design pattern to handle generic operation types.</li> |
| <li>implementation of the cached data class <code>BaseDataCache</code> using the singleton design pattern.</li> |
| <li>the ability to introduce different registries and number synchronization methods through the <code>springboot starter</code>, which is very scalable.</li> |
| <li>support for hot updates of rules through <code>admin</code> to facilitate traffic control.</li> |
| <li><code>Disruptor</code> queue is for data and operation decoupling, as well as data buffering.</li> |
| </ul></description></item><item><title>Blog: Makes it More Convenient for You to Proxy Dubbo Services in Apache APISIX</title><link>https://dubbo.apache.org/en/blog/2022/01/18/makes-it-more-convenient-for-you-to-proxy-dubbo-services-in-apache-apisix/</link><pubDate>Tue, 18 Jan 2022 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2022/01/18/makes-it-more-convenient-for-you-to-proxy-dubbo-services-in-apache-apisix/</guid><description> |
| <h2 id="background">Background</h2> |
| <p><a href="https://dubbo.apache.org/en/">Apache Dubbo</a> is a MicroService development framework open sourced by Alibaba and donated to Apache, which provides two key capabilities of RPC communication and microservice governance. It has not only been validated by Ali&rsquo;s massive traffic in e-commerce scenario, but also been widely implemented in domestic technology companies.</p> |
| <p>In practical application scenarios, Apache Dubbo is generally used as the implementation framework for RPC calls between back-end systems, and when HTTP interfaces need to be provided to the front-end, the Dubbo Service is packaged as an HTTP interface through a &ldquo;glue layer&rdquo; and then delivered to the front-end system.</p> |
| <p><a href="https://apisix.apache.org/">Apache APISIX</a> is the top open source project of Apache Software Foundation and the most active open source gateway project today. As a dynamic, real-time, high-performance open source API gateway, Apache APISIX provides rich traffic management features such as load balancing, dynamic upstream, grayscale publishing, service meltdown, authentication, observability, and more.</p> |
| <p>Benefiting from the advantages of Apache Dubbo application scenarios, Apache APISIX is based on the open source project tengine/mod_dubbo module to equip Apache Dubbo services with HTTP gateway capabilities. Dubbo Service can be easily published as an HTTP service via the dubbo-proxy plugin.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/apisix-plugin/1.png" alt="Architecture Diagram"></p> |
| <h2 id="how-to-use">How to use</h2> |
| <h3 id="getting-started-installation-and-use">Getting Started: Installation and Use</h3> |
| <blockquote> |
| <p>Here we recommend using the Apache APISIX version 2.11 image for installation. This version of APISIX-Base has the Dubbo module compiled by default, so you can use the <code>dubbo-proxy</code> plugin directly.</p> |
| </blockquote> |
| <p>In the next steps, we will use the <a href="https://github.com/apache/dubbo-samples"><code>dubbo-samples</code></a> project for a partial demonstration. This project is a demo application implemented using Apache Dubbo, and in this article we use one of the sub-modules as the Dubbo Provider.</p> |
| <p>Before we get into the action, let&rsquo;s take a brief look at the definition, configuration, and implementation of the Dubbo interface.</p> |
| <h4 id="interface-implementation">Interface implementation</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">DemoService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * standard samples dubbo infterace demo |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param context pass http infos |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return Map&lt;String, Object&gt;&lt;/&gt; pass to response http |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> **/</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">apisixDubbo</span>(Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> httpRequestContext); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>As shown above, the Dubbo interface is defined in a fixed way. The <code>Map</code> of method parameters represents the information passed by APISIX to the Dubbo Provider about the HTTP request (e.g. header, body, &hellip;). The <code>Map</code> of the method return value indicates how the Dubbo Provider passes some information to APISIX about the HTTP response to be returned.</p> |
| <p>After the interface information, the DemoService can be published via XML configuration.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- service implementation, as same as regular local bean --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.samples.provider.DemoServiceImpl&#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;!-- declare the service interface to be exported --&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.apisix.DemoService&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>After the above configuration, the Consumer can access the <code>apisixDubbo</code> method through <code>org.apache.dubbo.samples.apisix.DemoService</code> The specific interface implementation is as follows.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">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 style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">apisixDubbo</span>(Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> httpRequestContext) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (Map.Entry<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> entry : httpRequestContext.entrySet()) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Key = &#34;</span> <span style="color:#719e07">+</span> entry.getKey() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, Value = &#34;</span> <span style="color:#719e07">+</span> entry.getValue()); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> ret <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> ret.put(<span style="color:#2aa198">&#34;body&#34;</span>, <span style="color:#2aa198">&#34;dubbo success\n&#34;</span>); <span style="color:#586e75">// http response body</span> |
| </span></span><span style="display:flex;"><span> ret.put(<span style="color:#2aa198">&#34;status&#34;</span>, <span style="color:#2aa198">&#34;200&#34;</span>); <span style="color:#586e75">// http response status</span> |
| </span></span><span style="display:flex;"><span> ret.put(<span style="color:#2aa198">&#34;test&#34;</span>, <span style="color:#2aa198">&#34;123&#34;</span>); <span style="color:#586e75">// http response header</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> ret; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>:::note |
| In the above code, <code>DemoServiceImpl</code> prints the received <code>httpRequestContext</code> and describes the HTTP response to the Dubbo request by returning a Map object with the specified Key. |
| :::</p> |
| <h4 id="operation-steps">Operation steps</h4> |
| <ol> |
| <li>Start <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-tengine#install-dubbo"><code>dubbo-samples</code></a>.</li> |
| <li>Enable the <code>dubbo-proxy</code> plugin in the <code>config.yaml</code> file.</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-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#586e75"># Add this in config.yaml</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">plugins</span>: |
| </span></span><span style="display:flex;"><span> - ... <span style="color:#586e75"># plugin you need</span> |
| </span></span><span style="display:flex;"><span> - dubbo-proxy |
| </span></span></code></pre></div><ol start="3"> |
| <li>Create an Upstream that points to the Dubbo Provider.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>curl http://127.0.0.1:9180/apisix/admin/upstreams/1 -H <span style="color:#2aa198">&#39;X-API-KEY: edd1c9f034335f136f87ad84b625c8f1&#39;</span> -X PUT -d <span style="color:#2aa198">&#39; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198">{ |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;nodes&#34;: { |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;127.0.0.1:20880&#34;: 1 |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> }, |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;type&#34;: &#34;roundrobin&#34; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198">}&#39;</span> |
| </span></span></code></pre></div><ol start="4"> |
| <li>Expose an HTTP route for the DemoService.</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-shell" data-lang="shell"><span style="display:flex;"><span>curl http://127.0.0.1:9180/apisix/admin/routes/1 -H <span style="color:#2aa198">&#39;X-API-KEY: edd1c9f034335f136f87ad84b625c8f1&#39;</span> -X PUT -d <span style="color:#2aa198">&#39; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198">{ |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;host&#34;: &#34;example.org&#34; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;uris&#34;: [ |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;/demo&#34; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> ], |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;plugins&#34;: { |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;dubbo-proxy&#34;: { |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;service_name&#34;: &#34;org.apache.dubbo.samples.apisix.DemoService&#34;, |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;service_version&#34;: &#34;0.0.0&#34;, |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;method&#34;: &#34;apisixDubbo&#34; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> } |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> }, |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;upstream_id&#34;: 1 |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198">}&#39;</span> |
| </span></span></code></pre></div><ol start="5"> |
| <li>Use the curl command to request Apache APISIX and view the returned results.</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-shell" data-lang="shell"><span style="display:flex;"><span>curl http://127.0.0.1:9080/demo -H <span style="color:#2aa198">&#34;Host: example.org&#34;</span> -X POST --data <span style="color:#2aa198">&#39;{&#34;name&#34;: &#34;hello&#34;}&#39;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>&lt; HTTP/1.1 <span style="color:#2aa198">200</span> OK |
| </span></span><span style="display:flex;"><span>&lt; Date: Sun, <span style="color:#2aa198">26</span> Dec <span style="color:#2aa198">2021</span> 11:33:27 GMT |
| </span></span><span style="display:flex;"><span>&lt; Content-Type: text/plain; <span style="color:#268bd2">charset</span><span style="color:#719e07">=</span>utf-8 |
| </span></span><span style="display:flex;"><span>&lt; Content-Length: <span style="color:#2aa198">14</span> |
| </span></span><span style="display:flex;"><span>&lt; Connection: keep-alive |
| </span></span><span style="display:flex;"><span>&lt; test: <span style="color:#2aa198">123</span> |
| </span></span><span style="display:flex;"><span>&lt; Server: APISIX/2.11.0 |
| </span></span><span style="display:flex;"><span>&lt; |
| </span></span><span style="display:flex;"><span>dubbo success |
| </span></span></code></pre></div><p>:::note |
| The above code returns the <code>test: 123</code> Header, and the <code>dubbo success</code> string as the body. This is the same as what we expected in the <code>DemoServiceImpl</code> code. |
| :::</p> |
| <ol start="6"> |
| <li>You can view the logs of the Dubbo Provider.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>Key = content-length, Value = 17 |
| </span></span><span style="display:flex;"><span>Key = host, Value = example.org |
| </span></span><span style="display:flex;"><span>Key = content-type, Value = application/x-www-form-urlencoded |
| </span></span><span style="display:flex;"><span>Key = body, Value = [B@70754265 |
| </span></span><span style="display:flex;"><span>Key = accept, Value = */* |
| </span></span><span style="display:flex;"><span>Key = user-agent, Value = curl/7.80.0 |
| </span></span></code></pre></div><p>:::note |
| The Header and Body of the HTTP request are available through the <code>httpRequestContext</code>, where the Header is used as a Map element, while the Body has a fixed string &ldquo;body&rdquo; as the Key value and a Byte array as the Value. |
| :::</p> |
| <h3 id="advanced-complex-scenario-example">Advanced: Complex Scenario Example</h3> |
| <p>As you can see in the simple use case above, we do publish Dubbo Service as an HTTP service via Apache APISIX, but there are obvious limitations in its use. For example, the parameters and return values of the interface must be <code>Map&lt;String, Object&gt;</code>.</p> |
| <p>So, how do you expose the HTTP service through Apache APISIX if there is an interface in your project that is already defined, but does not meet the above restrictions?</p> |
| <h4 id="operation-steps-1">Operation steps</h4> |
| <p>For the above scenario, we can use the HTTP Request Body to describe the Service and Method to be invoked and the corresponding parameters, and then use the reflection mechanism of Java to realize the invocation of the target method. Finally, the return value is serialized to JSON and written to the HTTP Response Body.</p> |
| <p>This will further enhance the &ldquo;HTTP to Dubbo&rdquo; capability of Apache APISIX and apply it to all existing Dubbo services. For details, see the following.</p> |
| <ol> |
| <li>Add a Dubbo Service for existing projects to handle HTTP to Dubbo conversions in a unified way.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DubboInvocationParameter</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String type; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String value; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DubboInvocation</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String service; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String method; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> DubboInvocationParameter<span style="color:#719e07">[]</span> parameters; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">HTTP2DubboService</span> { |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">invoke</span>(Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> context) <span style="color:#268bd2">throws</span> Exception; |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#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">HTTP2DubboServiceImpl</span> <span style="color:#268bd2">implements</span> HTTP2DubboService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Autowired</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> ApplicationContext appContext; |
| </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> Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">invoke</span>(Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> context) <span style="color:#268bd2">throws</span> Exception { |
| </span></span><span style="display:flex;"><span> DubboInvocation invocation <span style="color:#719e07">=</span> JSONObject.parseObject((<span style="color:#dc322f">byte</span><span style="color:#719e07">[]</span>) context.get(<span style="color:#2aa198">&#34;body&#34;</span>), DubboInvocation.class); |
| </span></span><span style="display:flex;"><span> Object<span style="color:#719e07">[]</span> args <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Object<span style="color:#719e07">[</span>invocation.getParameters().size()<span style="color:#719e07">]</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> 0; i <span style="color:#719e07">&lt;</span> args.length; i<span style="color:#719e07">++</span>) { |
| </span></span><span style="display:flex;"><span> DubboInvocationParameter parameter <span style="color:#719e07">=</span> invocation.getParameters().get(i); |
| </span></span><span style="display:flex;"><span> args<span style="color:#719e07">[</span>i<span style="color:#719e07">]</span> <span style="color:#719e07">=</span> JSONObject.parseObject(parameter.getValue(), Class.forName(parameter.getType())); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Object svc <span style="color:#719e07">=</span> appContext.getBean(Class.forName(invocation.getService())); |
| </span></span><span style="display:flex;"><span> Object result <span style="color:#719e07">=</span> svc.getClass().getMethod(invocation.getMethod()).invoke(args); |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> httpResponse <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> httpResponse.put(<span style="color:#2aa198">&#34;status&#34;</span>, 200); |
| </span></span><span style="display:flex;"><span> httpResponse.put(<span style="color:#2aa198">&#34;body&#34;</span>, JSONObject.toJSONString(result)); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> httpResponse; |
| </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><ol start="2"> |
| <li>Initiate the relevant call with the following command request.</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-shell" data-lang="shell"><span style="display:flex;"><span>curl http://127.0.0.1:9080/demo -H <span style="color:#2aa198">&#34;Host: example.org&#34;</span> -X POST --data <span style="color:#2aa198">&#39; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198">{ |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;service&#34;: &#34;org.apache.dubbo.samples.apisix.DemoService&#34;, |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;method&#34;: &#34;createUser&#34;, |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;parameters&#34;: [ |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> { |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;type&#34;: &#34;org.apache.dubbo.samples.apisix.User&#34;, |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> &#34;value&#34;: &#34;{&#39;</span>name<span style="color:#2aa198">&#39;: &#39;</span>hello<span style="color:#2aa198">&#39;}&#34; |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> } |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> ] |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198">}&#39;</span> |
| </span></span></code></pre></div><h2 id="summary">Summary</h2> |
| <p>In this article, we introduced how to use Apache APISIX to implement a proxy for Dubbo Service. By introducing the <code>dubbo-proxy</code> plugin, you can build a simpler and more efficient traffic link for the back-end system of Dubbo framework.</p> |
| <p>We hope that the above steps and use cases will provide you with ideas for using it in relevant scenarios. For more information about the <code>dubbo-proxy</code> plugin, please refer to the <a href="https://apisix.apache.org/docs/apisix/plugins/dubbo-proxy/">official documentation</a>.</p></description></item><item><title>Blog: 2.7.14 Release Note</title><link>https://dubbo.apache.org/en/blog/2021/09/20/2.7.14-release-note/</link><pubDate>Mon, 20 Sep 2021 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2021/09/20/2.7.14-release-note/</guid><description> |
| <h2 id="change-lists">Change Lists</h2> |
| <ul> |
| <li>add Dynamic Configuration Override Support For ServiceDiscovery. (#8389)</li> |
| <li>fix mock parameters doesn&rsquo;t work when it contain &lsquo;:&rsquo; or &lsquo;=&rsquo;. (#8379)</li> |
| <li>fix the issue of taking the zone parameter value in ZoneAwareClusterInvoker. (#8521)</li> |
| <li>add the switch for check class is in serialize white list , default is true. (#8537)</li> |
| <li>fix NPE on serialization checking when request timed out. (#8587)</li> |
| <li>fix NetUtils.ignoreNetworkInterface can&rsquo;t process network card name contains &lsquo;(&rsquo; symbol. (#8629)</li> |
| <li>unify the way of getting local address. (#8679)</li> |
| <li>fix retries param didn&rsquo;t work well when it is 0. (#8743)</li> |
| <li>close client immediately when destroy unused invoker. (#8756)</li> |
| <li>fix destroy IllegalStateException and doOverrideIfNecessary NPE. (#8683)</li> |
| <li>show message according to log level when DefaultFuture.closeChannel. (#8778)</li> |
| <li>use MapUtils instead of AttachmentsAdapter. (#8772)</li> |
| </ul> |
| <h2 id="dependency-changes">Dependency Changes</h2> |
| <ul> |
| <li>netty4: 4.1.51.Final -&gt; 4.1.66.Final</li> |
| <li>netty4_ssl: 2.0.39.Final -&gt; 2.0.40.Final</li> |
| <li>http_client: 4.5.3 -&gt; 4.5.13</li> |
| <li>jetty: 9.4.11.v20180605 -&gt; 9.4.43.v20210629</li> |
| <li>apollo_client: 1.1.1 -&gt; 1.8.0</li> |
| <li>tomcat_embed: 8.5.31-&gt; 9.0.48</li> |
| <li>commons_io: 2.6 -&gt; 2.7</li> |
| <li>curator: 5.0.0 -&gt; 5.1.0</li> |
| <li>hessian_lite: 3.2.8 -&gt; 3.2.11</li> |
| </ul></description></item><item><title>Blog: 3.0.2.1 Release Note</title><link>https://dubbo.apache.org/en/blog/2021/08/23/3.0.2.1-release-note/</link><pubDate>Mon, 23 Aug 2021 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2021/08/23/3.0.2.1-release-note/</guid><description> |
| <p>This is a bugfix version of 3.0.2. |
| Exactly the same as version 3.0.2, except for the following changes.</p> |
| <h2 id="bugfix">Bugfix</h2> |
| <ul> |
| <li>Fix nacos group inviable in consumer side (#8533)</li> |
| <li>Fix NPE on serialization checking when request timed out (#8547)</li> |
| <li>Compact with dubbo-all without farbic-io (#8546)</li> |
| </ul></description></item><item><title>Blog: 3.0.2 Release Note</title><link>https://dubbo.apache.org/en/blog/2021/08/18/3.0.2-release-note/</link><pubDate>Wed, 18 Aug 2021 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2021/08/18/3.0.2-release-note/</guid><description> |
| <h2 id="features">Features</h2> |
| <ul> |
| <li>improve generic service with @DubboService annotation.</li> |
| <li>metadata report config support xml to config protocol and port.</li> |
| <li>compatible for curator5.</li> |
| <li>p2p invoke support wildcard url match.</li> |
| <li>add Dynamic Configuration Override Support For ServiceDiscovery.</li> |
| <li>add provider configuration override disable option.</li> |
| <li>support native image.</li> |
| <li>support disable shutdown hook.</li> |
| <li>add Kubernetes Mesh Rule support.</li> |
| <li>support SSL at netty transport.</li> |
| </ul> |
| <h2 id="bugfixs">BugFixs</h2> |
| <ul> |
| <li>fix re-start override dynamic config.</li> |
| <li>fix delete configurators does not take effect.</li> |
| <li>fix triple protocol will throw exception when the service is exposed.</li> |
| <li>fix ConfigCenterConfig.setAddress will override username problem.</li> |
| <li>fix DefaultFuture.closeChannel will shutdown ExecutorService.</li> |
| <li>fix TripleClientHandler#writeRequest throwing NPE problem.</li> |
| <li>fix NPE when parse migration rule error happen.</li> |
| <li>fix Activated Extensions order.</li> |
| <li>fix URLAddress#parse method to judge the isPathAddress problem when the address is ipv6.</li> |
| <li>fix custom parameter in configuration properties does not work.</li> |
| <li>fix Config id Override when both using API and Spring.</li> |
| <li>fix service discovery not work on bootstrap &amp; fix address pollution.</li> |
| <li>fix nacos registry can&rsquo;t received instance change notify.</li> |
| <li>fix could not resolve placeholder &lsquo;${dubbo.application}&rsquo; in xml.</li> |
| <li>fix service parameter fetch order.</li> |
| <li>fix error of register dubbo bootstrap application listener manually.</li> |
| <li>fix mock parameters doesn&rsquo;t work when it contain &lsquo;:&rsquo; or &lsquo;=&rsquo;.</li> |
| <li>fix delete mesh rule npe.</li> |
| </ul> |
| <h2 id="optimization">Optimization</h2> |
| <ul> |
| <li>add exception catch for RemovalTask, ensure semaphore release.</li> |
| <li>check duplicated ReferenceConfig/ServiceConfig by unique service name.</li> |
| <li>improve the performance for generating random numbers.</li> |
| <li>if user define interface service discovery, not publish service name mapping info.</li> |
| <li>use StringBuilder#append(Char) to improve performance.</li> |
| <li>gRPC Compile class interface order.</li> |
| <li>improve property placeholder resolving of reference bean.</li> |
| <li>use CompletableFuture#get(long, TimeUnit) to take place of CompletableFuture#get() in MergeableClusterInvoker.</li> |
| <li>service delay export config ignore metadata service.</li> |
| <li>improve dubbo config beans and bootstrap initialization.</li> |
| <li>improve duplicated config checking and add tests for reference annotation.</li> |
| <li>replace with ring for registry notification &amp; suppress property checker.</li> |
| <li>improve dynamic configuration initialization.</li> |
| <li>lock-free ConfigManager and improve config checking.</li> |
| <li>modify metadata equals and instance listener.</li> |
| <li>improve async export / refer.</li> |
| <li>use TreeSet to ensure ServiceNames order when subscribe.</li> |
| <li>make first tenth calls notify not delay RegistryNotifier.</li> |
| <li>refactor compiler to generate new format stubs.</li> |
| <li>change mesh rule group to config default value.</li> |
| <li>compatible with nacos grouping via group.</li> |
| <li>remove runtime params in ServiceInfo.</li> |
| <li>throw RpcException when NacosException occurred.</li> |
| <li>configcenter ban accessLogKey and FileRouterFactory key.</li> |
| <li>improve config bean initialization compatible with spring 3.x/4.1.x.</li> |
| <li>dubbo bootstrap start re-entry, export/refer new services.</li> |
| <li>org.apache.dubbo.* add serialization whitelist.</li> |
| <li>ensure generated config id is unique, checking existed config.</li> |
| <li>compatible with filed change declaration override for Javaassist.</li> |
| <li>refactor Codec check, default deny.</li> |
| <li>compatible with adaptive extensions when ApplicationModel is null.</li> |
| </ul> |
| <h2 id="code-improvement">Code Improvement</h2> |
| <p>Thanks for these contribution to improve stability of Apache Dubbo.</p> |
| <p><a href="https://github.com/apache/dubbo/pull/8111">#8111</a>, |
| <a href="https://github.com/apache/dubbo/pull/8147">#8147</a>, |
| <a href="https://github.com/apache/dubbo/pull/8164">#8164</a>, |
| <a href="https://github.com/apache/dubbo/pull/8177">#8177</a>, |
| <a href="https://github.com/apache/dubbo/pull/8180">#8180</a>, |
| <a href="https://github.com/apache/dubbo/pull/8161">#8161</a>, |
| <a href="https://github.com/apache/dubbo/pull/8183">#8183</a>, |
| <a href="https://github.com/apache/dubbo/pull/8205">#8205</a>, |
| <a href="https://github.com/apache/dubbo/pull/8173">#8173</a>, |
| <a href="https://github.com/apache/dubbo/pull/8219">#8219</a>, |
| <a href="https://github.com/apache/dubbo/pull/8228">#8228</a>, |
| <a href="https://github.com/apache/dubbo/pull/8232">#8232</a>, |
| <a href="https://github.com/apache/dubbo/pull/8230">#8230</a>, |
| <a href="https://github.com/apache/dubbo/pull/8236">#8236</a>, |
| <a href="https://github.com/apache/dubbo/pull/8260">#8260</a>, |
| <a href="https://github.com/apache/dubbo/pull/8262">#8262</a>, |
| <a href="https://github.com/apache/dubbo/pull/8252">#8252</a>, |
| <a href="https://github.com/apache/dubbo/pull/8246">#8246</a>, |
| <a href="https://github.com/apache/dubbo/pull/8208">#8208</a>, |
| <a href="https://github.com/apache/dubbo/pull/8278">#8278</a>, |
| <a href="https://github.com/apache/dubbo/pull/8267">#8267</a>, |
| <a href="https://github.com/apache/dubbo/pull/8277">#8277</a>, |
| <a href="https://github.com/apache/dubbo/pull/8291">#8291</a>, |
| <a href="https://github.com/apache/dubbo/pull/8296">#8296</a>, |
| <a href="https://github.com/apache/dubbo/pull/8302">#8302</a>, |
| <a href="https://github.com/apache/dubbo/pull/8175">#8175</a>, |
| <a href="https://github.com/apache/dubbo/pull/8319">#8319</a>, |
| <a href="https://github.com/apache/dubbo/pull/8309">#8309</a>, |
| <a href="https://github.com/apache/dubbo/pull/8336">#8336</a>, |
| <a href="https://github.com/apache/dubbo/pull/8332">#8332</a>, |
| <a href="https://github.com/apache/dubbo/pull/8328">#8328</a>, |
| <a href="https://github.com/apache/dubbo/pull/8355">#8355</a>, |
| <a href="https://github.com/apache/dubbo/pull/8396">#8396</a>, |
| <a href="https://github.com/apache/dubbo/pull/8401">#8401</a>, |
| <a href="https://github.com/apache/dubbo/pull/8395">#8395</a>, |
| <a href="https://github.com/apache/dubbo/pull/8415">#8415</a>, |
| <a href="https://github.com/apache/dubbo/pull/8406">#8406</a>, |
| <a href="https://github.com/apache/dubbo/pull/8411">#8411</a>, |
| <a href="https://github.com/apache/dubbo/pull/8418">#8418</a>, |
| <a href="https://github.com/apache/dubbo/pull/8439">#8439</a>, |
| <a href="https://github.com/apache/dubbo/pull/8404">#8404</a>, |
| <a href="https://github.com/apache/dubbo/pull/8443">#8443</a></p> |
| <h2 id="dependency-changes">Dependency Changes</h2> |
| <ul> |
| <li>remove dependency: org.eclipse.collections:eclipse-collections</li> |
| <li>remove dependency: com.google.guava:guava</li> |
| <li>jetty: 9.4.11.v20180605 -&gt; 9.4.43.v20210629</li> |
| <li>apollo client: 1.1.1 -&gt; 1.8.0</li> |
| <li>snakeyaml: 1.20 -&gt; 1.29</li> |
| <li>tomcat embed: 8.5.31 -&gt; 8.5.69</li> |
| <li>nacos client: 2.0.0 -&gt; 2.0.2</li> |
| <li>swagger: 1.5.19 -&gt; 1.5.24</li> |
| <li>hessian_lite: 3.2.8 -&gt; 3.2.11</li> |
| </ul></description></item><item><title>Blog: 3.0.1 Release Note</title><link>https://dubbo.apache.org/en/blog/2021/07/02/3.0.1-release-note/</link><pubDate>Fri, 02 Jul 2021 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2021/07/02/3.0.1-release-note/</guid><description> |
| <h2 id="optimization">Optimization</h2> |
| <ul> |
| <li>Refactor NameMapping to Metadata, Support application field in MigrationRule</li> |
| <li>Add cache for scan result</li> |
| <li>Improve config overrides of method and argument</li> |
| <li>Support servlet takeover mode</li> |
| <li>Add ServiceListener for ServiceConfig</li> |
| <li>Improve method callback</li> |
| </ul> |
| <h2 id="bugfixs">BugFixs</h2> |
| <ul> |
| <li>Add force check</li> |
| <li>Fix multi-registry will destroy unavailable clusters</li> |
| <li>Remove needless toString convert &amp; Enable checking by default</li> |
| <li>Ignore invalid MetadataReportConfig</li> |
| <li>Fix NPE when consumer start</li> |
| <li>Fix some compatiable issues</li> |
| <li>Optimize Service related issues</li> |
| <li>Opt Migration &amp; Fix reSubscribe for ServiceDiscovery</li> |
| <li>Fix NPE in MetadataInfo</li> |
| <li>Fix customizer not changed</li> |
| </ul> |
| <h2 id="code-improvement">Code Improvement</h2> |
| <p>Thanks for these contribution to improve stability of Apache Dubbo.</p> |
| <p><a href="https://github.com/apache/dubbo/pull/8043">#8043</a>, |
| <a href="https://github.com/apache/dubbo/pull/8044">#8044</a>, |
| <a href="https://github.com/apache/dubbo/pull/8048">#8048</a>, |
| <a href="https://github.com/apache/dubbo/pull/8071">#8071</a>, |
| <a href="https://github.com/apache/dubbo/pull/8119">#8119</a>, |
| <a href="https://github.com/apache/dubbo/pull/8132">#8132</a></p></description></item><item><title>Blog: Past Releases</title><link>https://dubbo.apache.org/en/blog/2020/05/18/past-releases/</link><pubDate>Mon, 18 May 2020 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2020/05/18/past-releases/</guid><description> |
| <div class="pageinfo pageinfo-primary"> |
| <p>This document is no longer maintained. You are currently viewing a snapshot version. If you want to see the latest version of the documentation, see <a href="https://dubbo.apache.org/en/release/">Latest Version</a>.</p> |
| </div> |
| <h2 id="verification">Verification</h2> |
| <p>you can follow these <a href="https://www.apache.org/info/verification">procedures</a> and the <a href="https://downloads.apache.org/dubbo/KEYS">KEYS</a> file to verify the download files</p> |
| <h2 id="apache-dubbo">Apache Dubbo</h2> |
| <blockquote> |
| <p>GitHub: <a href="https://github.com/apache/dubbo">https://github.com/apache/dubbo</a> <br> |
| Release Notes: <a href="https://github.com/apache/dubbo/releases">https://github.com/apache/dubbo/releases</a></p> |
| </blockquote> |
| <h3 id="320-beta3-2022-12-22">3.2.0-beta.3 (2022-12-22)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/dubbo/3.2.0-beta.3/apache-dubbo-3.2.0-beta.3-src.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/3.2.0-beta.3/apache-dubbo-3.2.0-beta.3-src.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/3.2.0-beta.3/apache-dubbo-3.2.0-beta.3-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="313-2022-12-22">3.1.3 (2022-12-22)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/dubbo/3.1.4/apache-dubbo-3.1.4-src.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/3.1.4/apache-dubbo-3.1.4-src.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/3.1.4/apache-dubbo-3.1.4-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2719-2022-12-13">2.7.19 (2022-12-13)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/dubbo/2.7.19/apache-dubbo-2.7.19-src.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.7.19/apache-dubbo-2.7.19-src.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.7.19/apache-dubbo-2.7.19-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="320-beta2-2022-11-28">3.2.0-beta.2 (2022-11-28)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.2.0-beta.2/apache-dubbo-3.2.0-beta.2-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.2.0-beta.2/apache-dubbo-3.2.0-beta.2-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.2.0-beta.2/apache-dubbo-3.2.0-beta.2-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="313-2022-11-28">3.1.3 (2022-11-28)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.1.3/apache-dubbo-3.1.3-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.3/apache-dubbo-3.1.3-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.3/apache-dubbo-3.1.3-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="320-beta1-2022-11-08">3.2.0-beta.1 (2022-11-08)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.2.0-beta.1/apache-dubbo-3.2.0-beta.1-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.2.0-beta.1/apache-dubbo-3.2.0-beta.1-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.2.0-beta.1/apache-dubbo-3.2.0-beta.1-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="312-2022-11-08">3.1.2 (2022-11-08)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.1.2/apache-dubbo-3.1.2-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.2/apache-dubbo-3.1.2-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.2/apache-dubbo-3.1.2-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="311-2022-09-29">3.1.1 (2022-09-29)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.1.1/apache-dubbo-3.1.1-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.1/apache-dubbo-3.1.1-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.1/apache-dubbo-3.1.1-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="3012-2022-09-29">3.0.12 (2022-09-29)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/dubbo/3.0.12/apache-dubbo-3.0.12-src.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/3.0.12/apache-dubbo-3.0.12-src.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/3.0.12/apache-dubbo-3.0.12-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2718-2022-09-29">2.7.18 (2022-09-29)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.18/apache-dubbo-2.7.18-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.18/apache-dubbo-2.7.18-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.18/apache-dubbo-2.7.18-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2717-2022-08-23">2.7.17 (2022-08-23)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.17/apache-dubbo-2.7.17-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.17/apache-dubbo-2.7.17-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.17/apache-dubbo-2.7.17-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="3011-2022-08-23">3.0.11 (2022-08-23)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.11/apache-dubbo-3.0.11-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.11/apache-dubbo-3.0.11-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.11/apache-dubbo-3.0.11-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="310-2022-08-22">3.1.0 (2022-08-22)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.1.0/apache-dubbo-3.1.0-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.0/apache-dubbo-3.1.0-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.1.0/apache-dubbo-3.1.0-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="3010-2022-07-21">3.0.10 (2022-07-21)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.10/apache-dubbo-3.0.10-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.10/apache-dubbo-3.0.10-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.10/apache-dubbo-3.0.10-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2716-2022-07-06">2.7.16 (2022-07-06)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.16/apache-dubbo-2.7.16-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.16/apache-dubbo-2.7.16-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.16/apache-dubbo-2.7.16-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="309-2022-06-23">3.0.9 (2022-06-23)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.9/apache-dubbo-3.0.9-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.9/apache-dubbo-3.0.9-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.9/apache-dubbo-3.0.9-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="308-2022-05-11">3.0.8 (2022-05-11)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.8/apache-dubbo-3.0.8-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.8/apache-dubbo-3.0.8-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.8/apache-dubbo-3.0.8-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="307-2022-04-01">3.0.7 (2022-04-01)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.7/apache-dubbo-3.0.7-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.7/apache-dubbo-3.0.7-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.7/apache-dubbo-3.0.7-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="306-2022-02-28">3.0.6 (2022-02-28)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.6/apache-dubbo-3.0.6-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.6/apache-dubbo-3.0.6-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.6/apache-dubbo-3.0.6-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="305-2021-12-30">3.0.5 (2021-12-30)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.5/apache-dubbo-3.0.5-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.5/apache-dubbo-3.0.5-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.5/apache-dubbo-3.0.5-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2715-2021-12-29">2.7.15 (2021-12-29)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.15/apache-dubbo-2.7.15-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.15/apache-dubbo-2.7.15-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.15/apache-dubbo-2.7.15-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2612-2021-12-29">2.6.12 (2021-12-29)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.12/apache-dubbo-2.6.12-src.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.12/apache-dubbo-v-src.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.12/apache-dubbo-2.6.12-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="304-2021-10-24">3.0.4 (2021-10-24)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.4/apache-dubbo-3.0.4-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.4/apache-dubbo-3.0.4-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.4/apache-dubbo-3.0.4-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="303-2021-09-27">3.0.3 (2021-09-27)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.3/apache-dubbo-3.0.3-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.3/apache-dubbo-3.0.3-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.3/apache-dubbo-3.0.3-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2714-2021-09-20">2.7.14 (2021-09-20)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.14/apache-dubbo-2.7.14-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.14/apache-dubbo-2.7.14-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.14/apache-dubbo-2.7.14-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2611-2021-09-18">2.6.11 (2021-09-18)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.cgi?path=dubbo/2.6.11/apache-dubbo-2.6.11-source-release.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.cgi?path=dubbo/2.6.11/apache-dubbo-2.6.11-source-release.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.cgi?path=dubbo/2.6.11/apache-dubbo-2.6.11-source-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="3021-2021-08-23">3.0.2.1 (2021-08-23)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.2.1/apache-dubbo-3.0.2.1-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.2.1/apache-dubbo-3.0.2.1-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.2.1/apache-dubbo-3.0.2.1-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="302-2021-08-16">3.0.2 (2021-08-16)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.2/apache-dubbo-3.0.2-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.2/apache-dubbo-3.0.2-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.2/apache-dubbo-3.0.2-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2713-2021-08-05">2.7.13 (2021-08-05)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.13/apache-dubbo-2.7.13-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.13/apache-dubbo-2.7.13-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.13/apache-dubbo-2.7.13-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="301-2021-07-02">3.0.1 (2021-07-02)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.1/apache-dubbo-3.0.1-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.1/apache-dubbo-3.0.1-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.1/apache-dubbo-3.0.1-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="300-2021-06-16">3.0.0 (2021-06-16)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/3.0.0/apache-dubbo-3.0.0-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.0/apache-dubbo-3.0.0-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/3.0.0/apache-dubbo-3.0.0-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2712-2021-06-11">2.7.12 (2021-06-11)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.12/apache-dubbo-2.7.12-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.12/apache-dubbo-2.7.12-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.12/apache-dubbo-2.7.12-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2711-2021-05-12">2.7.11 (2021-05-12)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.11/apache-dubbo-2.7.11-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.11/apache-dubbo-2.7.11-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.11/apache-dubbo-2.7.11-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2710-2021-04-08">2.7.10 (2021-04-08)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.10/apache-dubbo-2.7.10-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.10/apache-dubbo-2.7.10-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.10/apache-dubbo-2.7.10-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="279-2020-02-23">2.7.9 (2020-02-23)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.9/apache-dubbo-2.7.9-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.9/apache-dubbo-2.7.9-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.9/apache-dubbo-2.7.9-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="278-2020-07-28">2.7.8 (2020-07-28)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.8/apache-dubbo-2.7.8-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.8/apache-dubbo-2.7.8-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.8/apache-dubbo-2.7.8-source-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="277-2020-05-18">2.7.7 (2020-05-18)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.7/apache-dubbo-2.7.7-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.7/apache-dubbo-2.7.7-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.7/apache-dubbo-2.7.7-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="275-2019-12-29">2.7.5 (2019-12-29)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.5/apache-dubbo-2.7.5-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.5/apache-dubbo-2.7.5-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.5/apache-dubbo-2.7.5-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="2741-2019-10-27">2.7.4.1 (2019-10-27)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.4.1/apache-dubbo-2.7.4.1-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.4.1/apache-dubbo-2.7.4.1-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.4.1/apache-dubbo-2.7.4.1-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="274-2019-10-19">2.7.4 (2019-10-19)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.4/apache-dubbo-2.7.4-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.4/apache-dubbo-2.7.4-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.4/apache-dubbo-2.7.4-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="273-2019-07-19">2.7.3 (2019-07-19)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.3/apache-dubbo-2.7.3-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.3/apache-dubbo-2.7.3-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.3/apache-dubbo-2.7.3-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="272-2019-06-06">2.7.2 (2019-06-06)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/dubbo/2.7.2/apache-dubbo-2.7.2-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.2/apache-dubbo-2.7.2-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/dubbo/2.7.2/apache-dubbo-2.7.2-src.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="271-2019-03-26">2.7.1 (2019-03-26)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.7.1/apache-dubbo-incubating-2.7.1-src.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.1/apache-dubbo-incubating-2.7.1-src.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.1/apache-dubbo-incubating-2.7.1-src.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.7.1/apache-dubbo-incubating-2.7.1-bin.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.1/apache-dubbo-incubating-2.7.1-bin.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.1/apache-dubbo-incubating-2.7.1-bin.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="270-2019-01-29">2.7.0 (2019-01-29)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.7.0/apache-dubbo-incubating-2.7.0-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.0/apache-dubbo-incubating-2.7.0-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.0/apache-dubbo-incubating-2.7.0-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.7.0/apache-dubbo-incubating-2.7.0-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.0/apache-dubbo-incubating-2.7.0-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.7.0/apache-dubbo-incubating-2.7.0-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="267-2019-07-15">2.6.7 (2019-07-15)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.7/apache-dubbo-2.6.7-source-release.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.7/apache-dubbo-2.6.7-source-release.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.7/apache-dubbo-2.6.7-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.7/apache-dubbo-2.6.7-bin-release.zip">binary</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.7/apache-dubbo-2.6.7-bin-release.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/dubbo/2.6.7/apache-dubbo-2.6.7-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="266-2019-03-07">2.6.6 (2019-03-07)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/2.6.6/apache-dubbo-incubating-2.6.6-source-release.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/2.6.6/apache-dubbo-incubating-2.6.6-source-release.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/2.6.6/apache-dubbo-incubating-2.6.6-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/2.6.6/apache-dubbo-incubating-2.6.6-bin-release.zip">binary</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/2.6.6/apache-dubbo-incubating-2.6.6-bin-release.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/2.6.6/apache-dubbo-incubating-2.6.6-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="265-2018-11-23">2.6.5 (2018-11-23)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.5/apache-dubbo-incubating-2.6.5-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.5/apache-dubbo-incubating-2.6.5-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.5/apache-dubbo-incubating-2.6.5-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.5/apache-dubbo-incubating-2.6.5-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.5/apache-dubbo-incubating-2.6.5-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.5/apache-dubbo-incubating-2.6.5-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="264-2018-10-08">2.6.4 (2018-10-08)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.4/apache-dubbo-incubating-2.6.4-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.4/apache-dubbo-incubating-2.6.4-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.4/apache-dubbo-incubating-2.6.4-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.4/apache-dubbo-incubating-2.6.4-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.4/apache-dubbo-incubating-2.6.4-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.4/apache-dubbo-incubating-2.6.4-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="263-2018-09-11">2.6.3 (2018-09-11)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.3/apache-dubbo-incubating-2.6.3-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.3/apache-dubbo-incubating-2.6.3-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.3/apache-dubbo-incubating-2.6.3-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.3/apache-dubbo-incubating-2.6.3-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.3/apache-dubbo-incubating-2.6.3-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.3/apache-dubbo-incubating-2.6.3-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="262-2018-06-07">2.6.2 (2018-06-07)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.2/dubbo-incubating-2.6.2-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.2/dubbo-incubating-2.6.2-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.2/dubbo-incubating-2.6.2-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/2.6.2/dubbo-incubating-2.6.2-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.2/dubbo-incubating-2.6.2-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/2.6.2/dubbo-incubating-2.6.2-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h2 id="dubbo-spring-boot-starter">Dubbo Spring Boot Starter</h2> |
| <blockquote> |
| <p>GitHub: <a href="https://github.com/apache/incubator-dubbo-spring-boot-project">https://github.com/apache/incubator-dubbo-spring-boot-project</a> <br> |
| 发布说明：https://github.com/apache/incubator-dubbo-spring-boot-project/releases</p> |
| </blockquote> |
| <h3 id="271-2019-04-09">2.7.1 (2019-04-09)</h3> |
| <ul> |
| <li><a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/spring-boot-project/2.7.1/apache-dubbo-spring-boot-project-incubating-2.7.1-source-release.zip">source</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/spring-boot-project/2.7.1/apache-dubbo-spring-boot-project-incubating-2.7.1-source-release.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/spring-boot-project/2.7.1/apache-dubbo-spring-boot-project-incubating-2.7.1-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/spring-boot-project/2.7.1/apache-dubbo-spring-boot-project-incubating-2.7.1-bin-release.zip">binary</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/spring-boot-project/2.7.1/apache-dubbo-spring-boot-project-incubating-2.7.1-bin-release.zip.asc">asc</a> | |
| <a href="https://www.apache.org/dyn/closer.lua/incubator/dubbo/spring-boot-project/2.7.1/apache-dubbo-spring-boot-project-incubating-2.7.1-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="270-2019-02-14">2.7.0 (2019-02-14)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/2.7.0/apache-dubbo-spring-boot-project-incubating-2.7.0-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/2.7.0/apache-dubbo-spring-boot-project-incubating-2.7.0-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/2.7.0/apache-dubbo-spring-boot-project-incubating-2.7.0-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/2.7.0/apache-dubbo-spring-boot-project-incubating-2.7.0-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/2.7.0/apache-dubbo-spring-boot-project-incubating-2.7.0-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/2.7.0/apache-dubbo-spring-boot-project-incubating-2.7.0-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="021-2019-01-27">0.2.1 (2019-01-27)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.2.1/apache-dubbo-spring-boot-project-incubating-0.2.1-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.2.1/apache-dubbo-spring-boot-project-incubating-0.2.1-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.2.1/apache-dubbo-spring-boot-project-incubating-0.2.1-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.2.1/apache-dubbo-spring-boot-project-incubating-0.2.1-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.2.1/apache-dubbo-spring-boot-project-incubating-0.2.1-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.2.1/apache-dubbo-spring-boot-project-incubating-0.2.1-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h3 id="012-2019-01-27">0.1.2 (2019-01-27)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.1.2/apache-dubbo-spring-boot-project-incubating-0.1.2-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.1.2/apache-dubbo-spring-boot-project-incubating-0.1.2-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.1.2/apache-dubbo-spring-boot-project-incubating-0.1.2-source-release.zip.sha512">sha512</a></li> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.1.2/apache-dubbo-spring-boot-project-incubating-0.1.2-bin-release.zip">binary</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.1.2/apache-dubbo-spring-boot-project-incubating-0.1.2-bin-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/spring-boot-project/0.1.2/apache-dubbo-spring-boot-project-incubating-0.1.2-bin-release.zip.sha512">sha512</a></li> |
| </ul> |
| <h2 id="dubbo-admin">Dubbo Admin</h2> |
| <blockquote> |
| <p>GitHub: <a href="https://github.com/apache/incubator-dubbo-admin">https://github.com/apache/incubator-dubbo-admin</a> <br> |
| Release Notes: <a href="https://github.com/apache/incubator-dubbo-admin/releases">https://github.com/apache/incubator-dubbo-admin/releases</a></p> |
| </blockquote> |
| <h3 id="01-2019-02-15">0.1 (2019-02-15)</h3> |
| <ul> |
| <li><a href="https://archive.apache.org/dist/incubator/dubbo/dubbo-ops/0.1/apache-dubbo-ops-incubating-0.1-source-release.zip">source</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/dubbo-ops/0.1/apache-dubbo-ops-incubating-0.1-source-release.zip.asc">asc</a> | |
| <a href="https://archive.apache.org/dist/incubator/dubbo/dubbo-ops/0.1/apache-dubbo-ops-incubating-0.1-source-release.zip.sha512">sha512</a></li> |
| </ul></description></item><item><title>Blog: Dubbo Admin service test</title><link>https://dubbo.apache.org/en/blog/2019/08/26/service-test/</link><pubDate>Mon, 26 Aug 2019 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2019/08/26/service-test/</guid><description> |
| <p>Based on the metadata of Dubbo2.7, Dubbo Admin implements the service test function, which can call the real service provider on the console through generalized call.</p> |
| <h2 id="usage">Usage</h2> |
| <ul> |
| <li> |
| <p>Deploy the provider: You can download the demo <a href="https://github.com/nzomkxia/dubbo-demo">here</a>. This project is based on Spring Boot, which is convenient to start in the IDE or command line. For service testing, you only need to start <code>dubbo-basic-provider</code>.</p> |
| </li> |
| <li> |
| <p>Service-seeking: After completing the server deployment, you can query the corresponding service on the Dubbo Admin&rsquo;s <code>service test</code> page: |
| <img src="https://dubbo.apache.org/imgs/blog/admin/testSearch.jpg" alt="testSearch"><br> |
| the information here is similar to the metadata, including the method name, parameter type and return value. Click the label on the right to enter the <code>service test</code> page.</p> |
| </li> |
| <li> |
| <p>Service test： |
| <img src="https://dubbo.apache.org/imgs/blog/admin/testSuccess.jpg" alt="testSuccess"><br> |
| <code>service test</code> page contains two json editor, the parameter&rsquo;s informations are all stored in a json format, where you need to fill in the corresponding parameter values (in this case, the number type is String ), after filling, click <code>execute</code> to initiate the call to the server, and the result of the call is displayed in the editor on the right. If the call fails, the detailed cause of the failure is displayed. Let&rsquo;s look at the example of the call failure.<br> |
| <img src="https://dubbo.apache.org/imgs/blog/admin/testFail.jpg" alt="testFail"></p> |
| <p>In this case, the Dubbo service provider&rsquo;s process is shut down before the service test is executed, you can see that the returned result is an <code>No provider availble</code> exception. As with normal calls, business and framework exceptions are returned in the results, for easy business troubleshooting.</p> |
| </li> |
| <li> |
| <p>Complex type parameters <br> |
| Consider the following methods and types in <code>UserService</code>:</p> |
| </li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">//org.apache.dubbo.demo.api.UserService</span> |
| </span></span><span style="display:flex;"><span>Result <span style="color:#268bd2">getUser</span>(String name, UserInfoDO userInfoDO); |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">UserInfoDO</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">int</span> id; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> LocationDO locationDO; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> DepartmentDO departmentDO; |
| </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">toString</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;UserInfoDO{&#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;id=&#34;</span> <span style="color:#719e07">+</span> id <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;, locationDO=&#34;</span> <span style="color:#719e07">+</span> locationDO.toString() <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;, departmentDO=&#34;</span> <span style="color:#719e07">+</span> departmentDO.toString() <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#39;}&#39;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DepartmentDO</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String departName; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> LocationDO departLocation; |
| </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">toString</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;DepartmentDO{&#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;departName=&#39;&#34;</span> <span style="color:#719e07">+</span> departName <span style="color:#719e07">+</span> <span style="color:#2aa198">&#39;\&#39;&#39;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;, departLocation=&#34;</span> <span style="color:#719e07">+</span> departLocation.toString() <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#39;}&#39;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">LocationDO</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String address; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">int</span> postNum; |
| </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">toString</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;LocationDO{&#34;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;address=&#39;&#34;</span> <span style="color:#719e07">+</span> address <span style="color:#719e07">+</span> <span style="color:#2aa198">&#39;\&#39;&#39;</span> <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;, postNum=&#34;</span> <span style="color:#719e07">+</span> postNum <span style="color:#719e07">+</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#39;}&#39;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The parameters are complex complex type. When the service is tested, the value of each field will be filled out layer by layer, As shown below:<br> |
| <img src="https://dubbo.apache.org/imgs/blog/admin/complex.jpg" alt="complex"> |
| It can also make successful call and the result is returned.</p> |
| <h2 id="principledata-source">Principle：Data source</h2> |
| <p>In the service test, the most important thing is the complete method signature, and the type information of the parameters, with which the values of each parameter can be filled step by step to assemble the complete service consumer. In Dubbo 2.7, the metadata center has been added. The method signature and parameter type information of Dubbo Admin is from here:<br> |
| <img src="https://dubbo.apache.org/imgs/blog/admin/metadata.png" alt="medatada"> |
| As shown, the server will register the metadata information of the service to the metadata center when it runs,the format is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> ... |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;methods&#34;</span>: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;name&#34;</span>: <span style="color:#2aa198">&#34;sayHello&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;parameterTypes&#34;</span>: [ |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;org.apache.dubbo.demo.model.User&#34;</span> |
| </span></span><span style="display:flex;"><span> ], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;returnType&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.demo.model.Result&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> ... |
| </span></span><span style="display:flex;"><span> ], |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;types&#34;</span>: [ |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char&#34;</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">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;long&#34;</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">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.demo.model.Result&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;msg&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;value&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char[]&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;hash&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;userName&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;java.lang.String&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;value&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char[]&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;hash&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;org.apache.dubbo.demo.model.User&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;id&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;java.lang.Long&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;value&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;long&#34;</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;username&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;java.lang.Sring&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;properties&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;value&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;char[]&#34;</span> |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;hash&#34;</span>: { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;type&#34;</span>: <span style="color:#2aa198">&#34;int&#34;</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }, |
| </span></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>Related to service testing is the method and type information contained in <code>methods</code> and <code>types</code>. Based on this information, Dubbo Admin renders the parameters into the Json Editor of the service test page, where the user enters the values of each parameter and each member variable.</p> |
| <h2 id="principle-generalized-calls">Principle: Generalized calls</h2> |
| <p>With the parameter type, the next question is how to call to the server. In the traditional Dubbo RPC call, the client needs to rely on the server&rsquo;s API jar package ( refer to the <a href="https://github.com/nzomkxia/dubbo-demo/tree/master/dubbo-basic-consumer">dubbo-basic-consumer</a> in the previous demo ), which is unlikely for Dubbo Admin, because the up and down of services are dynamic, Dubbo Admin can not dynamically increase the jar package dependencies, so you need to use the <strong>generalization call</strong> in Dubbo , which means that in the absence of the server API interface, the client initiates a service call through the <code>GenericService</code> interface, and the data objects in return values are represented by maps. The generalization call doesn&rsquo;t require special processing on the server side, only need to be initiated by the client side.</p> |
| <h2 id="summary-and-outlook">Summary and outlook</h2> |
| <p>This article briefly introduces the usage and principle of service testing, and will further enhance this function in the future, such as processing the parameter types of abstract classes, importing parameter values from json files, supporting the saving of parameter values, etc., to facilitate regression testing of the service interface.</p></description></item><item><title>Blog: Tracing Dubbo service with Apache Skywalking</title><link>https://dubbo.apache.org/en/blog/2019/08/11/tracing-dubbo-service-with-apache-skywalking/</link><pubDate>Sun, 11 Aug 2019 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2019/08/11/tracing-dubbo-service-with-apache-skywalking/</guid><description> |
| <h2 id="introduction-to-apache-skywalking">Introduction to Apache Skywalking</h2> |
| <p><a href="https://github.com/apache/skywalking">Apache Skywalking</a> is the APM system that it designed for micro-services architectures and cloud native architecture systems and supports distribute tracking. <a href="https://github.com/apache/skywalking">Apache skywalking (incubator)</a> collects and analyzes the trace data and generates the relationship between the application and the service metric, Apache skywalking supports multiple languages agent, for example <a href="https://github.com/apache/skywalking">Java</a>,<a href="https://github.com/OpenSkywalking/skywalking-netcore">.net core</a>,<a href="https://github.com/OpenSkywalking/skywalking-nodejs">Node.js</a> and <a href="https://github.com/SkyAPM/go2sky">Go</a>.</p> |
| <p>Currently, Skywalking has supported analysis the operation of distributed systems from 6 visual dimensions. The overview view is a global view of your applications and components, including the number of components and applications, application alarm fluctuations, slow service lists, and application throughput; The topology shows the topological relationship of the whole application; The application view represents the upstream and downstream relationship of the application from single application, TOP N services and servers, JVM, host and process info. The service view focuses on the operation of a single service portal and the upstream and downstream dependencies of this service and it helps the user to optimize and monitor a single service; the trace graph shows all the buried points of the invocation and the execution time of each burial point, and the alarm view is based on the configuration threshold for the application, server, service for real-time alarms</p> |
| <h2 id="dubbo-and-apache-skywalking">Dubbo and Apache Skywalking</h2> |
| <h3 id="build-the-dubbo-demo--project">Build the Dubbo demo project</h3> |
| <p>The Dubbo demo has been uploaded to the <a href="https://github.com/SkywalkingTest/dubbo-trace-example">GitHub repository</a>.</p> |
| <h4 id="api-project">API project</h4> |
| <p>Service interface definition: |
| package org.apache.skywalking.demo.interfaces;</p> |
| <p>public interface HelloService { |
| String sayHello(String name); |
| }</p> |
| <h4 id="service-provider-project">Service provider project</h4> |
| <p>package org.apache.skywalking.demo.provider;</p> |
| <p>@Service(version = &ldquo;${demo.service.version}&rdquo;, |
| application = &ldquo;${dubbo.application.id}&rdquo;, |
| protocol = &ldquo;${dubbo.protocol.id}&rdquo;, |
| registry = &ldquo;${dubbo.registry.id}&rdquo;, timeout = 60000) |
| public class HelloServiceImpl implements HelloService {</p> |
| <pre><code>public String sayHello(String name) { |
| LockSupport.parkNanos(TimeUnit.SECONDS.toNanos(1)); |
| return &quot;Hello, &quot; + name; |
| } |
| </code></pre> |
| <p>}</p> |
| <h4 id="service-consumer-project">Service consumer project</h4> |
| <p>package org.apache.skywalking.demo.consumer;</p> |
| <p>@RestController |
| public class ConsumerController {</p> |
| <pre><code>private static int COUNT = 0; |
| @Reference(version = &quot;${demo.service.version}&quot;, |
| application = &quot;${dubbo.application.id}&quot;, |
| url = &quot;dubbo://localhost:20880&quot;, timeout = 60000) |
| private HelloService helloService; |
| @GetMapping(&quot;/sayHello/{name}&quot;) |
| public String sayHello(@PathVariable(name = &quot;name&quot;) String name) { |
| if ((COUNT++) % 3 == 0){ |
| throw new RuntimeException(); |
| } |
| LockSupport.parkNanos(TimeUnit.SECONDS.toNanos(2)); |
| return helloService.sayHello(name); |
| } |
| </code></pre> |
| <p>}</p> |
| <h3 id="deploy-apache-skywalking">Deploy Apache Skywalking</h3> |
| <p><a href="https://github.com/apache/skywalking">Apache skywalking</a> offers two deployment modes: single-node mode and cluster mode,Here is the single-node mode deployment step, and more about how to deploy skywalking with cluster mode, please reference <a href="https://skywalking.apache.org/docs/main/next/en/setup/backend/backend-setup/">document</a>.</p> |
| <h4 id="third-party-components">Third-party components</h4> |
| <ol> |
| <li>JDK 8+</li> |
| <li>Elasticsearch 5.x</li> |
| </ol> |
| <h4 id="deployment-step">Deployment step</h4> |
| <ol> |
| <li>Download <a href="http://skywalking.apache.org/downloads/">Apache Skywalking Collector</a></li> |
| <li>Deploy Elasticsearch service |
| <ul> |
| <li>Set <code>cluster.name</code> to <code>CollectorDBCluster</code></li> |
| <li>Set <code>network.host</code> to <code>0.0.0.0</code></li> |
| <li>Start elasticsearch service</li> |
| </ul> |
| </li> |
| <li>Unzip and start the Skywalking Collector. Run the &rsquo; bin/startup.sh &rsquo; command to start skywalking Collector</li> |
| </ol> |
| <h4 id="deploy-the-demo">Deploy the demo</h4> |
| <p>Before you deploy the demo service, please run the following command:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>./mvnw clean package |
| </span></span></code></pre></div><h4 id="deploy-the-provider-service">Deploy the provider service</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>java -jar -javaagent:$AGENT_PATH/skywalking-agent.jar -Dskywalking.agent.application_code=dubbo-provider -Dskywalking.collector.servers=localhost:10800 dubbo-provider/target/dubbo-provider.jar |
| </span></span></code></pre></div><h4 id="deploy-the-consumer-service">Deploy the consumer service</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>java -jar -javaagent:$AGENT_PATH/skywalking-agent.jar -Dskywalking.agent.application_code=dubbo-consumer -Dskywalking.collector.servers=localhost:10800 dubbo-consumer/target/dubbo-consumer.jar |
| </span></span></code></pre></div><h4 id="visit-demo-service">visit demo service</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>curl http://localhost:8080/sayHello/test |
| </span></span></code></pre></div><h2 id="skywalking-scren-snapshot">Skywalking scren snapshot</h2> |
| <h3 id="dashboard">Dashboard</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/skywalking-dashboard.png" alt="/admin-guide/images/skywalking-dashboard.png"></p> |
| <h3 id="topology">Topology</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/skywalking-topology.png" alt="/admin-guide/images/skywalking-topology.png"></p> |
| <h3 id="application-view">Application view</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/skywalking-application.png" alt="/admin-guide/images/skywalking-application.png"></p> |
| <p>JVM Information |
| <img src="https://dubbo.apache.org/imgs/blog/skywalking-application_instance.png" alt="/admin-guide/images/skywalking-application_instance.png"></p> |
| <h3 id="service-view">Service view</h3> |
| <p>Consumer side |
| <img src="https://dubbo.apache.org/imgs/blog/skywalking-service-consumer.png" alt="/admin-guide/images/skywalking-service-consumer.png"></p> |
| <p>provider side |
| <img src="https://dubbo.apache.org/imgs/blog/skywalking-service-provider.png" alt="/admin-guide/images/skywalking-service-provider.png"></p> |
| <h3 id="trace">Trace</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/skywalking-trace.png" alt="/admin-guide/images/skywalking-trace.png"></p> |
| <p>Span info |
| <img src="https://dubbo.apache.org/imgs/blog/skywalking-span-Info.png" alt="/admin-guide/images/skywalking-span-Info.png"></p> |
| <h3 id="alarm-view">Alarm view</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/skywalking-alarm.png" alt="/admin-guide/images/skywalking-alarm.png"></p></description></item><item><title>Blog: Dubbo extensible mechanism source code analysis - part 2</title><link>https://dubbo.apache.org/en/blog/2019/05/02/dubbo-extensible-mechanism-source-code-analysis-part-2/</link><pubDate>Thu, 02 May 2019 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2019/05/02/dubbo-extensible-mechanism-source-code-analysis-part-2/</guid><description> |
| <p>In the <a href="https://dubbo.apache.org/en/blog/2019/04/25/dubbo-extensible-mechanism-source-code-analysis-part-1/" title="">actual implementation of the Dubbo extensibility mechanism</a>, we learned some concepts of the Dubbo extension mechanism, explored the implementation of LoadBalance in Dubbo, and implemented a LoadBalance on our own. Do you think Dubbo&rsquo;s extension mechanism is great? Next, we will go deep into the source code of Dubbo and see what it is.</p> |
| <h2 id="extensionloader">ExtensionLoader</h2> |
| <p><code>ExtensionLoader</code> is the core class, which is responsible for the loading and lifecycle management of extension points. Let&rsquo;s start with this class. There are many methods of Extension, and the common methods include:</p> |
| <ul> |
| <li><code>public static &lt;T&gt; ExtensionLoader&lt;T&gt; getExtensionLoader(Class&lt;T&gt; type)</code></li> |
| <li><code>public T getExtension(String name)</code></li> |
| <li><code>public T getAdaptiveExtension()</code></li> |
| </ul> |
| <p>The common usages are:</p> |
| <ul> |
| <li><code>LoadBalance lb = ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(loadbalanceName)</code></li> |
| <li><code>RouterFactory routerFactory = ExtensionLoader.getExtensionLoader(RouterFactory.class).getAdaptiveExtension()</code></li> |
| </ul> |
| <p>Notice: In the source code shown below, I&rsquo;ll remove extraneous code (such as logging, exception catching, and so on) to make it easy to read and understand.</p> |
| <ol> |
| <li>getExtensionLoader |
| This is a static factory method that enters an extensible interface and returns an ExtensionLoader entity class for this interface. With this entity class, you can get not only a specific extension based on name, but also an adaptive extension.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">static</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> ExtensionLoader<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">getExtensionLoader</span>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// An extension point must be an interface</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span>type.isInterface()) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;Extension type(&#34;</span> <span style="color:#719e07">+</span> type <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;) is not interface!&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// @SPI annotations must be provided</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span>withExtensionAnnotation(type)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;Extension type without @SPI Annotation!&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Get the corresponding ExtensionLoader from the cache according to the interface</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Each extension will only be loaded once</span> |
| </span></span><span style="display:flex;"><span> ExtensionLoader<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> loader <span style="color:#719e07">=</span> (ExtensionLoader<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span>) EXTENSION_LOADERS.get(type); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (loader <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Initialize extension</span> |
| </span></span><span style="display:flex;"><span> EXTENSION_LOADERS.putIfAbsent(type, <span style="color:#719e07">new</span> ExtensionLoader<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span>(type)); |
| </span></span><span style="display:flex;"><span> loader <span style="color:#719e07">=</span> (ExtensionLoader<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span>) EXTENSION_LOADERS.get(type); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> loader; |
| </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">private</span> <span style="color:#268bd2">ExtensionLoader</span>(Class<span style="color:#719e07">&lt;?&gt;</span> type) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span>.type <span style="color:#719e07">=</span> type; |
| </span></span><span style="display:flex;"><span> objectFactory <span style="color:#719e07">=</span> (type <span style="color:#719e07">==</span> ExtensionFactory.class <span style="color:#719e07">?</span> <span style="color:#cb4b16">null</span> : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension()); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="2"> |
| <li>getExtension</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> T <span style="color:#268bd2">getExtension</span>(String name) { |
| </span></span><span style="display:flex;"><span> Holder<span style="color:#719e07">&lt;</span>Object<span style="color:#719e07">&gt;</span> holder <span style="color:#719e07">=</span> cachedInstances.get(name); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (holder <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> cachedInstances.putIfAbsent(name, <span style="color:#719e07">new</span> Holder<span style="color:#719e07">&lt;</span>Object<span style="color:#719e07">&gt;</span>()); |
| </span></span><span style="display:flex;"><span> holder <span style="color:#719e07">=</span> cachedInstances.get(name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> Object instance <span style="color:#719e07">=</span> holder.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Get it from the cache. If it does not exist, create</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">synchronized</span> (holder) { |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> holder.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> createExtension(name); |
| </span></span><span style="display:flex;"><span> holder.set(instance); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> (T) instance; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Some judgments and caching have been made in the getExtension method, and the main logic is in the createExtension method. Let&rsquo;s move on to the createExtension method.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> T <span style="color:#268bd2">createExtension</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Get the extension class according to the name of extension point. For example, for LoadBalance, get the RandomLoadBalance class according to random</span> |
| </span></span><span style="display:flex;"><span> Class<span style="color:#719e07">&lt;?&gt;</span> clazz <span style="color:#719e07">=</span> getExtensionClasses().get(name); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> T instance <span style="color:#719e07">=</span> (T) EXTENSION_INSTANCES.get(clazz); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Use reflection to call newInstance to create an example of an extension class</span> |
| </span></span><span style="display:flex;"><span> EXTENSION_INSTANCES.putIfAbsent(clazz, (T) clazz.newInstance()); |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> (T) EXTENSION_INSTANCES.get(clazz); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Make dependency injection for the extended class samples</span> |
| </span></span><span style="display:flex;"><span> injectExtension(instance); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// If there is a wrapper, add the wrapper</span> |
| </span></span><span style="display:flex;"><span> Set<span style="color:#719e07">&lt;</span>Class<span style="color:#719e07">&lt;?&gt;&gt;</span> wrapperClasses <span style="color:#719e07">=</span> cachedWrapperClasses; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (wrapperClasses <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">&amp;&amp;</span> <span style="color:#719e07">!</span>wrapperClasses.isEmpty()) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (Class<span style="color:#719e07">&lt;?&gt;</span> wrapperClass : wrapperClasses) { |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> instance; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The createExtension method has done the following:</p> |
| <ol> |
| <li>First, get the corresponding extension class according to name. Read the extension point configuration file from the <code>META-INF</code> folder under ClassPath.</li> |
| <li>Use reflection to create an instance of an extended class.</li> |
| <li>make dependency injection for the attributes of the extended class instance. That is, IoC.</li> |
| <li>If there is a wrapper, add the wrapper. That is, AOP.</li> |
| </ol> |
| <p>Let&rsquo;s focus on these four processes.</p> |
| <ol> |
| <li>Get the corresponding extension class according to name. Let’s read the code first:</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> getExtensionClasses() { |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> classes <span style="color:#719e07">=</span> cachedClasses.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (classes <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">synchronized</span> (cachedClasses) { |
| </span></span><span style="display:flex;"><span> classes <span style="color:#719e07">=</span> cachedClasses.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (classes <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> classes <span style="color:#719e07">=</span> loadExtensionClasses(); |
| </span></span><span style="display:flex;"><span> cachedClasses.set(classes); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> classes; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// synchronized in getExtensionClasses</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">private</span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> loadExtensionClasses() { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> SPI defaultAnnotation <span style="color:#719e07">=</span> type.getAnnotation(SPI.class); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (defaultAnnotation <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> String value <span style="color:#719e07">=</span> defaultAnnotation.value(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (value <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">&amp;&amp;</span> (value <span style="color:#719e07">=</span> value.trim()).length() <span style="color:#719e07">&gt;</span> 0) { |
| </span></span><span style="display:flex;"><span> String<span style="color:#719e07">[]</span> names <span style="color:#719e07">=</span> NAME_SEPARATOR.split(value); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (names.length <span style="color:#719e07">&gt;</span> 1) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;more than 1 default extension name on extension &#34;</span> <span style="color:#719e07">+</span> type.getName()); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (names.length <span style="color:#719e07">==</span> 1) cachedDefaultName <span style="color:#719e07">=</span> names<span style="color:#719e07">[</span>0<span style="color:#719e07">]</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span> extensionClasses <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>String, Class<span style="color:#719e07">&lt;?&gt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY); |
| </span></span><span style="display:flex;"><span> loadFile(extensionClasses, DUBBO_DIRECTORY); |
| </span></span><span style="display:flex;"><span> loadFile(extensionClasses, SERVICES_DIRECTORY); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> extensionClasses; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>This process is very simple. Get the extension class from the cache first, and if it does not exist, load it from the configuration file. The path of the configuration file has been mentioned before:</p> |
| <ul> |
| <li><code>META-INF/dubbo/internal</code></li> |
| <li><code>META-INF/dubbo</code></li> |
| <li><code>META-INF/services</code></li> |
| </ul> |
| <ol start="2"> |
| <li>Use reflection to create an extended instance. This process is very simple. We can do this using <code>clazz.newInstance()</code>. The attributes of the extended instance created are all null values.</li> |
| <li>Extended instance is automatic assembly. In the actual scenario, there have dependencies between classes. Dependencies are also referenced in the extended instance, such as a simple Java class, an extension of another Dubbo, or a Spring Bean. The situation of dependencies is complex, and Dubbo&rsquo;s processing is relatively complicated. We will have a special chapter to explain it later. Now, we just need to know that Dubbo can correctly inject common dependencies in extension points, Dubbo extension dependencies or Spring dependencies, etc..</li> |
| <li>Extended instance is auto-wrapping. Auto-wrapping is about implementing Spring like AOP functionality. Dubbo uses it to implement some common functions internally, such as logging, monitoring, and so on. The contents of the extended instance auto-wrapper will also be explained separately later.</li> |
| </ol> |
| <p>After the above 4 steps, Dubbo creates and initializes an extended instance. The dependencies of this instance are injected and packaged as needed. At this point, this extended instance can be used.</p> |
| <h2 id="auto-assembly-of-dubbo-spi-advanced-usage">Auto-assembly of Dubbo SPI advanced usage</h2> |
| <p>The relevant code for auto-assembly is in the injectExtension method:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> T <span style="color:#268bd2">injectExtension</span>(T instance) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (Method method : instance.getClass().getMethods()) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (method.getName().startsWith(<span style="color:#2aa198">&#34;set&#34;</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&amp;&amp;</span> method.getParameterTypes().length <span style="color:#719e07">==</span> 1 |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&amp;&amp;</span> Modifier.isPublic(method.getModifiers())) { |
| </span></span><span style="display:flex;"><span> Class<span style="color:#719e07">&lt;?&gt;</span> pt <span style="color:#719e07">=</span> method.getParameterTypes()<span style="color:#719e07">[</span>0<span style="color:#719e07">]</span>; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String property <span style="color:#719e07">=</span> method.getName().length() <span style="color:#719e07">&gt;</span> 3 <span style="color:#719e07">?</span> method.getName().substring(3, 4).toLowerCase() <span style="color:#719e07">+</span> method.getName().substring(4) : <span style="color:#2aa198">&#34;&#34;</span>; |
| </span></span><span style="display:flex;"><span> Object object <span style="color:#719e07">=</span> objectFactory.getExtension(pt, property); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (object <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> method.invoke(instance, object); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> instance; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>To accomplish the automatic assembly of dependencies of the extended instances, you first need to know what the dependencies are and what the types of dependencies are. The solution of Dubbo is to find the Java standard setter method. That is, the method name starting with set has only one parameter. If such a set method exists in an extension class, Dubbo injects it into dependencies, which is similar to the injection of Spring&rsquo;s set method. However, dependency injection in Dubbo is more complicated than that in Spring, because all the methods injected into Spring are Spring beans and managed by the Spring container. In Dubbo&rsquo;s dependency injection, you may need to inject another extension of Dubbo, or a Spring Bean, or a component of Google guice, or a component in any other framework. Dubbo needs to be able to load extensions from any scenario. In the injectExtension method, it is implemented with <code>Object object = objectFactory. getExtension (pt, property)</code>. ObjectFactory is ExtensionFactory type and initialized when creating ExtensionLoader:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#268bd2">ExtensionLoader</span>(Class<span style="color:#719e07">&lt;?&gt;</span> type) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span>.type <span style="color:#719e07">=</span> type; |
| </span></span><span style="display:flex;"><span> objectFactory <span style="color:#719e07">=</span> (type <span style="color:#719e07">==</span> ExtensionFactory.class <span style="color:#719e07">?</span> <span style="color:#cb4b16">null</span> : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension()); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>ObjectFacore is also an extension, obtained through <code>ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension()</code>.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-extensionfactory.png" alt="Dubbo-ExtensionFactory" title=""></p> |
| <p>ExtensionFactory includes three implementations:</p> |
| <ol> |
| <li>SpiExtensionFactory: use Dubbo&rsquo;s Spi to load Extension.</li> |
| <li>SpringExtensionFactory: load Extension from the Spring container.</li> |
| <li>AdaptiveExtensionFactory: adaptive AdaptiveExtensionLoader</li> |
| </ol> |
| <p>Pay attention to the AdaptiveExtensionLoader here, the source code is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Adaptive</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AdaptiveExtensionFactory</span> <span style="color:#268bd2">implements</span> ExtensionFactory { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> List<span style="color:#719e07">&lt;</span>ExtensionFactory<span style="color:#719e07">&gt;</span> factories; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">AdaptiveExtensionFactory</span>() { |
| </span></span><span style="display:flex;"><span> ExtensionLoader<span style="color:#719e07">&lt;</span>ExtensionFactory<span style="color:#719e07">&gt;</span> loader <span style="color:#719e07">=</span> ExtensionLoader.getExtensionLoader(ExtensionFactory.class); |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>ExtensionFactory<span style="color:#719e07">&gt;</span> list <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ArrayList<span style="color:#719e07">&lt;</span>ExtensionFactory<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (String name : loader.getSupportedExtensions()) { |
| </span></span><span style="display:flex;"><span> list.add(loader.getExtension(name)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> factories <span style="color:#719e07">=</span> Collections.unmodifiableList(list); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> T <span style="color:#268bd2">getExtension</span>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (ExtensionFactory factory : factories) { |
| </span></span><span style="display:flex;"><span> T extension <span style="color:#719e07">=</span> factory.getExtension(type, name); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (extension <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> extension; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The AdaptiveExtensionLoader class has @Adaptive annotations. As mentioned earlier, Dubbo creates an adaptive instance for each extension. If the extension class has @Adaptive annotations, it will use it as an adaptive class. If not, Dubbo will create one for us. So <code>ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension())</code> will return an AdaptiveExtensionLoader instance as an adaptive extension instance. |
| The AdaptiveExtensionLoader will iterate through all the ExtensionFactory implementations and try to load the extensions. If found, return. If not, continue to find it in the next ExtensionFactory. Dubbo has two ExtensionFactory built in, which are searched from Dubbo&rsquo;s own extension mechanism and Spring container. Since ExtensionFactory itself is also an extension point, we can implement our own ExtensionFactory to enable automatic assembly of Dubbo to support our custom components. For example, we used Google&rsquo;s guice as an IoC container in our project. We can implement our own GuiceExtensionFactory to enable Dubbo to load extensions from the guice container.</p> |
| <h2 id="aop-of-dubbo-spi-advanced-usage">AOP of Dubbo SPI advanced usage</h2> |
| <p>We often use AOP functionality when using Spring. Insert other logic before and after the method of the target class. For example, Spring AOP is usually used to implement logging, monitoring, and authentication, and so on. |
| Does Dubbo&rsquo;s extension mechanism also support similar features? The answer is yes. In Dubbo, there is a special class called the Wrapper class. It uses the wrapper class to wrap the original extension point instance through the decorator pattern, and then inserts additional logic before and after the original extension point implementation to implement AOP functionality.</p> |
| <h3 id="what-is-the-wrapper-class">What is the Wrapper class</h3> |
| <p>So what kind of class is the Wrapper class in the Dubbo extension mechanism? The Wrapper class is a class that has a replication constructor and also is a typical decorator pattern. Here&rsquo;s a Wrapper class:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">class</span> <span style="color:#268bd2">A</span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> A a; |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">A</span>(A a){ |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span>.a <span style="color:#719e07">=</span> a; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Class A has a constructor <code>public A(A a)</code>, and the argument to the constructor is A itself. Such a class can be a Wrapper class in the Dubbo extension mechanism. Such Wrapper classes in Dubbo include ProtocolFilterWrapper, ProtocolListenerWrapper, and so on. You can check the source code to deepen your understanding.</p> |
| <h3 id="how-to-configure-the-wrapper-class">How to configure the Wrapper class</h3> |
| <p>The Wrapper class in Dubbo is also an extension point. Like other extension points, it is also configured in the <code>META-INF</code> folder. For example, the ProtocolFilterWrapper and ProtocolListenerWrapper in the previous example are configured in the path <code>dubbo-rpc/dubbo-rpc-api/src/main/resources/META-INF/dubbo/internal/org.apache.dubbo.rpc.Protocol</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-text" data-lang="text"><span style="display:flex;"><span>filter=org.apache.dubbo.rpc.protocol.ProtocolFilterWrapper |
| </span></span><span style="display:flex;"><span>listener=org.apache.dubbo.rpc.protocol.ProtocolListenerWrapper |
| </span></span><span style="display:flex;"><span>mock=org.apache.dubbo.rpc.support.MockProtocol |
| </span></span></code></pre></div><p>When Dubbo loads the extension configuration file, there is a piece of code as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> clazz.getConstructor(type); |
| </span></span><span style="display:flex;"><span> Set<span style="color:#719e07">&lt;</span>Class<span style="color:#719e07">&lt;?&gt;&gt;</span> wrappers <span style="color:#719e07">=</span> cachedWrapperClasses; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (wrappers <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> cachedWrapperClasses <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashSet<span style="color:#719e07">&lt;</span>Class<span style="color:#719e07">&lt;?&gt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> wrappers <span style="color:#719e07">=</span> cachedWrapperClasses; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> wrappers.add(clazz); |
| </span></span><span style="display:flex;"><span>} <span style="color:#719e07">catch</span> (NoSuchMethodException e) {} |
| </span></span></code></pre></div><p>The meaning of this code is that if the extension class has a copy constructor, it will be saved for later use. The class that has the copy constructor is the Wrapper class. The parameter obtained by <code>clazz.getConstructor(type)</code> is the constructor of the extension point interface. Note that the parameter type of the constructor is an extension point interface, not an extension class. |
| Take Protocol as an example. The configuration file <code>dubbo-rpc/dubbo-rpc-api/src/main/resources/META-INF/dubbo/internal/org.apache.dubbo.rpc.Protocol defines filter=org.apache.dubbo.rpc.protocol. ProtocolFilterWrapper</code>. |
| The code of ProtocolFilterWrapper is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProtocolFilterWrapper</span> <span style="color:#268bd2">implements</span> Protocol { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Protocol protocol; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// One parameter is the copy constructor of Protocol</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">ProtocolFilterWrapper</span>(Protocol protocol) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (protocol <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;protocol == null&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span>.protocol <span style="color:#719e07">=</span> protocol; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>ProtocolFilterWrapper has a constructor <code>public ProtocolFilterWrapper(Protocol protocol)</code>, and the parameter is the extension point Protocol. So it is a Wrapper class in the Dubbo extension mechanism. The ExtensionLoader will cache it. When creating Extension instances later, the ExtensionLoader use these wrapper classes to wrap the original Extension point in turn.</p> |
| <h2 id="extension-point-adaptive">Extension point adaptive</h2> |
| <p>As mentioned earlier, Dubbo needs to determine which extension to use based on method parameters at runtime. So there is an extension point adaptive instance. In fact, it is an extension point proxy that delays the selection of extensions from starting Dubbo to calling RPC. Each extension point in Dubbo has an adaptive class. If it is not explicitly provided, Dubbo will automatically create one for us. By default, Javaassist is used. |
| Let&rsquo;s first look at the code to create an adaptive extension class:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> T <span style="color:#268bd2">getAdaptiveExtension</span>() { |
| </span></span><span style="display:flex;"><span> Object instance <span style="color:#719e07">=</span> cachedAdaptiveInstance.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">synchronized</span> (cachedAdaptiveInstance) { |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> cachedAdaptiveInstance.get(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (instance <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> instance <span style="color:#719e07">=</span> createAdaptiveExtension(); |
| </span></span><span style="display:flex;"><span> cachedAdaptiveInstance.set(instance); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> (T) instance; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Continue to read the createAdaptiveExtension method:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> T <span style="color:#268bd2">createAdaptiveExtension</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> injectExtension((T) getAdaptiveExtensionClass().newInstance()); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Continue to read the getAdaptiveExtensionClass method:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> Class<span style="color:#719e07">&lt;?&gt;</span> getAdaptiveExtensionClass() { |
| </span></span><span style="display:flex;"><span> getExtensionClasses(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (cachedAdaptiveClass <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> cachedAdaptiveClass; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> cachedAdaptiveClass <span style="color:#719e07">=</span> createAdaptiveExtensionClass(); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Continue to read the createAdaptiveExtensionClass method. After a long journey, we finally come to a concrete realization. Look at this createAdaptiveExtensionClass method, which first generates the Java source code for the adaptive class, and then compile the source code into Java bytecode and load it into the JVM.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> Class<span style="color:#719e07">&lt;?&gt;</span> createAdaptiveExtensionClass() { |
| </span></span><span style="display:flex;"><span> String code <span style="color:#719e07">=</span> createAdaptiveExtensionClassCode(); |
| </span></span><span style="display:flex;"><span> ClassLoader classLoader <span style="color:#719e07">=</span> findClassLoader(); |
| </span></span><span style="display:flex;"><span> org.apache.dubbo.common.compiler.Compiler compiler <span style="color:#719e07">=</span> ExtensionLoader.getExtensionLoader(org.apache.dubbo.common.compiler.Compiler.class).getAdaptiveExtension(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> compiler.compile(code, classLoader); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The default implementation of Compiler&rsquo;s code is javassist.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span>(<span style="color:#2aa198">&#34;javassist&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">Compiler</span> { |
| </span></span><span style="display:flex;"><span> Class<span style="color:#719e07">&lt;?&gt;</span> compile(String code, ClassLoader classLoader); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The createAdaptiveExtensionClassCode () method uses a StringBuilder to build Java source code for the adaptive class. The method implementation is relatively long, and the code is not posted here. The approach to bytecode generation is also interesting, first generating Java source code, then compiling it and loading it into the jvm. In this way, the generated Java class can be better controlled. And it doesn&rsquo;t have to care about the API of the bytecode generation framework. Because the xxx.java file is universal in Java, it is also the one we are most familiar with. However, the code is not very readable and you need to build xx. Java content bit by bit. |
| Below are the Java code example for Protocol adaptive class created by createAdaptiveExtensionClassCode method:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.rpc; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.common.extension.ExtensionLoader; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">Protocol$Adaptive</span> <span style="color:#268bd2">implements</span> org.apache.dubbo.rpc.Protocol { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">destroy</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> UnsupportedOperationException(<span style="color:#2aa198">&#34;method public abstract void org.apache.dubbo.rpc.Protocol.destroy() of interface org.apache.dubbo.rpc.Protocol is not adaptive method!&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">int</span> <span style="color:#268bd2">getDefaultPort</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> UnsupportedOperationException(<span style="color:#2aa198">&#34;method public abstract int org.apache.dubbo.rpc.Protocol.getDefaultPort() of interface org.apache.dubbo.rpc.Protocol is not adaptive method!&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> org.apache.dubbo.rpc.Exporter <span style="color:#268bd2">export</span>(org.apache.dubbo.rpc.Invoker arg0) <span style="color:#268bd2">throws</span> org.apache.dubbo.rpc.RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (arg0 <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;org.apache.dubbo.rpc.Invoker argument == null&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (arg0.getUrl() <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;org.apache.dubbo.rpc.Invoker argument getUrl() == null&#34;</span>); |
| </span></span><span style="display:flex;"><span> org.apache.dubbo.common.URL url <span style="color:#719e07">=</span> arg0.getUrl(); |
| </span></span><span style="display:flex;"><span> String extName <span style="color:#719e07">=</span> (url.getProtocol() <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">?</span> <span style="color:#2aa198">&#34;dubbo&#34;</span> : url.getProtocol()); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (extName <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Fail to get extension(org.apache.dubbo.rpc.Protocol) name from url(&#34;</span> <span style="color:#719e07">+</span> url.toString() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;) use keys([protocol])&#34;</span>); |
| </span></span><span style="display:flex;"><span> org.apache.dubbo.rpc.Protocol extension <span style="color:#719e07">=</span> (org.apache.dubbo.rpc.Protocol) ExtensionLoader.getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> extension.export(arg0); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> org.apache.dubbo.rpc.Invoker <span style="color:#268bd2">refer</span>(java.lang.Class arg0, org.apache.dubbo.common.URL arg1) <span style="color:#268bd2">throws</span> org.apache.dubbo.rpc.RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (arg1 <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalArgumentException(<span style="color:#2aa198">&#34;url == null&#34;</span>); |
| </span></span><span style="display:flex;"><span> org.apache.dubbo.common.URL url <span style="color:#719e07">=</span> arg1; |
| </span></span><span style="display:flex;"><span> String extName <span style="color:#719e07">=</span> (url.getProtocol() <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">?</span> <span style="color:#2aa198">&#34;dubbo&#34;</span> : url.getProtocol()); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (extName <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> IllegalStateException(<span style="color:#2aa198">&#34;Fail to get extension(org.apache.dubbo.rpc.Protocol) name from url(&#34;</span> <span style="color:#719e07">+</span> url.toString() <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;) use keys([protocol])&#34;</span>); |
| </span></span><span style="display:flex;"><span> org.apache.dubbo.rpc.Protocol extension <span style="color:#719e07">=</span> (org.apache.dubbo.rpc.Protocol) ExtensionLoader.getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> extension.refer(arg0, arg1); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The general logic is the same as at the beginning. The parameters are parsed through the url, and the parsed logic is controlled by the value parameter of @adaptive, and then the extension points implementation are obtained according to the name of the extension point. And then finally make the call. If you want to know the specific construction logic of .Java code, you can see the complete implementation of <code>createAdaptiveExtensionClassCode</code>. |
| In the generated Protocol$Adaptive, both the getDefaultPort and destroy methods are found to throw the exception directly. Why? Take a look at the source code of Protocol:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span>(<span style="color:#2aa198">&#34;dubbo&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">Protocol</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> <span style="color:#268bd2">getDefaultPort</span>(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Exporter<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">export</span>(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker) <span style="color:#268bd2">throws</span> RpcException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">refer</span>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RpcException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">destroy</span>(); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>As you can see, there are four methods in the Protocol interface, but only the methods of export and refer use the @Adaptive annotation. Dubbo automatically generates adaptive instances, and only the methods modified by @Adaptive has a specific implementation. Therefore, in the Protocol$Adaptive class, only the export and refer methods have specific implementations, and the rest of the methods throw exceptions.</p></description></item><item><title>Blog: Dubbo extensible mechanism source code analysis - part 1</title><link>https://dubbo.apache.org/en/blog/2019/04/25/dubbo-extensible-mechanism-source-code-analysis-part-1/</link><pubDate>Thu, 25 Apr 2019 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2019/04/25/dubbo-extensible-mechanism-source-code-analysis-part-1/</guid><description> |
| <h2 id="1-extension-mechanism-of-dubbo">1. Extension Mechanism of Dubbo</h2> |
| <p>Dubbo is claimed as a high-performance RPC framework on its official website. Today, I want to talk about another great specialty of Dubbo &mdash; its scalability. As quote: Rome wasn’t built in a day. Any successful system always starts as a prototype. It is impossible to design a perfect system at the beginning. Instead, we should focus on true demand and keep improving the system. On the coding side, it requires us to pay attention on abstraction layers and high-level isolation. In that case, the system could keep a healthy structure and easy to maintain while new features or third-party extensions are added. Under some circumstances, a designer should pursue more of scalability than the system’s current performance. |
| When talking about software design, people always mention scalability. A framework with good scalability requires the following: |
| 1.The framework should follow opening/closed principle: software entities should be open for extension, but closed for modification; This means a framework should allow the maintainer to add new functions with as few modifications as possible. |
| 2.The framework should allow the user to add new functions by adding code on his project without modifying the framework&rsquo;s original source code base. |
| With microkernel architecture and extension mechanism, Dubbo satisfies such requirements and achieves good scalability. In the following chapters, we will discuss Dubbo&rsquo;s extension mechanism in detail.</p> |
| <h2 id="2extension-solutions">2.Extension Solutions</h2> |
| <p>Creating Extensible applications usually considers:</p> |
| <ul> |
| <li>Factory method pattern</li> |
| <li>IoC container</li> |
| <li>OSGi (Open Services Gateway initiative)</li> |
| </ul> |
| <p>As a framework, Dubbo does not wish to rely on other IoC containers such as Spring, Guice. OSGi is too complicated to fit Dubbo. In the end, Dubbo SPI is inherited from standard JDK SPI and makes it more powerful.</p> |
| <h2 id="3java-spi-mechanism">3.Java SPI Mechanism</h2> |
| <p>We will first discuss Java SPI mechanism, which is a basis for understanding Dubbo’s extension mechanism. If you are familiar with Java SPI, you can skip this part.</p> |
| <p>Java SPI (Service Provider Interface) is a feature for discovering and loading implementations matching a given interface provided in JDK. We can create a text file with the same name as the interface under resource directory <code>META-INF/services</code>. The content of the file is the fully qualified class name of the SPI implementation, in which each component is separated by a line breaker. JDK uses <code>java.util.ServiceLoader</code> to load implementations of a service. Let us use a simple example to show how Java SPI works.</p> |
| <ol> |
| <li>Define an interface IRepository to store data.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">IRepository</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">save</span>(String data); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="2"> |
| <li>Create 2 implementations for IRepository: MysqlRepository and MongoRepository</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MysqlRepository</span> <span style="color:#268bd2">implements</span> IRepository { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">save</span>(String data) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Save &#34;</span> <span style="color:#719e07">+</span> data <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; to Mysql&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MongoRepository</span> <span style="color:#268bd2">implements</span> IRepository { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">save</span>(String data) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Save &#34;</span> <span style="color:#719e07">+</span> data <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34; to Mongo&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="3"> |
| <li>Create a configuration file under <code>META-INF/services</code>.</li> |
| </ol> |
| <p>The file name is <code>META-INF/services/com.demo.IRepository</code>, the content of file is:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>com.demo.MongoRepository |
| </span></span><span style="display:flex;"><span>com.demo.MysqlRepository |
| </span></span></code></pre></div><ol start="4"> |
| <li>Load IRepository using ServiceLoader</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ServiceLoader<span style="color:#719e07">&lt;</span>IRepository<span style="color:#719e07">&gt;</span> serviceLoader <span style="color:#719e07">=</span> ServiceLoader.load(IRepository.class); |
| </span></span><span style="display:flex;"><span>Iterator<span style="color:#719e07">&lt;</span>IRepository<span style="color:#719e07">&gt;</span> it <span style="color:#719e07">=</span> serviceLoader.iterator(); |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">while</span> (it <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">&amp;&amp;</span> it.hasNext()){ |
| </span></span><span style="display:flex;"><span> IRepository demoService <span style="color:#719e07">=</span> it.next(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;class:&#34;</span> <span style="color:#719e07">+</span> demoService.getClass().getName()); |
| </span></span><span style="display:flex;"><span> demoService.save(<span style="color:#2aa198">&#34;tom&#34;</span>); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>In the above example, we created an extension and two of its applications. We created the configuration file in ClassPath and loaded the extensions using ServiceLoader. The final output is: |
| class:testDubbo.MongoRepository |
| Save tom to Mongo |
| class:testDubbo.MysqlRepository |
| Save tom to Mysql</p> |
| <h2 id="4-dubbo-spi-mechanism">4. Dubbo SPI Mechanism</h2> |
| <p>Java SPI is simple to use. It also supports basic extension point functions, however, it has some disadvantages:</p> |
| <ul> |
| <li>It will load and instantiate all implementations at once to find the requested implementation.</li> |
| <li>The configuration file only includes the extension implementation but does not name them, which makes it hard to reference them in applications.</li> |
| <li>If extensions depend on other extensions, Java SPI cannot automatically load the dependency SPI.</li> |
| <li>It does not provide functions such as IOC or AOP in Spring.</li> |
| <li>It is hard to assemble extensions with other frameworks. For example, if the extension depends on Spring bean, the original Java SPI will not support it.</li> |
| </ul> |
| <p>Therefore, Java SPI is good for some simple scenarios, but does not fit for Dubbo. Dubbo makes some extensions on the original SPI mechanism. We will discuss more about the Dubbo SPI mechanism in the following sections.</p> |
| <h2 id="5-basic-concepts-for-dubbo-extension-point-mechanism">5. Basic Concepts for Dubbo Extension Point Mechanism</h2> |
| <p>Before diving into Dubbo&rsquo;s extension mechanism，Let us first declare some basic concepts in Dubbo SPI. Those terms will appear multiple times in the following section.</p> |
| <h3 id="51-extension-point">5.1 Extension Point</h3> |
| <p>an interface of java.</p> |
| <h3 id="52-extension">5.2 Extension</h3> |
| <p>an implementation class of the Extension Point</p> |
| <h3 id="53-extension-instance">5.3 Extension Instance</h3> |
| <p>instance of an extension point implementation class</p> |
| <h3 id="54-extension-adaptive-instance">5.4 Extension Adaptive Instance</h3> |
| <p>Maybe it is a little difficult to understand this concept when hearing about it the first time. It may help you understand it better by calling it an extension proxy class. The extension adaptive instance is actually an extension proxy, which implements the method of extension point interface. When calling the interface method of the extension point, it will decide which extension to use according to the actual parameters. For example, the extension point of an IRepository has one save method, and two implementations MysqlRepository and MongoRepository. When calling the method of the interface, the adaptive instance of IRepository will determine which IRepository implementation to call according to the parameters in the save method. If the parameter repository=mysql in the method, then we can call the save method of MysqlRepository. If repository=mongo, then we can call the save method of MongoRepository, which is similar to late binding in Object-oriented languages. However, why does Dubbo introduce the concept of extended adaptive instances?</p> |
| <ul> |
| <li>There are two configurations in Dubbo, one is a fixed system-level configuration and it will not be changed after Dubbo launches. Another is the run-time configuration that may be different for each RPC. For instance, the timeout is configured as 10 seconds in the xml file, which will not change after Dubbo launches. However, for a certain PRC call, we can set its timeout to 30 seconds so as to override the system-level configuration. For Dubbo, the parameters called in each RPC is unknown and only at run-time can you make the right decision according to revealed parameters.</li> |
| <li>Our class is usually singleton-scaled, such as beans of Spring IoC Container. When instantiating beans, if it depends on some specific extension point, it will know which extension to use, otherwise, the bean will not know how to choose extensions. At this time, a proxy mode is needed, which implements the interface of an extension point. The method can dynamically select the appropriate extension according to the run-time parameters, and this proxy is an adaptive instance. Adaptive extension instance is widely used in Dubbo, in Dubbo, each extension will have an adaptive class, and if we do not provide it, Dubbo will automatically generate one for us by using the bytecode encoder. Therefore, we basically don&rsquo;t recognize the existence of adaptive classes. We will explain how the adaptive class works in later chapters.</li> |
| </ul> |
| <h3 id="55-spi">5.5 @SPI</h3> |
| <p>@SPI annotation works on the interface of the extension point, which indicates that the interface is an extension point, and can be loaded by Dubbo ExtensionLoader. If there is no such ExtentionLoader, the call will throw an exception.</p> |
| <h3 id="56-adaptive">5.6 @Adaptive</h3> |
| <p>@Adaptive annotation is used on the method that extends the interface, which indicates an adaptive method. When Dubbo generates an adaptive instance for an extension point, if the function has @Adaptive annotation, then Dubbo will generate the corresponding code for the method. The method determines which extension to use according to the parameters. When @Adaptive annotation is used on the class to implement a Decorator class, it is similar to the Decorator pattern, whose major function is to return a specified class. Currently in Dubbo, both AdaptiveCompiler and AdaptiveExtensionFactory have @Adaptive annotation.</p> |
| <h3 id="57-extensionloader">5.7 ExtensionLoader</h3> |
| <p>Similar to the Java SPI ServiceLoader, it is responsible for loading extensions and life-cycle maintenance.</p> |
| <h3 id="58-extension-alias">5.8 Extension Alias</h3> |
| <p>Different from Java, each extension in Dubbo has an alias, which is used to reference them in the application, such as</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#268bd2">random</span><span style="color:#719e07">=</span>com.alibaba.dubbo.rpc.cluster.loadbalance.RandomLoadBalance |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">roundrobin</span><span style="color:#719e07">=</span>com.alibaba.dubbo.rpc.cluster.loadbalance.RoundRobinLoadBalance |
| </span></span></code></pre></div><p>where random, roundrobin are alias of the corresponding extensions, and we can directly use them in the configuration file.</p> |
| <h3 id="59-paths">5.9 Paths</h3> |
| <p>Similar to the way Java SPI loading the extension configuration from the <code>META-INF/services</code> directory, Dubbo will also load the extension configuration file from the following path:</p> |
| <ul> |
| <li><code>META-INF/dubbo/internal</code></li> |
| <li><code>META-INF/dubbo</code></li> |
| <li><code>META-INF/services</code></li> |
| </ul> |
| <h2 id="6-interpretation-for-dubbos-loadbalance-extension-point">6. Interpretation for Dubbo&rsquo;s LoadBalance Extension Point</h2> |
| <p>Now that we know some basic idea about Dubbo, let us check a practical extension point in Dubbo to get some intuition.</p> |
| <p>We take the Dubbo’s LoadBalance extension point as an example. A service in Dubbo usually has multiple providers. When a consumer calls the service, he needs to choose one of the providers. This is an example of LoadBalance. Now, let us figure out how LoadBalance becomes an extension point in Dubbo.</p> |
| <h3 id="61-loadbalance-interfance">6.1 LoadBalance Interfance</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span>(RandomLoadBalance.NAME) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">LoadBalance</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</span>(<span style="color:#2aa198">&#34;loadbalance&#34;</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">select</span>(List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers, URL url, Invocation invocation) <span style="color:#268bd2">throws</span> RpcException; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>LoadBalance interface has only one select method. Select method chose one invoker among multiple invokers. In the code above, the elements related to Dubbo SPI are:</p> |
| <ul> |
| <li>@SPI(RandomLoadBalance.NAME) @SPI is used for LoadBalance interface, which indicates that the LoadBalance interface is an extension point. Without the @SPI annotation, if we try to load the extension, it will throw an exception. @SPI annotation has one parameter, and this parameter represents the Alias of the default implementation of the extension point. If there has no explicitly specified extension, the default implementation will be used. |
| <code>RandomLoadBalance.NAME</code> is a constant with value “random” and is a random load balancing implementation. The definition of random is in the configuration file <code>META-INF/dubbo/internal/com.alibaba.dubbo.rpc.cluster.LoadBalance</code>:</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#268bd2">random</span><span style="color:#719e07">=</span>com.alibaba.dubbo.rpc.cluster.loadbalance.RandomLoadBalance |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">roundrobin</span><span style="color:#719e07">=</span>com.alibaba.dubbo.rpc.cluster.loadbalance.RoundRobinLoadBalance |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">leastactive</span><span style="color:#719e07">=</span>com.alibaba.dubbo.rpc.cluster.loadbalance.LeastActiveLoadBalance |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">consistenthash</span><span style="color:#719e07">=</span>com.alibaba.dubbo.rpc.cluster.loadbalance.ConsistentHashLoadBalance |
| </span></span></code></pre></div><p>There are four extension implementations of LoadBalance defined in the configuration file. The implementation of load balancing will not be covered in this article. The only thing we need to know is that Dubbo provides four kinds of load balancing implementations. We can explicitly specify an implementation by using xml file, properties file or JVM parameter. If there has no explicitly specified implementation, Dubbo will use random as default.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo_loadbalance.png" alt="img"></p> |
| <ul> |
| <li>@Adaptive(&ldquo;loadbalance&rdquo;) Applying @Adaptive annotation on select method indicates that select method is an adaptive method. Dubbo will automatically generate the corresponding code for the method. When select method is called, it will decide which extension to apply based on the method parameters. @Adaptive parameter <code>loadbalance</code> indicates that the value of loadbalance in method is the extension implementation that will be actually called. However, we cannot find loadbalance parameter in select method, then how can we obtain the value of loadbalance? There is another URL-type parameter in select method, and Dubbo obtains the value of loadbalance from that URL. Here we need to use Dubbo’s URL bus pattern, in one word, URL contains all the parameters in RPC. There is a member variable <code>Map&lt;String, String&gt;parameters</code> in the URL class, which contains loadbalance as a parameter</li> |
| </ul> |
| <h3 id="62-obtain-loadbalance-extension">6.2 Obtain LoadBalance extension</h3> |
| <p>The code of LoadBalance in Dubbo is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>LoadBalance lb <span style="color:#719e07">=</span> ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(loadbalanceName); |
| </span></span></code></pre></div><p>Using ExtensionLoader.getExtensionLoader(LoadBalance.class) method to obtain an implementation of ExtensionLoader, then we call getExtension and pass an extension alias to obtain the corresponding extension implementation.</p> |
| <h2 id="7-customize-a-loadbalance-extension">7. Customize a LoadBalance Extension</h2> |
| <p>In this session, we will use a simple example to implement a LoadBalance and integrate it into Dubbo. I will show some important steps and codes, and the complete demo can be downloaded from the following address(<a href="https://github.com/vangoleo/dubbo-spi-demo">https://github.com/vangoleo/dubbo-spi-demo</a>).</p> |
| <h3 id="71-implement-loadbalance-interface">7.1 implement LoadBalance Interface</h3> |
| <p>First, we build a LoadBalance instance. Since we just need the instance to demonstrate Dubbo extension mechanism, it will be very simple. We choose the first invoker and print a log sentence in the console.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.dubbo.spi.demo.consumer; |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoLoadBalance</span> <span style="color:#268bd2">implements</span> LoadBalance { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">select</span>(List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers, URL url, Invocation invocation) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;DemoLoadBalance: Select the first invoker...&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invokers.get(0); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="72-add-extension-configuration-file">7.2 Add extension configuration file</h3> |
| <p>Add file:<code>META-INF/dubbo/com.alibaba.dubbo.rpc.cluster.LoadBalance</code>. The content of file is:</p> |
| <div class="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><span style="color:#268bd2">demo</span><span style="color:#719e07">=</span>com.dubbo.spi.demo.consumer.DemoLoadBalance |
| </span></span></code></pre></div><h3 id="73-configure-customized-loadbalance">7.3 Configure customized LoadBalance</h3> |
| <p>Through the above 2 steps, we have already added a LoadBalance implementation named demo, and set up the configuration file. In the next step, we need to explicitly tell Dubbo to implement the demo while doing load balancing. If we use Dubbo through spring, we could set it up in the xml file.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;helloService&#34;</span> interface=<span style="color:#2aa198">&#34;com.dubbo.spi.demo.api.IHelloService&#34;</span> loadbalance=<span style="color:#2aa198">&#34;demo&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Configure &lt;loadbalance=&ldquo;demo&rdquo;&gt; in <a href="dubbo:reference">dubbo:reference</a> at consumer part.</p> |
| <h3 id="74-launch-dubbo">7.4 launch Dubbo</h3> |
| <p>Launch Dubbo and call IHelloService, the console will output log: <code>DemoLoadBalance: Select the first invoker...</code>, which means Dubbo does use our customized LoadBalance.</p> |
| <h2 id="summary">Summary</h2> |
| <p>So far, we learnt the basic concepts of Dubbo SPI beginning with Java SPI, and we used LoadBalance in Dubbo as an example to help us understand better. Finally, we practiced and created a customized LoadBalance and integrated it to Dubbo. We believe that combining concepts and practice, everyone can get a better idea of Dubbo’s scalability. To summarize, Dubbo SPI has the following features:</p> |
| <ul> |
| <li>Build extensions on Dubbo does not require modifications on the original source code base.</li> |
| <li>The customized Dubbo extension point implementation is a normal Java class. Dubbo does not introduce any specialized elements, and have almost zero code intrusion. |
| *Extension registration on Dubbo requires only configuration file under the ClassPath directory. It is simple to use and has no effect on the existing code. This meets opening/closed principle.</li> |
| <li>Dubbo&rsquo;s extension mechanism default: @SPI(&ldquo;dubbo&rdquo;) represents the default SPI object.</li> |
| <li>Dubbo&rsquo;s extension mechanism supports the advanced features such as IoC and AoP, etc.</li> |
| <li>Dubbo&rsquo;s extension mechanism supports third-party IoC containers. It supports Spring beans by default and can be extended to other containers, such as Google/Guice.</li> |
| <li>It is easy to switch the implementation of the extension point because it requires only modifications on the specific implementation in the configuration file without changing the code.</li> |
| </ul> |
| <p>In the next article, we will go deep and check Dubbo&rsquo;s source code to learn more about Dubbo&rsquo;s extensibility mechanism.</p></description></item><item><title>Blog: Implementation background and practice of Dubbo client asynchronous interface</title><link>https://dubbo.apache.org/en/blog/2019/02/20/implementation-background-and-practice-of-dubbo-client-asynchronous-interface/</link><pubDate>Wed, 20 Feb 2019 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2019/02/20/implementation-background-and-practice-of-dubbo-client-asynchronous-interface/</guid><description> |
| <h2 id="preface">Preface</h2> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubboasyn_client/1_en.png" alt="image | left"></p> |
| <p>Let&rsquo;s start with a brief introduction about the stages of a complete Dubbo invocation.</p> |
| <ol> |
| <li> |
| <p>Biz~ represents business thread, that is, the thread where the business logic is located. Biz~ thread pool may be created and maintained by business itself, most of which may be managed by system framework itself (for example, a web system runs under Tomcat container, Biz~ thread is maintained by Tomcat); IO~ stands for network data processing thread, which is created and maintained by IO framework (such as Netty, Grizzly). Dubbo Remoting&rsquo;s default Netty implementation is NioEventloopLoopGroup. In addition, according to the binding relationship between Channel and IO thread, IO~ can also be regarded as an acceptable Channel for event messages. Asynchronous processing stages such as Biz and IO are abstractly described in JDK8 as completionstages.</p> |
| </li> |
| <li> |
| <p>As we all know, the way of data communication between threads is shared variables. The data communication between Biz and IO is Queue. Specifically to Dubbo, Biz put a task in EventLoop&rsquo;s LinkedBlockingQueue in the client side implementation (i.e. the steps labeled in Figure 1 above), and the corresponding Thread in the EventLoop will keep iteration the Queue to keep on executing the information the task contains. Specific code can refer to SingleThreadEventExecutor (by the way, the default is to use in the Netty is capacity-free LinkedBlockingQueue, when the Biz processing rate higher than the rate of network, there seems to be a Memory Leak risk).</p> |
| </li> |
| <li> |
| <p>As shown in the figure above, a standard RPC call passes through four message (event) transfers of 1,2,3,4, respectively are the client business thread sending requests to the client IO thread, the server business logic thread receiving the server IO thread requests, the server logic thread responding to the server IO thread after processing, and the client IO thread receiving the results feedback to the business logic thread.</p> |
| </li> |
| </ol> |
| <h2 id="client-asynchronization">Client Asynchronization</h2> |
| <h3 id="background">Background</h3> |
| <p>In the Java language (other languages are not clear), a call of the local interface can be transparently converted into the call of remote RPC through the proxy mechanism. Most business parties prefer this programming method similar to the local interface to do remote service invocation. Therefore, although RPC is naturally asynchronous internally, users using Dubbo mostly use synchronization, while asynchrony becomes a minority use scenario. The advantage of synchronization is that the programming model is more in line with the &ldquo;traditional&rdquo; habits of the business side. The cost is that the current Biz~threads need to be blocked after the request event represented by 1 in the figure, and can not be awakened until the response processing represented by 4. In the process of 1,2,3,4, which is short in microsecond level and long in second level, the Biz~ thread will be blocked, which will consume thread resources and increase the overhead of system resources.</p> |
| <p>Therefore, the motivation of client asynchronization is to save thread resource overhead at the cost of understanding how asynchronization is used. In the synchronous mode, the return type of API interface represents a certain business class, while in the asynchronous case, the response and the request are completely independent events, so it is most suitable for the return type of API interface to be CompletionStage mentioned above, which is the inevitable asynchronization supported by Dubbo on asynchronization. Back to the latest Dubbo release, without changing the interface, you need to register a callback interface to handle the response return event when the service is created.</p> |
| <p>The example blow is to illustrate it.</p> |
| <h3 id="the-sample">The sample</h3> |
| <p>Refer to the example code for event notification: <a href="https://github.com/dubbo/dubbo-samples/tree/master/2-advanced/dubbo-samples-notify">https://github.com/dubbo/dubbo-samples/tree/master/dubbo-samples-notify</a></p> |
| <p>Event notification allows the Consumer to trigger &lsquo;oninvoke&rsquo;, &lsquo;onreturn&rsquo; and &lsquo;onthrow&rsquo; events, which respectively represent before the call, after the call returns normally, or when an exception occurs.</p> |
| <p>You can specify a method for notifying events when configuring the Consumer, such as:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoCallback&#34;</span> class=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.notify.impl.NotifyImpl&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> check=<span style="color:#2aa198">&#34;false&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.notify.api.DemoService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> group=<span style="color:#2aa198">&#34;cn&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;sayHello&#34;</span> onreturn=<span style="color:#2aa198">&#34;demoCallback.onreturn&#34;</span> onthrow=<span style="color:#2aa198">&#34;demoCallback.onthrow&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><p>The code for NotifyImpl is as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">NotifyImpl</span> <span style="color:#268bd2">implements</span> Notify{ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Map<span style="color:#719e07">&lt;</span>Integer, String<span style="color:#719e07">&gt;</span> ret <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>Integer, String<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onreturn</span>(String name, <span style="color:#dc322f">int</span> id) { |
| </span></span><span style="display:flex;"><span> ret.put(id, name); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;onreturn: &#34;</span> <span style="color:#719e07">+</span> name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onthrow</span>(Throwable ex, String name, <span style="color:#dc322f">int</span> id) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;onthrow: &#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>It is important to note that the parameters for the three methods in the custom Notify interface are as follows:</p> |
| <ul> |
| <li><code>oninvoke</code> The parameters of the method are the same as those of the calling method.</li> |
| <li><code>onreturn</code> The first parameter of the method is the return value of the calling method, and the rest is the parameters of the calling method.</li> |
| <li><code>onthrow</code> The first parameter to the method is the call exception, and the rest is the parameter to the calling method.</li> |
| </ul> |
| <p>In the above configuration, the <code>sayHello</code> method is called synchronously, so the execution of the event notification method is also synchronously executed. <code>async=true</code> can be configured to make the method call asynchronous, and the notification event method is also executed asynchronously. In particular, the <code>oninvoke</code> method executes synchronously, regardless of whether it is invoked asynchronously or not.</p> |
| <h3 id="practical-advice">Practical advice</h3> |
| <ul> |
| <li> |
| <div data-type="alignment" data-value="justify" style="text-align:justify"> |
| <div data-type="p">Logical Non-Strongly dependent results after RPC invocation: Asynchronous callbacks are suitable for client-side asynchronous invocation when the client <strong>is not strongly dependent on the server response</strong>.</div> |
| </div> |
| </li> |
| <li> |
| <div data-type="alignment" data-value="justify" style="text-align:justify"> |
| <div data-type="p">RX scenario: after learning about reactive programming model, I believe that as long as the programming thinking can embrace reactive and the state machine design of business model can be adjusted appropriately, asynchronous solutions can be applied in all scenarios, so as to achieve better terminal response experience. For Dubbo, the current asynchronous interface model needs to be improved like the reactive model interface in order to make the user more naturally apply the asynchronous interface. </div> |
| </div> |
| </li> |
| </ul> |
| <h3 id="conclusions">Conclusions</h3> |
| <ul> |
| <li>The motivation of client asynchronization is that the request sending and response processing are two different independent events, how the response is handled and in which thread is handled are not required to be coupled with the business logic thread of the request sending event.</li> |
| <li>The processing logic of response event callbacks in which thread to process is to be selected according to the situation. It is recommended that if the callback logic is relatively simple, it should be directly in the IO thread; if it contains IO type synchronization operations such as remote access or DB access, it is recommended that it be processed in a separate thread pool.</li> |
| </ul></description></item><item><title>Blog: Implementation background and practice of Dubbo server asynchronous interface</title><link>https://dubbo.apache.org/en/blog/2019/02/20/implementation-background-and-practice-of-dubbo-server-asynchronous-interface/</link><pubDate>Wed, 20 Feb 2019 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2019/02/20/implementation-background-and-practice-of-dubbo-server-asynchronous-interface/</guid><description> |
| <h2 id="preface">Preface</h2> |
| <p>It is suggested to make an understanding of the thread phase involved in the process of Dubbo first, please refer to <a href="https://dubbo.apache.org/en/blog/2019/02/20/implementation-background-and-practice-of-dubbo-client-asynchronous-interface/">Implementation background and practice of Dubbo client asynchronous interface</a> for details.</p> |
| <h2 id="implementation-background">Implementation background</h2> |
| <p>It is necessary to introduce the server-side thread strategy in more detail to deepen the user&rsquo;s judgment basis for selecting server-side asynchrony. It is also necessary to introduce coroutines, the &ldquo;secret weapon&rdquo; often used in server-side asynchrony.</p> |
| <h3 id="server-side-thread-strategy">Server-side thread strategy</h3> |
| <p>Dubbo supports a variety of NIO frameworks to implement remoting protocols. Whether Netty, Mina or Grizzly, the implementations are much the same. They are all based on event-driven methods to establish network channels and read data streams. Taking introduction to <a href="https://javaee.github.io/grizzly/iostrategies.html">Thread Strategy</a> of Grizzly as an example, the following four categories are usually supported. Dubbo as an RPC framework, the default choice is the first strategy. Because it is impossible to determine whether the business services are CPU-intensive or IO blocking type. the first strategy is the most insurance strategy. Of course, after understanding these strategies, it is the most perfect choice to make targeted choices based on business scenarios.</p> |
| <ol> |
| <li><strong>Worker-thread Strategy</strong></li> |
| </ol> |
| <p>The most useful IOStrategy, where Selector thread delegates NIO events processing to a worker threads.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubboasyn_server/1.png" alt="workerthread-strategy.png"></p> |
| <p>This IOStrategy is very scalable and safe. We can change the size of selector and worker thread pool as required and there is no risk that some problem, which may occur during the specific NIO event processing, will impact other Channels registered on the same Selector.</p> |
| <p>The disadvantage is the cost of thread context switching.</p> |
| <ol start="2"> |
| <li><strong>Same-thread Strategy</strong></li> |
| </ol> |
| <p>Potentially the most efficient IOStrategy. Unlike the worker-thread IOStrategy, the same-thread IOStrategy processes NIO events in the current thread, avoiding expensive thread context switches.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubboasyn_server/2.png" alt="samethread-strategy.png"></p> |
| <p>This IOStrategy is still pretty scalable, because we can tune the selector thread pool size, but it does have drawbacks. Care needs to be taken that channel NIO event processing won’t block or execute any long lasting operation, because it may block the processing of other NIO events that occur on the same Selector.</p> |
| <ol start="3"> |
| <li><strong>Dynamic Strategy</strong></li> |
| </ol> |
| <p>As mentioned previously worker-thread and same-thread strategies have distinct advantages and disadvantages. However, what if a strategy could try to swap them smartly during runtime depending on the current conditions (load, gathered statistics… etc)?</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubboasyn_server/3.png" alt="dynamic-strategy.png"></p> |
| <p>Potentially this IOStrategy could bring a lot of benefit and allow finer control of the resources. However, it’s important to not overload the condition evaluation logic, as its complexity will make this IOStrategy inefficient comparing to previous two strategies.</p> |
| <p>By the way, I want you to pay more attention to this strategy, which is probably the best combination of Dubbo server asynchrony.</p> |
| <ol start="4"> |
| <li><strong>Leader-follower Strategy</strong></li> |
| </ol> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubboasyn_server/4.png" alt="leaderfollower-strategy.png"></p> |
| <p>This IOStrategy is similar to worker-thread IOStrategy, but instead of passing NIO event processing to a worker thread, it changes worker thread to a selector thread by passing it the control over Selector and the actual NIO event processing takes place in the current thread. This strategy actually confuses worker and IO thread stages, which is not recommended.</p> |
| <h3 id="coroutine-and-thread">Coroutine and thread</h3> |
| <p>In terms of CPU resource management, the minimum scheduling unit of OS and JVM is thread. The coroutine library implemented by business application through extension can have independent running unit. In fact, it is also done based on thread. The principle should be to save the context and switch to another coroutine when IO blocking or lock waiting is encountered.</p> |
| <p><strong>In the default Dubbo thread strategy, there are worker thread pools to execute the business logic, but the ThreadPool Full problem often occurs. In order to release worker threads as soon as possible, another thread will be set up in the implementation of the business service. The cost is thread context switching again, and it&rsquo;s necessary to consider link-level data transfer (such as tracing information) and flow-control export controls, etc. Of course, if Dubbo can switch to the Same-thread strategy, combined with the coroutine library support, server-side asynchrony is a recommended use.</strong></p> |
| <h2 id="the-sample">The sample</h2> |
| <p>Use an example to experience the Dubbo server-side asynchronous interface. For Demo code, visit <a href="https://github.com/dubbo/dubbo-samples/tree/master/2-advanced/dubbo-samples-notify">https://github.com/dubbo/dubbo-samples/tree/master/dubbo-samples-notify</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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService { |
| </span></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> System.out.println(<span style="color:#2aa198">&#34;Main sayHello() method start.&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> AsyncContext asyncContext <span style="color:#719e07">=</span> RpcContext.startAsync(); |
| </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> asyncContext.signalContextSwitch(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Attachment from consumer: &#34;</span> <span style="color:#719e07">+</span> RpcContext.getContext().getAttachment(<span style="color:#2aa198">&#34;consumer-key1&#34;</span>)); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34; -- Async start.&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep(500); |
| </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> } |
| </span></span><span style="display:flex;"><span> asyncContext.write(<span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, response from provider.&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34; -- Async end.&#34;</span>); |
| </span></span><span style="display:flex;"><span> }).start(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Main sayHello() method end.&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;hello, &#34;</span> <span style="color:#719e07">+</span> name; |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><h2 id="practical-suggestions">Practical suggestions</h2> |
| <ul> |
| <li>Don&rsquo;t rely too much on server-side asynchrony.</li> |
| <li>Server-side asynchrony is basically a false proposition in the face of event-driven or Reactive.<span data-type="color" style="color:rgb(36, 41, 46)"><span data-type="background" style="background-color:rgb(255, 255, 255)">Supplement the reason: the server asynchrony is said Dubbo server-side business threads (default is 200) is not enough, but in the Event-Driven mode, 200 threads certainly do not need that much, just as much as the number of CPU cores. As long as the business implementation is non-blocking and pure asynchronous business logic processing, it is a waste of resources to use as many threads as possible.</span></span></li> |
| <li>To use server-side asynchrony, it is recommended that the server-side thread strategy adopt the Same_thread pattern + Coroutine Library.</li> |
| </ul> |
| <h2 id="conclusions">Conclusions</h2> |
| <p>When Dubbo supports business applications, it encounters a variety of requirements scenarios, and server-side asynchrony provides users with a solution to deal with ThreadPool Full. In the case of ThreadPool Full, if the current system bottleneck is CPU, this solution is not recommended. If the system load is not high, increasing the number of worker threads or using server asynchrony can be considered.</p></description></item><item><title>Blog: How to use Seata to ensure consistency between Dubbo Microservices</title><link>https://dubbo.apache.org/en/blog/2019/01/17/how-to-use-seata-to-ensure-consistency-between-dubbo-microservices/</link><pubDate>Thu, 17 Jan 2019 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2019/01/17/how-to-use-seata-to-ensure-consistency-between-dubbo-microservices/</guid><description> |
| <h2 id="use-case">Use case</h2> |
| <p>A business logic for user purchasing commodities. The whole business logic is powered by 3 microservices:</p> |
| <ul> |
| <li>Storage service: deduct storage count on given commodity.</li> |
| <li>Order service: create order according to purchase request.</li> |
| <li>Account service: debit the balance of user&rsquo;s account.</li> |
| </ul> |
| <h3 id="architecture">Architecture</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/fescar/fescar-1.png" alt="Architecture"></p> |
| <h3 id="storageservice">StorageService</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">StorageService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * deduct storage count |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">deduct</span>(String commodityCode, <span style="color:#dc322f">int</span> count); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="orderservice">OrderService</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">OrderService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * create order |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> Order <span style="color:#268bd2">create</span>(String userId, String commodityCode, <span style="color:#dc322f">int</span> orderCount); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="accountservice">AccountService</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AccountService</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * debit balance of user&#39;s account |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">debit</span>(String userId, <span style="color:#dc322f">int</span> money); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="main-business-logic">Main business logic</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">BusinessServiceImpl</span> <span style="color:#268bd2">implements</span> BusinessService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> StorageService storageService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> OrderService orderService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * purchase |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">purchase</span>(String userId, String commodityCode, <span style="color:#dc322f">int</span> orderCount) { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> storageService.deduct(commodityCode, orderCount); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> orderService.create(userId, commodityCode, orderCount); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">StorageServiceImpl</span> <span style="color:#268bd2">implements</span> StorageService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> StorageDAO storageDAO; |
| </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">deduct</span>(String commodityCode, <span style="color:#dc322f">int</span> count) { |
| </span></span><span style="display:flex;"><span> Storage storage <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Storage(); |
| </span></span><span style="display:flex;"><span> storage.setCount(count); |
| </span></span><span style="display:flex;"><span> storage.setCommodityCode(commodityCode); |
| </span></span><span style="display:flex;"><span> storageDAO.update(storage); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">OrderServiceImpl</span> <span style="color:#268bd2">implements</span> OrderService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> OrderDAO orderDAO; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> AccountService accountService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Order <span style="color:#268bd2">create</span>(String userId, String commodityCode, <span style="color:#dc322f">int</span> orderCount) { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> orderMoney <span style="color:#719e07">=</span> calculate(commodityCode, orderCount); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> accountService.debit(userId, orderMoney); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> Order order <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Order(); |
| </span></span><span style="display:flex;"><span> order.userId <span style="color:#719e07">=</span> userId; |
| </span></span><span style="display:flex;"><span> order.commodityCode <span style="color:#719e07">=</span> commodityCode; |
| </span></span><span style="display:flex;"><span> order.count <span style="color:#719e07">=</span> orderCount; |
| </span></span><span style="display:flex;"><span> order.money <span style="color:#719e07">=</span> orderMoney; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> orderDAO.insert(order); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h2 id="distributed-transaction-solution-with-seata">Distributed Transaction Solution with Seata</h2> |
| <p><img src="https://dubbo.apache.org/imgs/blog/fescar/fescar-2.png" alt="undefined"></p> |
| <p>We just need an annotation <code>@GlobalTransactional</code> on business method:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#268bd2">@GlobalTransactional</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">purchase</span>(String userId, String commodityCode, <span style="color:#dc322f">int</span> orderCount) { |
| </span></span><span style="display:flex;"><span> ...... |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><h2 id="example-powered-by-dubbo--seata">Example powered by Dubbo + Seata</h2> |
| <h3 id="step-1-setup-database">Step 1: Setup database</h3> |
| <ul> |
| <li>Requirement: MySQL with InnoDB engine.</li> |
| </ul> |
| <p><strong>Note:</strong> In fact, there should be 3 database for the 3 services in the example use case. However, we can just create one database and configure 3 data sources for simple.</p> |
| <p>Modify Spring XML with the database URL/username/password you just created.</p> |
| <p>dubbo-account-service.xml |
| dubbo-order-service.xml |
| dubbo-storage-service.xml</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;property</span> name=<span style="color:#2aa198">&#34;url&#34;</span> value=<span style="color:#2aa198">&#34;jdbc:mysql://x.x.x.x:3306/xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;property</span> name=<span style="color:#2aa198">&#34;username&#34;</span> value=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;property</span> name=<span style="color:#2aa198">&#34;password&#34;</span> value=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="step-2-create-undo_log-table-for-seata">Step 2: Create undo_log table for Seata</h3> |
| <p><code>UNDO_LOG</code> table is required by Seata AT mode.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sql" data-lang="sql"><span style="display:flex;"><span><span style="color:#586e75">-- Note that when Seata version is upgraded to 0.3.0+, it is changed from the previous normal index to the unique index. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">`</span>undo_log<span style="color:#719e07">`</span> ( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>id<span style="color:#719e07">`</span> <span style="color:#b58900">bigint</span>(<span style="color:#2aa198">20</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> AUTO_INCREMENT, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span> <span style="color:#b58900">bigint</span>(<span style="color:#2aa198">20</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span> <span style="color:#b58900">varchar</span>(<span style="color:#2aa198">100</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>context<span style="color:#719e07">`</span> <span style="color:#b58900">varchar</span>(<span style="color:#2aa198">128</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>rollback_info<span style="color:#719e07">`</span> longblob <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_status<span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_created<span style="color:#719e07">`</span> datetime <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>log_modified<span style="color:#719e07">`</span> datetime <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>ext<span style="color:#719e07">`</span> <span style="color:#b58900">varchar</span>(<span style="color:#2aa198">100</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>id<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">UNIQUE</span> <span style="color:#719e07">KEY</span> <span style="color:#719e07">`</span>ux_undo_log<span style="color:#719e07">`</span> (<span style="color:#719e07">`</span>xid<span style="color:#719e07">`</span>,<span style="color:#719e07">`</span>branch_id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE<span style="color:#719e07">=</span>InnoDB AUTO_INCREMENT<span style="color:#719e07">=</span><span style="color:#2aa198">1</span> <span style="color:#719e07">DEFAULT</span> CHARSET<span style="color:#719e07">=</span>utf8; |
| </span></span></code></pre></div><h3 id="step-3-create-tables-for-example-business">Step 3: Create tables for example business</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sql" data-lang="sql"><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">DROP</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>storage_tbl<span style="color:#719e07">`</span>; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">`</span>storage_tbl<span style="color:#719e07">`</span> ( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>id<span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> AUTO_INCREMENT, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>commodity_code<span style="color:#719e07">`</span> <span style="color:#b58900">varchar</span>(<span style="color:#2aa198">255</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span><span style="color:#719e07">count</span><span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#2aa198">0</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>id<span style="color:#719e07">`</span>), |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">UNIQUE</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>commodity_code<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE<span style="color:#719e07">=</span>InnoDB <span style="color:#719e07">DEFAULT</span> CHARSET<span style="color:#719e07">=</span>utf8; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">DROP</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>order_tbl<span style="color:#719e07">`</span>; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">`</span>order_tbl<span style="color:#719e07">`</span> ( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>id<span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> AUTO_INCREMENT, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>user_id<span style="color:#719e07">`</span> <span style="color:#b58900">varchar</span>(<span style="color:#2aa198">255</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>commodity_code<span style="color:#719e07">`</span> <span style="color:#b58900">varchar</span>(<span style="color:#2aa198">255</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span><span style="color:#719e07">count</span><span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#2aa198">0</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>money<span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#2aa198">0</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE<span style="color:#719e07">=</span>InnoDB <span style="color:#719e07">DEFAULT</span> CHARSET<span style="color:#719e07">=</span>utf8; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">DROP</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">IF</span> <span style="color:#719e07">EXISTS</span> <span style="color:#719e07">`</span>account_tbl<span style="color:#719e07">`</span>; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">CREATE</span> <span style="color:#719e07">TABLE</span> <span style="color:#719e07">`</span>account_tbl<span style="color:#719e07">`</span> ( |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>id<span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">NOT</span> <span style="color:#719e07">NULL</span> AUTO_INCREMENT, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>user_id<span style="color:#719e07">`</span> <span style="color:#b58900">varchar</span>(<span style="color:#2aa198">255</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#719e07">NULL</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">`</span>money<span style="color:#719e07">`</span> <span style="color:#b58900">int</span>(<span style="color:#2aa198">11</span>) <span style="color:#719e07">DEFAULT</span> <span style="color:#2aa198">0</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">PRIMARY</span> <span style="color:#719e07">KEY</span> (<span style="color:#719e07">`</span>id<span style="color:#719e07">`</span>) |
| </span></span><span style="display:flex;"><span>) ENGINE<span style="color:#719e07">=</span>InnoDB <span style="color:#719e07">DEFAULT</span> CHARSET<span style="color:#719e07">=</span>utf8; |
| </span></span></code></pre></div><h3 id="step-4-start-seata-server">Step 4: Start Seata-Server</h3> |
| <ul> |
| <li>Download server <a href="https://github.com/seata/seata/releases">package</a>, unzip it.</li> |
| <li>Start Seata-Server</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>Usage: sh seata-server.sh<span style="color:#719e07">(</span><span style="color:#719e07">for</span> linux and mac<span style="color:#719e07">)</span> or cmd seata-server.bat<span style="color:#719e07">(</span><span style="color:#719e07">for</span> windows<span style="color:#719e07">)</span> <span style="color:#719e07">[</span>options<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> Options: |
| </span></span><span style="display:flex;"><span> --host, -h |
| </span></span><span style="display:flex;"><span> The host to bind. |
| </span></span><span style="display:flex;"><span> Default: 0.0.0.0 |
| </span></span><span style="display:flex;"><span> --port, -p |
| </span></span><span style="display:flex;"><span> The port to listen. |
| </span></span><span style="display:flex;"><span> Default: <span style="color:#2aa198">8091</span> |
| </span></span><span style="display:flex;"><span> --storeMode, -m |
| </span></span><span style="display:flex;"><span> log store mode : file、db |
| </span></span><span style="display:flex;"><span> Default: file |
| </span></span><span style="display:flex;"><span> --help |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>e.g. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>sh seata-server.sh -p <span style="color:#2aa198">8091</span> -h 127.0.0.1 -m file |
| </span></span></code></pre></div><h3 id="step-5-run-example">Step 5: Run example</h3> |
| <ul> |
| <li>Start AccountService (<a href="https://github.com/apache/dubbo-samples/blob/master/99-integration/dubbo-samples-transaction/src/main/java/org/apache/dubbo/samples/starter/DubboAccountServiceStarter.java">DubboAccountServiceStarter</a>).</li> |
| <li>Start StockService (<a href="https://github.com/apache/dubbo-samples/blob/master/99-integration/dubbo-samples-transaction/src/main/java/org/apache/dubbo/samples/starter/DubboStorageServiceStarter.java">DubboStorageServiceStarter</a>).</li> |
| <li>Start OrderService (<a href="https://github.com/apache/dubbo-samples/blob/master/99-integration/dubbo-samples-transaction/src/main/java/org/apache/dubbo/samples/starter/DubboOrderServiceStarter.java">DubboOrderServiceStarter</a>).</li> |
| <li>Run BusinessService for test (<a href="https://github.com/apache/dubbo-samples/blob/master/99-integration/dubbo-samples-transaction/src/main/java/org/apache/dubbo/samples/starter/DubboBusinessTester.java">DubboBusinessTester</a>).</li> |
| </ul> |
| <h3 id="related-projects">Related projects</h3> |
| <ul> |
| <li>Seata: <a href="https://github.com/seata/seata">https://github.com/seata/seata</a></li> |
| <li>Seata Samples : <a href="https://github.com/seata/seata-samples">https://github.com/seata/seata-samples</a></li> |
| </ul></description></item><item><title>Blog: The fifth Dubbo meetup has been held in Hangzhou</title><link>https://dubbo.apache.org/en/blog/2018/12/10/the-fifth-dubbo-meetup-has-been-held-in-hangzhou/</link><pubDate>Mon, 10 Dec 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/12/10/the-fifth-dubbo-meetup-has-been-held-in-hangzhou/</guid><description> |
| <p>The fifth Dubbo meetup has been held in Hangzhou,</p> |
| <p>Please enjoy the slides of the topics:</p> |
| <ul> |
| <li>Ding Li: How to involve in dubbo community <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201812%40hangzhou/how-to-involve-in-dubbo-community.pdf">slides</a></li> |
| <li>Shenli Cao: Dubbo 2.7 introduction <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201812%40hangzhou/dubbo-2.7-introduction.pdf">slides</a></li> |
| <li>Tao Yang: Dubbo practice in netease koala <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201812%40hangzhou/dubbo-practice-in-netease-koala.pdf">slides</a></li> |
| <li>Mercy Ma: Nacos support in Dubbo <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201812%40hangzhou/nacos-support-in-dubbo.pdf">slides</a></li> |
| <li>Yihao Zhao: Sentinel: Sentinel support for Dubbo <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201812%40hangzhou/sentinel-support-for-dubbo.pdf">slides</a></li> |
| <li>Zhixuan Chen: Troubleshooting Dubbo with Arthas <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201812%40hangzhou/troubleshooting-dubbo-with-arthas.pdf">slides</a></li> |
| </ul></description></item><item><title>Blog: Dubbo Integrates with Nacos to Become a Registry</title><link>https://dubbo.apache.org/en/blog/2018/11/07/dubbo-integrates-with-nacos-to-become-a-registry/</link><pubDate>Wed, 07 Nov 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/11/07/dubbo-integrates-with-nacos-to-become-a-registry/</guid><description> |
| <p>Nacos is an important registry in Dubbo ecosystem, and dubbo-registry-nacos is the implementation of Dubbo-integrated Nacos registry.</p> |
| <h2 id="preparation-works">Preparation Works</h2> |
| <p>Before you integrate dubbo-registry-nacos into your Dubbo project, make sure the Nacos service is started in the background. If you are not familiar with the basic use of Nacos, you can refer to the Quick Start for Nacos: <a href="https://nacos.io/en-us/docs/quick-start.html">https://nacos.io/en-us/docs/quick-start.html</a>. Nacos versions above 0.6.1 are recommended.</p> |
| <h2 id="get-started-quickly">Get Started Quickly</h2> |
| <p>The operation steps for Dubbo to integrate Nacos into a registry are simple, the general steps can be divided into &ldquo;add Maven dependency&rdquo; and &ldquo;configure the registry.&rdquo;</p> |
| <h2 id="increase-maven-dependency">Increase Maven Dependency</h2> |
| <p>First, you need to add the Maven dependency of dubbo-registry-nacos to your project&rsquo;s pom.xml file, and it is strongly recommended that you use Dubbo 2.6.5:</p> |
| <div class="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></span><span style="display:flex;"><span> ... |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Dubbo Nacos registry 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<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-registry-nacos<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.0.2<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;!-- Keep latest Nacos client 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;groupId&gt;</span>org.apache.nacos<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>nacos-client<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;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Dubbo 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<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>2.6.5<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;!-- Alibaba Spring Context extension --&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.spring<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-support<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>1.0.2<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></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>When you add dubbo-registry-nacos to your project, you don&rsquo;t need to programmatically implement the service discovery and registration logic, the actual implementation is provided by the third-party package, and then to configure the Naocs registry.</p> |
| <h2 id="configure-the-registry">Configure the Registry</h2> |
| <p>Assuming your Dubbo application is assembled by the Spring Framework, there are two configuration options: Dubbo Spring externalization configuration and Spring XML configuration files, I strongly recommend the former.</p> |
| <h2 id="dubbo-spring-externalization-configuration">Dubbo Spring Externalization Configuration</h2> |
| <p>Dubbo Spring externalization configuration is a new feature introduced by Dubbo 2.5.8, which automatically generates and binds Dubbo configuration Bean through the Spring Environment property, simplifying configuration and lowering the threshold for microservice development.</p> |
| <p>Assume your Dubbo application uses Zookeeper as the registry and its server IP address is 10.20.153.10, the registered address is also stored in the dubbo-config.properties file as a Dubbo externalization configuration attribute, as shown below:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75">## application</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.name <span style="color:#719e07">=</span> <span style="color:#2aa198">your-dubbo-application</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## Zookeeper registry address</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address <span style="color:#719e07">=</span> <span style="color:#2aa198">zookeeper://10.20.153.10:2181</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span></code></pre></div><p>Assuming your Nacos Server is also running on server 10.20.153.10 and using the default Nacos service port 8848, you can simply adjust the dubbo.registry.address property as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75">## 其他属性保持不变</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## Nacos registry address</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address <span style="color:#719e07">=</span> <span style="color:#2aa198">nacos://10.20.153.10:8848</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span></code></pre></div><p>Subsequently, restart your Dubbo application, and Dubbo&rsquo;s service delivery and consumption information can be displayed in the Nacos console:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-registry-nacos-1.png" alt="image-20181213103845976"></p> |
| <p>As shown in the figure, the service name prefixed with providers: is the meta-information for the service provider, and consumers: represents the meta-information of the service consumer. Click &ldquo;Details&rdquo; to view service status details:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-registry-nacos-2.png" alt="image-20181213104145998"></p> |
| <p>If you are using the Spring XML configuration file to assemble the Dubbo registry, refer to the next section.</p> |
| <h2 id="spring-xml-configuration-file">Spring XML Configuration File</h2> |
| <p>Also, assume your Dubbo application uses Zookeeper as the registry and its server IP address is 10.20.153.10 and assemble the Spring Bean in an XML file, as shown below:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Provider application information for dependency calculation --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;dubbo-provider-xml-demo&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Using the Zookeeper registry Zookeeper --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;zookeeper://10.20.153.10: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:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><p>Similar to the Dubbo Spring externalization configuration, simply adjust the address property configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Provider application information for dependency calculation--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;dubbo-provider-xml-demo&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Using the Nacos registry --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;nacos://10.20.153.10:8848&#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>Once you restart the Dubbo application, you can also see that the registration meta-information for both service providers and consumers is presented in the Nacos console:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-registry-nacos-3.png" alt="image-20181213113049185"></p> |
| <p>Do you absolutely configure or switch Nacos registry super Easy? If you want to get more or unclear, refer to the complete example below.</p> |
| <h2 id="complete-example">Complete Example</h2> |
| <p>The metadata in the above image is derived from the Dubbo Spring annotation-driven example and the Dubbo Spring XML configuration-driven example, both of which will be described below, you can choose your preferred programming model. Before we get into the formal discussion, let&rsquo;s look at the preparations for both, as they both rely on Java service interfaces and implementations. Also, ensure that the Nacos service is started in the local (127.0.0.1) environment.</p> |
| <h3 id="example-interfaces-and-implementations">Example Interfaces and Implementations</h3> |
| <p>First, define the sample interface, as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.demo.service; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * DemoService |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @since 2.7.4 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#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">sayName</span>(String name); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Provide implementation classes for the above interfaces:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#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.demo.service; |
| </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.Service; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.apache.dubbo.rpc.RpcContext; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.beans.factory.annotation.Value; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Default {@link DemoService} |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @since 2.7.4 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Service</span>(version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${demo.service.version}&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DefaultService</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">@Value</span>(<span style="color:#2aa198">&#34;${demo.service.name}&#34;</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String serviceName; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayName</span>(String name) { |
| </span></span><span style="display:flex;"><span> RpcContext rpcContext <span style="color:#719e07">=</span> RpcContext.getContext(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> String.format(<span style="color:#2aa198">&#34;Service [name :%s , port : %d] %s(\&#34;%s\&#34;) : Hello,%s&#34;</span>, |
| </span></span><span style="display:flex;"><span> serviceName, |
| </span></span><span style="display:flex;"><span> rpcContext.getLocalPort(), |
| </span></span><span style="display:flex;"><span> rpcContext.getMethodName(), |
| </span></span><span style="display:flex;"><span> name, |
| </span></span><span style="display:flex;"><span> name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Once the interface and implementation are ready, the annotation-driven and XML configuration-driven implementations will be used below.</p> |
| <h2 id="spring-annotation-driven-example">Spring Annotation-driven Example</h2> |
| <p>Dubbo 2.7.4 reconstructs the Spring annotation-driven programming model.</p> |
| <h3 id="service-provider-annotation-driven-implementation">Service Provider Annotation-driven Implementation</h3> |
| <ul> |
| <li>Define property source of Dubbo provider externalization configuration - provider-config.properties</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75">## application</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.name <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo-provider-demo</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## Nacos registry address</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address <span style="color:#719e07">=</span> <span style="color:#2aa198">nacos://127.0.0.1:8848</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## Dubbo Protocol</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.name <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port <span style="color:#719e07">=</span> <span style="color:#2aa198">-1</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Provider @Service version</span> |
| </span></span><span style="display:flex;"><span>demo.service.version<span style="color:#719e07">=</span><span style="color:#2aa198">1.0.0</span> |
| </span></span><span style="display:flex;"><span>demo.service.name <span style="color:#719e07">=</span> <span style="color:#2aa198">demoService</span> |
| </span></span></code></pre></div><ul> |
| <li>Implement service provider bootstrap - DemoServiceProviderBootstrap</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.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.apache.dubbo.demo.service.DemoService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.context.annotation.AnnotationConfigApplicationContext; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.context.annotation.PropertySource; |
| </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:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * {@link DemoService} provider demo |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span>(scanBasePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;org.apache.dubbo.demo.service&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@PropertySource</span>(value <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;classpath:/provider-config.properties&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceProviderBootstrap</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> AnnotationConfigApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AnnotationConfigApplicationContext(); |
| </span></span><span style="display:flex;"><span> context.register(DemoServiceProviderBootstrap.class); |
| </span></span><span style="display:flex;"><span> context.refresh(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;DemoService provider is starting...&#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><p>Wherein, the annotation @EnableDubbo activates the Dubbo annotation-driven and externalization configuration, its scanBasePackages property scans the specified Java package, exposes all service interface implementation classes labeled @Service as Spring Bean, and then exports the Dubbo service.</p> |
| <p>@PropertySource is the standard import property configuration resource annotation introduced by Spring Framework 3.1, which provides externalization configuration for Dubbo.</p> |
| <h2 id="service-consumer-annotation-driven-implementation">Service consumer annotation-driven implementation</h2> |
| <ul> |
| <li>Define property source of Dubbo consumer externalization configuration - consumer-config.properties</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75">## Dubbo Application info</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.name <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo-consumer-demo</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## Nacos registry address</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address <span style="color:#719e07">=</span> <span style="color:#2aa198">nacos://127.0.0.1:8848</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># @Reference version</span> |
| </span></span><span style="display:flex;"><span>demo.service.version<span style="color:#719e07">=</span> <span style="color:#2aa198">1.0.0</span> |
| </span></span></code></pre></div><p>Similarly, the dubbo.registry.address property points to the Nacos registry, through which metadata about other Dubbo services is obtained.</p> |
| <ul> |
| <li>Implement service consumer bootstrap class - DemoServiceConsumerBootstrap</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.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.annotation.Reference; |
| </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.apache.dubbo.demo.service.DemoService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.context.annotation.AnnotationConfigApplicationContext; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.context.annotation.PropertySource; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> javax.annotation.PostConstruct; |
| </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:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * {@link DemoService} consumer demo |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</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">@PropertySource</span>(value <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;classpath:/consumer-config.properties&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceConsumerBootstrap</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Reference</span>(version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${demo.service.version}&#34;</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">@PostConstruct</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">init</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> 0; i <span style="color:#719e07">&lt;</span> 10; i<span style="color:#719e07">++</span>) { |
| </span></span><span style="display:flex;"><span> System.out.println(demoService.sayName(<span style="color:#2aa198">&#34;小马哥（mercyblitz）&#34;</span>)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#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> AnnotationConfigApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AnnotationConfigApplicationContext(); |
| </span></span><span style="display:flex;"><span> context.register(DemoServiceConsumerBootstrap.class); |
| </span></span><span style="display:flex;"><span> context.refresh(); |
| </span></span><span style="display:flex;"><span> context.close(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Similarly, the @EnableDubbo annotation activates the Dubbo annotation-driven and externalization configuration, although it currently belongs to the service consumer and does not require the Java package name to scan the service implementation labeled @Service.</p> |
| <p>@Reference is a dependency injection annotation for Dubbo remote services that requires service provider and consumer contract interface, version, and group information. In the current service consumption example, the service version of DemoService is derived from the property configuration file consumer-config.properties.</p> |
| <p>The @PostConstruct code shows that when the DemoServiceConsumerBootstrap Bean is initialized, it executes ten Dubbo remote method invocation.</p> |
| <h3 id="run-the-annotation-driven-example">Run the Annotation-driven Example</h3> |
| <p>Start DemoServiceProviderBootstrap twice locally and the registry will have two health services:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-registry-nacos-4.png" alt="image-20181213123909636"></p> |
| <p>Run DemoServiceConsumerBootstrap again and the results are as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>Service [name :demoService , port : 20880] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20881] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20880] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20880] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20881] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20881] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20880] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20880] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20881] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :demoService , port : 20881] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span></code></pre></div><p>Run correctly and the service consumer uses a load balancing strategy to allocate ten RPC calls equally to two Dubbo service provider instances.</p> |
| <h3 id="spring-xml-configuration-driven-example">Spring XML Configuration-driven Example</h3> |
| <p>Spring XML configuration-driven is the programming model of traditional Spring assembly components.</p> |
| <h4 id="service-provider-xml-configuration-driven">Service Provider XML Configuration-driven</h4> |
| <p>Define the service provider XML context configuration file - /META-INF/spring/dubbo-provider-context.xml</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">Provider application information for dependency calculation |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;dubbo-provider-xml-demo&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Using the Nacos registry --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;nacos://127.0.0.1:8848&#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;!-- Using Dubbo protocol to expose services on random ports --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;-1&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Declare the service interface to be exposed --&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.demo.service.DemoService&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span> version=<span style="color:#2aa198">&#34;2.0.0&#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;!-- Implement services like local beans --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.service.DefaultService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li>Implement service provider bootstrap class - DemoServiceProviderBootstrap</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.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.demo.service.DemoService; |
| </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:#719e07">import</span> java.io.IOException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * {@link DemoService} provider demo XML bootstrap |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceProviderXmlBootstrap</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> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(); |
| </span></span><span style="display:flex;"><span> context.setConfigLocation(<span style="color:#2aa198">&#34;/META-INF/spring/dubbo-provider-context.xml&#34;</span>); |
| </span></span><span style="display:flex;"><span> context.refresh(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;DemoService provider (XML) is starting...&#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><h4 id="service-consumer-xml-configuration-driven">Service Consumer XML Configuration-driven</h4> |
| <p>Define the consumer provider XML context configuration file - /META-INF/spring/dubbo- consumer-context.xml</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">Provider application information for dependency calculation |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:application</span> name=<span style="color:#2aa198">&#34;dubbo-consumer-xml-demo&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Using the Nacos registry--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;nacos://127.0.0.1:8848&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- Reference service interface --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.service.DemoService&#34;</span> version=<span style="color:#2aa198">&#34;2.0.0&#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><ul> |
| <li>Implement service consumer bootstrap class - DemoServiceConsumerBootstrap</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.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.demo.service.DemoService; |
| </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:#719e07">import</span> java.io.IOException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * {@link DemoService} consumer demo XML bootstrap |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoServiceConsumerXmlBootstrap</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> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(); |
| </span></span><span style="display:flex;"><span> context.setConfigLocation(<span style="color:#2aa198">&#34;/META-INF/spring/dubbo-consumer-context.xml&#34;</span>); |
| </span></span><span style="display:flex;"><span> context.refresh(); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;DemoService consumer (XML) is starting...&#34;</span>); |
| </span></span><span style="display:flex;"><span> DemoService demoService <span style="color:#719e07">=</span> context.getBean(<span style="color:#2aa198">&#34;demoService&#34;</span>, DemoService.class); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> 0; i <span style="color:#719e07">&lt;</span> 10; i<span style="color:#719e07">++</span>) { |
| </span></span><span style="display:flex;"><span> System.out.println(demoService.sayName(<span style="color:#2aa198">&#34;小马哥（mercyblitz）&#34;</span>)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> context.close(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h4 id="run-xml-configuration-driven-example">Run XML Configuration-driven Example</h4> |
| <p>As such, start two DemoServiceProviderXmlBootstrap bootstraps and observe the changes in the Nacos registry service provider:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-registry-nacos-5.png" alt="image-20181213125527201"></p> |
| <p>The service version driven by the XML configuration is 2.0.0, so the registration service is correct.</p> |
| <p>Run the service consumer bootstrap DemoServiceConsumerXmlBootstrap again and observe the console output:</p> |
| <div class="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>Service [name :null , port : 20882] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20882] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20883] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20882] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20882] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20883] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20882] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20883] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20883] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span><span style="display:flex;"><span>Service [name :null , port : 20883] sayName(&#34;小马哥（mercyblitz）&#34;) : Hello,小马哥（mercyblitz） |
| </span></span></code></pre></div><p>As a result, both operation and load balancing are normal due to the property demo.service.name has not been added to the current example, the &ldquo;name&rdquo; information is output as null. For more information, please refer to: <a href="https://github.com/apache/dubbo/tree/master/dubbo-registry/dubbo-registry-nacos">https://github.com/apache/dubbo/tree/master/dubbo-registry/dubbo-registry-nacos</a>.</p> |
| <p>If you&rsquo;re interested in or fond of open source projects like Dubbo and Nacos, try clicking &ldquo;star&rdquo; to support them. The links are as follows:</p> |
| <ul> |
| <li>Apache Dubbo: <a href="https://github.com/apache/dubbo">https://github.com/apache/dubbo</a></li> |
| <li>Dubbo Nacos Registry: <a href="https://github.com/apache/dubbo/tree/master/dubbo-registry/dubbo-registry-nacos">https://github.com/apache/dubbo/tree/master/dubbo-registry/dubbo-registry-nacos</a></li> |
| <li>Alibaba Nacos: <a href="https://github.com/alibaba/nacos">https://github.com/alibaba/nacos</a></li> |
| </ul></description></item><item><title>Blog: Introduction to the Dubbo protocol</title><link>https://dubbo.apache.org/en/blog/2018/10/05/introduction-to-the-dubbo-protocol/</link><pubDate>Fri, 05 Oct 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/10/05/introduction-to-the-dubbo-protocol/</guid><description> |
| <h2 id="the-concept-of-the-protocol">The concept of the protocol</h2> |
| <p>The protocol is the foundation of communication between two network entities, and data is transmitted from one entity to another in the form of a byte stream over the network. In the world of byte streams, this one-dimensional byte stream cannot be reshaped into two-dimensional or multi-dimensional data structures and domain objects without a protocol.</p> |
| <h3 id="what-is-the-protocol">What is the protocol</h3> |
| <p>The protocol is the semantics determined by both parties for the communication. For example, we design a protocol for string transmission, which allows the client to send a string and the server receives the corresponding string.</p> |
| <p>This protocol is quite simple, first 4-byte represent the total length of the message, followed by 1-byte represents the length of the charset, and then followed by the message payload, charset name and string body.</p> |
| <p>For example, Send a string <code>abc</code> encoded by <code>iso-8859-1</code> to the server end. After protocol trans-coding, the content is: <code>18 = 4 + 1 + 10 + 3|10|iso-8859-1|abc</code>, when the server receives these byte streams, it first reads 4-byte and converts it to int, in this case is 18, which is the length of message. Then continue to read the remaining 14 bytes, the remaining first byte read will be the length of the charset name, which is 10, the after 10-byte content is converted to a string, the content is <code>iso-8859-1</code>. Use this charset to construct the subsequent byte array into the string <code>new String(bytes, &quot;iso-8859-1&quot;)</code>.</p> |
| <p>In the previous example of a custom string transfer protocol, we have already seen the role of protocols in data transmission. Without a protocol, the data exchange cannot be completed. The following is Wikipedia&rsquo;s definition of the communication protocol.</p> |
| <blockquote> |
| <p>In telecommunication, a communication protocol is a system of rules that allow two or more entities of a communications system to transmit information via any kind of variation of a physical quantity. The protocol defines the rules syntax, semantics and synchronization of communication and possible error recovery methods. Protocols may be implemented by hardware, software, or a combination of both.</p> |
| </blockquote> |
| <p>Communication protocols need to define syntax, semantics, and communication synchronization operations. The content described here is actually a formal description of the previous custom string transfer protocol.</p> |
| <h3 id="the-definition-of-codec">The definition of <code>Codec</code></h3> |
| <p><code>org.apache.dubbo.remoting.Codec2</code> define the <strong>Codec</strong>&rsquo;s I/O processing, so the main methods are <code>encode</code> and <code>decode</code>, as defined below:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SPI</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">Codec2</span> { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</span>({Constants.CODEC_KEY}) |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">encode</span>(Channel channel, ChannelBuffer buffer, Object message) <span style="color:#268bd2">throws</span> IOException; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Adaptive</span>({Constants.CODEC_KEY}) |
| </span></span><span style="display:flex;"><span> Object <span style="color:#268bd2">decode</span>(Channel channel, ChannelBuffer buffer) <span style="color:#268bd2">throws</span> IOException; |
| </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">enum</span> DecodeResult { |
| </span></span><span style="display:flex;"><span> NEED_MORE_INPUT, SKIP_SOME_INPUT |
| </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><code>Codec</code> works on a protocol, <code>encode</code> method means to encode the communication object to the <code>ByteBufferWrapper</code>, and <code>decode</code> method decodes the <code>ChannelBuffer</code> read from the network into <code>Object</code>, which is the communication object.</p> |
| <h2 id="common-protocol-mode">Common protocol mode</h2> |
| <p>Protocols in application layer have three general forms: fixed-length protocol, special delimiter protocol and protocol header + payload mode. The specific contents of these forms are described below.</p> |
| <p>When reading data from the network in the form of a byte stream, it is necessary to determine when a meaningful transmission content ends. Moreover, the transmission of data on the network, there are sticky packets and fragment packets problem. The solution to this problem is that the protocol can accurately identify, when the sticky packets or fragment packets occurs, it can handle it correctly.</p> |
| <h3 id="fixed-length-protocol">Fixed-length protocol</h3> |
| <p>The fixed-length protocol means that the length of the protocol content is fixed. For example, the protocol byte length is 50. When 50 bytes are read from the network, the decoding operation is performed. The fixed-length protocol is more efficient when reading or writing, because the size of the data cache is basically determined, just like an array. The defect is the lack of adaptability. Taking the RPC scene as an example, it is difficult to estimate the length.</p> |
| <blockquote> |
| <p>Refer to Netty&rsquo;s <code>FixedLengthFrameDecoder</code></p> |
| </blockquote> |
| <h3 id="special-delimiter-protocol">Special delimiter protocol</h3> |
| <p>Compared to fixed-length protocols, if we can define a special character as the end of each protocol unit, we can communicate in a variable length, so as to balance the data transmission and efficiency, such as the delimiter \n.</p> |
| <p>The problem with the special delimiter method is that it think about the process of protocol transmission in a simple way. For a protocol unit, it must be read all before it can be processed. In addition, it must be prevented that the data transmitted by the user cannot be the same as the delimiter, otherwise it will be disordered.</p> |
| <blockquote> |
| <p>Refer to Netty&rsquo;s <code>DelimiterBasedFrameDecoder</code></p> |
| </blockquote> |
| <h3 id="variable-length-protocolprotocol-head--payload">Variable length protocol(protocol head + payload)</h3> |
| <p>Generally, it is a custom protocol, which is composed of a fixed length and a variable content. The fixed length part needs to specify the length of the variable content part.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>+————————————————+ |
| </span></span><span style="display:flex;"><span>|fixed-length | |
| </span></span><span style="display:flex;"><span>+————————————————+ |
| </span></span><span style="display:flex;"><span>|variable content| |
| </span></span><span style="display:flex;"><span>+————————————————+ |
| </span></span></code></pre></div><blockquote> |
| <p>Refer to Netty&rsquo;s <code>LengthFieldBasedFrameDecoder</code></p> |
| </blockquote> |
| <p>The Dubbo protocol is actually a variable length protocol, which is covered in more detail in later chapters.</p> |
| <h2 id="the-dubbo-protocol">The Dubbo protocol</h2> |
| <h3 id="overview-to-the-dubbo-protocol">Overview to the Dubbo protocol</h3> |
| <p>The Dubbo framework defines a proprietary RPC protocol in which the specific content of the request and response protocols is presented using a table.</p> |
| <p><img src="https://dubbo.apache.org/imgs/dev/dubbo_protocol_header.png" alt="/dev-guide/images/dubbo_protocol_header.jpg"></p> |
| <h3 id="dubbo-protocol-details">Dubbo protocol details</h3> |
| <ul> |
| <li> |
| <p>Magic - Magic High &amp; Magic Low (16 bits)</p> |
| <p>Identify protocol version, Dubbo protocol: 0xdabb</p> |
| </li> |
| <li> |
| <p>Req/Res (1 bit)</p> |
| <p>Identify a request or response. request: 1; response: 0.</p> |
| </li> |
| <li> |
| <p>2 Way (1 bit)</p> |
| <p>Only useful when Req/Res is 1(request), identifying if you expect to return a value from the server. Set to 1 if a return value from the server is required.</p> |
| </li> |
| <li> |
| <p>Event (1 bit)</p> |
| <p>Identifies whether it is an event message, for example, a heartbeat event. Set to 1 if this is an event.</p> |
| </li> |
| <li> |
| <p>Serialization ID (5 bit)</p> |
| <p>Identifies the serialization type: for example, the value of fastjson is 6.</p> |
| </li> |
| <li> |
| <p>Status (8 bits)</p> |
| <p>Only useful when Req/Res is 0 (response), used to identify the status of the response</p> |
| <ul> |
| <li>20 - OK</li> |
| <li>30 - CLIENT_TIMEOUT</li> |
| <li>31 - SERVER_TIMEOUT</li> |
| <li>40 - BAD_REQUEST</li> |
| <li>50 - BAD_RESPONSE</li> |
| <li>60 - SERVICE_NOT_FOUND</li> |
| <li>70 - SERVICE_ERROR</li> |
| <li>80 - SERVER_ERROR</li> |
| <li>90 - CLIENT_ERROR</li> |
| <li>100 - SERVER_THREADPOOL_EXHAUSTED_ERROR</li> |
| </ul> |
| </li> |
| <li> |
| <p>Request ID (64 bits)</p> |
| <p>Identifies the only request, the type is long.</p> |
| </li> |
| <li> |
| <p>Data Length (32 bits)</p> |
| <p>The length of the serialized content (variable part), counted in bytes, the type is int.</p> |
| </li> |
| <li> |
| <p>Variable Part</p> |
| <p>After being serialized by a specific serialization type (identified by the serialization ID), each part is a byte [] or byte.</p> |
| <ul> |
| <li>If it is a request packet (Req/Res = 1), each part is: |
| <ul> |
| <li>Dubbo version</li> |
| <li>Service name</li> |
| <li>Service version</li> |
| <li>Method name</li> |
| <li>Method parameter types</li> |
| <li>Method arguments</li> |
| <li>Attachments</li> |
| </ul> |
| </li> |
| <li>If it is a response packet (Req/Res = 0), each part is: |
| <ul> |
| <li>Return value&rsquo;s type (byte), identifying the type of value returned from the server: |
| <ul> |
| <li>Return null: RESPONSE_NULL_VALUE 2</li> |
| <li>Normal response value: RESPONSE_VALUE 1</li> |
| <li>Exception: RESPONSE_WITH_EXCEPTION 0</li> |
| </ul> |
| </li> |
| <li>Return value: response bytes returned from the server</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <p><strong>Note:</strong> For the variable part, when uses json serialization in current version of Dubbo framework, an additional line break is added as a separator between each part of the content. Please add a new line break after each part of the variable part, such as:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>Dubbo version bytes (line break) |
| </span></span><span style="display:flex;"><span>Service name bytes (line break) |
| </span></span><span style="display:flex;"><span>... |
| </span></span></code></pre></div><h2 id="advantages-and-disadvantages-about-the-dubbo-protocol">Advantages and disadvantages about the Dubbo protocol</h2> |
| <h3 id="advantages">Advantages</h3> |
| <ul> |
| <li>The protocol is designed to be very compact. The data type can be represented by 1 bit will not be represented by a byte, such as a boolean type identifier.</li> |
| <li>The request header is the same as response header, and the specific content is assembled to the variable part through the serializer, and it is simple to implement.</li> |
| </ul> |
| <h3 id="to-be-improved">To be improved</h3> |
| <ul> |
| <li> |
| <p>Similar to the http request, the header can determine the resource to be accessed, and Dubbo needs to involve the specific serializer to resolve the service name, method, method signature, and these resource locators are string type or string array. It&rsquo;s easy to convert to bytes, so it can be assembled into the header. Similar to http2 header compression, resources called for rpc can also be negotiated with an int to identify, which improves performance. This is easier to implement if the resource locator is assembled on <code>header</code>.</p> |
| </li> |
| <li> |
| <p>Use req/res to determine if it is a request, then you can refine the protocol, remove some unwanted identifiers and add some specific identifiers. For example, <code>status</code>, <code>twoWay</code> can be strictly customized to remove redundant identifiers. There is also a timeout identifier that is transmitted as the <code>attachment</code> of the Dubbo. In theory, it should be placed in the header of the request protocol, because the timeout is essential in the network request. Referring to <code>attachment</code>, you can see from the implementation that there are some fields in <code>attachment</code> that are duplicated with existing fields in <code>content</code>, such as <code>path</code> and <code>version</code>, which increase the protocol size.</p> |
| </li> |
| <li> |
| <p>Dubbo will convert the service name <code>com.alibaba.middleware.hsf.guide.api.param.ModifyOrderPriceParam</code> to <code>Lcom/alibaba/middleware/hsf/guide/api/param/ModifyOrderPriceParam;</code>, which is theoretically unnecessary, simply append a <code>;</code> will be fine.</p> |
| </li> |
| <li> |
| <p>The Dubbo protocol does not reserve extension fields, and cannot add new identifiers. The scalability is not very good. For example, the only way to add the <code>response context</code> function is to change the protocol version, but this requires both the client and server versions to be upgraded. Very unfriendly in distributed scenarios.</p> |
| </li> |
| </ul> |
| <h2 id="conclusion">Conclusion</h2> |
| <p>This article mainly introduces the concept of the protocol and the commonly used protocol mode. Then it analyzes the Dubbo protocol in detail and also mentions some shortcomings. However, compared with its simplicity and ease of implementation, the above shortcomings are not enough to drive us to redesign a new version of the protocol, so we welcome suggestions and features for protocol optimization.</p></description></item><item><title>Blog: Integrate Dubbo with Kubernetes</title><link>https://dubbo.apache.org/en/blog/2018/09/30/integrate-dubbo-with-kubernetes/</link><pubDate>Sun, 30 Sep 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/09/30/integrate-dubbo-with-kubernetes/</guid><description> |
| <h1 id="general-goal">General goal</h1> |
| <p>Dubbo&rsquo;s provider don&rsquo;t care about service registration.Open its Dubbo service port,the declaration and publishment of the service will be executed by Kubernetes. |
| Dubbo&rsquo;s consumer directly discovers the corresponding service endpoints of Kubernetes during service discovery procedure, thereby reusing Dubbo&rsquo;s existing microservice channel capabilities.The benefit is that there is no need to rely on any third-party soft-loaded registry and it can be seamlessly integrated into the multi-tenant security system of Kubernetes. Reference demo : <a href="https://github.com/dubbo/dubbo-Kubernetes">https://github.com/dubbo/dubbo-ubernetes</a></p> |
| <h1 id="introduction">Introduction</h1> |
| <p>Kubernates is a hierarchical system with rich secondary development function based on the expansibility.</p> |
| <ul> |
| <li>First of all, Kubernates&rsquo;s core function is to manage the container cluster. Kubernates manages the storage and calculation of containerized cluster, based on the container runtime (CRI), network interface (CNI) and storage service interface (CSI/FV).</li> |
| <li>Secondly，Kubernates has application-oriented deployment and routing capabilities，including statefulness/statelessness，batch processing and service-oriented applications，especially the application management based on microservices architecture which includes service discovery，service definition and unified configuration on the basis of configmap.</li> |
| <li>Finally, on top of the abstract model of the basic resource (mainly the resources of abstract infrastructure, IaaS) and the application layer is the governance layer, which includes elastic expansion, namespaces/tenants and so on. Naturally, it is a matter of course to set up service about unified log center and omnidirectional monitoring on the Kubernetes based upon the foundational capabilities of atomic inner core.</li> |
| </ul> |
| <p>We will explain the above description with a diagram of Kubernetes Architecture. In 2018, Kubernetes took a qualitative step toward the standard PaaS basement.Someone hold opinions that the reason is the ability for secondary development on the basis of the expansion and someone think the key is declarative programming and strong community operations relying on Google and Redhat. However,I think the essential reason is Layered architecture and the abstract domain modeling in the problem domain as the figure below.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/k8s/1.png" alt="img"></p> |
| <p>From a micro-service architecture perspective, Kubernetes is a micro-service framework (more appropriate than a micro-service platform or toolkit set at this time) in a sense, supporting the basic capabilities of microservices for service discovery/registration. Use the following table to make a brief description.</p> |
| <table> |
| <thead> |
| <tr> |
| <th style="text-align:left">The design of microservice</th> |
| <th style="text-align:left">The function of Kubernetes</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td style="text-align:left">Point 1：API gateway</td> |
| <td style="text-align:left">Ingress</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 2：Statelessness, distinguish between stateful and stateless applications</td> |
| <td style="text-align:left">Stateless corresponds to Deployment，and stateful corresponds to StatefulSet</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 3：Horizontal expansion of the database</td> |
| <td style="text-align:left">Headless service points to PaaS service or StatefulSet deployment</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 4：Cache</td> |
| <td style="text-align:left">Headless service points to PaaS service or StatefulSet deployment</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 5：Service splitting and service discovery</td> |
| <td style="text-align:left">Service</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 6：Service orchestration and flexibility</td> |
| <td style="text-align:left">Replicas of deployment</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 7：Unified configuration center</td> |
| <td style="text-align:left">ConfigMap</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 8：Unified log center</td> |
| <td style="text-align:left">DaemonSet deploys log agent</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 9：Circut break, current limiting and downgrade</td> |
| <td style="text-align:left">Service Mesh</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Point 10：Comprehensive monitoring</td> |
| <td style="text-align:left">Cadsivor, DaemonSet deploys and monitors Agent</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>By the way, the microservices field involves many issues, which can be explained as follows. When building microservices, we will delve into Distributed System, a discipline has a 40-year research background and is rooted in the adaptive system theory. It&rsquo;s a bit complicated, but the concepts it covers are more or less heard for us, and it solves problems that we&rsquo;re familiar with:</p> |
| <ul> |
| <li>Deployment</li> |
| <li>Delivery</li> |
| <li>APIs</li> |
| <li>Versioning</li> |
| <li>Contracts</li> |
| <li>Scaling / Autoscaling</li> |
| <li>Service Discovery</li> |
| <li>Load Balancing</li> |
| <li>Routing / Adaptive Routing</li> |
| <li>Health Checking</li> |
| <li>Configuration</li> |
| <li>Circuit Breaking</li> |
| <li>Bulk-heads</li> |
| <li>TTL / Deadlining</li> |
| <li>Latency Tracing</li> |
| <li>Service Causal Tracing</li> |
| <li>Distributed logging</li> |
| <li>Metrics Exposure, Collection</li> |
| </ul> |
| <p>For Kubernetes, only a few of problems are solved. Problems such as Dynamic Routing, Stability Control (Circuit Breaking, Bulk-heads, etc.) , Distributed Service Tracking, etc. are all the blank. These problems are exactly what Service Mesh needs to solve, and these also plays an important role in CNCF&rsquo;s Tail Map. Of course, as Dubbo is a basically complete microservices infrastructure (Dubbo is based on the Sidecar which is a common solution for solving cross-language claims in Service Mesh, and the details of Dubbo are so complicated that they need to be explained in the new topic ) , that is to say, it is very meaningful to integrate Dubbo into the k8s system. The original definition of Service Mesh is cited below:</p> |
| <blockquote> |
| <p><span data-type="color" style="color:rgb(119, 119, 119)"><span data-type="background" style="background-color:rgb(255, 255, 255)">A service mesh is a dedicated infrastructure layer for handling service-to-service communication. It's responsible for the reliable delivery of requests through the complex topology of services that comprise a modern, cloud native application.</span></span></p> |
| </blockquote> |
| <p>We will know the existing solution, Dubbo integrates the Clould Native Equipment - Kubernetes&rsquo;s basic abilities to solve the microservices&rsquo;s core problems, can be regarded as a Service Mesh solution in a narrow sense, but it can only be used in the Java field. You can understand the above words as a joke, haha.</p> |
| <h1 id="tspan-data-typecolor-stylecolorrgb51-51-51span-data-typebackground-stylebackground-colorrgb255-255-255houghtspanspanplan">T<span data-type="color" style="color:rgb(51, 51, 51)"><span data-type="background" style="background-color:rgb(255, 255, 255)">hought</span></span>/Plan</h1> |
| <p>Kubernetes is a natural address registration center for microservices, similar to zookeeper, VIPserver and Configserver used internally by Alibaba. Specifically, the Pod in Kubernetes is a running instance of the application. The scheduled deployment/start/stop of the Pod will call the API-Server service to maintain its state to ETCD. The service in Kubernetes is coresponded to the concept of the microservices defined as follows.</p> |
| <blockquote> |
| <p>A Kubernetes Service is an abstraction layer which defines a logical set of Pods and enables external traffic exposure, load balancing and service discovery for those Pods.</p> |
| </blockquote> |
| <p>In conclusion, the Kubernetes service has the following characteristics:</p> |
| <ul> |
| <li>Each Service has a unique name and corresponding IP. IP is automatically assigned by Kubernetes and the name is defined by the developer.</li> |
| <li>Service IP has several manifestations: ClusterIP, NodePort, LoadBalance and Ingress. ClusterIP is mainly used for intra-cluster communication; NodePort, Ingress and LoadBalance, which are used to expose services to access portals outside the cluster.</li> |
| </ul> |
| <p>At first sight, the service of Kubernetes has its own IP, while under the original fixed mindset: Dubbo/HSF service is aggregated by the IP of the entire service cluster, that means, Kubernetes and Dubbo/HSF look like something different in natural, but when carefully thinking, the difference becomes insignificant. Because the only IP under Kubernetes is just a Virtural IP&ndash;VIP, behind the vip are multiple endpoints, which is the factual processing node.</p> |
| <p>Here we only discuss the situation that the Dubbo service in the cluster is accessed in the same Kubernetes cluster, As for the provider outside Kubernetes to access the provider in Kubernetes, since it involves the problem of network address space, and it usually requires GateWay/loadbalance for mapping conversion, which there not detail discussion for this case. Besides, there are two options available for Kubernetes:</p> |
| <ol> |
| <li> |
| <p>DNS: The default Kubernetes service is based on the DNS plugin (The latest version of the recommendation is coreDNS), one proposal on Dubbo is about this. since HSF/Dubbo has always highlighted its soft-load address discovery capability, it ignores Static&rsquo;s strategy insteadily, my understanding is that as a service discovery mechanism, the static resolution mechanism is one of the simplest and most needed to support mechanism, you can also refer to Envoy&rsquo;s point of views. While at the same time, ant&rsquo;s SOFA has always supported this static strategy, it can provides an explanation for an engineering fragment of the SOFA project. There are two advantages to doing this. 1) When the soft load center crash is unavailable and the address list cannot be obtained, there is a mechanism to Failover to this policy to handle certain requests. 2) Under LDC/unitization, the ant&rsquo;s load center cluster is deployed in the equipment room/area. First, the LDC of the soft load center is guaranteed to be stable and controllable. When the unit needs the request center, the address of the VIP can come in handy.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2018/09/30/integrate-dubbo-with-kubernetes/TB1Kj1ktpkoBKNjSZFEXXbrEVXa-985-213.png" alt="img"></p> |
| </li> |
| <li> |
| <p>API：DNS relies on the DNS plugin, which will generate additional operation, so consider directly obtaining the endpoint through the client of Kubernetes. In fact, by accessing the API server interface of Kubernetes, you can directly obtain the list of endpoints behind a certain servie, and can also monitor the changes in its address list. Thereby implementing the soft load discovery strategy recommended by Dubbo/HSF. Refer to the code for details:</p> |
| </li> |
| </ol> |
| <p>The above two thoughts need to consider the following two points:</p> |
| <ol> |
| <li>Kubernetes and Dubbo are consistent with the mapping name of service. Dubbo&rsquo;s service is determined by serviename, group, version to determine its uniqueness, and servicename generally has a longer package name for its service interface. Need to map the servie name of Kubernetes and the service name of dubbo. Either add a property like SOFA to define it. This is a big change, but it is most reasonable. Or it is a fixed rule to reference the deployed environment variables, which can be used for quick verification.</li> |
| <li>Port problem:The default Pod and Pod network interoperability is solved, need to be validated.</li> |
| </ol> |
| <h2 id="demo-verification">Demo Verification</h2> |
| <p>The following is a demo deployment through Kubernetes service in Alibaba Cloud&rsquo;s Container Registry and EDAS. Visit Alibaba Cloud -》Container Registry.</p> |
| <ol> |
| <li> |
| <p>Create repo and bind the github codebase. As shown below. |
| <img src="https://dubbo.apache.org/imgs/blog/2018/09/30/integrate-dubbo-with-kubernetes/TB1m.tEtrorBKNjSZFjXXc_SpXa-1892-870.png" alt="img"></p> |
| </li> |
| <li> |
| <p>Click Manage enter the repository details page. Click Build in images service panel, construct the demo into image and publish it to the specified repository. As shown below. |
| <img src="https://dubbo.apache.org/imgs/blog/2018/09/30/integrate-dubbo-with-kubernetes/TB1oYqvtcIrBKNjSZK9XXagoVXa-1872-888.png" alt="img"></p> |
| </li> |
| <li> |
| <p>Switch to Enterprise Distributed Application Services (EDAS) products panel, visit Resource Management -&gt; Clusters. Create Kubernetes cluster and bind ECS. As shown below. |
| <img src="https://dubbo.apache.org/imgs/blog/2018/09/30/integrate-dubbo-with-kubernetes/TB1b1p2trZnBKNjSZFKXXcGOVXa-1858-833.png" alt="img"></p> |
| </li> |
| <li> |
| <p>Application Management -&gt; Create application, type Kubernetes application and specify the image in the container registry . As shown below. |
| <img src="https://dubbo.apache.org/imgs/blog/2018/09/30/integrate-dubbo-with-kubernetes/TB1_YywtDCWBKNjSZFtXXaC3FXa-1737-588.png" alt="img"></p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/2018/09/30/integrate-dubbo-with-kubernetes/TB18uzTtdcnBKNjSZR0XXcFqFXa-1820-861.png" alt="img"></p> |
| </li> |
| <li> |
| <p>After creation , then deploy applications. As shown below. |
| <img src="https://dubbo.apache.org/imgs/blog/2018/09/30/integrate-dubbo-with-kubernetes/TB1fEpEtrorBKNjSZFjXXc_SpXa-1846-783.png" alt="img"></p> |
| </li> |
| </ol> |
| <ul> |
| <li> |
| <p>The supplementary application name cannot have uppercase letters, all lowercase, otherwise there is a problem of deployment failure.</p> |
| </li> |
| <li> |
| <p>When creating an app, after selecting the image, the next button cannot be clicked and you need to click Choose to continue.</p> |
| </li> |
| <li> |
| <p>EDAS has two independent Kubernetes services, one based on Alibaba Cloud&rsquo;s container service, and one set by Lark. I experience the latter.</p> |
| </li> |
| <li> |
| <p>The development joint of Docker and IDE integration, you need to consider the relevant plug-ins for integrating IDEA.</p> |
| </li> |
| <li> |
| <p>There is always an error in deployment, maybe there is a problem with the Kubernetes service. Need further investigation.</p> |
| </li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{ |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;kind&#34;</span>: <span style="color:#2aa198">&#34;Pod&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;namespace&#34;</span>: <span style="color:#2aa198">&#34;lzumwsrddf831iwarhehd14zh2-default&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;name&#34;</span>: <span style="color:#2aa198">&#34;dubbo-k8s-demo-610694273-jq238&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;uid&#34;</span>: <span style="color:#2aa198">&#34;12892e67-8bc8-11e8-b96a-00163e02c37b&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;apiVersion&#34;</span>: <span style="color:#2aa198">&#34;v1&#34;</span>, |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&#34;resourceVersion&#34;</span>: <span style="color:#2aa198">&#34;850282769&#34;</span> |
| </span></span><span style="display:flex;"><span>}, <span style="color:#2aa198">&#34;reason&#34;</span>: <span style="color:#2aa198">&#34;FailedSync&#34;</span>, <span style="color:#2aa198">&#34;message&#34;</span>: <span style="color:#2aa198">&#34;Error syncing pod&#34;</span>, &#34; |
| </span></span></code></pre></div></description></item><item><title>Blog: How to prepare an Apache Release</title><link>https://dubbo.apache.org/en/blog/2018/09/02/how-to-prepare-an-apache-release/</link><pubDate>Sun, 02 Sep 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/09/02/how-to-prepare-an-apache-release/</guid><description> |
| <h2 id="understanding-the-apache-release-cycle">Understanding the Apache Release Cycle</h2> |
| <p>In general, Source Release is the key and the required content of Apache. But Binary Release is optional, Dubbo can choose whether to release binary packages to the Apache repository or to the Maven central repository.</p> |
| <p>Please refer to the following links for more information on ASF&rsquo;s release guide:</p> |
| <ul> |
| <li><a href="http://www.apache.org/dev/release-publishing">Apache Release Guide</a></li> |
| <li><a href="http://www.apache.org/dev/release.html">Apache Release Policy</a></li> |
| <li><a href="http://www.apache.org/dev/publishing-maven-artifacts.html">Maven Release Info</a></li> |
| </ul> |
| <h2 id="preparation-of-local-building-environment">Preparation of Local Building Environment</h2> |
| <p>Mainly including the related preparation of signature utilities and Maven repository certification</p> |
| <ol> |
| <li> |
| <p>Install GPG,refer to <a href="https://www.gnupg.org/download/index.html">https://www.gnupg.org/download/index.html</a></p> |
| <ul> |
| <li>For example, in Mac OS</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>$ brew install gpg |
| </span></span><span style="display:flex;"><span>$ gpg --version <span style="color:#586e75">#check version,should be 2.x</span> |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Generate the key with GPG</p> |
| <ul> |
| <li>Generate the key according to the prompt</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ gpg2 --full-gen-key |
| </span></span><span style="display:flex;"><span>gpg <span style="color:#719e07">(</span>GnuPG<span style="color:#719e07">)</span> 2.0.12; Copyright <span style="color:#719e07">(</span>C<span style="color:#719e07">)</span> <span style="color:#2aa198">2009</span> Free Software Foundation, Inc. |
| </span></span><span style="display:flex;"><span>This is free software: you are free to change and redistribute it. |
| </span></span><span style="display:flex;"><span>There is NO WARRANTY, to the extent permitted by law. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Please <span style="color:#719e07">select</span> what kind of key you want: |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">(</span>1<span style="color:#719e07">)</span> RSA and RSA <span style="color:#719e07">(</span>default<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">(</span>2<span style="color:#719e07">)</span> DSA and Elgamal |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">(</span>3<span style="color:#719e07">)</span> DSA <span style="color:#719e07">(</span>sign only<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">(</span>4<span style="color:#719e07">)</span> RSA <span style="color:#719e07">(</span>sign only<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span>Your selection? <span style="color:#2aa198">1</span> |
| </span></span><span style="display:flex;"><span>RSA keys may be between <span style="color:#2aa198">1024</span> and <span style="color:#2aa198">4096</span> bits long. |
| </span></span><span style="display:flex;"><span>What keysize <span style="color:#719e07">do</span> you want? <span style="color:#719e07">(</span>2048<span style="color:#719e07">)</span> <span style="color:#2aa198">4096</span> |
| </span></span><span style="display:flex;"><span>Requested keysize is <span style="color:#2aa198">4096</span> bits |
| </span></span><span style="display:flex;"><span>Please specify how long the key should be valid. |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">0</span> <span style="color:#719e07">=</span> key does not expire |
| </span></span><span style="display:flex;"><span> &lt;n&gt; <span style="color:#719e07">=</span> key expires in n days |
| </span></span><span style="display:flex;"><span> &lt;n&gt;w <span style="color:#719e07">=</span> key expires in n weeks |
| </span></span><span style="display:flex;"><span> &lt;n&gt;m <span style="color:#719e07">=</span> key expires in n months |
| </span></span><span style="display:flex;"><span> &lt;n&gt;y <span style="color:#719e07">=</span> key expires in n years |
| </span></span><span style="display:flex;"><span>Key is valid <span style="color:#719e07">for</span>? <span style="color:#719e07">(</span>0<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span>Key does not expire at all |
| </span></span><span style="display:flex;"><span>Is this correct? <span style="color:#719e07">(</span>y/N<span style="color:#719e07">)</span> y |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>GnuPG needs to construct a user ID to identify your key. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Real name: Robert Burrell Donkin |
| </span></span><span style="display:flex;"><span>Email address: rdonkin@apache.org |
| </span></span><span style="display:flex;"><span>Comment: CODE SIGNING KEY |
| </span></span><span style="display:flex;"><span>You selected this USER-ID: |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#34;Robert Burrell Donkin (CODE SIGNING KEY) &lt;rdonkin@apache.org&gt;&#34;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Change <span style="color:#719e07">(</span>N<span style="color:#719e07">)</span>ame, <span style="color:#719e07">(</span>C<span style="color:#719e07">)</span>omment, <span style="color:#719e07">(</span>E<span style="color:#719e07">)</span>mail or <span style="color:#719e07">(</span>O<span style="color:#719e07">)</span>kay/<span style="color:#719e07">(</span>Q<span style="color:#719e07">)</span>uit? O |
| </span></span><span style="display:flex;"><span>You need a Passphrase to protect your secret key. <span style="color:#586e75"># enter the password, which will be used frequently when packaging.</span> |
| </span></span></code></pre></div><ul> |
| <li>View key id</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>$ gpg --list-keys |
| </span></span><span style="display:flex;"><span>pub rsa4096/28681CB1 2018-04-26 <span style="color:#586e75"># 28681CB1 is the key id</span> |
| </span></span><span style="display:flex;"><span>uid <span style="color:#719e07">[</span>ultimate<span style="color:#719e07">]</span> liujun <span style="color:#719e07">(</span>apache-dubbo<span style="color:#719e07">)</span> &lt;liujun@apache.org&gt; |
| </span></span><span style="display:flex;"><span>sub rsa4096/D3D6984B 2018-04-26 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">########### Note: Different diaplay for different version.</span> |
| </span></span><span style="display:flex;"><span>$ gpg --list-keys |
| </span></span><span style="display:flex;"><span>pub rsa4096 2018-11-12 <span style="color:#719e07">[</span>SC<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> 63AAE9838F4A303E40BAF5FEA3A1CA7A5D4A3981 <span style="color:#586e75"># Last 8 character(5D4A3981) as key id，it will be used when send public key to keyserver</span> |
| </span></span><span style="display:flex;"><span>uid <span style="color:#719e07">[</span> 绝对 <span style="color:#719e07">]</span> Victory Cao <span style="color:#719e07">(</span>CODE SIGNING KEY<span style="color:#719e07">)</span> &lt;victory@apache.org&gt; |
| </span></span><span style="display:flex;"><span>sub rsa4096 2018-11-12 <span style="color:#719e07">[</span>E<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># send public key to keyserver via key id </span> |
| </span></span><span style="display:flex;"><span>$ gpg --keyserver pgpkeys.mit.edu --send-key 28681CB1 |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Here pgpkeys.mit.edu is a random selection of keyserver. Any key server from the list https://sks-keyservers.net/status/ is acceptable because they are automatically synchronized.</span> |
| </span></span></code></pre></div><ul> |
| <li>If there are multiple public keys，you can set the default key</li> |
| </ul> |
| <p>~/.gnupg/gpg.conf</p> |
| <div class="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># If you have more than 1 secret key in your keyring, you may want to |
| </span></span><span style="display:flex;"><span># uncomment the following option and set your preferred keyid. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>default-key 28681CB1 |
| </span></span></code></pre></div><ul> |
| <li>If there are multiple public keys, you can also delete unuseful key：</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span><span style="color:#586e75">### Delete the private key first, then delete the public key.</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>$ gpg --yes --delete-secret-keys shenglicao2@gmail.com <span style="color:#586e75">### indicate email address </span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>$ gpg --delete-keys 1808C6444C781C0AEA0AAD4C4D6A8007D20DB8A4 |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Set up Apache central repository.</p> |
| <ul> |
| <li>The parent pom of Dubbo project is apache pom</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;parent&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;groupId&gt;</span>org.apache<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;artifactId&gt;</span>apache<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;version&gt;</span>19<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/parent&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li> |
| <p>Add the following contents to .m2/settings.xml</p> |
| <p>Enter the passwords after |
| encrypting by <a href="http://maven.apache.org/guides/mini/guide-encryption.html">maven-encryption-plugin</a></p> |
| </li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;settings&gt;</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;servers&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- To publish a snapshot of some part of Maven --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;server&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;id&gt;</span>apache.snapshots.https<span style="color:#268bd2">&lt;/id&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;username&gt;</span> <span style="color:#586e75">&lt;!-- YOUR APACHE LDAP USERNAME --&gt;</span> <span style="color:#268bd2">&lt;/username&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;password&gt;</span> <span style="color:#586e75">&lt;!-- YOUR APACHE LDAP PASSWORD (encrypted) --&gt;</span> <span style="color:#268bd2">&lt;/password&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/server&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- To stage a release of some part of Maven --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;server&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;id&gt;</span>apache.releases.https<span style="color:#268bd2">&lt;/id&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;username&gt;</span> <span style="color:#586e75">&lt;!-- YOUR APACHE LDAP USERNAME --&gt;</span> <span style="color:#268bd2">&lt;/username&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;password&gt;</span> <span style="color:#586e75">&lt;!-- YOUR APACHE LDAP PASSWORD (encrypted) --&gt;</span> <span style="color:#268bd2">&lt;/password&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/server&gt;</span> |
| </span></span><span style="display:flex;"><span> ... |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- gpg passphrase used when generate key --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;server&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;id&gt;</span>gpg.passphrase<span style="color:#268bd2">&lt;/id&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;passphrase&gt;</span><span style="color:#586e75">&lt;!-- yourKeyPassword --&gt;</span><span style="color:#268bd2">&lt;/passphrase&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/server&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/servers&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/settings&gt;</span> |
| </span></span></code></pre></div></li> |
| </ol> |
| <h2 id="pack--upload">Pack &amp; Upload</h2> |
| <ol> |
| <li> |
| <p>Pull the new branch from the master branch as the release branch. If you want to release the ${release_version} version now, pull the new branch ${release_version}-release from 2.6.x. Then the |
| modifications and taggings related to ${release_version} Release Candidates are applied to ${release_version}-release branch, and is merged into the master branch after the final release.</p> |
| </li> |
| <li> |
| <p>First of all, verify that the maven component packing, source packing, signature, etc are working properly on the ${release_version}-release branch.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ mvn clean install -Papache-release |
| </span></span><span style="display:flex;"><span>$ mvn deploy |
| </span></span></code></pre></div></li> |
| </ol> |
| <p>This push the snapshot package to the maven central repository.</p> |
| <ol start="3"> |
| <li> |
| <p>Release with maven-release-plugin</p> |
| <ul> |
| <li>verify with dryRun</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ mvn release:prepare -Prelease -Darguments<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;-Dmaven.test.skip=true&#34;</span> -DautoVersionSubmodules<span style="color:#719e07">=</span><span style="color:#b58900">true</span> -Dusername<span style="color:#719e07">=</span>YOUR GITHUB ID -DdryRun<span style="color:#719e07">=</span><span style="color:#b58900">true</span> |
| </span></span></code></pre></div><ul> |
| <li>After verification, run release:prepare</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ mvn release:clean |
| </span></span><span style="display:flex;"><span>$ mvn release:prepare -Prelease -Darguments<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;-Dmaven.test.skip=true&#34;</span> -DautoVersionSubmodules<span style="color:#719e07">=</span><span style="color:#b58900">true</span> -Dusername<span style="color:#719e07">=</span>YOUR GITHUB ID -DpushChanges<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span></code></pre></div><blockquote> |
| <p>If you are promted to input password for pushing to GitHub (basically including adding new commits and tags), do not input your login password of GitHub. Use <code>Personal access tokens</code> instead. You can go to <a href="https://github.com/settings/profile">https://github.com/settings/profile</a>, click <code>Developer settings</code> -&gt; <code>Personal access tokens</code>, and generate a new token if not. Please refer to this <a href="https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token">guide</a> for more infomation. |
| you need to choose the release artifactId, next artifactId and the release tag, the default tag is dubbo-parent-xxxx, you need to change it to dubbo-xxxx</p> |
| </blockquote> |
| <p>After executing the above commands, you will find that:</p> |
| <ol> |
| <li>source-release.zip and bin-release.zip are generated under dubbo-distribution directory, please unzip it and check the file structure</li> |
| <li><code>-DpushChanges=false</code> tells maven not to push the commits and tags to the remote repostiroy. If not specified, the version tag will be pushed to github repository, you will see a commit called <code>[maven-release-plugin] prepare release dubbo-x.x.x</code> added.</li> |
| <li>The branch version is upgraded to ${release_version+1}-SNAPSHOT automatically. If <code>-DpushChanges=true</code> is specified, the modifications will be pushed to the remote repository, you will see a commit called <code>[maven-release-plugin] prepare for next development iteration</code> added.</li> |
| </ol> |
| <p>If <code>-DpushChanges=false</code> is specified, you will have to manually push the commit to remote repository before go to next step.</p> |
| <ul> |
| <li>Run release:perform</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ mvn release:perform -Prelease -Darguments<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;-Dmaven.test.skip=true&#34;</span> -DautoVersionSubmodules<span style="color:#719e07">=</span><span style="color:#b58900">true</span> -Dusername<span style="color:#719e07">=</span>YOUR GITHUB ID |
| </span></span></code></pre></div><p>Maven will download the source code from the tag you just pushed, compile it, and deploy to remote maven repsoitry in staging state.</p> |
| </li> |
| </ol> |
| <h3 id="note">Note</h3> |
| <blockquote> |
| <p>When you deploy the package into repository, it will be interrupted for network. So you must restart to desploy.<br> |
| The problem is that missing package occurred many times at deploying. So you should check the quantity of package, especially parent package.</p> |
| </blockquote> |
| <h2 id="prepare-apache-release">Prepare Apache Release</h2> |
| <ol> |
| <li> |
| <p>Prepare the svn local environment (Apache hosting the release content of project by svn)</p> |
| </li> |
| <li> |
| <p>Checkout dubbo to local directory</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ svn checkout https://dist.apache.org/repos/dist/dev/dubbo |
| </span></span></code></pre></div><p>Assume that the local directory is <code>~/apache/incubator/dubbo</code></p> |
| </li> |
| <li> |
| <p>The current release version is ${release_version}, new directory</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ <span style="color:#b58900">cd</span> ~/apache/incubator/dubbo <span style="color:#586e75"># dubbo svn root directory</span> |
| </span></span><span style="display:flex;"><span>$ mkdir <span style="color:#2aa198">${</span><span style="color:#268bd2">release_version</span><span style="color:#2aa198">}</span> |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Add public key to <a href="https://dist.apache.org/repos/dist/dev/dubbo/KEYS">KEYS</a> file if you are the first time to be a release manager. KEYS is mainly used to allow people who participate in the voting to be imported locally to verify the correctness of the sign.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ gpg -a --export your_key_id &gt;&gt; KEYS |
| </span></span></code></pre></div><p>For more information on how to get your key id, please refer to this <a href="https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key">guide</a></p> |
| </li> |
| <li> |
| <p>Copy the source.zip package from the Dubbo root directory to the svn local repository dubbo/${release_version}</p> |
| </li> |
| <li> |
| <p>Generate sha512 sign</p> |
| <p>For source-release.zip</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ shasum -a <span style="color:#2aa198">512</span> apache-dubbo-<span style="color:#2aa198">${</span><span style="color:#268bd2">release_version</span><span style="color:#2aa198">}</span>-source-release.zip &gt;&gt; apache-dubbo-<span style="color:#2aa198">${</span><span style="color:#268bd2">release_version</span><span style="color:#2aa198">}</span>-source-release.zip.sha512 |
| </span></span></code></pre></div><p>For bin-release.zip</p> |
| <p>Please add <code>-b</code> paramter when generating sha512 for bin-release.zip, which indicates it is a binary file.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ shasum -b -a <span style="color:#2aa198">512</span> apache-dubbo-<span style="color:#2aa198">${</span><span style="color:#268bd2">release_version</span><span style="color:#2aa198">}</span>-bin-release.zip &gt;&gt; apache-dubbo-<span style="color:#2aa198">${</span><span style="color:#268bd2">release_version</span><span style="color:#2aa198">}</span>-bin-release.zip.sha512 |
| </span></span></code></pre></div><p>You should generate something like this:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>b8f13d1df6d6c9a1facc72fafc00b2d22bea1e600517c507467d8fca2f776a7a3877101742da53114bfa629ca5b941eb4d9ef989de43f0833e2a794e7ccf5c8a *apache-dubbo-spring-boot-project-2.7.0-bin-release.zip |
| </span></span></code></pre></div><p>Note there is a <code>*</code> sign before the file name.</p> |
| </li> |
| <li> |
| <p>If the binary release is accompanied with the source release. Run the following command in the dubbo-distribution module:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ mvn install |
| </span></span></code></pre></div><p>Go to target directory, copy bin-release.zip and bin-release.zip.asc to svn local repository dubbo/${release_version}, and refer to step 6 to generate sha512 sign.</p> |
| </li> |
| <li> |
| <p>Commit to Apache svn</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ svn status |
| </span></span><span style="display:flex;"><span>$ svn commit -m <span style="color:#2aa198">&#39;prepare for ${release_version} RC1&#39;</span> |
| </span></span></code></pre></div></li> |
| </ol> |
| <h2 id="verify-release-candidates">Verify Release Candidates</h2> |
| <p><strong>A full check list can be found <a href="https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist">here</a></strong></p> |
| <p>The verification link includes but is not limited to the following contents and forms:</p> |
| <h3 id="check-signatures-and-hashes-are-good">Check signatures and hashes are good</h3> |
| <h4 id="check-the-sha512-sum">check the sha512 sum</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>$ shasum -c apache-dubbo-<span style="color:#2aa198">${</span><span style="color:#268bd2">release_version</span><span style="color:#2aa198">}</span>-source-release.zip.sha512 |
| </span></span><span style="display:flex;"><span>$ shasum -c apache-dubbo-<span style="color:#2aa198">${</span><span style="color:#268bd2">release_version</span><span style="color:#2aa198">}</span>-bin-release.zip.sha512 |
| </span></span></code></pre></div><h4 id="check-the-gpg-signarure">check the gpg signarure</h4> |
| <p>If it&rsquo;s your first time verify a release candidte, you should import public keys first.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span> $ curl https://dist.apache.org/repos/dist/dev/dubbo/KEYS &gt;&gt; KEYS <span style="color:#586e75"># download public keys to local directory</span> |
| </span></span><span style="display:flex;"><span> $ gpg --import KEYS <span style="color:#586e75"># import keys</span> |
| </span></span><span style="display:flex;"><span> $ gpg —edit-key liujun |
| </span></span><span style="display:flex;"><span> &gt; trust <span style="color:#586e75"># type trust command</span> |
| </span></span></code></pre></div><p>Now, you can verify signature with command</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>gpg --verify apache-dubbo-2.6.3-source-release.zip.asc apache-dubbo-2.6.3-source-release.zip |
| </span></span><span style="display:flex;"><span>gpg --verify apache-dubbo-2.6.3-bin-release.zip.asc apache-dubbo-2.6.3-bin-release.zip |
| </span></span></code></pre></div><h3 id="check-source-release-file-content">Check source release file content</h3> |
| <p>Unzip apache-dubbo-${release_version}-source-release.zip to the default directory and check the following:</p> |
| <ul> |
| <li>Directory with &lsquo;incubating&rsquo; in name |
| <code>apache-dubbo-${release_version}-source-release</code></li> |
| <li>DISCLAIMER exists</li> |
| <li>LICENSE and NOTICE exists and contents are good</li> |
| <li>All files and no binary files exist</li> |
| <li>All files has standard ASF License header</li> |
| <li>Can compile from source</li> |
| <li>All unit tests can pass |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>mvn clean <span style="color:#b58900">test</span> <span style="color:#586e75"># This will run all unit tests</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># you can also open rat and style plugin to check if every file meets requirements.</span> |
| </span></span><span style="display:flex;"><span>mvn clean <span style="color:#b58900">test</span> -Drat.skip<span style="color:#719e07">=</span><span style="color:#b58900">false</span> -Dcheckstyle.skip<span style="color:#719e07">=</span><span style="color:#b58900">false</span> |
| </span></span></code></pre></div></li> |
| <li>Release candidates match with corresponding tags, you can find tag link and hash in vote email. |
| <ul> |
| <li>check the version number in pom.xml are the same</li> |
| <li>check there are no extra files or directories in the source package, for example, no empty directories or useless log files.<br> |
| <code>diff -r rc_dir tag_dir</code></li> |
| <li>check the top n tag commits, dive into the related files and check if the source package has the same changes</li> |
| </ul> |
| </li> |
| </ul> |
| <h3 id="check-binary-distribution-file-content">Check binary distribution file content</h3> |
| <p>Unzip apache-dubbo-${release_version}-bin-release.zip and check:</p> |
| <ul> |
| <li>Check signatures are good</li> |
| <li>&lsquo;incubating&rsquo; in name</li> |
| <li>LICENSE and NOTICE exists and contents are good</li> |
| </ul> |
| <p>Note that if the binary distribution contains third party files, you may need to update LICENSE file by adding the 3rd party license files. If these dependency is Apache License 2.0, and it contains NOTICE file, you may also need to update NOTICE file as well.</p> |
| <h2 id="release-vote">Release vote</h2> |
| <p>The voting is divided into two phases:</p> |
| <ol> |
| <li>Dubbo community votes and sends the voting email to <a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a>. After reviewing by community developers and winning 3 binding tickets that agree to release, you can go to the next stage of voting.</li> |
| <li>Apache community votes and sends the voting email to <a href="mailto:general@incubator.apache.org">general@incubator.apache.org</a>. After reviewing by Apache IPMC(Incubator PMC) members and winning 3 binding votes that agree to release, you will be allowed to release officially.</li> |
| </ol> |
| <p>The mail template for Apache Dubbo vote：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-tex" data-lang="tex"><span style="display:flex;"><span>Hello Dubbo Community, |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>This is a call for vote to release Apache Dubbo (Incubating) version 2.6.2. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The release candidates: |
| </span></span><span style="display:flex;"><span>https://dist.apache.org/repos/dist/dev/dubbo/2.6.2/ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Git tag for the release: |
| </span></span><span style="display:flex;"><span>https://github.com/apache/dubbo/tree/dubbo-2.6.2 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Hash for the release tag: |
| </span></span><span style="display:flex;"><span>afab04c53edab38d52275d2a198ea1aff7a4f41e |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Release Notes: |
| </span></span><span style="display:flex;"><span>https://github.com/apache/dubbo/releases/tag/untagged-4775c0a22c60fca55118 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The artifacts have been signed with Key : 28681CB1, which can be found in the keys file: |
| </span></span><span style="display:flex;"><span>https://dist.apache.org/repos/dist/dev/dubbo/KEYS |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The vote will be open for at least 72 hours or until necessary number of votes are reached. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Please vote accordingly: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>[ ] +1 approve |
| </span></span><span style="display:flex;"><span>[ ] +0 no opinion |
| </span></span><span style="display:flex;"><span>[ ] -1 disapprove with the reason |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Thanks, |
| </span></span><span style="display:flex;"><span>The Apache Dubbo (Incubating) Team |
| </span></span></code></pre></div><p>The mail template for Apache Incubator vote：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>Hello all, |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>This is a call for vote to release Apache Dubbo (Incubating) version 2.6.4. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The Apache Dubbo community has voted on and approved a proposal to release |
| </span></span><span style="display:flex;"><span>Apache Dubbo (Incubating) version 2.6.4. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>We now kindly request the Incubator PMC members review and vote on this |
| </span></span><span style="display:flex;"><span>incubator release. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Apache Dubbo™ is a high-performance, java based, open source |
| </span></span><span style="display:flex;"><span>RPC framework. Dubbo offers three key functionalities, which include |
| </span></span><span style="display:flex;"><span>interface based remote call, fault tolerance &amp; load balancing, and |
| </span></span><span style="display:flex;"><span>automatic service registration &amp; discovery. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Dubbo community vote and result thread: |
| </span></span><span style="display:flex;"><span>https://lists.apache.org/thread.html/8d5c39eece6288beed2e22ca976350728c571d2a9cef1c9a9e56a409@%3Cdev.dubbo.apache.org%3E |
| </span></span><span style="display:flex;"><span>A minor issue also can be found in the above thread. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The release candidates (RC1): |
| </span></span><span style="display:flex;"><span>https://dist.apache.org/repos/dist/dev/dubbo/2.6.4 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Git tag for the release (RC1): |
| </span></span><span style="display:flex;"><span>https://github.com/apache/dubbo/tree/dubbo-2.6.4 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Hash for the release tag: |
| </span></span><span style="display:flex;"><span>88037747a3b69d3225c73f6fbcda36ebd8435887 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Release Notes: |
| </span></span><span style="display:flex;"><span>*https://github.com/apache/dubbo/blob/dubbo-2.6.4/CHANGES.md |
| </span></span><span style="display:flex;"><span>&lt;https://github.com/apache/dubbo/blob/dubbo-2.6.4/CHANGES.md&gt;* |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The artifacts have been signed with Key : 7955FB6D1DD21CF7, which can be |
| </span></span><span style="display:flex;"><span>found in the keys file: |
| </span></span><span style="display:flex;"><span>https://dist.apache.org/repos/dist/dev/dubbo/KEYS |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Look at here for how to verify this release candidate: |
| </span></span><span style="display:flex;"><span>https://github.com/apache/dubbo-website/blob/asf-site/blog/en-us/prepare-an-apache-release.md#prepare-apache-release |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The vote will be open for at least 72 hours or until necessary number of |
| </span></span><span style="display:flex;"><span>votes are reached. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Please vote accordingly: |
| </span></span><span style="display:flex;"><span>[ ] +1 approve |
| </span></span><span style="display:flex;"><span>[ ] +0 no opinion |
| </span></span><span style="display:flex;"><span>[ ] -1 disapprove with the reason |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Thanks, |
| </span></span><span style="display:flex;"><span>The Apache Dubbo (Incubating) Team |
| </span></span></code></pre></div><p>The mail template to announce the vote result:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-text" data-lang="text"><span style="display:flex;"><span>We’ve received 3 +1 binding votes and one +1 non-binding vote: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>+1 binding, Ian Luo |
| </span></span><span style="display:flex;"><span>+1 binding, Huxing Zhang |
| </span></span><span style="display:flex;"><span>+1 binding, Jun Liu |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>+1 non-binding, Jerrick |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>I will create a new vote thread in Apache community now. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Best regards, |
| </span></span><span style="display:flex;"><span>The Apache Dubbo (Incubating) Team |
| </span></span></code></pre></div><h2 id="official-release">Official Release</h2> |
| <p>When the release vote has passed,</p> |
| <ol> |
| <li>Add the release files to <a href="https://dist.apache.org/repos/dist/release/dubbo">official release directory</a></li> |
| <li>Remove the release files in <a href="https://dist.apache.org/repos/dist/dev/dubbo">dev directory</a></li> |
| <li>Remove the the release file for the previous release under <a href="https://dist.apache.org/repos/dist/release/dubbo/">official release directory</a>, which will be archived and can be found <a href="https://archive.apache.org/dist/incubator/dubbo/">here</a></li> |
| <li>Publish <a href="https://github.com/apache/dubbo/releases">release notes</a> on Github.</li> |
| <li>Update the recommend dependency on <a href="https://github.com/apache/dubbo#maven-dependency">Github</a> to the latest version, also update the version in other place if necessary.</li> |
| <li>Add the download link to official website <a href="https://dubbo.apache.org/en/blog/2020/05/18/past-releases/">https://dubbo.apache.org/en/blog/2020/05/18/past-releases/</a>, using the ASF mirror system. The latest release download link should be something like <code>https://www.apache.org/dyn/closer.cgi?path=incubator/dubbo/$VERSION/apache-dubbo-$VERSION-source-release.zip</code>. The download link for the previous release version should be changed like <code>https://archive.apache.org/dist/incubator/dubbo/$VERSION/apache-dubbo-$VERSION-bin-release.zip)</code>. Please refer to the <a href="https://dubbo.apache.org/en/blog/2020/05/18/past-releases/">download page</a> for more details.</li> |
| <li>Make sure all the commits in the release branch are merged into master branch, and then remove the remote release branch. For example: <code>git push origin --delete 2.7.0-release</code></li> |
| <li>Send mail to <a href="mailto:dev@dubbo.apache.org">dev@dubbo.apache.org</a> and <a href="mailto:general@incubator.apache.org">general@incubator.apache.org</a>, notify the community that the release is completed. |
| The mail template to announce release:</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-text" data-lang="text"><span style="display:flex;"><span>Hello Community, |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>The Apache Dubbo team is pleased to announce that the |
| </span></span><span style="display:flex;"><span>2.6.6 has just been released. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Apache Dubbo™ is a high-performance, java based, open source |
| </span></span><span style="display:flex;"><span>RPC framework. Dubbo offers three key functionalities, which include |
| </span></span><span style="display:flex;"><span>interface based remote call, fault tolerance &amp; load balancing, and |
| </span></span><span style="display:flex;"><span>automatic service registration &amp; discovery. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Both the source release[1] and the maven binary release[2] are available |
| </span></span><span style="display:flex;"><span>now, you can also find the detailed release notes in here[3]. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>If you have any usage questions, or have problems when upgrading or find |
| </span></span><span style="display:flex;"><span>any problems about enhancements included in this release, please don’t |
| </span></span><span style="display:flex;"><span>hesitate to let us know by sending feedback to this mailing list or filing |
| </span></span><span style="display:flex;"><span>an issue on GitHub[4]. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>===== |
| </span></span><span style="display:flex;"><span>*Disclaimer* |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>Apache Dubbo is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>[1] https://dubbo.apache.org/en/blog/2020/05/18/past-releases/ |
| </span></span><span style="display:flex;"><span>[2] http://central.maven.org/maven2/com/alibaba/dubbo |
| </span></span><span style="display:flex;"><span>[3] https://github.com/apache/dubbo/releases |
| </span></span><span style="display:flex;"><span>[4] https://github.com/apache/dubbo/issues |
| </span></span></code></pre></div><h2 id="complete-maven-convenient-binary-release">Complete Maven Convenient Binary release</h2> |
| <p><strong><a href="https://repository.apache.org/">repository.apache.org</a> The permissions of the nexus repository have been applied, see <a href="https://issues.apache.org/jira/browse/INFRA-16451">jira</a>。</strong></p> |
| <p>To release the maven artifacts, go to <a href="https://repository.apache.org">repository.apache.org</a>, and choose the staging repository, click the release button. Wait for a moment and verify it at <a href="https://repository.apache.org/content/repositories/releases/org/apache/dubbo/">here</a>, make sure your artifacts are there and correct. It will take some time to sync to maven central repository. You can verify it at <a href="https://repo.maven.apache.org/maven2/org/apache/dubbo">here</a></p> |
| <h2 id="faq">FAQ</h2> |
| <h4 id="gpg-signing-failed-inappropriate-ioctl-for-device">gpg: signing failed: Inappropriate ioctl for device</h4> |
| <p>If you&rsquo;ve encoutered this error, try the following commands:</p> |
| <div class="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">export</span> GPG_TTY<span style="color:#719e07">=$</span>(tty) |
| </span></span></code></pre></div></description></item><item><title>Blog: How to implement a fully asynchronous calls chain based on Dubbo</title><link>https://dubbo.apache.org/en/blog/2018/09/02/how-to-implement-a-fully-asynchronous-calls-chain-based-on-dubbo/</link><pubDate>Sun, 02 Sep 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/09/02/how-to-implement-a-fully-asynchronous-calls-chain-based-on-dubbo/</guid><description> |
| <p>Implementing the full asynchronous programming based on Dubbo, which is a new feature introduced in version 2.7.0 after the enhancement of the existing asynchronous mode.This article first reviews the supported functions and existing problems of asynchronization in 2.6.x and earlier versions, and introduces the targeted enhancements based on CompletableFuture in version 2.7.0. Then, the use of enhanced asynchronous programming is elaborated through several examples. Finally, it summarizes the new problems brought by the introduction of asynchronous mode and corresponding solutions from Dubbo. By reading this article, it is easy to implement a fully asynchronous remote service call chain based on Dubbo 2.7.0+.</p> |
| <h2 id="asynchronous-mode-before-version-26x">Asynchronous mode before version 2.6.x</h2> |
| <p>Dubbo Provides some asynchronous programming capabilities in 2.6.x and earlier versions, including <a href="https://dubbo.apache.org/en/docs/v2.7/user/examples/async-call/">Asynchronous Call</a>, <a href="https://dubbo.apache.org/en/docs/v2.7/user/examples/callback-parameter/">Parameter Callback</a> and <a href="https://dubbo.apache.org/en/docs/v2.7/user/examples/events-notify/">Event Notification</a> on Consumer side. There are some brief introductions to the usage and Demo in the above document links.</p> |
| <p>But the current asynchronous method has the following problems:</p> |
| <ul> |
| <li>Methods to access Future object are not direct enough.</li> |
| <li>Future interface cannot implement automatic callback. Customized ResponseFuture class could implement callback, however it only supports limited asynchronous scenes. For example, it does not support mutual coordination or combination between Future objects.</li> |
| <li>Asynchronization on Provider side is not supported.</li> |
| </ul> |
| <p>Take the asynchronous method of Consumer side as an example:</p> |
| <ol> |
| <li>Define a original synchronous interface and add the declaration to support asynchronous calls.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">FooService</span> { |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">findFoo</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;fooService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.foo.FooService&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;findFoo&#34;</span> async=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><ol start="2"> |
| <li>Obtain Future object through RpcContext.</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// this call will return null immediately</span> |
| </span></span><span style="display:flex;"><span>fooService.findFoo(fooId); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Obtain the Future instance. When the result is returned, Future instance will be notified and the result will be set to Future instance.</span> |
| </span></span><span style="display:flex;"><span>Future<span style="color:#719e07">&lt;</span>Foo<span style="color:#719e07">&gt;</span> fooFuture <span style="color:#719e07">=</span> RpcContext.getContext().getFuture(); |
| </span></span><span style="display:flex;"><span>fooFuture.get(); |
| </span></span></code></pre></div><p>or</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">// this call will return null immediately</span> |
| </span></span><span style="display:flex;"><span>fooService.findFoo(fooId); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// get Dubbo&#39;s built-in ResponseFuture, and set the callback</span> |
| </span></span><span style="display:flex;"><span>ResponseFuture future <span style="color:#719e07">=</span> ((FutureAdapter)RpcContext.getContext().getFuture()).getFuture(); |
| </span></span><span style="display:flex;"><span>future.setCallback(<span style="color:#719e07">new</span> ResponseCallback() { |
| </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">done</span>(Object response) { |
| </span></span><span style="display:flex;"><span> System.out.print(response); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">caught</span>(Throwable exception) { |
| </span></span><span style="display:flex;"><span> exception.printStackTrace(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>}); |
| </span></span></code></pre></div><p>From this simple example, we can see there are some inconveniences in use:</p> |
| <ol> |
| <li>The synchronization interface of findFoo cannot directly return a Future object representing the asynchronous result, which is further obtained through RpcContext.</li> |
| <li>Future object can only be obtained from get method that will block until getting the result.</li> |
| <li>Callback can be set by getting the built-in ResponseFuture interface. However, the API to obtain ResponseFuture is not convenient enough to support other asynchronous scenes except callback. For example, it does not support the scene where multiple Future objects work together.</li> |
| </ol> |
| <h2 id="enhancement-based-on-completablefuture-in-version-270">Enhancement based on CompletableFuture in version 2.7.0</h2> |
| <p>People who understand the evolution history of Future in Java should know that the Future used in Dubbo 2.6.x and earlier versions is introduced in Java 5, so there are some problems in function design.The CompletableFuture introduced in Java 8 further enriches the Future interface and solves these problems well.</p> |
| <p>Support for Java 8 has been upgraded in Dubbo 2.7.0, and Dubbo has enhanced the current asynchronous functionality based on CompletableFuture.</p> |
| <ol> |
| <li> |
| <p>Now it supports direct definition of service interfaces that return CompletableFuture. Through these interfaces, we can implement asynchronous programming on both Consumer side and Provider side more naturally.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</span> { |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHello</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></li> |
| <li> |
| <p>If you don&rsquo;t want to define the return value of the interface as a Future object, or if there is a defined synchronization interface, you can additionally define an asynchronous interface and provide a method to return a Future object.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</span> { |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHello</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@AsyncFor</span>(AsyncService.class) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GrettingServiceAsync</span> <span style="color:#268bd2">extends</span> GreetingsService { |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHiAsync</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>In this way, Provider can only implement the sayHi method. The Consumer can get a Future instance by directly calling sayHiAsync, and Dubbo framework will convert it to a call to the sayHi method on the Provider side automatically.</p> |
| <p>Providing an asynchronous method definition for each synchronization method can be inconvenient. Further, using <a href="https://github.com/dubbo/dubbo-async-processor">Annotation Processor implementation</a> in the Dubbo ecosystem can automatically generate asynchronous method definitions for us.</p> |
| </li> |
| <li> |
| <p>Similarly, if your original interface definition doesn&rsquo;t return a Future object, the Provider side also provides a programming interface similar to the Async Servlet in Servlet 3.0 to support asynchronization : <code>RpcContext.startAsync()</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:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</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><div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService { |
| </span></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:#268bd2">final</span> AsyncContext asyncContext <span style="color:#719e07">=</span> RpcContext.startAsync(); |
| </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> asyncContext.write(<span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, response from provider.&#34;</span>); |
| </span></span><span style="display:flex;"><span> }).start(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>At the beginning of the method body, it starts asynchronization by running <code>RpcContext.startAsync()</code> , and it starts a new thread to execute the business logic asynchronously. After the time-consuming operation is completed, the result is written back by <code>asyncContext.write</code>.</p> |
| </li> |
| <li> |
| <p>RpcContext returns CompletableFuture directly.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> f <span style="color:#719e07">=</span> RpcContext.getContext().getCompletableFuture(); |
| </span></span></code></pre></div></li> |
| </ol> |
| <p>All of the above enhancements are based on the compatibility with existing asynchronous programming, so asynchronous programs written based on 2.6.x versions can be successfully compiled without any modification.</p> |
| <p>Next, let&rsquo;s illustrate how to implement a fully asynchronous Dubbo service call chain through a few examples.</p> |
| <h2 id="example-1completablefuture-interface">example 1：CompletableFuture interface</h2> |
| <p>CompletableFuture interface can be used both for a synchronous call and for an asynchronous call on Consumer or Provider side. This example implements asynchronous calls between Consumer and Provider sides. Code link <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-async/dubbo-samples-async-original-future">dubbo-samples-async-original-future</a>.</p> |
| <ol> |
| <li> |
| <p>Interface definition</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</span> { |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHello</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Note that the return type of this interface is <code>CompletableFuture&lt;String&gt;</code>.</p> |
| </li> |
| <li> |
| <p>Provider Side</p> |
| <ul> |
| <li> |
| <p>Implementation</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHello</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> CompletableFuture.supplyAsync(() <span style="color:#719e07">-&gt;</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep(5000); |
| </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> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;async response from provider.&#34;</span>; |
| </span></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>We can see that the business code is switched to be executed in the new thread by supplyAsync, so the Provider side is asynchronous.</p> |
| </li> |
| <li> |
| <p>Config</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;asyncService&#34;</span> class=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.impl.AsyncServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.api.AsyncService&#34;</span> ref=<span style="color:#2aa198">&#34;asyncService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>The Config is the same as the original interface.</p> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>Consumer Side</p> |
| <ul> |
| <li>Config</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;asyncService&#34;</span> timeout=<span style="color:#2aa198">&#34;10000&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.api.AsyncService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>The Config is the same as the original interface.</p> |
| <ul> |
| <li>Call remote service</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">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> Exception { |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(<span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span>{<span style="color:#2aa198">&#34;META-INF/spring/async-consumer.xml&#34;</span>}); |
| </span></span><span style="display:flex;"><span> context.start(); |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> AsyncService asyncService <span style="color:#719e07">=</span> (AsyncService) context.getBean(<span style="color:#2aa198">&#34;asyncService&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> asyncService.sayHello(<span style="color:#2aa198">&#34;async call request&#34;</span>); |
| </span></span><span style="display:flex;"><span> future.whenComplete((v, t) <span style="color:#719e07">-&gt;</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (t <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> t.printStackTrace(); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Response: &#34;</span> <span style="color:#719e07">+</span> v); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Executed before response return.&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.in.read(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p><code>CompletableFuture&lt;String&gt; future = asyncService.sayHello(&quot;async call request&quot;);</code>It is convenient to return the Future instance, which implements the asynchronous service call on the Consumer side.</p> |
| </li> |
| </ol> |
| <h2 id="example-2synchronous-interface-uses-annotation-processor">Example 2：Synchronous interface uses Annotation Processor</h2> |
| <p>This example demonstrates how to implement the Consumer-side asynchronous service call using the Annotation Processor based on the original synchronous interface. Code link <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-async/dubbo-samples-async-generated-future">dubbo-samples-async-generated-future</a>.</p> |
| <ol> |
| <li> |
| <p>Interface definition</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@DubboAsync</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> String <span style="color:#268bd2">sayHi</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>This is a generic definition of the Dubbo service interface. Note that add the @DubboAsync annotation when using Annotation Processor.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.alibaba<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-async-processer<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>1.0.0-SNAPSHOT<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;plugin&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.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>maven-compiler-plugin<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>3.7.0<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;source&gt;</span>1.8<span style="color:#268bd2">&lt;/source&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;target&gt;</span>1.8<span style="color:#268bd2">&lt;/target&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;annotationProcessorPaths&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;path&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.alibaba<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-async-processer<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>1.0.0-SNAPSHOT<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/path&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/annotationProcessorPaths&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;/plugin&gt;</span> |
| </span></span></code></pre></div><p>The above config is the Maven dependency that imports dubbo-async-processer processor. Developers who define interfaces (providing APIs) usually add the above dependencies to the project, so that when doing API packaging, the following interface definitions will be automatically generated in APIs:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">* Generated by dubbo-async-processer |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">*/</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">package</span> com.alibaba.dubbo.samples.api; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> java.util.concurrent.CompletableFuture; |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@javax.annotation.Generated</span>(<span style="color:#2aa198">&#34;com.alibaba.dubbo.async.processor.AsyncAnnotationProcessor&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@org.apache.dubbo.common.config.AsyncFor</span>(com.alibaba.dubbo.samples.api.GreetingsService.class) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GreetingsServiceAsync</span> <span style="color:#268bd2">extends</span> GreetingsService { |
| </span></span><span style="display:flex;"><span>CompletableFuture<span style="color:#719e07">&lt;</span>java.lang.String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHiAsync</span>(java.lang.String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Provider side</p> |
| <ul> |
| <li>Config</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;greetingsService&#34;</span> class=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.impl.GreetingsServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.api.GreetingsService&#34;</span> ref=<span style="color:#2aa198">&#34;greetingsService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li>Service implementation</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">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></li> |
| <li> |
| <p>Consumer side</p> |
| <ul> |
| <li>Config</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;greetingsService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.api.GreetingsServiceAsync&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Note that the service interface uses <strong>GreetingsServiceAsync</strong></p> |
| <ul> |
| <li>Service call</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">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> Exception { |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(<span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span>{<span style="color:#2aa198">&#34;META-INF/spring/async-consumer.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> GreetingsServiceAsync greetingsService <span style="color:#719e07">=</span> (GreetingsServiceAsync) context.getBean(<span style="color:#2aa198">&#34;greetingsService&#34;</span>); |
| </span></span><span style="display:flex;"><span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> greetingsService.sayHiAsync(<span style="color:#2aa198">&#34;async call reqeust&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;async call ret :&#34;</span> <span style="color:#719e07">+</span> future.get()); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> System.in.read(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>In this way, we can use <code>CompletableFuture&lt;String&gt; future = greetingsService.sayHiAsync(&quot;async call reqeust&quot;);</code> directly，and return CompletableFuture.</p> |
| </li> |
| </ol> |
| <h2 id="example-3use-asynccontext">Example 3：Use AsyncContext</h2> |
| <p>This example demonstrates how to implement the Provider-side asynchronous execution through AsyncContext based on the original synchronous interface. Code link <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-async/dubbo-samples-async-provider">dubbo-samples-async-provider</a>.</p> |
| <ol> |
| <li> |
| <p>Interface definition</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</span> { |
| </span></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></li> |
| <li> |
| <p>Provider side</p> |
| <ul> |
| <li>Config</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;asyncService&#34;</span> class=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.impl.AsyncServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> async=<span style="color:#2aa198">&#34;true&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.api.AsyncService&#34;</span> ref=<span style="color:#2aa198">&#34;asyncService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>Note that adding <code>async=&quot;true&quot;</code> indicates that this is a service that starts the Provider-side execution asynchronously.</p> |
| <ul> |
| <li>Asynchronous execution implementation</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService { |
| </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:#268bd2">final</span> AsyncContext asyncContext <span style="color:#719e07">=</span> RpcContext.startAsync(); |
| </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> asyncContext.signalContextSwitch(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep(500); |
| </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> } |
| </span></span><span style="display:flex;"><span> asyncContext.write(<span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, response from provider.&#34;</span>); |
| </span></span><span style="display:flex;"><span> }).start(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></li> |
| <li> |
| <p>Consumer side</p> |
| <ul> |
| <li>Config</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;asyncService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.api.AsyncService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><ul> |
| <li>Service call</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">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> Exception { |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(<span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span>{<span style="color:#2aa198">&#34;META-INF/spring/async-consumer.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> AsyncService asyncService <span style="color:#719e07">=</span> (AsyncService) context.getBean(<span style="color:#2aa198">&#34;asyncService&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.out.println(asyncService.sayHello(<span style="color:#2aa198">&#34;async call request&#34;</span>)); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> System.in.read(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div></li> |
| </ol> |
| <h2 id="new-problems-resulted-from-asynchronization">New problems resulted from asynchronization</h2> |
| <h3 id="filter-chain">Filter Chain</h3> |
| <p>The following is a complete Filter chain for a normal Dubbo call.</p> |
| <p>After using the asynchronous call, since the asynchronous result is executed separately in the asynchronous thread, the Result passed through the second half of the Filter chain is null, and the real result cannot be processed by the Filter chain when it is returned.</p> |
| <p>In order to solve this problem, PostProcessFilter and AbstractPostProcessFilter were introduced in Dubbo 2.7.0. The PostProcessFilter interface extends from the Filter interface, and AbstractPostProcessFilter is an abstract implementation of PostProcessFilter.</p> |
| <p>The following is an example of extending the Filter and supporting the asynchronous Filter chain.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Activate</span>(group <span style="color:#719e07">=</span> {Constants.PROVIDER, Constants.CONSUMER}) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AsyncPostprocessFilter</span> <span style="color:#268bd2">extends</span> AbstractPostProcessFilter { |
| </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> Result <span style="color:#268bd2">invoke</span>(Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker, Invocation invocation) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> postProcessResult(invoker.invoke(invocation), invoker, invocation); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">protected</span> Result <span style="color:#268bd2">doPostProcess</span>(Result result, Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker, Invocation invocation) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;Filter get the return value: &#34;</span> <span style="color:#719e07">+</span> result.getValue()); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> result; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="context-passing">Context passing</h3> |
| <p>Currently, the context we are considering mainly refers to the data stored in the RpcContext. In most scenarios, the user needs to complete the passing of the Context before switching the service thread.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Save the context of the current thread</span> |
| </span></span><span style="display:flex;"><span> RpcContext context <span style="color:#719e07">=</span> RpcContext.getContext(); |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> CompletableFuture<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">sayHello</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> CompletableFuture.supplyAsync(() <span style="color:#719e07">-&gt;</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// Set context into new thread</span> |
| </span></span><span style="display:flex;"><span> RpcContext.setContext(context); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep(5000); |
| </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> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;async response from provider.&#34;</span>; |
| </span></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>However, AsyncContext also provides the signalContextSwitch() method for a convenient Context switch.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AsyncServiceImpl</span> <span style="color:#268bd2">implements</span> AsyncService { |
| </span></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:#268bd2">final</span> AsyncContext asyncContext <span style="color:#719e07">=</span> RpcContext.startAsync(); |
| </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> asyncContext.signalContextSwitch(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep(500); |
| </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> } |
| </span></span><span style="display:flex;"><span> asyncContext.write(<span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, response from provider.&#34;</span>); |
| </span></span><span style="display:flex;"><span> }).start(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div></description></item><item><title>Blog: The fourth Dubbo meetup has been held in Chengdu</title><link>https://dubbo.apache.org/en/blog/2018/08/26/the-fourth-dubbo-meetup-has-been-held-in-chengdu/</link><pubDate>Sun, 26 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/26/the-fourth-dubbo-meetup-has-been-held-in-chengdu/</guid><description> |
| <h1 id="the-fourth-dubbo-meetup-has-been-held-in-chengdu">The fourth Dubbo meetup has been held in Chengdu</h1> |
| <p><img src="https://dubbo.apache.org/imgs/blog/meetup-chengdu/all-hands.webp" alt="img"></p> |
| <h2 id="the-depth-of-the-user-communication">The depth of the user communication</h2> |
| <p>On August 26, 10:00 am - 12:00am, invited the arrival of the car to help, cloud gold, former BBD, flying fish star four companies open source enthusiasts and heavy users participate in face-to-face communication;According to the participants&rsquo; feedback, answer to Dubbo many doubt, especially how to participate in the contribution to the community, as well as code contribution value point.Hope later can be more deeply involved in Dubbo communities and activities.</p> |
| <h2 id="meetup-activity-information">Meetup activity information</h2> |
| <p>The event is still full, total enrollment of 976, 350 + site users, live PV 13207.</p> |
| <h2 id="the-registration-information">The registration information</h2> |
| <p>Aliware Open Source, headquarters - Apache Dubbo developers salon on August 26 (Sunday) in chengdu high-tech zone tianfu hemicyenine rong international plaza, 200 five street on the 8th floor held the second floor conference room, technical thinking is GG feast, dry goods and welfare will not one less.</br> |
| Sign up link：http://www.huodongxing.com/event/7453091088400</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-chengdu-meetup-img.jpg" alt="img"></p></description></item><item><title>Blog: Dubbo Basic Usage - Dubbo Consumer Configuration</title><link>https://dubbo.apache.org/en/blog/2018/08/14/dubbo-basic-usage-dubbo-consumer-configuration/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/dubbo-basic-usage-dubbo-consumer-configuration/</guid><description> |
| <h2 id="dubbo-consumer-configuration">Dubbo Consumer Configuration</h2> |
| <h3 id="consumer-configuration-detailed">Consumer Configuration Detailed</h3> |
| <p>There are 3 ways to configure the Dubbo Consumer: XML configuration, API call mode configuration, and annotation mode configuration.</p> |
| <h4 id="xml-configuration">XML Configuration</h4> |
| <h6 id="example-of-the-simplest-configuration">Example of the simplest configuration:</h6> |
| <div class="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> |
| </span></span><span style="display:flex;"><span>&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt; |
| </span></span><span style="display:flex;"><span>&lt;beans xmlns=&#34;http://www.springframework.org/schema/beans&#34; |
| </span></span><span style="display:flex;"><span> Xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; |
| </span></span><span style="display:flex;"><span> Xmlns:dubbo=&#34;http://dubbo.apache.org/schema/dubbo&#34; |
| </span></span><span style="display:flex;"><span> Xsi:schemaLocation=&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema /dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:application name=&#34;hello-world-app&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:registry address=&#34;multicast://224.5.6.7:1234&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:protocol name=&#34;dubbo&#34; port=&#34;20880&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:reference id=&#34;demoServiceRemote&#34; interface=&#34;com.alibaba.dubbo.demo.DemoService&#34; /&gt; |
| </span></span><span style="display:flex;"><span>&lt;/beans&gt; |
| </span></span></code></pre></div><blockquote> |
| <p>For the supported configuration tags and corresponding configuration items, refer to the usage in the provider.</p> |
| </blockquote> |
| <blockquote> |
| <p>Next, focus on the configuration of &lt;dubbo:reference/&gt;.</p> |
| </blockquote> |
| <ul> |
| <li>&lt;dubbo:reference/&gt; List of main attributes supported:</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>Property Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>id</td> |
| <td>service reference id, as java bean id, requires unique</td> |
| </tr> |
| <tr> |
| <td>Interface</td> |
| <td>interface name for finding services</td> |
| </tr> |
| <tr> |
| <td>version</td> |
| <td>version number, consistent with the service provider&rsquo;s version</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>service method call timeout (ms)</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>The number of retry attempts by the remote service, excluding the first call, no need to retry, please set to 0</td> |
| </tr> |
| <tr> |
| <td>Connections</td> |
| <td>For each provider&rsquo;s maximum number of connections, rmi, http, hessian, etc. The short connection protocol indicates the number of restricted connections, and the dubbo equal-length connection association indicates the number of long connections established</td> |
| </tr> |
| <tr> |
| <td>Loadbalance</td> |
| <td>Load balancing policy, optional values: random, roundrobin, leastactive, respectively: random, polling, least active call</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>Whether to execute asynchronously, unreliable asynchronous, just ignore return value, do not block execution thread</td> |
| </tr> |
| <tr> |
| <td>generic</td> |
| <td>generalized call, can bypass</td> |
| </tr> |
| <tr> |
| <td>check</td> |
| <td>Check if the provider exists at startup, true error, false ignore</td> |
| </tr> |
| <tr> |
| <td>Actives</td> |
| <td>Maximum concurrent calls per method per service consumer</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>For other configuration properties, please refer to xsd: <a href="http://dubbo.apache.org/schema/dubbo/dubbo.xsd">http://dubbo.apache.org/schema/dubbo/dubbo.xsd</a></p> |
| <ul> |
| <li>&lt;dubbo:method/&gt; As a child of &lt;dubbo:reference/&gt;, it can be configured for methods. The more commonly used attributes are:</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>Property Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>executes</td> |
| <td>request ceiling for service execution</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>Timeout retries</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>call timeout</td> |
| </tr> |
| <tr> |
| <td>Loadbalance</td> |
| <td>Load balancing policy, optional values: random, roundrobin, leastactive, respectively: random, polling, least active call</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>Whether to execute asynchronously, unreliable asynchronous, just ignore return value, do not block execution thread</td> |
| </tr> |
| <tr> |
| <td>Actives</td> |
| <td>Maximum concurrent call limit per service consumer</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>For other properties, you can refer to xsd above.</p> |
| <h6 id="configured-coverage-relationship">Configured coverage relationship</h6> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-config-override.jpg" alt="undefined"></p> |
| <p>Coverage diagram for configuration</p> |
| <p>It contains the configuration of the consumer side and the provider, pay attention to the distinction.</p> |
| <h4 id="annotation">annotation</h4> |
| <h6 id="reference-annotation-remote-service">Reference Annotation Remote Service</h6> |
| <div class="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> |
| </span></span><span style="display:flex;"><span>Public class AnnotationConsumeService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> @com.alibaba.dubbo.config.annotation.Reference |
| </span></span><span style="display:flex;"><span> Public AnnotateService annotateService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> // ... |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The configuration in this way is the same as the previous configuration in xml.</p> |
| <blockquote> |
| <p>To specify the way dubbo scans the path, refer to the implementation of the provider in the previous section.</p> |
| </blockquote> |
| <h4 id="api-direct-trigger">api direct trigger</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>Import com.alibaba.dubbo.rpc.config.ApplicationConfig; |
| </span></span><span style="display:flex;"><span>Import com.alibaba.dubbo.rpc.config.RegistryConfig; |
| </span></span><span style="display:flex;"><span>Import com.alibaba.dubbo.rpc.config.ConsumerConfig; |
| </span></span><span style="display:flex;"><span>Import com.alibaba.dubbo.rpc.config.ReferenceConfig; |
| </span></span><span style="display:flex;"><span>Import com.xxx.XxxService; |
| </span></span><span style="display:flex;"><span>// current application configuration |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ApplicationConfig application = new ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>application.setName(&#34;yyy&#34;); |
| </span></span><span style="display:flex;"><span>// Connect to the registry configuration |
| </span></span><span style="display:flex;"><span>RegistryConfig registry = new RegistryConfig(); |
| </span></span><span style="display:flex;"><span>registry.setAddress(&#34;10.20.130.230:9090&#34;); |
| </span></span><span style="display:flex;"><span>registry.setUsername(&#34;aaa&#34;); |
| </span></span><span style="display:flex;"><span>registry.setPassword(&#34;bbb&#34;); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>// Note: ReferenceConfig is a heavy object that internally encapsulates the connection to the registry and the connection to the service provider. |
| </span></span><span style="display:flex;"><span>// reference remote service |
| </span></span><span style="display:flex;"><span>ReferenceConfig&lt;XxxService&gt; reference = new ReferenceConfig&lt;XxxService&gt;(); // This instance is heavy, encapsulates the connection to the registry and the connection to the provider, please cache it yourself, otherwise it may cause memory and connection leaks. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>reference.setApplication(application); |
| </span></span><span style="display:flex;"><span>reference.setRegistry(registry); // Multiple registries can use setRegistries() |
| </span></span><span style="display:flex;"><span>reference.setInterface(XxxService.class); |
| </span></span><span style="display:flex;"><span>reference.setVersion(&#34;1.0.0&#34;); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>// Use xxxService like local beans |
| </span></span><span style="display:flex;"><span>XxxService xxxService = reference.get(); |
| </span></span></code></pre></div><h6 id="methodspecial-settings">methodSpecial settings</h6> |
| <div class="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> |
| </span></span><span style="display:flex;"><span>// Method level configuration |
| </span></span><span style="display:flex;"><span>List&lt;MethodConfig&gt; methods = new ArrayList&lt;MethodConfig&gt;(); |
| </span></span><span style="display:flex;"><span>MethodConfig method = new MethodConfig(); |
| </span></span><span style="display:flex;"><span>method.setName(&#34;createXxx&#34;); |
| </span></span><span style="display:flex;"><span>method.setTimeout(10000); |
| </span></span><span style="display:flex;"><span>method.setRetries(0); |
| </span></span><span style="display:flex;"><span>Methods.add(method); |
| </span></span><span style="display:flex;"><span>// reference remote service |
| </span></span><span style="display:flex;"><span>ReferenceConfig&lt;XxxService&gt; reference = new ReferenceConfig&lt;XxxService&gt;(); // This instance is heavy, encapsulates the connection to the registry and the connection to the provider, please cache it yourself, otherwise it may cause memory and connection leaks. |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span>reference.setMethods(methods); // Set method level configuration |
| </span></span></code></pre></div><h3 id="consumer-calling-remote-service">Consumer Calling Remote Service</h3> |
| <p>The above chapters are more from a configuration point of view, and then through a complete example, explain the complete use of dubbo consumer.</p> |
| <p>There is only one service UserReadService in this example, there is a method getUserById. Need to call a remote service through Dubbo. The specific steps are as follows:</p> |
| <ol> |
| <li>Create a project |
| If there is already a project, you can ignore it. Create a spring boot project that can be created at <a href="https://start.spring.io/">https://start.spring.io/</a>. |
| The provider of the service has been defined in the provider section.</li> |
| <li>Call the service</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>@RestController |
| </span></span><span style="display:flex;"><span>Public class UserTestController{ |
| </span></span><span style="display:flex;"><span> @Autowired |
| </span></span><span style="display:flex;"><span> Private UserReadService userReadService; |
| </span></span><span style="display:flex;"><span> @RequestMapping(&#34;/user/getById&#34;) |
| </span></span><span style="display:flex;"><span> Public String getUserById(Long id){ |
| </span></span><span style="display:flex;"><span> // just test |
| </span></span><span style="display:flex;"><span> Return userReadService.getUserById(id).toString(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>3.Dubbo configuration</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt; |
| </span></span><span style="display:flex;"><span>&lt;beans xmlns=&#34;http://www.springframework.org/schema/beans&#34; |
| </span></span><span style="display:flex;"><span> Xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; |
| </span></span><span style="display:flex;"><span> Xmlns:dubbo=&#34;http://dubbo.apache.org/schema/dubbo&#34; |
| </span></span><span style="display:flex;"><span> Xsi:schemaLocation=&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema /dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:application name=&#34;hello-world-app&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:registry address=&#34;multicast://224.5.6.7:1234&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:protocol name=&#34;dubbo&#34; port=&#34;20880&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:reference id=&#34;userReadService&#34; interface=&#34;com.package.UserReadService&#34;check=&#34;false&#34; /&gt; |
| </span></span><span style="display:flex;"><span>&lt;/beans&gt; |
| </span></span></code></pre></div><p>Other ways of configuring Dubbo can refer to the relevant configuration in the previous section, or use the integrated dubbo spring boot starter mode.</p></description></item><item><title>Blog: Dubbo: Several ways about synchronous/asynchronous invoke</title><link>https://dubbo.apache.org/en/blog/2018/08/14/dubbo-several-ways-about-synchronous/asynchronous-invoke/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/dubbo-several-ways-about-synchronous/asynchronous-invoke/</guid><description> |
| <p>As we all know，Dubbo adopts a single large join protocol by default and takes the NIO asynchronous communication mechanism of Netty as the low-level implementation. Based on this mechanism, Dubbo implements several invocation modes as follows:</p> |
| <ul> |
| <li>synchronous invoke</li> |
| <li>asynchronous invoke</li> |
| <li>parameters callback</li> |
| <li>event notification</li> |
| </ul> |
| <h3 id="synchronous-invoke">Synchronous invoke</h3> |
| <p>Synchronous invoke is a kind of blocking invocation mode, that is the Consumer keeps blocking and waiting, until the Provider returns.</p> |
| <p>Generally, a typical synchronous invocation process is as follows:</p> |
| <ol> |
| <li>Consumer service thread invokes the remote API and sends requests to the Provider. Meanwhile, the current service thread stays in blocking state;</li> |
| <li>Provider process relative request after receiving it from Consumer. Then returns the results to Consumer;</li> |
| <li>After Consumer receiving results, the current thread continues to execute.</li> |
| </ol> |
| <p>Here are two problems:</p> |
| <ol> |
| <li>How does Consumer service thread turn into <code>blocking</code> state?</li> |
| <li>How does the service thread be awaked to execute after Consumer receiving results?</li> |
| </ol> |
| <p>In fact, the low-level I/O operations of Dubbo are all asynchronous. The Consumer gets a Future object after invoking the Provider. For synchronous invoke, the service thread takes advantage of <code>Future#get(timeout)</code> to block and wait for Provider returning results, with the &rsquo;timeout&rsquo; indicating the timeout defined by Consumer. When the result returns, the Future will be set and the blocked service thread will be awaked. The service thread will return an exception if there is no result after timeout.</p> |
| <h3 id="asynchronous-invoke">Asynchronous invoke</h3> |
| <p>For scenarios that Provider has a long response time, it&rsquo;s necessary to implement asynchronous invoke based on Dubbo&rsquo;s underlying asynchronous NIO. It could utilize the resource of Consumer effectively, and costs less than using multi-thread for Consumer.</p> |
| <p>Asynchronous invoke does not need specific configuration for Provider. In the example，the API of Provider is defined as follow：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">AsyncService</span> { |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">goodbye</span>(String name); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h5 id="consumer-configuration">Consumer configuration</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;asyncService&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.async.api.AsyncService&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;goodbye&#34;</span> async=<span style="color:#2aa198">&#34;true&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><p>Notice that if we need an asynchronous revoke method, we must use <code>&lt;dubbo:method/&gt;</code> label to describe it.</p> |
| <h5 id="consumer-triggers-invocation">Consumer triggers invocation</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>AsyncService service <span style="color:#719e07">=</span> ...; |
| </span></span><span style="display:flex;"><span>String result <span style="color:#719e07">=</span> service.goodbye(<span style="color:#2aa198">&#34;samples&#34;</span>);<span style="color:#586e75">// returns NULL and DO NOT use!</span> |
| </span></span><span style="display:flex;"><span>Future<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> future <span style="color:#719e07">=</span> RpcContext.getContext().getFuture(); |
| </span></span><span style="display:flex;"><span>... <span style="color:#586e75">// other service thread logic</span> |
| </span></span><span style="display:flex;"><span>result <span style="color:#719e07">=</span> future.get(); <span style="color:#586e75">// could use get(timeout, unit) to configure timeout, when it needs to get the asynchronous result</span> |
| </span></span></code></pre></div><p>After Dubbo Consumer triggers invocation, it uses <code>RpcContext.getContext().getFuture()</code> to get the relative <code>Future</code> object, and then it could start executing other tasks. Anytime when we need results, <code>future.get(timeout)</code> is supposed to be called.</p> |
| <p>Under several special conditions, it could be set whether to wait for sending the request, to accelerate the return of invocation:</p> |
| <ul> |
| <li><code>sent=&quot;true&quot;</code> Waiting for sending the request, and return an exception if it fails;</li> |
| <li><code>sent=&quot;false&quot;</code> Do not wait for the request, and returns immediately after putting the request to the I/O queue.</li> |
| </ul> |
| <p>We set it to <code>false</code> by default. And detailed configuration is as follows：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;goodbye&#34;</span> async=<span style="color:#2aa198">&#34;true&#34;</span> sent=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>If you only want to be asynchronous, then omit the result thoroughly, <code>return=&quot;false&quot;</code> could be set to reduce the creation and management cost of Future:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;goodbye&#34;</span> async=<span style="color:#2aa198">&#34;true&#34;</span> return=<span style="color:#2aa198">&#34;false&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>At this time，<code>RpcContext.getContext().getFuture()</code> will return <code>null</code>。</p> |
| <p>The complete sequence diagram of asynchronous invoke is as follow:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-async.svg" alt="Asynchronous invoke"></p> |
| <p>The sample locates at：https://github.com/dubbo/dubbo-samples/tree/master/dubbo-samples-async</p> |
| <h3 id="parameters-callback">Parameters callback</h3> |
| <p>The parameter Callback is somewhat similar to the local Callback mechanism, but Callback is not an inner class or interface of Dubbo. Instead, it is defined by the Provider. Dubbo will generate a reverse proxy based on the long connection, so as to implement the logic of calling the Consumer from the Provider.</p> |
| <h5 id="service-and-callback-definition-of-provider">Service and Callback definition of Provider</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">CallbackService</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">addListener</span>(String key, CallbackListener listener); |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">CallbackListener</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">changed</span>(String msg); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h5 id="service-implementation-of-provider">Service implementation of Provider</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">CallbackServiceImpl</span> <span style="color:#268bd2">implements</span> CallbackService { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>String, CallbackListener<span style="color:#719e07">&gt;</span> listeners <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;</span>String, CallbackListener<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">CallbackServiceImpl</span>() { |
| </span></span><span style="display:flex;"><span> Thread t <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Thread(<span style="color:#719e07">new</span> Runnable() { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">run</span>() { |
| </span></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> <span style="color:#719e07">for</span> (Map.Entry<span style="color:#719e07">&lt;</span>String, CallbackListener<span style="color:#719e07">&gt;</span> entry : listeners.entrySet()) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> entry.getValue().changed(getChanged(entry.getKey())); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable t) { |
| </span></span><span style="display:flex;"><span> listeners.remove(entry.getKey()); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> Thread.sleep(5000); <span style="color:#586e75">// timely trigger change event</span> |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span> (Throwable t) { |
| </span></span><span style="display:flex;"><span> t.printStackTrace(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }); |
| </span></span><span style="display:flex;"><span> t.setDaemon(<span style="color:#cb4b16">true</span>); |
| </span></span><span style="display:flex;"><span> t.start(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">addListener</span>(String key, CallbackListener listener) { |
| </span></span><span style="display:flex;"><span> listeners.put(key, listener); |
| </span></span><span style="display:flex;"><span> listener.changed(getChanged(key)); <span style="color:#586e75">// send notification for change</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">private</span> String <span style="color:#268bd2">getChanged</span>(String key) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Changed: &#34;</span> <span style="color:#719e07">+</span> <span style="color:#719e07">new</span> SimpleDateFormat(<span style="color:#2aa198">&#34;yyyy-MM-dd HH:mm:ss&#34;</span>).format(<span style="color:#719e07">new</span> Date()); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h5 id="service-exposure-of-provider">Service exposure of Provider</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;callbackService&#34;</span> class=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.callback.impl.CallbackServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.callback.api.CallbackService&#34;</span> ref=<span style="color:#2aa198">&#34;callbackService&#34;</span> connections=<span style="color:#2aa198">&#34;1&#34;</span> callbacks=<span style="color:#2aa198">&#34;1000&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;addListener&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:argument</span> index=<span style="color:#2aa198">&#34;1&#34;</span> callback=<span style="color:#2aa198">&#34;true&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!--&lt;dubbo:argument type=&#34;com.demo.CallbackListener&#34; callback=&#34;true&#34; /&gt;--&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dubbo:method&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:service&gt;</span> |
| </span></span></code></pre></div><p>Here，Provider needs to declare which parameter is the Callback parameter in the method.</p> |
| <h5 id="callback-interface-implementation-of-consumer">Callback interface implementation of Consumer</h5> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>CallbackService callbackService <span style="color:#719e07">=</span> ...; |
| </span></span><span style="display:flex;"><span>callbackService.addListener(<span style="color:#2aa198">&#34;foo.bar&#34;</span>, <span style="color:#719e07">new</span> CallbackListener() { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">changed</span>(String msg) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;callback1:&#34;</span> <span style="color:#719e07">+</span> msg); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>}); |
| </span></span></code></pre></div><p>The implementation class of the Callback interface is on the Consumer, which automatically exports a Callback service when the method is called. Thus during Provider processing the call, if the parameter is determined as Callback, it will generate a proxy. Therefore, when the service implementation class calling the Callback method, it will be passed to the Consumer to execute the code.</p> |
| <p>The sample code above is located at：https://github.com/dubbo/dubbo-samples/tree/master/dubbo-samples-callback</p> |
| <p>This invocation mode is somewhat like message publishing and subscribing, but there is a little difference. For example, when the Consumer completes the export of Callback service, if it restarts later, then the Provider will fail to adjust. Meanwhile it is also a problem for the Provider to clean up the proxy.</p> |
| <h3 id="event-notification">Event notification</h3> |
| <p>Event notification allows the Consumer triggering three events，particularly <code>oninvoke</code>, <code>onreturn</code>, <code>onthrow</code> before calling, after calling or occurring exceptions.</p> |
| <p>You can specify which events need to be notified during configuring Consumer, such as:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoCallback&#34;</span> class=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.notify.impl.NotifyImpl&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> check=<span style="color:#2aa198">&#34;false&#34;</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.notify.api.DemoService&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span> group=<span style="color:#2aa198">&#34;cn&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:method</span> name=<span style="color:#2aa198">&#34;sayHello&#34;</span> onreturn=<span style="color:#2aa198">&#34;demoCallback.onreturn&#34;</span> onthrow=<span style="color:#2aa198">&#34;demoCallback.onthrow&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:reference&gt;</span> |
| </span></span></code></pre></div><p>Among them，the code of NotifyImpl is as follow：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">NotifyImpl</span> <span style="color:#268bd2">implements</span> Notify{ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Map<span style="color:#719e07">&lt;</span>Integer, String<span style="color:#719e07">&gt;</span> ret <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>Integer, String<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onreturn</span>(String name, <span style="color:#dc322f">int</span> id) { |
| </span></span><span style="display:flex;"><span> ret.put(id, name); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;onreturn: &#34;</span> <span style="color:#719e07">+</span> name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">onthrow</span>(Throwable ex, String name, <span style="color:#dc322f">int</span> id) { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;onthrow: &#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>Here we address that the parameter rules of three methods in the custom Notify interface are as follows:</p> |
| <ul> |
| <li><code>oninvoke</code> method&rsquo;s parameters are the same as the calling method parameters;</li> |
| <li><code>onreturn</code> method&rsquo;s first parameter is the returned value of calling method，and the others are the same as the calling method;</li> |
| <li><code>onthrow</code> method&rsquo;s first parameter is an invoked exception，and the others are the same as the calling method.</li> |
| </ul> |
| <p>In the above configuration, <code>sayHello</code> method is an asynchronous invocation, so the execution of event notification method is also synchronous. You can configure the <code>async = true</code> to make method invocation asynchronous, at this moment, event notification method is executed asynchronously. Especially emphasize that <code>oninvoke</code> method is executed synchronously, whether is an asynchronous call or not.</p> |
| <p>Please refer to the sample code for event notification：https://github.com/dubbo/dubbo-samples/tree/master/dubbo-samples-notify</p></description></item><item><title>Blog: Dubbo Basic Usage -- Dubbo Provider Configuration</title><link>https://dubbo.apache.org/en/blog/2018/08/14/dubbo-basic-usage--dubbo-provider-configuration/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/dubbo-basic-usage--dubbo-provider-configuration/</guid><description> |
| <p>This chapter mainly talking about how to configure dubbo. According to the configuration mode, it can be divided into the following mode: XML Configuration, Properties Configuration, Annotation Configuration, API Invocation Mode Configuration. And according to the function, we can divide them into Dubbo Provider and Dubbo Consumer. In the following sections, we would explain Dubbo Provider and Dubbo Consumer respectively.</p> |
| <h2 id="dubbo-provider-configuration">Dubbo Provider Configuration</h2> |
| <h3 id="provider-configuration-in-detail">Provider Configuration in Detail</h3> |
| <p>The configuration mode of Dubbo Provider has 4 different ways: XML Configuration, Properties Configuration, API Invocation Mode Configuration and Annotation Configuration.</p> |
| <h4 id="xml-configuration">XML Configuration</h4> |
| <h6 id="the-simplest-configuration-example">The simplest configuration example：</h6> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt; |
| </span></span><span style="display:flex;"><span>&lt;beans xmlns=&#34;http://www.springframework.org/schema/beans&#34; |
| </span></span><span style="display:flex;"><span> xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=&#34;http://dubbo.apache.org/schema/dubbo&#34; |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:application name=&#34;hello-world-app&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:registry address=&#34;multicast://224.5.6.7:1234&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:protocol name=&#34;dubbo&#34; port=&#34;20880&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:service interface=&#34;com.alibaba.dubbo.demo.DemoService&#34; ref=&#34;demoServiceLocal&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:reference id=&#34;demoServiceRemote&#34; interface=&#34;com.alibaba.dubbo.demo.DemoService&#34; /&gt; |
| </span></span><span style="display:flex;"><span>&lt;/beans&gt; |
| </span></span></code></pre></div><p>In the example above，note the way to write dubbo schema：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&lt;beans xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=&#34;http://code.alibabatech.com/schema/dubbo&#34; |
| </span></span><span style="display:flex;"><span> xmlns=&#34;http://www.springframework.org/schema/beans&#34; |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd |
| </span></span><span style="display:flex;"><span> http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd&#34;&gt; |
| </span></span></code></pre></div><h6 id="supported-configuration-tags">Supported Configuration Tags</h6> |
| <table> |
| <thead> |
| <tr> |
| <th>Tags</th> |
| <th>Application</th> |
| <th style="text-align:left">Describe</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>&lt;dubbo:service/&gt;</td> |
| <td>Service Configuration</td> |
| <td style="text-align:left">Expose a service, define the meta information of the service. One service can use multiple protocols to expose and can be registered to multiple registry centers</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:reference/&gt;</td> |
| <td>Reference Configuration</td> |
| <td style="text-align:left">Create a remote service agent, one reference can point to multiple registry centers</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:protocol/&gt;</td> |
| <td>Protocol Configuration</td> |
| <td style="text-align:left">Configure protocol information for providing services, protocol is specified by the provider and accepted passively by the consumer</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:application/&gt;</td> |
| <td>Application Configuration</td> |
| <td style="text-align:left">Configure current application information, regardless of whether the application is provider or consumer</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:module/&gt;</td> |
| <td>Module Configuration</td> |
| <td style="text-align:left">Configure current module information. Optional</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:registry/&gt;</td> |
| <td>Registry Center Configuration</td> |
| <td style="text-align:left">Configure information related to connect registry centers</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:monitor/&gt;</td> |
| <td>Monitoring Center Configuration</td> |
| <td style="text-align:left">Configure information related to connect monitor centers. Optional</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:provider/&gt;</td> |
| <td>Provider Configuration</td> |
| <td style="text-align:left">When some properties ProtocolConfig or ServiceConfig are not configured, use this default value. Optional</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:consumer/&gt;</td> |
| <td>Consumer Configuration</td> |
| <td style="text-align:left">When some properties of ReferenceConfig are not configured, use this default value. Optional</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:method/&gt;</td> |
| <td>Method Configuration</td> |
| <td style="text-align:left">Configure specific method level information of ServiceConfig and ReferenceConfig</td> |
| </tr> |
| <tr> |
| <td>&lt;dubbo:argument/&gt;</td> |
| <td>Parameter Configuration</td> |
| <td style="text-align:left">Configure parameters of specific method</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-config.jpg" alt="undefined"></p> |
| <p>Configuration Diagram</p> |
| <h6 id="configuration-item-in-detail">Configuration item in detail</h6> |
| <ul> |
| <li> |
| <p>&lt;dubbo:application name=&ldquo;hello-world-app&rdquo; /&gt;<br> |
| Apply to specific application name, note that you need to make sure that the application name is unique. The application name can be displayed in the following console admin for easy management.</p> |
| </li> |
| <li> |
| <p>&lt;dubbo:registry address=&ldquo;multicast://224.5.6.7:1234&rdquo; /&gt;<br> |
| Configure registry center, related to the specific mechanism of service discovery. It can be zookeeper address or eureka address. The address above is the broadcast address, which is very convenient in the test process of the local service invocation.</p> |
| </li> |
| <li> |
| <p>&lt;dubbo:protocol name=&ldquo;dubbo&rdquo; port=&ldquo;20880&rdquo; /&gt;<br> |
| Here is the transport protocol and the default port, generally no changes are required.</p> |
| </li> |
| </ul> |
| <blockquote> |
| <p>Next, we will focus on the configuration of &lt;dubbo:service/&gt;</p> |
| </blockquote> |
| <ul> |
| <li>&lt;dubbo:service/&gt;mainly supports the following properties：</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>Properties Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>version</td> |
| <td>Version number</td> |
| </tr> |
| <tr> |
| <td>scope</td> |
| <td>Service visibility, value can be local or remote，remote by default</td> |
| </tr> |
| <tr> |
| <td>actives</td> |
| <td>Maximum number of activated requests</td> |
| </tr> |
| <tr> |
| <td>async</td> |
| <td>Whether the method called asynchronously，false by default</td> |
| </tr> |
| <tr> |
| <td>cache</td> |
| <td>Service cache，optional value：lru/threadlocal/jcache</td> |
| </tr> |
| <tr> |
| <td>callbacks</td> |
| <td>Limitation of callback instance</td> |
| </tr> |
| <tr> |
| <td>generic</td> |
| <td>Generalized calls which can be bypassed</td> |
| </tr> |
| <tr> |
| <td>class</td> |
| <td>The implementation of the service&rsquo;s class name</td> |
| </tr> |
| <tr> |
| <td>connections</td> |
| <td>The number of connections in the service</td> |
| </tr> |
| <tr> |
| <td>delay</td> |
| <td>The number of milliseconds delay for publicating the service</td> |
| </tr> |
| <tr> |
| <td>executes</td> |
| <td>Upper bound of service execution requests</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>Timeout retry times</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>Invocation timeout time</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>For other configuration properties, please refer to xsd：http://dubbo.apache.org/schema/dubbo/dubbo.xsd</p> |
| <ul> |
| <li>&lt;dubbo:method/&gt; as the sub-element of &lt;dubbo:service/&gt; can be configured corresponding to method. Properties that are commonly used are：</li> |
| </ul> |
| <table> |
| <thead> |
| <tr> |
| <th>Properties Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>executes</td> |
| <td>Upper bound of service execution requests</td> |
| </tr> |
| <tr> |
| <td>retries</td> |
| <td>Timeout retry times</td> |
| </tr> |
| <tr> |
| <td>timeout</td> |
| <td>Invocation timeout time</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>For other properties，you can refer to xsd above。</p> |
| <h6 id="configuration-override-relationship">Configuration Override Relationship</h6> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-config-override.jpg" alt="undefined"></p> |
| <p>Configuration Coverage Relationship Diagram</p> |
| <p>The Override relationship here includes the configuration of both provider end and consumer end. If you have any questions about consumer, you can refer to the next chapter, consumer chapter, to understand.</p> |
| <h4 id="dubboproperties-configuration">dubbo.properties Configuration</h4> |
| <blockquote> |
| <p>If the public configuration is very simple, no multiple registry centers, no multiple protocols, etc., or if you want multiple Spring containers to share the configuration, you can use dubbo.properties as the default configurations.</p> |
| </blockquote> |
| <p>Dubbo would load dubbo.properties under the classpath root directory automaticaly，you can change the default configuration location by JVM startup parameter -Ddubbo.properties.file=xxx.properties.</p> |
| <h6 id="dubboproperties-configuration-example">dubbo.properties Configuration example</h6> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span># application name |
| </span></span><span style="display:flex;"><span>dubbo.application.name=dubbodemo-provider |
| </span></span><span style="display:flex;"><span># registry center address |
| </span></span><span style="display:flex;"><span>dubbo.registry.address=zookeeper://localhost:2181 |
| </span></span><span style="display:flex;"><span># Example of broadcasting registry center |
| </span></span><span style="display:flex;"><span>#dubbo.registry.address=multicast://224.5.6.7:1234 |
| </span></span><span style="display:flex;"><span># address for calling protocol |
| </span></span><span style="display:flex;"><span>dubbo.protocol.name=dubbo |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port=28080 |
| </span></span></code></pre></div><h6 id="mapping-rule">Mapping Rule</h6> |
| <p>Split the tag name and properties in XML configuration with dots, and multiple properties should be split into multiple lines</p> |
| <ul> |
| <li>For example: dubbo.application.name=foo equivalents to &lt;dubbo:application name=&ldquo;foo&rdquo; /&gt;</li> |
| <li>For example: dubbo.registry.address=10.20.153.10:9090 equivalents to &lt;dubbo:registry address=&ldquo;10.20.153.10:9090&rdquo; /&gt;</li> |
| </ul> |
| <p>If there are multiple configurations having the same tag name, they can be distinguished by id, and if there is no id, the configurations will be applied to all tags with the same name.</p> |
| <ul> |
| <li>For example: dubbo.protocol.rmi.port=1234 equivalents to &lt;dubbo:protocol id=&ldquo;rmi&rdquo; name=&ldquo;rmi&rdquo; port=&ldquo;1234&rdquo; /&gt;</li> |
| <li>For example: dubbo.registry.china.address=10.20.153.10:9090 equivalents to &lt;dubbo:registry id=&ldquo;china&rdquo; address=&ldquo;10.20.153.10:9090&rdquo; /&gt;</li> |
| </ul> |
| <h6 id="coverage-strategy">Coverage Strategy</h6> |
| <p><img src="https://dubbo.apache.org/imgs/user/dubbo-config.jpg" alt="undefined"></p> |
| <ul> |
| <li>When JVM starts, -D parameter has priority, so that users can rewrite the parameters when deploy and start, for example, the protocol port should be changed when start.</li> |
| <li>Then comes to XML, the configurations in dubbo.properties are invalid, if they are configured in XML.</li> |
| <li>Properties are the last, which can be considered as default value. Only when there is no configuration in XML, the corresponding configuarations in dubbo.properties will become effective, which usually applies to shared public configuration, like application name.</li> |
| </ul> |
| <blockquote> |
| <p>Note:</p> |
| </blockquote> |
| <ol> |
| <li>If there are multiple dubbo.properties in the classpath root directory, for example, if dubbo.properties exist in multiple JAR files, Dubbo will load anyone arbitrarily and print the Error logs, which may change to throwing exceptions later.↩</li> |
| <li>When the protocol&rsquo;s id is not configured, protocol name will be used as id as default.</li> |
| </ol> |
| <h4 id="annotation">Annotation</h4> |
| <h6 id="service-annotation-exposure-service">Service Annotation Exposure Service</h6> |
| <div class="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>import com.alibaba.dubbo.config.annotation.Service; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>@Service(timeout = 5000) |
| </span></span><span style="display:flex;"><span>public class AnnotateServiceImpl implements AnnotateService { |
| </span></span><span style="display:flex;"><span> // ... |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h6 id="javaconfig-configuration-public-module">Javaconfig Configuration Public Module</h6> |
| <div class="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>@Configuration |
| </span></span><span style="display:flex;"><span>public class DubboConfiguration { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> @Bean |
| </span></span><span style="display:flex;"><span> public ApplicationConfig applicationConfig() { |
| </span></span><span style="display:flex;"><span> ApplicationConfig applicationConfig = new ApplicationConfig(); |
| </span></span><span style="display:flex;"><span> applicationConfig.setName(&#34;provider-test&#34;); |
| </span></span><span style="display:flex;"><span> return applicationConfig; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> @Bean |
| </span></span><span style="display:flex;"><span> public RegistryConfig registryConfig() { |
| </span></span><span style="display:flex;"><span> RegistryConfig registryConfig = new RegistryConfig(); |
| </span></span><span style="display:flex;"><span> registryConfig.setAddress(&#34;zookeeper://127.0.0.1:2181&#34;); |
| </span></span><span style="display:flex;"><span> registryConfig.setClient(&#34;curator&#34;); |
| </span></span><span style="display:flex;"><span> return registryConfig; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The result of configuration using this method is the same as that of using xml.</p> |
| <h6 id="specify-the-dubbo-scan-path">Specify the Dubbo Scan Path</h6> |
| <div class="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>@SpringBootApplication |
| </span></span><span style="display:flex;"><span>@DubboComponentScan(basePackages = &#34;com.alibaba.dubbo.test.service.impl&#34;) |
| </span></span><span style="display:flex;"><span>public class ProviderTestApp { |
| </span></span><span style="display:flex;"><span> // ... |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>or use the spring bean xml configuration:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&lt;dubbo:annotation package=&#34;com.chanshuyi.service.impl&#34; /&gt; |
| </span></span></code></pre></div><h4 id="api-trigger-directly">API Trigger Directly</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span>import com<span style="color:#719e07">.</span>alibaba<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>rpc<span style="color:#719e07">.</span>config<span style="color:#719e07">.</span>ApplicationConfig; |
| </span></span><span style="display:flex;"><span>import com<span style="color:#719e07">.</span>alibaba<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>rpc<span style="color:#719e07">.</span>config<span style="color:#719e07">.</span>RegistryConfig; |
| </span></span><span style="display:flex;"><span>import com<span style="color:#719e07">.</span>alibaba<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>rpc<span style="color:#719e07">.</span>config<span style="color:#719e07">.</span>ProviderConfig; |
| </span></span><span style="display:flex;"><span>import com<span style="color:#719e07">.</span>alibaba<span style="color:#719e07">.</span>dubbo<span style="color:#719e07">.</span>rpc<span style="color:#719e07">.</span>config<span style="color:#719e07">.</span>ServiceConfig; |
| </span></span><span style="display:flex;"><span>import com<span style="color:#719e07">.</span>xxx<span style="color:#719e07">.</span>XxxService; |
| </span></span><span style="display:flex;"><span>import com<span style="color:#719e07">.</span>xxx<span style="color:#719e07">.</span>XxxServiceImpl; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">//</span> Service implementation |
| </span></span><span style="display:flex;"><span>XxxService xxxService <span style="color:#719e07">=</span> new XxxServiceImpl(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">//</span> current application configuration |
| </span></span><span style="display:flex;"><span>ApplicationConfig application <span style="color:#719e07">=</span> new ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>application<span style="color:#719e07">.</span>setName(<span style="color:#2aa198">&#34;xxx&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">//</span> connect to registry center configuration |
| </span></span><span style="display:flex;"><span>RegistryConfig registry <span style="color:#719e07">=</span> new RegistryConfig(); |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>setAddress(<span style="color:#2aa198">&#34;10.20.130.230:9090&#34;</span>); |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>setUsername(<span style="color:#2aa198">&#34;aaa&#34;</span>); |
| </span></span><span style="display:flex;"><span>registry<span style="color:#719e07">.</span>setPassword(<span style="color:#2aa198">&#34;bbb&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">//</span> service provider<span style="color:#2aa198">&#39;s protocol configuration</span> |
| </span></span><span style="display:flex;"><span>ProtocolConfig protocol <span style="color:#719e07">=</span> new ProtocolConfig(); |
| </span></span><span style="display:flex;"><span>protocol<span style="color:#719e07">.</span>setName(<span style="color:#2aa198">&#34;dubbo&#34;</span>); |
| </span></span><span style="display:flex;"><span>protocol<span style="color:#719e07">.</span>setPort(<span style="color:#2aa198">12345</span>); |
| </span></span><span style="display:flex;"><span>protocol<span style="color:#719e07">.</span>setThreads(<span style="color:#2aa198">200</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">//</span> Note: ServiceConfig is a heavy object, which encapsulated the connection with registry center internally, <span style="color:#719e07">and</span> open the service port |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">//</span> Service provider exposes service configuration |
| </span></span><span style="display:flex;"><span>ServiceConfig<span style="color:#719e07">&lt;</span>XxxService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> new ServiceConfig<span style="color:#719e07">&lt;</span>XxxService<span style="color:#719e07">&gt;</span>(); <span style="color:#719e07">//</span> This instance is very heavy, which encapsulated the connection with registry center, please cache it by yourself, it might cause memory <span style="color:#719e07">and</span> connection leakage otherwise<span style="color:#719e07">.</span> |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setApplication(application); |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setRegistry(registry); <span style="color:#719e07">//</span> multiple registry centers can use setRegistries() |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setProtocol(protocol); <span style="color:#719e07">//</span> multiple protocols can use setProtocols() |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setInterface(XxxService<span style="color:#719e07">.</span><span style="color:#719e07">class</span>); |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setRef(xxxService); |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span>setVersion(<span style="color:#2aa198">&#34;1.0.0&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">//</span> exposure <span style="color:#719e07">and</span> register service |
| </span></span><span style="display:flex;"><span>service<span style="color:#719e07">.</span><span style="color:#719e07">export</span>(); |
| </span></span></code></pre></div><p>Generally, this method is not recommended in spring applications. The reason can be checked by reading the source code on github, which would not be explained here.</p> |
| <h3 id="provider-interface-and-implement">Provider Interface and Implement</h3> |
| <p>The above chapters are described mainly from a configuration perspective, and lets explain the complete use of Dubbo provider by going through a complete example.</p> |
| <p>There is only one service UserReadService, and one method getUserById in this example. |
| This service need to be exposed to a remote service by Dubbo. Detail steps are shown below:</p> |
| <ol> |
| <li>Create Project |
| Skip this step if there is already a project. Create a Spring Boot project, which can be created through <a href="https://start.spring.io/">https://start.spring.io/</a>.</li> |
| <li>Define Interface |
| Define interface: UserReadService</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>public interface UserReadService{ |
| </span></span><span style="display:flex;"><span> public User getUserById(Long userId); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Generally, this interface should be placed in an independent JAR file as a client package. |
| Generally, the other services need to refer this client package if they want to consume this service(except for generalized call). |
| 3. Implement Interface |
| Implement UserReadService, and deploy current implementation in the Provider&rsquo;s application.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>public UserReadServiceImpl implements UserReadService{ |
| </span></span><span style="display:flex;"><span> public User getUserById(Long userId){ |
| </span></span><span style="display:flex;"><span> return xxx; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="4"> |
| <li>Dubbo Configuration</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>&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt; |
| </span></span><span style="display:flex;"><span>&lt;beans xmlns=&#34;http://www.springframework.org/schema/beans&#34; |
| </span></span><span style="display:flex;"><span> xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=&#34;http://dubbo.apache.org/schema/dubbo&#34; |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:application name=&#34;hello-world-app&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:registry address=&#34;multicast://224.5.6.7:1234&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:protocol name=&#34;dubbo&#34; port=&#34;20880&#34; /&gt; |
| </span></span><span style="display:flex;"><span> &lt;bean id=&#34;userReadService&#34; class=&#34;com.package.UserReadServiceImpl&#34;/&gt; |
| </span></span><span style="display:flex;"><span> &lt;dubbo:service interface=&#34;com.package.UserReadService&#34; ref=&#34;userReadService&#34; /&gt; |
| </span></span><span style="display:flex;"><span>&lt;/beans&gt; |
| </span></span></code></pre></div><p>For the other modes of Dubbo configuration, please refer to the related configurations in the previous chapter, or use the integrated Dubbo Spring Boot starter method.</p></description></item><item><title>Blog: Manipulating Services Dynamically via QoS</title><link>https://dubbo.apache.org/en/blog/2018/08/14/manipulating-services-dynamically-via-qos/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/manipulating-services-dynamically-via-qos/</guid><description> |
| <h1 id="manipulating-services-dynamically-via-qos">Manipulating Services Dynamically via QoS</h1> |
| <p>QoS (short form of <strong>Quality of Service</strong>), is a common terminology talking about network devices. For example, by adjusting and manipulating the weights of ports of a router dynamically via QoS, engineers could give priority to services running on these ports and make sure these services&rsquo; quality and reliability.</p> |
| <p>In Dubbo, QoS is used to query and manipulate services dynamically, like getting a list of active provider and consumer services, and launching or withdrawing services (i.e registering to or unregistering services from registration center).</p> |
| <h2 id="mechanism-of-qos">Mechanism of QoS</h2> |
| <p>From 2.5.8, QoS is introduced into Dubbo and is activated by default. All QoS&rsquo;s features are abstracted to commands, which could be executed to get responses from QoS.</p> |
| <blockquote> |
| <p>QoS is based on Netty4. In versions earlier than 2.6.x, Dubbo relies on Netty3, so you have to add Netty4 as a dependency explicitly to ensure that Netty4 works. If you generate a Dubbo application on <a href="http://start.dubbo.io">http://start.dubbo.io</a>, there&rsquo;s no need to add configurations because Netty4 is listed as a dependency by default.</p> |
| </blockquote> |
| <p><img src="https://dubbo.apache.org/imgs/blog/qos-architecture.png" alt="undefined"></p> |
| <p>The picture above shows how QoS works:</p> |
| <ol> |
| <li>Start and listen to a port (22222 by default).</li> |
| <li>Choose a corresponding request handler by detecting the protocol (telnet or http) a request comply with.</li> |
| <li>Decode and parse the request to generate corresponding command according to the protocol.</li> |
| <li>Execute commands and return with responses.</li> |
| </ol> |
| <h3 id="qos-commands">QoS Commands:</h3> |
| <p>Commands that QoS supports at the current moment include:</p> |
| <ul> |
| <li><code>help</code>, list available commands</li> |
| <li><code>ls</code>: list all active provider services and consumer services</li> |
| <li><code>online</code>: dynamically register a service or all services to registration center</li> |
| <li><code>offline</code>: dynamically remove (unregister) a services or all services from registration center</li> |
| <li><code>quit</code>: quit the current telnet session</li> |
| </ul> |
| <p>Now we are going to demonstrate how to manipulate services dynamically via QoS.</p> |
| <h4 id="access-qos-via-telnet">Access QoS via Telnet</h4> |
| <p>Assuming that our Dubbo server has started, connect to it via telnet:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ telnet localhost <span style="color:#2aa198">22222</span> |
| </span></span><span style="display:flex;"><span>Trying 127.0.0.1... |
| </span></span><span style="display:flex;"><span>Connected to localhost. |
| </span></span><span style="display:flex;"><span>Escape character is <span style="color:#2aa198">&#39;^]&#39;</span>. |
| </span></span><span style="display:flex;"><span> ????????? ??? ?? ??????????? ??????????? ???????? |
| </span></span><span style="display:flex;"><span> ??? ???? ??? ??? ??? ??? ??? ??? ??? ??? |
| </span></span><span style="display:flex;"><span> ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? |
| </span></span><span style="display:flex;"><span> ??? ??? ??? ??? ?????????? ?????????? ??? ??? |
| </span></span><span style="display:flex;"><span> ??? ??? ??? ??? ??????????? ??????????? ??? ??? |
| </span></span><span style="display:flex;"><span> ??? ??? ??? ??? ??? ??? ??? ??? ??? ??? |
| </span></span><span style="display:flex;"><span> ??? ???? ??? ??? ??? ??? ??? ??? ??? ??? |
| </span></span><span style="display:flex;"><span> ????????? ????????? ??????????? ??????????? ???????? |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; |
| </span></span></code></pre></div><p>A <code>dubbo&gt;</code> prompt would show up once you connect to server. Now input <code>help</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-sh" data-lang="sh"><span style="display:flex;"><span>dubbo&gt;help |
| </span></span><span style="display:flex;"><span>+---------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| <span style="color:#b58900">help</span> | <span style="color:#b58900">help</span> <span style="color:#b58900">command</span> | |
| </span></span><span style="display:flex;"><span>+---------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| ls | ls service | |
| </span></span><span style="display:flex;"><span>+---------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| offline | offline dubbo | |
| </span></span><span style="display:flex;"><span>+---------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| online | online dubbo | |
| </span></span><span style="display:flex;"><span>+---------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| quit | quit telnet console | |
| </span></span><span style="display:flex;"><span>+---------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; |
| </span></span></code></pre></div><p>This command lists all available commands with explanations.</p> |
| <p>You can also use <code>help</code> to a specific command to read examples of that command.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>dubbo&gt;help online |
| </span></span><span style="display:flex;"><span>+--------------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| COMMAND NAME | online | |
| </span></span><span style="display:flex;"><span>+--------------+----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| EXAMPLE | online dubbo | |
| </span></span><span style="display:flex;"><span>| | online xx.xx.xxx.service | |
| </span></span><span style="display:flex;"><span>+--------------+----------------------------------------------------------------------------------+ |
| </span></span></code></pre></div><p>Use <code>ls</code> to check services&rsquo; status:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>dubbo&gt;ls |
| </span></span><span style="display:flex;"><span>As Provider side: |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>| Provider Service Name |PUB| |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>|org.apache.dubbo.demo.provider.DemoService| Y | |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>As Consumer side: |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span>|Consumer Service Name|NUM| |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span></code></pre></div><p>There is a service named <code>org.apache.dubbo.demo.provider.DemoService</code> in the provider side. <code>PUB=Y</code> in the second columns means that the service has been published to the registration center, waiting to be called by the consumer side.</p> |
| <p>Assuming that we need to withdraw a service dynamically, we can use <code>offline</code> command:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo&gt;offline org.apache.dubbo.demo.provider.DemoService |
| </span></span><span style="display:flex;"><span>OK |
| </span></span></code></pre></div><p>You can see that the command responds with <code>OK</code>. Check the services&rsquo; status using <code>ls</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-sh" data-lang="sh"><span style="display:flex;"><span>dubbo&gt;ls |
| </span></span><span style="display:flex;"><span>As Provider side: |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>| Provider Service Name |PUB| |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>|org.apache.dubbo.demo.provider.DemoService| N | |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>As Consumer side: |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span>|Consumer Service Name|NUM| |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span></code></pre></div><p>You can see that <code>PUB</code> of <code>org.apache.dubbo.demo.provider.DemoService</code> has been set to <code>N</code>.</p> |
| <p>Quit the current telnet session using <code>quit</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-sh" data-lang="sh"><span style="display:flex;"><span>dubbo&gt;quit |
| </span></span><span style="display:flex;"><span>BYE! |
| </span></span><span style="display:flex;"><span>Connection closed by foreign host. |
| </span></span></code></pre></div><h4 id="access-qos-via-http">Access QoS via HTTP</h4> |
| <p>In the example above we performed an offline action to <code>org.apache.dubbo.demo.provider.DemoService</code>. Now we are going to demonstrate how to register the service above via HTTP.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>$ curl -i http://localhost:22222/online?service<span style="color:#719e07">=</span>org.apache.dubbo.demo.provider.DemoService |
| </span></span><span style="display:flex;"><span>HTTP/1.1 <span style="color:#2aa198">200</span> OK |
| </span></span><span style="display:flex;"><span>Content-Type: text/plain |
| </span></span><span style="display:flex;"><span>Content-Length: <span style="color:#2aa198">2</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>OK% |
| </span></span></code></pre></div><blockquote> |
| <p>Beware of the parameters of online action. They need to be provided in the form of <code>key=value</code>. However, <code>key</code> would be ignored actually.</p> |
| </blockquote> |
| <p>The action responds with <code>OK</code>. Now use <code>ls</code> to check providers&rsquo; status at the current moment.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>$ curl -i http://localhost:22222/ls |
| </span></span><span style="display:flex;"><span>HTTP/1.1 200 OK |
| </span></span><span style="display:flex;"><span>Content-Type: text/plain |
| </span></span><span style="display:flex;"><span>Content-Length: 365 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>As Provider side: |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>| Provider Service Name |PUB| |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>|org.apache.dubbo.demo.provider.DemoService| Y | |
| </span></span><span style="display:flex;"><span>+------------------------------------------+---+ |
| </span></span><span style="display:flex;"><span>As Consumer side: |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span>|Consumer Service Name|NUM| |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span></code></pre></div><p>You can see that the service&rsquo;s <code>PUB</code> status has been changed to <code>Y</code>.</p> |
| <h3 id="qos-parameters">QoS&rsquo; Parameters</h3> |
| <p>You can use parameters that QoS provides to config its startup. These parameters include:</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Parameter</th> |
| <th>Explanation</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>qosEnable</td> |
| <td>Activate QoS or not</td> |
| <td>true</td> |
| </tr> |
| <tr> |
| <td>qosPort</td> |
| <td>The port QoS would bind to</td> |
| <td>22222</td> |
| </tr> |
| <tr> |
| <td>qosAcceptForeignIp</td> |
| <td>Enable remote access or not</td> |
| <td>false</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <p>Attention. From 2.6.4/2.7.0, <code>qosAcceptForeignIp</code> is set to <code>false</code> by default, because it&rsquo;s risky if this property is set to <code>true</code>. Think twice before you turn it on.</p> |
| </blockquote> |
| <p>You can configure these parameters in the following ways:</p> |
| <ul> |
| <li>System property</li> |
| <li><code>dubbo.properties</code></li> |
| <li>XML</li> |
| <li>Spring-boot auto configuration</li> |
| </ul> |
| <p>They have priority in the following order: system property &gt; <code>dubbo.properties</code> &gt; XML &gt; spring-boot.</p> |
| <h4 id="system-property">System Property</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>-Ddubbo.application.qos.enable=true |
| </span></span><span style="display:flex;"><span>-Ddubbo.application.qos.port=33333 |
| </span></span><span style="display:flex;"><span>-Ddubbo.application.qos.accept.foreign.ip=false |
| </span></span></code></pre></div><h4 id="dubboproperties"><code>Dubbo.properties</code></h4> |
| <p>Create a <code>dubbo.properties</code> file in this directory <code>src/main/resources</code> in your project, and copy the following codes into it:</p> |
| <div class="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.application.qos.enable=true |
| </span></span><span style="display:flex;"><span>dubbo.application.qos.port=33333 |
| </span></span><span style="display:flex;"><span>dubbo.application.qos.accept.foreign.ip=false |
| </span></span></code></pre></div><h4 id="xml">XML</h4> |
| <p>If you are going to config using XML, you can try this:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#719e07">&lt;?xml version=&#34;1.0&#34; encoding=&#34;UTF-8&#34;?&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;beans</span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:dubbo=<span style="color:#2aa198">&#34;http://dubbo.apache.org/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://www.springframework.org/schema/beans/spring-beans.xsd |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span 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 style="color:#268bd2">&lt;dubbo:parameter</span> key=<span style="color:#2aa198">&#34;qos.enable&#34;</span> value=<span style="color:#2aa198">&#34;true&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:parameter</span> key=<span style="color:#2aa198">&#34;qos.accept.foreign.ip&#34;</span> value=<span style="color:#2aa198">&#34;false&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:parameter</span> key=<span style="color:#2aa198">&#34;qos.port&#34;</span> value=<span style="color:#2aa198">&#34;33333&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dubbo:application&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:registry</span> address=<span style="color:#2aa198">&#34;multicast://224.5.6.7:1234&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.provider.DemoService&#34;</span> ref=<span style="color:#2aa198">&#34;demoService&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoService&#34;</span> class=<span style="color:#2aa198">&#34;org.apache.dubbo.demo.provider.DemoServiceImpl&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><h4 id="spring-boot-auto-configuration"><code>spring-boot</code> auto configuration</h4> |
| <p>If you are developing a spring-boot application, you can configure in <code>application.properties</code> or <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-fallback" data-lang="fallback"><span style="display:flex;"><span>dubbo.application.qosEnable=true |
| </span></span><span style="display:flex;"><span>dubbo.application.qosPort=33333 |
| </span></span><span style="display:flex;"><span>dubbo.application.qosAcceptForeignIp=false |
| </span></span></code></pre></div></description></item><item><title>Blog: Source code analysis of spring-boot+Dubbo App start and stop</title><link>https://dubbo.apache.org/en/blog/2018/08/14/source-code-analysis-of-spring-boot-dubbo-app-start-and-stop/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/source-code-analysis-of-spring-boot-dubbo-app-start-and-stop/</guid><description> |
| <h2 id="introduction">Introduction</h2> |
| <p><a href="https://github.com/apache/dubbo-spring-boot-project">Dubbo Spring Boot</a> project is dedicated to simplifying the development of the Dubbo RPC framework in the Spring Boot application. It also integrates the feature of Spring Boot:</p> |
| <ul> |
| <li><a href="https://github.com/apache/dubbo-spring-boot-project/blob/master/dubbo-spring-boot-autoconfigure">Autoconfigure</a> (ex: Annotation driver, Autoconfigure, etc.)</li> |
| <li><a href="https://github.com/apache/dubbo-spring-boot-project/blob/master/dubbo-spring-boot-actuator">Production-Ready</a> (ex: Security, Healthy check, Externalize configuration, etc.)</li> |
| </ul> |
| <h2 id="the-analysis-of-dubboconsumer-startup">The analysis of DubboConsumer startup</h2> |
| <p>Have you ever thought about this : since the <code>DubboConsumerDemo</code> application in <code>dubbo-spring-boot-project</code> has only one line of code, why not just exit directly when the <code>main</code> method is executed?</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SpringBootApplication</span>(scanBasePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;com.alibaba.boot.dubbo.demo.consumer.controller&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DubboConsumerDemo</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(DubboConsumerDemo.class,args); |
| </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>In fact, to answer this question, we need to abstract it first, that is, under what circumstances will a JVM process exit?</p> |
| <p>Take Java 8 as an example. By referring to the JVM language specification[1], there is a clear description in Section 12.8:</p> |
| <blockquote> |
| <p>A program terminates all its activity and <em>exits</em> when one of two things happens:</p> |
| <ul> |
| <li>All the threads that are not daemon threads terminate.</li> |
| <li>Some thread invokes the <code>exit</code> method of class <code>Runtime</code> or class <code>System</code>, and the <code>exit</code> operation is not forbidden by the security manager.</li> |
| </ul> |
| </blockquote> |
| <p>Therefore, in view of the above situation, we judge that there must be some non-daemon thread not exiting. All thread information can be seen by <code>jstack</code>, including whether they are daemon threads, and <code>jstack</code> can be used to find out which threads are non-daemon.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>➜ jstack <span style="color:#2aa198">57785</span> | grep tid | grep -v <span style="color:#2aa198">&#34;daemon&#34;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;container-0&#34;</span> <span style="color:#586e75">#37 prio=5 os_prio=31 tid=0x00007fbe312f5800 nid=0x7103 waiting on condition [0x0000700010144000]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;container-1&#34;</span> <span style="color:#586e75">#49 prio=5 os_prio=31 tid=0x00007fbe3117f800 nid=0x7b03 waiting on condition [0x0000700010859000]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;DestroyJavaVM&#34;</span> <span style="color:#586e75">#83 prio=5 os_prio=31 tid=0x00007fbe30011000 nid=0x2703 waiting on condition [0x0000000000000000]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;VM Thread&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe3005e800 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x3703 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;GC Thread#0&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe30013800 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x5403 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;GC Thread#1&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe30021000 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x5303 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;GC Thread#2&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe30021800 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x2d03 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;GC Thread#3&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe30022000 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x2f03 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;G1 Main Marker&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe30040800 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x5203 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;G1 Conc#0&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe30041000 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x4f03 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;G1 Refine#0&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe31044800 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x4e03 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;G1 Refine#1&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe31045800 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x4d03 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;G1 Refine#2&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe31046000 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x4c03 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;G1 Refine#3&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe31047000 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x4b03 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;G1 Young RemSet Sampling&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe31047800 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x3603 runnable |
| </span></span><span style="display:flex;"><span><span style="color:#2aa198">&#34;VM Periodic Task Thread&#34;</span> <span style="color:#268bd2">os_prio</span><span style="color:#719e07">=</span><span style="color:#2aa198">31</span> <span style="color:#268bd2">tid</span><span style="color:#719e07">=</span>0x00007fbe31129000 <span style="color:#268bd2">nid</span><span style="color:#719e07">=</span>0x6703 waiting on condition |
| </span></span></code></pre></div><blockquote> |
| <p>We can find all the thread digests by <code>grep tid</code> here, and find the line that doesn&rsquo;t contain the daemon keyword by <code>grep -v</code> command.</p> |
| </blockquote> |
| <p>We can get some information from the above results:</p> |
| <ul> |
| <li>There are two &ldquo;suspicious&rdquo; threads : <code>container-0</code>, <code>container-1</code>. They are non-daemon thread in wait state.</li> |
| <li>There are alse some threads about GC, and threads that start with <code>VM</code>. They are also some non-daemon threads, but they are most likely the JVM&rsquo;s own threads, which we can ignore for now.</li> |
| </ul> |
| <p>In summary, we can infer that it is likely that the <code>container-0</code> and <code>container-1</code> cause the JVM to not exit. Now let&rsquo;s search through the source code to find out who created the two threads.</p> |
| <p>By the source code analysis of Spring-boot, we can find these code in the <code>startDaemonAwaitThread</code> method of <code>org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainer</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:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">startDaemonAwaitThread</span>() { |
| </span></span><span style="display:flex;"><span> Thread awaitThread <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Thread(<span style="color:#2aa198">&#34;container-&#34;</span> <span style="color:#719e07">+</span> (containerCounter.get())) { |
| </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>() { |
| </span></span><span style="display:flex;"><span> TomcatEmbeddedServletContainer.this.tomcat.getServer().await(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> }; |
| </span></span><span style="display:flex;"><span> awaitThread.setContextClassLoader(getClass().getClassLoader()); |
| </span></span><span style="display:flex;"><span> awaitThread.setDaemon(<span style="color:#cb4b16">false</span>); |
| </span></span><span style="display:flex;"><span> awaitThread.start(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>Let&rsquo;s add a breakpoint in this method, and focus on the call stack:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-plain" data-lang="plain"><span style="display:flex;"><span>initialize:115, TomcatEmbeddedServletContainer (org.springframework.boot.context.embedded.tomcat) |
| </span></span><span style="display:flex;"><span>&lt;init&gt;:84, TomcatEmbeddedServletContainer (org.springframework.boot.context.embedded.tomcat) |
| </span></span><span style="display:flex;"><span>getTomcatEmbeddedServletContainer:554, TomcatEmbeddedServletContainerFactory (org.springframework.boot.context.embedded.tomcat) |
| </span></span><span style="display:flex;"><span>getEmbeddedServletContainer:179, TomcatEmbeddedServletContainerFactory (org.springframework.boot.context.embedded.tomcat) |
| </span></span><span style="display:flex;"><span>createEmbeddedServletContainer:164, EmbeddedWebApplicationContext (org.springframework.boot.context.embedded) |
| </span></span><span style="display:flex;"><span>onRefresh:134, EmbeddedWebApplicationContext (org.springframework.boot.context.embedded) |
| </span></span><span style="display:flex;"><span>refresh:537, AbstractApplicationContext (org.springframework.context.support) |
| </span></span><span style="display:flex;"><span>refresh:122, EmbeddedWebApplicationContext (org.springframework.boot.context.embedded) |
| </span></span><span style="display:flex;"><span>refresh:693, SpringApplication (org.springframework.boot) |
| </span></span><span style="display:flex;"><span>refreshContext:360, SpringApplication (org.springframework.boot) |
| </span></span><span style="display:flex;"><span>run:303, SpringApplication (org.springframework.boot) |
| </span></span><span style="display:flex;"><span>run:1118, SpringApplication (org.springframework.boot) |
| </span></span><span style="display:flex;"><span>run:1107, SpringApplication (org.springframework.boot) |
| </span></span><span style="display:flex;"><span>main:35, DubboConsumerDemo (com.alibaba.boot.dubbo.demo.consumer.bootstrap) |
| </span></span></code></pre></div><p>It can be seen that during the startup process of the Spring-boot application, the above method is executed since the execution of Tomcat exposes the HTTP service by default. Also, all threads started by Tomcat are daemon threads by default, such as the Acceptor of the listening request, threads in working threads, etc. Thus the JVM will also exit after the startup is complete in there is no extra control here. Therefore, it is necessary to explicitly start a thread and continue to wait under certain conditions, thereby avoid thread exit.</p> |
| <p>Let&rsquo;s dig deeper to find out how the thread stay alive in Tomcat&rsquo;s <code>this.tomcat.getServer().await()</code> method.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">await</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span>( port<span style="color:#719e07">==-</span>1 ) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> awaitThread <span style="color:#719e07">=</span> Thread.currentThread(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">while</span>(<span style="color:#719e07">!</span>stopAwait) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep( 10000 ); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">catch</span>( InterruptedException ex ) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// continue and check the flag</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">finally</span> { |
| </span></span><span style="display:flex;"><span> awaitThread <span style="color:#719e07">=</span> <span style="color:#cb4b16">null</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>In the await method, the current thread checks the variable <code>stopAwait</code> every 10 seconds in a while loop. It is a <code>volatile</code> variable that is used to ensure that the current thread can see the change immediately after the variable being modified by another thread. If there is no change, it will stay in the loop. This is the reason why the thread does not exit, which is also the reason that the entire Spring-boot application doesn&rsquo;t exit.</p> |
| <p>Since Spring-boot application enables port 8080 and 8081(management port) at the same time, there are actually two Tomcats. So there are two threads named <code>container-0</code> and <code>container-1</code>.</p> |
| <p>Next, let&rsquo;s see how this Spring-boot application exits.</p> |
| <h2 id="the-analysis-of-dubboconsumer-exit">The analysis of DubboConsumer exit</h2> |
| <p>As mentioned in the previous description, there is a thread that checks the variable <code>stopAwait</code> continuously. So there must be a thread to modify <code>stopAwait</code> at Stop, thus break the while loop. But who is modifying this variable?</p> |
| <p>By analyzing the source code, we can see that there is only one method that modifies <code>stopAwait</code> : <code>org.apache.catalina.core.StandardServer#stopAwait</code>. To figure out who is calling this method, we add a breakpoint here.</p> |
| <blockquote> |
| <p>Note that after adding a breakpoint in Intellij IDEA&rsquo;s Debug mode, we also need to type <code>kill -s INT $PID</code> or <code>kill -s TERM $PID</code> in command line to trigger the breakpoint. Due to buggy IDEA, a single click to the stop button won&rsquo;t trigger the breakpoint.</p> |
| </blockquote> |
| <p>You can see the method is called by a thread called <code>Thread-3</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>stopAwait:390, StandardServer (org.apache.catalina.core) |
| </span></span><span style="display:flex;"><span>stopInternal:819, StandardServer (org.apache.catalina.core) |
| </span></span><span style="display:flex;"><span>stop:226, LifecycleBase (org.apache.catalina.util) |
| </span></span><span style="display:flex;"><span>stop:377, Tomcat (org.apache.catalina.startup) |
| </span></span><span style="display:flex;"><span>stopTomcat:241, TomcatEmbeddedServletContainer (org.springframework.boot.context.embedded.tomcat) |
| </span></span><span style="display:flex;"><span>stop:295, TomcatEmbeddedServletContainer (org.springframework.boot.context.embedded.tomcat) |
| </span></span><span style="display:flex;"><span>stopAndReleaseEmbeddedServletContainer:306, EmbeddedWebApplicationContext (org.springframework.boot.context.embedded) |
| </span></span><span style="display:flex;"><span>onClose:155, EmbeddedWebApplicationContext (org.springframework.boot.context.embedded) |
| </span></span><span style="display:flex;"><span>doClose:1014, AbstractApplicationContext (org.springframework.context.support) |
| </span></span><span style="display:flex;"><span>run:929, AbstractApplicationContext$2 (org.springframework.context.support) |
| </span></span></code></pre></div><p>Through source code analysis, it was executed by Spring&rsquo;s registered <code>ShutdownHook</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:#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">registerShutdownHook</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">this</span>.shutdownHook <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// No shutdown hook registered yet.</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span>.shutdownHook <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Thread() { |
| </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>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">synchronized</span> (startupShutdownMonitor) { |
| </span></span><span style="display:flex;"><span> doClose(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }; |
| </span></span><span style="display:flex;"><span> Runtime.getRuntime().addShutdownHook(<span style="color:#719e07">this</span>.shutdownHook); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>By reffering the Java API documentation[2], we found that ShutdownHook will be executed under the following two cases.</p> |
| <blockquote> |
| <p>The Java virtual machine <em>shuts down</em> in response to two kinds of events:</p> |
| <ul> |
| <li>The program <em>exits</em> normally, when the last non-daemon thread exits or when the <code>exit</code> (equivalently, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#exit-int-"><code>System.exit</code></a>) method is invoked, or</li> |
| <li>The virtual machine is <em>terminated</em> in response to a user interrupt, such as typing <code>^C</code>, or a system-wide event, such as user logoff or system shutdown.</li> |
| </ul> |
| </blockquote> |
| <ol> |
| <li>So it&rsquo;s either a call of <code>System.exit()</code></li> |
| <li>Respond to external signals, such as Ctrl+C(actually sent as SIGINT signal), or <code>SIGTERM</code> signal (<code>kill $PID</code> will send <code>SIGTERM</code> signal by default)</li> |
| </ol> |
| <p>Therefore, the normal application will execute the above ShutdownHook during the stop process (except <code>kill -9 $PID</code>). Its function is not only to close the Tomcat, but also to perform other cleanup work. It is unnecessary to go into details.</p> |
| <h2 id="summary">Summary</h2> |
| <ol> |
| <li>During the startup of <code>DubboConsumer</code>, an independent non-daemon thread is launched to query the status of the variable continuously, thus the process can&rsquo;t exit.</li> |
| <li>To stop the <code>DubboConsumer</code>, one should call ShutdownHook to change the variable to let the thread break the loop.</li> |
| </ol> |
| <h2 id="problems">Problems</h2> |
| <p>In the example of DubboProvider, we see that Provider doesn&rsquo;t start Tomcat to provide HTTP service, then how does the program stays alive without exiting? We will answer this question in the next article.</p> |
| <h3 id="notice">Notice</h3> |
| <p>By running the following unit test which create a thread in <code>Intellij IDEA</code> , we are surprised to find that the program exits with less than 1000s. Why?(The thread being created is a non-daemon thread)</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#268bd2">@Test</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">test</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> Thread(<span style="color:#719e07">new</span> Runnable() { |
| </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>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> Thread.sleep(1000000); |
| </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> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }).start(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>[1] <a href="https://docs.oracle.com/javase/specs/jls/se8/html/jls-12.html#jls-12.8">https://docs.oracle.com/javase/specs/jls/se8/html/jls-12.html#jls-12.8</a></p> |
| <p>[2] <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runtime.html#addShutdownHook">https://docs.oracle.com/javase/8/docs/api/java/lang/Runtime.html#addShutdownHook</a></p></description></item><item><title>Blog: Implementation of cross-language calls by Dubbo2.js</title><link>https://dubbo.apache.org/en/blog/2018/08/14/implementation-of-cross-language-calls-by-dubbo2.js/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/implementation-of-cross-language-calls-by-dubbo2.js/</guid><description> |
| <blockquote> |
| <p><a href="https://github.com/dubbo/dubbo2.js">dubbo2.js</a> is a Dubbo client for node.js developped by <a href="https://www.qianmi.com/">Qianmiwang</a>. It supports Dubbo&rsquo;s native protocol, which makes the RPC calls between javascript and java efficient and agile. This tool has been contributed to Dubbo&rsquo;s community.</p> |
| </blockquote> |
| <h2 id="cross-language-calls-for-micro-service">Cross-language calls for micro service</h2> |
| <p>Nowadays, Internet architecture tends to be micro-service way. The discussions about micro-service architecture becomes the most mentioned topic in different technical conferences. In China, most of the companies, such as Qianmiwang, choose Dubbo as their micro-servie architecture solution. As most of the internet companies, Qianmiwang uses various of programming languages. Java is for most of the backend services. Each business based on these backend can choose its own programming language such as go, python and javascript. Therefore, here comes a challenge, cross language calls. Some well mentioned solutions are as follows:</p> |
| <ul> |
| <li>Spring cloud. Spring cloud provides a set of components for micro-service development. It is based on HTTP protocol and is designed in the restful way, which makes it support cross-language calls. Other languages can call the services simply by implementing an HTTP interface.</li> |
| <li>Service mesh. People call service mesh the next generation of micro-service framework. The core of this solution is SideCar. Even though the concept of SideCar changes a lot during the revolution of Service mesh, its main job never changed: providing reliable communication between different services.</li> |
| <li>Motan. <a href="https://github.com/weibocom/motan">Motan</a> is an open source cross-language service framework developped by Sina Weibo. Its early version only supports motan-java. However, as the new versions come out, more languages are supported in order to handle the cross-language problem. Its newest version(1.1.0) provides motan-go, motan-php, motan-openresty, etc. Similar to SideCar in Service mesh, Motan forwards messages by mortan-go, which can be considered as an agent. Meanwhile, motan2, its own protocol, is built for cross-language calls.</li> |
| </ul> |
| <p>According to the solutions below, there are two ways to solve the cross-language calls problem:</p> |
| <ul> |
| <li>communicating by a common protocol.</li> |
| <li>implementing an agent as a protocol adapter.</li> |
| </ul> |
| <p>When a new team is choosing technical solutions, what I mentioned below could be our candidates. Meanwhile, the old system&rsquo;s compatibility and migration costs should also be considered. The first trial we did is to work on RPC protocol.</p> |
| <h2 id="cross-language-calls-by-a-common-protocol">Cross-language calls by a common protocol</h2> |
| <h3 id="springmvc">SpringMVC</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/springmvc.png" alt="springmvc"></p> |
| <p>Before achieving the real cross-language calls, the most common solution is to use the http protocol. We can call Dubbo provider indirectly by controller/restController provided by springmvc. This is easy to carry out, but there are lots of inconveniences. firstly, a call will go through too many nodes. Secondly, an extra communication layer (for http protocol) will be involved, but it could have been handled simply by the TCP protocol. Thirdly, we need to implement the RPC interface in the controller part. This will be extra work for developers.</p> |
| <h3 id="we-support-some-common-protocols">We support some common protocols</h3> |
| <p>Most of the service management frameworks support multiple protocols, dubbo as well. Besides its own protocol, the common protocols such as Dangdangwang&rsquo;s <a href="https://dangdangdotcom.github.io/dubbox/rest.html">Rest</a> protocol and Qianmiwang&rsquo;s <a href="https://github.com/apache/dubbo-rpc-jsonrpc">json-rpc</a> protocol are also supported.</p> |
| <p>The developers getting used to traditional RPC interfaces might feel uncomfortable while working on restful RPC interfaces. On the one hand, this is not good for rebuilding new interfaces. On the other hand, restful style might make these interfaces incompatible with the other protocols used by old interfaces. Of course, if there is no old system problems, using Rest protocol is the easiest implementation of cross-language calls, since most of the languages support it.</p> |
| <p>Even if Dubbo has tried on restful interface, the difference between rest architecture and RPC architecture should not be ignored. Rest architecture defines each resources, and it needs basic operations of http protocols such as GET, POST, DELETE, PUT. In my opinion, a Rest protocol is more for calls between different systems on the internet, while RPC is suitable for inner system calls. Similar to Rest protocol, json-rpc is also implemented by text sequence and http protocol. Using json-rpc can also solve the cross-language problems, meanwhile, it makes our solution compatible with old interfaces and there is no need to adapt to the restful style.</p> |
| <p>Json-rpc is Qianmiwang&rsquo;s early solution for cross-language protocol. They open-sourced their <a href="https://github.com/dubbo/dubbo-client-py">dubbo-client-py</a> and <a href="https://github.com/QianmiOpen/dubbo-node-client">dubbo-node-client</a>, two clients based on json-rpc protocol. With these tools, we can easily call the rpc services provided by dubbo-provider-java with while using python or node.js. The inner system calls for java services are still mainly implemented by Dubbo protocol. In addition, in order to adapt the old system, two protocols could be configured.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;jsonrpc&#34;</span> port=<span style="color:#2aa198">&#34;8080&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><h3 id="customized-protocols-for-cross-language-support">Customized Protocols for Cross-language Support</h3> |
| <p>The so-called protocol of the microservice framework can be simply interpreted as: message format and serialization scheme. Generally, the service governance framework would provide numbers of protocol configuration items for users to choose from. In addition to the above two common protocols,there exists some other customized protocols like the dubbo protocol, the default protocol for the dubbo framework, and Motan2, a cross-language protocol provided by the motan framework.</p> |
| <h4 id="motan2-for-cross-language-support">Motan2 for cross-language support</h4> |
| <p><img src="https://dubbo.apache.org/imgs/blog/motan-protocol-en.png" alt="motan2"></p> |
| <p>In the original Motan protocol, the protocol message consisted only of the Header and the Body, making deserialization indispensable for acquiring data stored in the Body, like path, param and group, which is terribly unfriendly for cross-language support. Therefore, the content of the protocol was modifiedin Motan2, Weibo released the open-source projects, <a href="https://github.com/weibocom/motan-go/">motan-go</a>, <a href="https://github.com/weibocom/motan-php">motan-php</a> and <a href="https://github.com/weibocom/motan-openresty">motan-openresty</a>. It used motan-go as an interpreter and the Simple serialization scheme to serialize the Body of protocol message. (Simple is a comparably weaker serialization scheme)</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/motan-agent.png" alt="agent"></p> |
| <p>After observation we find out that there is no big difference between the configuration of Motan2 and the dual protocol. It’s just that the agent here is implicit, and it co-exists with the main service. The most obvious difference is that different languages do not interact directly in agent scheme.</p> |
| <h4 id="dubbo-for-cross-language-support">Dubbo for cross-language support</h4> |
| <p>Instead of cross-language support, the dubbo protocol was originally designed only for common rpc requests. However, it’s not always the case that we can only choose to support it or not. We can always choose to offer different levels of support. It may be hard to offer cross-language support based on the dubbo protocol, but not impossible. Actually, Qianmiwang succeeded. It conquered the front-end cross-language business field built by nodejs with dubbo2.js. It builds the bridge between Nodejs and the native dubbo protocol. Next, we will focus on what we can do with dubbo2.js.</p> |
| <h5 id="dubbo-protocol-message-format">Dubbo protocol message format:</h5> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-protocol.png" alt="dubbo协议"></p> |
| <p>Details in dubbo protocol header message:</p> |
| <ul> |
| <li>Magic: similar to magic number in Java bytes code files, which is used to determine whether it is a data pack of dubbo protocol. The magic number is the constant, 0xdabb.</li> |
| <li>Flag: contains 8 bits. The lower four bits are used to indicate the type of serialization tool used for message body data (default hessian). Among the upper four bits, the 1 at first bit indicates request, the 1 at second bit indicates dual transfer, 1 at third bits indicates the heartbeat.</li> |
| <li>Status: used toset response status. Dubbo defines some types for response. Details can be found in <span data-type="color" style="color:rgb(36, 41, 46)"><span data-type="background" style="background-color:rgba(27, 31, 35, 0.05)">com.alibaba.dubbo.remoting.exchange.Response</span></span></li> |
| <li>Invoke id: Message id,Type long, Unique indentifier for each request (Due to asynchronous communication, it is used to match the request to the corresponding returned response)</li> |
| <li>Body length: message body length, type int,record bytes of body content.</li> |
| <li>Body content: request param, where serializedresponse parameters are stored.</li> |
| </ul> |
| <p>Protocol messages will eventually become bytes and be transmitted using TCP. Any language that supports network modules and has a socket will be able to be communicatedwith. Then, why cross-language support is difficult? There are two main obstaclesin calling service in Java using other languages:</p> |
| <ol> |
| <li><span data-type="color" style="color:#24292E">How </span><span data-type="color" style="color:#212121">can different languages represent data types in java, especially dynamiclanguages with possible non-strict data types</span>?</li> |
| <li><span data-type="color" style="color:#24292E">How to serialize string across language?</span></li> |
| </ol> |
| <h2 id="how-does-dubbo2js-solve-problems">How does dubbo2.js solve problems?</h2> |
| <p>We have analyzed two obstacles above. The key to dubbo2.js in solving these two problems depends on two class libraries: <a href="https://github.com/node-modules/js-to-java">js-to-java</a>，<a href="https://github.com/node-modules/hessian.js">hessian.js</a>. js-to-java, which makes nodejs have the ability to express Java objects. Hessian.js provides serialization capabilities. With the help of nodejs socket, and a duplicate set of dubbo protocol message format, we can finally achieve nodejs call to java-dubbo-provider.</p> |
| <h2 id="quick-start">Quick Start</h2> |
| <p>To give an intuitive feeling to readers interested in dubbo2.js, this section presents a quick start example that shows how easy it is to call dubbo service using dubbo2.js.</p> |
| <h3 id="1-initiate-dubbo-java-provider">1. Initiate dubbo-java-provider</h3> |
| <p>Java provides the backend dubbo service. Firstly, let’s define the service interface:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">DemoProvider</span> { |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHello</span>(String name); |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">echo</span>() ; |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">test</span>(); |
| </span></span><span style="display:flex;"><span> UserResponse <span style="color:#268bd2">getUserInfo</span>(UserRequest request); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Then we implement the interface:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoProviderImpl</span> <span style="color:#268bd2">implements</span> DemoProvider { |
| </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> System.out.println(<span style="color:#2aa198">&#34;[&#34;</span> <span style="color:#719e07">+</span> <span style="color:#719e07">new</span> SimpleDateFormat(<span style="color:#2aa198">&#34;HH:mm:ss&#34;</span>).format(<span style="color:#719e07">new</span> Date()) <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;] Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, request from consumer: &#34;</span> <span style="color:#719e07">+</span> RpcContext.getContext().getRemoteAddress()); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;, response form provider: &#34;</span> <span style="color:#719e07">+</span> RpcContext.getContext().getLocalAddress(); |
| </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">echo</span>() { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;receive....&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;pang&#34;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">test</span>() { |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;test&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> UserResponse <span style="color:#268bd2">getUserInfo</span>(UserRequest request) { |
| </span></span><span style="display:flex;"><span> System.out.println(request); |
| </span></span><span style="display:flex;"><span> UserResponse response <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> UserResponse(); |
| </span></span><span style="display:flex;"><span> response.setStatus(<span style="color:#2aa198">&#34;ok&#34;</span>); |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>String, String<span style="color:#719e07">&gt;</span> map <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>String, String<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> map.put(<span style="color:#2aa198">&#34;id&#34;</span>, <span style="color:#2aa198">&#34;1&#34;</span>); |
| </span></span><span style="display:flex;"><span> map.put(<span style="color:#2aa198">&#34;name&#34;</span>, <span style="color:#2aa198">&#34;test&#34;</span>); |
| </span></span><span style="display:flex;"><span> response.setInfo(map); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> response; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>After that,<span data-type="color" style="color:#24292E"> we expose the dubbo service with xml files:</span></p> |
| <div class="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://code.alibabatech.com/schema/dubbo&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd |
| </span></span></span><span style="display:flex;"><span><span style="color:#2aa198"> http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- dubbo provider info, used to compute dependency --&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:#268bd2">&lt;dubbo:registry</span> protocol=<span style="color:#2aa198">&#34;zookeeper&#34;</span> address=<span style="color:#2aa198">&#34;localhost: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 protocol, used to expose service at port 20880 --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:protocol</span> name=<span style="color:#2aa198">&#34;dubbo&#34;</span> port=<span style="color:#2aa198">&#34;20880&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">&lt;!-- realize a service as a local bean --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;bean</span> id=<span style="color:#2aa198">&#34;demoProvider&#34;</span> class=<span style="color:#2aa198">&#34;com.alibaba.dubbo.demo.provider.DemoProviderImpl&#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;!-- claim for service interfaces to expose --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:service</span> interface=<span style="color:#2aa198">&#34;com.alibaba.dubbo.demo.DemoProvider&#34;</span> ref=<span style="color:#2aa198">&#34;demoProvider&#34;</span> version=<span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/beans&gt;</span> |
| </span></span></code></pre></div><p>After we implemented all the configurations on server side, initiate an object initiater to register a dubbo service locally:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">Provider</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> Exception { |
| </span></span><span style="display:flex;"><span> ClassPathXmlApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ClassPathXmlApplicationContext(<span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span>{<span style="color:#2aa198">&#34;META-INF/spring/dubbo-demo-provider.xml&#34;</span>}); |
| </span></span><span style="display:flex;"><span> context.start(); |
| </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><h3 id="2-implement-dubbo-client-side-for-nodejs">2. Implement dubbo client-side for nodejs</h3> |
| <p>Install dubbo2.js using npm:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>npm install dubbo2.js --save |
| </span></span></code></pre></div><p>Configure dubboConfig.ts:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-typescript" data-lang="typescript"><span style="display:flex;"><span><span style="color:#268bd2">import</span> { Dubbo, java, TDubboCallResult } <span style="color:#268bd2">from</span> <span style="color:#2aa198">&#39;dubbo2.js&#39;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">const</span> dubbo <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Dubbo({ |
| </span></span><span style="display:flex;"><span> application<span style="color:#719e07">:</span> {name<span style="color:#719e07">:</span> <span style="color:#2aa198">&#39;demo-provider&#39;</span>}, |
| </span></span><span style="display:flex;"><span> register<span style="color:#719e07">:</span> <span style="color:#2aa198">&#39;localhost:2181&#39;</span>, |
| </span></span><span style="display:flex;"><span> dubboVersion<span style="color:#719e07">:</span> <span style="color:#2aa198">&#39;2.0.0&#39;</span>, |
| </span></span><span style="display:flex;"><span> interfaces<span style="color:#719e07">:</span> [ |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">&#39;com.alibaba.dubbo.demo.DemoProvider&#39;</span>, |
| </span></span><span style="display:flex;"><span> ], |
| </span></span><span style="display:flex;"><span>}); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">interface</span> IDemoService { |
| </span></span><span style="display:flex;"><span> sayHello(name: <span style="color:#dc322f">string</span>)<span style="color:#719e07">:</span> TDubboCallResult&lt;<span style="color:#268bd2">string</span>&gt;; |
| </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">export</span> <span style="color:#268bd2">const</span> demoService <span style="color:#719e07">=</span> dubbo.proxyService&lt;<span style="color:#268bd2">IDemoService</span>&gt;({ |
| </span></span><span style="display:flex;"><span> dubboInterface<span style="color:#719e07">:</span> <span style="color:#2aa198">&#39;com.alibaba.dubbo.demo.DemoProvider&#39;</span>, |
| </span></span><span style="display:flex;"><span> version<span style="color:#719e07">:</span> <span style="color:#2aa198">&#39;1.0.0&#39;</span>, |
| </span></span><span style="display:flex;"><span> methods<span style="color:#719e07">:</span> { |
| </span></span><span style="display:flex;"><span> sayHello(name: <span style="color:#dc322f">string</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> [java.<span style="color:#b58900">String</span>(name)]; |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> echo() {}, |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> test() {}, |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> getUserInfo() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> [ |
| </span></span><span style="display:flex;"><span> java.combine(<span style="color:#2aa198">&#39;com.alibaba.dubbo.demo.UserRequest&#39;</span>, { |
| </span></span><span style="display:flex;"><span> id: <span style="color:#dc322f">1</span>, |
| </span></span><span style="display:flex;"><span> name<span style="color:#719e07">:</span> <span style="color:#2aa198">&#39;nodejs&#39;</span>, |
| </span></span><span style="display:flex;"><span> email<span style="color:#719e07">:</span> <span style="color:#2aa198">&#39;node@qianmi.com&#39;</span>, |
| </span></span><span style="display:flex;"><span> }), |
| </span></span><span style="display:flex;"><span> ]; |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span> }, |
| </span></span><span style="display:flex;"><span>}); |
| </span></span></code></pre></div><blockquote> |
| <p>Using typescript brings better coding experience.</p> |
| </blockquote> |
| <p>Implement caller class main.ts：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-typescript" data-lang="typescript"><span style="display:flex;"><span><span style="color:#268bd2">import</span> {demoService} <span style="color:#268bd2">from</span> <span style="color:#2aa198">&#39;./dubboConfig&#39;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>demoService.sayHello(<span style="color:#2aa198">&#39;kirito&#39;</span>).then(({res,err})<span style="color:#719e07">=&gt;</span>{ |
| </span></span><span style="display:flex;"><span> console.log(res) |
| </span></span><span style="display:flex;"><span>}); |
| </span></span></code></pre></div><h3 id="3-call-maints">3. Call main.ts:</h3> |
| <p>Run nodejs client in Debug mode:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span><span style="color:#268bd2">DEBUG</span><span style="color:#719e07">=</span>dubbo* ts-node main.ts |
| </span></span></code></pre></div><p>Checkout running results:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>Hello kirito, response form provider: 172.19.6.151:20880 |
| </span></span></code></pre></div><p>Congratulations！</p> |
| <h2 id="features">Features</h2> |
| <ul> |
| <li>Support zookeeper as register center</li> |
| <li>Support TCP Dubbo Native protocol</li> |
| <li>Support directly Dubbo connection</li> |
| <li>Support link tracing</li> |
| <li>Generate dubbo interface Automatically</li> |
| </ul> |
| <h2 id="more-details">More details</h2> |
| <p>The sample code in this article is available here, <a href="https://github.com/dubbo/dubbo2.js">https://github.com/dubbo/dubbo2.js</a>. |
| If you don't know much about the dubbo protocol and want to understand how it works, the project provides a sub-moudle: java-socket-consumer, which is implemented in a process-oriented approach, realizing a process of sending dubbo protocal message with native socket and making function calls, and then get response.</p></description></item><item><title>Blog: Generic invoke of Dubbo</title><link>https://dubbo.apache.org/en/blog/2018/08/14/generic-invoke-of-dubbo/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/generic-invoke-of-dubbo/</guid><description> |
| <h1 id="generic-invoke-of-dubbo">Generic invoke of Dubbo</h1> |
| <p>The generic invoke could be considered to be used in the following cases:</p> |
| <ul> |
| <li>Service test platform</li> |
| <li>API service gateway</li> |
| </ul> |
| <p>The generic invoke is mainly used when the consumer does not have an API interface; |
| instead of depending the interface jar package, the service call is initiated directly through the GenericService interface, and all POJOs in the parameters and return values are represented by a <code>Map</code>. |
| Generic invoke does not require attention on the server and can be exposed as normal services.</p> |
| <p>Next, let&rsquo;s take a look at how the consumer uses generic invoke for service call.</p> |
| <h2 id="generic-invoke-through-spring-xml-configuration">Generic invoke through Spring XML configuration</h2> |
| <p>Declare <code>generic=&quot;true&quot;</code> in Spring configuration, such as</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span>&#34;userService&#34; interface=&#34;com.alibaba.dubbo.samples.generic.api.IUserService&#34; generic=&#34;true&#34;/&gt; |
| </span></span></code></pre></div><p>Where you need to use it, you can call it by forcing a type cast to GenericService.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>GenericService userService <span style="color:#719e07">=</span> (GenericService) context.getBean(<span style="color:#2aa198">&#34;userService&#34;</span>); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// primary param and return value</span> |
| </span></span><span style="display:flex;"><span>String name <span style="color:#719e07">=</span> (String) userService.$invoke(<span style="color:#2aa198">&#34;delete&#34;</span>, <span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span>{<span style="color:#dc322f">int</span>.class.getName()}, <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]</span>{1}); |
| </span></span><span style="display:flex;"><span>System.out.println(name); |
| </span></span></code></pre></div><p>Among them,</p> |
| <ol> |
| <li> |
| <p>The interface GenericService has only one method, named $invoke, which takes three arguments, a method name, an array of method parameter types, and an array of parameter values.</p> |
| </li> |
| <li> |
| <p>For arrays of method parameter types</p> |
| <p>i. If it is a basic type, such as int or long, use <code>int.class.getName()</code> to get its type;</p> |
| <p>ii. If it is a basic type array, such as int[], use <code>int[].class.getName()</code>;</p> |
| <p>iii. If it is a POJO, use the full class name directly, such as <code>com.alibaba.dubbo.samples.generic.api.Params</code>.</p> |
| </li> |
| </ol> |
| <h2 id="generic-invoke-through-api-programming">Generic invoke through API programming</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ApplicationConfig application <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig()ApplicationConfig application <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>application.setName(<span style="color:#2aa198">&#34;api-generic-consumer&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>RegistryConfig registry <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig(); |
| </span></span><span style="display:flex;"><span>registry.setAddress(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>application.setRegistry(registry); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// weak type interface name</span> |
| </span></span><span style="display:flex;"><span>reference.setInterface(<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.generic.api.IUserService&#34;</span>); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// declared as a generalized interface</span> |
| </span></span><span style="display:flex;"><span>reference.setGeneric(<span style="color:#cb4b16">true</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>reference.setApplication(application); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// replace all interface references with com.alibaba.dubbo.rpc.service.GenericService</span> |
| </span></span><span style="display:flex;"><span>GenericService genericService <span style="color:#719e07">=</span> reference.get(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>String name <span style="color:#719e07">=</span> (String) genericService.$invoke(<span style="color:#2aa198">&#34;delete&#34;</span>, <span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span>{<span style="color:#dc322f">int</span>.class.getName()}, <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]</span>{1}); |
| </span></span><span style="display:flex;"><span>System.out.println(name); |
| </span></span></code></pre></div><p>Through the API, you don&rsquo;t need to configure the service in advance like XML. You can dynamically construct ReferenceConfig; the API is more common than XML.</p> |
| <h2 id="the-case-where-parameters-or-return-values-are-pojos">The case where parameters or return values are POJOs</h2> |
| <p>For example, the method signature is <code>User get(Params params)</code>, where <code>User</code> has two attributes, id and name, and <code>Params</code> has one attribute, query.</p> |
| <p>The following is the code of the consumer:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>String<span style="color:#719e07">[]</span> parameterTypes <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> String<span style="color:#719e07">[]</span>{<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.generic.api.Params&#34;</span>}; |
| </span></span><span style="display:flex;"><span>Map<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span> params <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HashMap<span style="color:#719e07">&lt;</span>String, Object<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span>param.put(<span style="color:#2aa198">&#34;class&#34;</span>, <span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.generic.api.Params&#34;</span>); |
| </span></span><span style="display:flex;"><span>param.put(<span style="color:#2aa198">&#34;query&#34;</span>, <span style="color:#2aa198">&#34;a=b&#34;</span>); |
| </span></span><span style="display:flex;"><span>Object user <span style="color:#719e07">=</span> userService.$invoke(<span style="color:#2aa198">&#34;get&#34;</span>, parameterTypes, <span style="color:#719e07">new</span> Object<span style="color:#719e07">[]</span>{param}); |
| </span></span><span style="display:flex;"><span>System.out.println(<span style="color:#2aa198">&#34;sample one result: &#34;</span> <span style="color:#719e07">+</span> user); |
| </span></span></code></pre></div><p>The output of the above code is:</p> |
| <div class="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>sample one result: {name=charles, id=1, class=com.alibaba.dubbo.samples.generic.api.User} |
| </span></span></code></pre></div><p>Here, the Dubbo framework will automatically convert the return value from POJO to Map. |
| It can be seen that the return value <code>user</code> is a HashMap, which stores three k/vs, name, id, and class.</p> |
| <h2 id="generic-interface-implementation">Generic interface implementation</h2> |
| <p>The implementation of the generic interface is mainly used when the server does not have an API interface. All POJOs in the parameters and return values are represented by Map, which is usually used for framework integration. For example, to implement a generic remote service Mock framework, all service requests can be handled by implementing the interface GenericService.</p> |
| <h3 id="implementation-genericservice-on-the-server">Implementation GenericService on the server</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">GenericServiceImpl</span> <span style="color:#268bd2">implements</span> GenericService { |
| </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> Object <span style="color:#268bd2">$invoke</span>(String method, String<span style="color:#719e07">[]</span> parameterTypes, Object<span style="color:#719e07">[]</span> args) <span style="color:#268bd2">throws</span> GenericException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (method.equals(<span style="color:#2aa198">&#34;hi&#34;</span>)) { |
| </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> args<span style="color:#719e07">[</span>0<span style="color:#719e07">]</span>; |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> <span style="color:#719e07">if</span> (method.equals(<span style="color:#2aa198">&#34;hello&#34;</span>)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;hello, &#34;</span> <span style="color:#719e07">+</span> args<span style="color:#719e07">[</span>0<span style="color:#719e07">]</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;welcome&#34;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="server-exposed-service">Server exposed service</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ApplicationConfig application <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>application.setName(<span style="color:#2aa198">&#34;api-generic-provider&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>RegistryConfig registry <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig(); |
| </span></span><span style="display:flex;"><span>registry.setAddress(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>application.setRegistry(registry); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>GenericService genericService <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> GenericServiceImpl(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ServiceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> service <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span>service.setApplication(application); |
| </span></span><span style="display:flex;"><span>service.setInterface(<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.generic.api.HelloService&#34;</span>); |
| </span></span><span style="display:flex;"><span>service.setRef(genericService); |
| </span></span><span style="display:flex;"><span>service.export(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ServiceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> service2 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ServiceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span>service2.setApplication(application); |
| </span></span><span style="display:flex;"><span>service2.setInterface(<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.generic.api.HiService&#34;</span>); |
| </span></span><span style="display:flex;"><span>service2.setRef(genericService); |
| </span></span><span style="display:flex;"><span>service2.export(); |
| </span></span></code></pre></div><p>Similarly, you can expose the service using XML configuration; in this case, the server does not depend on the two interfaces HiService and HelloService.</p> |
| <h3 id="service-invoke-on-the-consumer">Service invoke on the consumer</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>ApplicationConfig application <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span>application.setName(<span style="color:#2aa198">&#34;api-generic-consumer&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>RegistryConfig registry <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig(); |
| </span></span><span style="display:flex;"><span>registry.setAddress(<span style="color:#2aa198">&#34;zookeeper://127.0.0.1:2181&#34;</span>); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>application.setRegistry(registry); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> reference <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// weak type interface name</span> |
| </span></span><span style="display:flex;"><span>reference.setInterface(HiService.class); |
| </span></span><span style="display:flex;"><span>reference.setApplication(application); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>HiService hiService <span style="color:#719e07">=</span> (HiService) reference.get(); |
| </span></span><span style="display:flex;"><span>System.out.println(hiService.hi(<span style="color:#2aa198">&#34;dubbo&#34;</span>)); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span> reference2 <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ReferenceConfig<span style="color:#719e07">&lt;</span>GenericService<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// weak type interface name</span> |
| </span></span><span style="display:flex;"><span>reference2.setInterface(HelloService.class); |
| </span></span><span style="display:flex;"><span>reference2.setApplication(application); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>HelloService helloService <span style="color:#719e07">=</span> (HelloService) reference2.get(); |
| </span></span><span style="display:flex;"><span>System.out.println(helloService.hello(<span style="color:#2aa198">&#34;community&#34;</span>)); |
| </span></span></code></pre></div><p>Similarly, the consumer can also reference the service using an XML configuration and then make the call. Here you can see that the calling method is a normal service call, not a generic call. Of course, it is also possible to use generic calls.</p> |
| <p>So far, a simple service Mock platform has been successfully launched!</p> |
| <h2 id="others">Others</h2> |
| <ul> |
| <li>The generic invoke and generic interface implementations introduced in this article are all based on the native Dubbo protocol. Prior to version 2.6.2, other protocols such as http/hessian don&rsquo;t support generic invoke. Version 2.6.3 will support the generic invoke of these two protocols.</li> |
| <li>The relevant sample codes mentioned in this article can be found in dubbo-samples: <a href="https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-generic">https://github.com/apache/dubbo-samples/tree/master/2-advanced/dubbo-samples-generic</a></li> |
| </ul></description></item><item><title>Blog: Native Image using GraalVM</title><link>https://dubbo.apache.org/en/blog/2018/08/14/native-image-using-graalvm/</link><pubDate>Tue, 14 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/14/native-image-using-graalvm/</guid><description> |
| <h2 id="overview">Overview</h2> |
| <p>This document will show you how to access GraalVM with a dubbo project and how to compile the project to a binary executable using native-image. The document also introduces the efforts we made in achieving this.</p> |
| <p>GraalVM&rsquo;s essential is the Graal compiler, an excellent just-in-time (JIT) compiler. It can be used as both a JIT compiler and a static compiler for ahead-of-time compilation. Graal compiler completes the primary compilation work.</p> |
| <p>For more information about GraalVM, read <a href="https://www.graalvm.org/docs/getting-started/container-images/">https://www.graalvm.org/docs/getting-started/container-images/</a>.</p> |
| <h2 id="preparation">Preparation</h2> |
| <p>Before compiling the dubbo project, make sure that we are programming based on the GraalVM environment.</p> |
| <p>GraalVM&rsquo;s installation process won&rsquo;t be introduced in this document. You can visit <a href="https://www.graalvm.org/">https://www.graalvm.org/</a> and select the latest version to install. After installation you will be able to see the following in local jdk:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-graalvm-support/graalvm_env.png" alt="graalvm_env.png"> |
| GraalVM we use here is based on jdk version 1.8.</p> |
| <h2 id="get-started">Get Started</h2> |
| <p>For user&rsquo;s convenience, we provide the following demo in the <a href="https://github.com/apache/dubbo/">apache dubbo</a> branch. In module dubbo-demo-native, dubbo&rsquo;s provider and consumer demos are given:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-graalvm-support/demo_path.png" alt="demo_path.png"></p> |
| <p>We used native-image&rsquo;s maven plug-in and customized several native-image starting parameters. Users only need to run maven&rsquo;s compile and package command in consumers&rsquo; and providers&rsquo; modules:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-go" data-lang="go"><span style="display:flex;"><span>mvn <span style="color:#719e07">-</span>U clean <span style="color:#719e07">package</span> <span style="color:#719e07">-</span>Dmaven.test.skip=<span style="color:#cb4b16">true</span> |
| </span></span></code></pre></div><p>You can see the following output after compilation:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-graalvm-support/consumer_compiler.png" alt="provider_compiler.png"><img src="https://dubbo.apache.org/imgs/blog/dubbo-graalvm-support/provider_compiler.png" alt="img"></p> |
| <p>Binary executable file generated can be found in the target catalog:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-graalvm-support/compile_result.png" alt="compile_result.png"></p> |
| <p>Size of the binary executable file is around 40M:</p> |
| <div class="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>MacdeMacBook-pro-3:target mac$ du -m demo-native-provider |
| </span></span><span style="display:flex;"><span>40 demo-native-provider |
| </span></span></code></pre></div><p>Note: example above is the service registration and discovery based on zookeeper. Users have to launch a zk locally before executing the binary executable file.</p> |
| <p>Launch the binary executable file:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>MacdeMacBook-pro-3:target mac$ ./demo-native-provider |
| </span></span><span style="display:flex;"><span>...... |
| </span></span><span style="display:flex;"><span>INFO: [DUBBO] DubboBootstrap is ready., dubbo version: 2.7.12-SNAPSHOT, current host: 10.220.186.228 |
| </span></span><span style="display:flex;"><span>Jun 15, 2021 2:29:14 PM org.apache.dubbo.common.logger.jdk.JdkLogger info |
| </span></span><span style="display:flex;"><span>INFO: [DUBBO] DubboBootstrap has started., dubbo version: 2.7.12-SNAPSHOT, current host: 10.220.186.228 |
| </span></span><span style="display:flex;"><span>Jun 15, 2021 2:29:14 PM org.apache.dubbo.common.logger.jdk.JdkLogger info |
| </span></span><span style="display:flex;"><span>INFO: [DUBBO] DubboBootstrap awaiting ..., dubbo version: 2.7.12-SNAPSHOT, current host: 10.220.186.228 |
| </span></span></code></pre></div><p>Enter consumer&rsquo;s target catalog and execute the binary executable file:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>MacdeMacBook-pro-3:target mac$ ./demo-native-consumer |
| </span></span><span style="display:flex;"><span>Hello dubbo, response from provider: 10.220.186.228:20880 |
| </span></span></code></pre></div><p>All the launches and invokes above finish within one second.</p> |
| <h2 id="our-efforts">Our Efforts</h2> |
| <h3 id="preparations">Preparations</h3> |
| <h4 id="class-initializations-auxiliary-configurations">Class Initialization&rsquo;s Auxiliary Configurations</h4> |
| <p>Since native-image is constructed prior to runtime, its construction is dependent on the static analysis of which code is accessible. However, this analysis cannot always fully predict all usages of Java Native Interface (JNI) , reflection, dynamic proxy object or classpath resource. In the format of <code>native-image</code> configuration file, we need to provide the usages whose dynamic functions are not detected.</p> |
| <p>Here we add the following to the JVM parameter:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>-agentlib:native-image-agent=config-output-dir=/path/to/config-dir/ |
| </span></span></code></pre></div><p>Parameter above will introduce agent and run the project in the conventional way. Agent will interact with JVM and intercept all invokes that look up classes, methods, fields, resources or request proxy access. Later agent will produce the following files in the specified catalog: <code>jni-config.json</code>, <code>reflect-config.json</code>, <code>proxy-config.json</code> and <code>resource-config.json</code>, etc.</p> |
| <p>Copy the files above into project&rsquo;s resource/META-INF/native-image folder. When native-image compiles, operations regarding JNI, reflection, dynamic proxy and resources will be loaded after finding class information from these json files.</p> |
| <p>Note: in reality, since agent detects operations while running and not all logic branches can be covered, some classes&rsquo; json info won&rsquo;t be generated. However, native-image compiles all classes. This will lead to unexpected errors. Currently there&rsquo;s no way for users to distinguish which classes&rsquo; information are lacking until the errors are reported. Lacked info has to be added to json files manually.</p> |
| <h4 id="import-native-image-plug-in">Import Native-Image Plug-In</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&lt;plugin&gt; |
| </span></span><span style="display:flex;"><span> &lt;groupId&gt;org.graalvm.nativeimage&lt;/groupId&gt; |
| </span></span><span style="display:flex;"><span> &lt;artifactId&gt;native-image-maven-plugin&lt;/artifactId&gt; |
| </span></span><span style="display:flex;"><span> &lt;version&gt;21.0.0.2&lt;/version&gt; |
| </span></span><span style="display:flex;"><span> &lt;executions&gt; |
| </span></span><span style="display:flex;"><span> &lt;execution&gt; |
| </span></span><span style="display:flex;"><span> &lt;goals&gt; |
| </span></span><span style="display:flex;"><span> &lt;goal&gt;native-image&lt;/goal&gt; |
| </span></span><span style="display:flex;"><span> &lt;/goals&gt; |
| </span></span><span style="display:flex;"><span> &lt;phase&gt;package&lt;/phase&gt; |
| </span></span><span style="display:flex;"><span> &lt;/execution&gt; |
| </span></span><span style="display:flex;"><span> &lt;/executions&gt; |
| </span></span><span style="display:flex;"><span> &lt;configuration&gt; |
| </span></span><span style="display:flex;"><span> &lt;skip&gt;false&lt;/skip&gt; |
| </span></span><span style="display:flex;"><span> &lt;imageName&gt;demo-native-provider&lt;/imageName&gt; |
| </span></span><span style="display:flex;"><span> &lt;mainClass&gt;org.apache.dubbo.demo.graalvm.provider.Application&lt;/mainClass&gt; |
| </span></span><span style="display:flex;"><span> &lt;buildArgs&gt; |
| </span></span><span style="display:flex;"><span> --no-fallback |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.MDC |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.LoggerFactory |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.impl.StaticLoggerBinder |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.helpers.Loader |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.Logger |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.helpers.LogLog |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.LogManager |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.apache.log4j.spi.LoggingEvent |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.impl.Log4jLoggerFactory |
| </span></span><span style="display:flex;"><span> --initialize-at-build-time=org.slf4j.impl.Log4jLoggerAdapter |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.Epoll |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.Native |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.EpollEventLoop |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.epoll.EpollEventArray |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.DefaultFileRegion |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.kqueue.KQueueEventArray |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.kqueue.KQueueEventLoop |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.kqueue.Native |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.Errors |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.IovArray |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.Limits |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.util.internal.logging.Log4JLogger |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.unix.Socket |
| </span></span><span style="display:flex;"><span> --initialize-at-run-time=io.netty.channel.ChannelHandlerMask |
| </span></span><span style="display:flex;"><span> --report-unsupported-elements-at-runtime |
| </span></span><span style="display:flex;"><span> --allow-incomplete-classpath |
| </span></span><span style="display:flex;"><span> --enable-url-protocols=http |
| </span></span><span style="display:flex;"><span> -H:+ReportExceptionStackTraces |
| </span></span><span style="display:flex;"><span> &lt;/buildArgs&gt; |
| </span></span></code></pre></div><p>After importing the plug-in, native-image command can be automatically executed when executing maven commands such as packaging.</p> |
| <h4 id="import-generated-spi-dependency-package">Import Generated SPI Dependency Package</h4> |
| <p>SPI mode of dubbo grants huge expandability. It depends on some generated code that are adaptive to extensions. These generated code are not supported by binary images. To deal with this problem, we did the following:</p> |
| <ul> |
| <li>Export generated code</li> |
| </ul> |
| <p>(Note: here we modified compiler&rsquo;s code in dubbo-common. Detailed explanations will be presented later on.)</p> |
| <div class="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>public Class&lt;?&gt; doCompile(String name, String source) throws Throwable { |
| </span></span><span style="display:flex;"><span> System.*out*.println(&#34;---&gt;write code:&#34; + name); |
| </span></span><span style="display:flex;"><span> Files.*write*(Paths.*get*(&#34;/tmp/sources/&#34; + name), source.getBytes()); |
| </span></span><span style="display:flex;"><span> ...... |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ul> |
| <li> |
| <p>Copy the exported code into dubbo-graalvm module |
| <img src="https://dubbo.apache.org/imgs/blog/dubbo-graalvm-support/graalvm.png" alt="graalvm.png"></p> |
| </li> |
| <li> |
| <p>Import module in new project</p> |
| </li> |
| </ul> |
| <p>pom dependency:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&lt;dependency&gt; |
| </span></span><span style="display:flex;"><span> &lt;groupId&gt;org.apache.dubbo&lt;/groupId&gt; |
| </span></span><span style="display:flex;"><span> &lt;artifactId&gt;dubbo-graalvm&lt;/artifactId&gt; |
| </span></span><span style="display:flex;"><span> &lt;version&gt;2.7.12-SNAPSHOT&lt;/version&gt; |
| </span></span><span style="display:flex;"><span>&lt;/dependency&gt; |
| </span></span></code></pre></div><p>(Note: dubbo that depends on this branch can directly add dependency. Other versions with new SPI added needs to update by exporting the source code.)</p> |
| <p>After importing dependencies, we can directly find classes using class names during the process of doCompiler without dynamically generating 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>@Override |
| </span></span><span style="display:flex;"><span>public Class&lt;?&gt; doCompile(String name, String sourceCode) throws Throwable { |
| </span></span><span style="display:flex;"><span> try { |
| </span></span><span style="display:flex;"><span> Class&lt;?&gt; res = Class.*forName*(name); |
| </span></span><span style="display:flex;"><span> return res; |
| </span></span><span style="display:flex;"><span> } catch (Throwable ex) { |
| </span></span><span style="display:flex;"><span> //ignore |
| </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>At this point, all dependencies required for native-image compilation are completed. Packaging can generate binary executable file.</p> |
| <h4 id="modifications-to-dubbo-source-code">Modifications to Dubbo Source Code</h4> |
| <p>Branch is named native_dubbo_0611 and modified based on tag version <a href="https://github.com/apache/dubbo/releases/tag/dubbo-2.7.12">dubbo-2.7.12</a>. Here we will explain the major modifications.</p> |
| <ul> |
| <li>Avoid dynamically generated code</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>//dubbo-common/src/main/java/org/apache/dubbo/common/compiler/support/JavassistCompiler.java |
| </span></span><span style="display:flex;"><span>@Override |
| </span></span><span style="display:flex;"><span>public Class&lt;?&gt; doCompile(String name, String source) throws Throwable { |
| </span></span><span style="display:flex;"><span> try { |
| </span></span><span style="display:flex;"><span> Class&lt;?&gt; res = Class.*forName*(name); |
| </span></span><span style="display:flex;"><span> return res; |
| </span></span><span style="display:flex;"><span> } catch (Throwable ex) { |
| </span></span><span style="display:flex;"><span> //ignore |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> CtClassBuilder builder = new CtClassBuilder(); |
| </span></span><span style="display:flex;"><span> builder.setClassName(name) |
| </span></span><span style="display:flex;"><span> //...... |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span>//dubbo-common/src/main/java/org/apache/dubbo/common/compiler/support/JdkCompiler.java |
| </span></span><span style="display:flex;"><span>@Override |
| </span></span><span style="display:flex;"><span>public Class&lt;?&gt; doCompile(String name, String sourceCode) throws Throwable { |
| </span></span><span style="display:flex;"><span> try { |
| </span></span><span style="display:flex;"><span> Class&lt;?&gt; res = Class.*forName*(name); |
| </span></span><span style="display:flex;"><span> return res; |
| </span></span><span style="display:flex;"><span> } catch (Throwable ex) { |
| </span></span><span style="display:flex;"><span> //ignore |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> int i = name.lastIndexOf(&#39;.&#39;); |
| </span></span><span style="display:flex;"><span> String packageName = i &lt; 0 ? &#34;&#34; : name.substring(0, i); |
| </span></span><span style="display:flex;"><span> //...... |
| </span></span></code></pre></div><p>Here we modified dubbo&rsquo;s both compilation methods. When compiling source code, first determine if the class, which is, in fact, the generated code in dubbo-graalvm that we imported, is loaded locally based on all class name reflection. The loaded class will be returned after importing the package. No compilation required.</p> |
| <ul> |
| <li>Substitute code generation in ExtensionLoader</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>//dubbo-common/src/main/java/org/apache/dubbo/common/extension/ExtensionLoader.java |
| </span></span><span style="display:flex;"><span>private Class&lt;?&gt; createAdaptiveExtensionClass() { |
| </span></span><span style="display:flex;"><span> try { |
| </span></span><span style="display:flex;"><span> Class c = Class.*forName*(generatePackageInfo() + &#34;.&#34; + type.getSimpleName() + &#34;$Adaptive&#34;); |
| </span></span><span style="display:flex;"><span> return c; |
| </span></span><span style="display:flex;"><span> } catch (Throwable e) { |
| </span></span><span style="display:flex;"><span> //ignore |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> String code = new AdaptiveClassCodeGenerator(type,cachedDefaultName).generate(); |
| </span></span><span style="display:flex;"><span> //...... |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span>private static final String *CODE_PACKAGE* = &#34;%s&#34;; |
| </span></span><span style="display:flex;"><span>private String generatePackageInfo() { |
| </span></span><span style="display:flex;"><span> return String.*format*(*CODE_PACKAGE*, type.getPackage().getName()); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>ExtensionLoader is the main logic class of the whole extension mechanism. Works such as loading configuration, extension class cache and generating self-adopting objects, are all done in the class.</p> |
| <p>getAdaptiveExtension() method automatically creates implementation class String for extension points interface.</p> |
| <p>Similar to the first modification mentioned above, since we imported the SPI package, code generation is no longer needed. Requesting local class based on class name will work. Return when the implementation class is found. Notice here that the generated extension class names all end with $Adaptive. When looking for classes, remember to add the suffix.</p> |
| <ul> |
| <li>Substitute Wrapper&rsquo;s usage in Reference/ServiceConfig</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>//dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ReferenceConfig.java |
| </span></span><span style="display:flex;"><span>// String[] methods = Wrapper.getWrapper(interfaceClass).getMethodNames(); |
| </span></span><span style="display:flex;"><span> String[] methods = Arrays.*stream*(interfaceClass.getMethods()).map(it-&gt;it.getName()).toArray(String[]::new); |
| </span></span><span style="display:flex;"><span> if (methods.length == 0) { |
| </span></span><span style="display:flex;"><span> l*ogger*.warn(&#34;No method found in service interface &#34; + interfaceClass.getName()); |
| </span></span><span style="display:flex;"><span> map.put(*METHODS_KEY*, *ANY_VALUE*); |
| </span></span><span style="display:flex;"><span> //...... |
| </span></span><span style="display:flex;"><span>} |
| </span></span><span style="display:flex;"><span>//dubbo-config/dubbo-config-api/src/main/java/org/apache/dubbo/config/ServiceConfig.java |
| </span></span><span style="display:flex;"><span>// String[] methods = Wrapper.getWrapper(interfaceClass).getMethodNames(); |
| </span></span><span style="display:flex;"><span> String[] methods = Arrays.*stream*(interfaceClass.getMethods()).map(it-&gt;it.getName()).toArray(String[]::new); |
| </span></span><span style="display:flex;"><span> if (methods.length == 0) { |
| </span></span><span style="display:flex;"><span> l*ogger*.warn(&#34;No method found in service interface &#34; + interfaceClass.getName()); |
| </span></span><span style="display:flex;"><span> map.put(*METHODS_KEY*, *ANY_VALUE*); |
| </span></span><span style="display:flex;"><span> //...... |
| </span></span></code></pre></div><p>Since Wrapper&rsquo;s getWrapper needs to be dynamically generated, here we substitute it by reflected getMethods.</p> |
| <ul> |
| <li>Add dubbo-graalvm module</li> |
| </ul> |
| <p>dubbo-graalvm&rsquo;s uses have been explained previously.</p> |
| <ul> |
| <li>Substitute fastjson by gson</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>//dubbo-registry/dubbo-registry-api/src/main/java/org/apache/dubbo/registry/client/metadata/store/InMemoryWritableMetadataService.java |
| </span></span><span style="display:flex;"><span>@Override |
| </span></span><span style="display:flex;"><span>public void publishServiceDefinition(URL providerUrl) { |
| </span></span><span style="display:flex;"><span> try { |
| </span></span><span style="display:flex;"><span> if (!ProtocolUtils.*isGeneric*(providerUrl.getParameter(*GENERIC_KEY*))) { |
| </span></span><span style="display:flex;"><span> String interfaceName = providerUrl.getParameter(*INTERFACE_KEY*); |
| </span></span><span style="display:flex;"><span> if (StringUtils.*isNotEmpty*(interfaceName)) { |
| </span></span><span style="display:flex;"><span> Class interfaceClass = Class.*forName*(interfaceName); |
| </span></span><span style="display:flex;"><span> ServiceDefinition serviceDefinition = ServiceDefinitionBuilder.*build*(interfaceClass); |
| </span></span><span style="display:flex;"><span> String data = new Gson().toJson(serviceDefinition); |
| </span></span><span style="display:flex;"><span> serviceDefinitions.put(providerUrl.getServiceKey(), data); |
| </span></span><span style="display:flex;"><span> return; |
| </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>cglib is used in fastjson for dynamic proxy, but native-image does not support cglib. So here we use gson instead.</p> |
| <ul> |
| <li>Substitute set by list for multiple interface proxy invoke</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span><span style="color:#719e07">//</span>dubbo<span style="color:#719e07">-</span>rpc<span style="color:#719e07">/</span>dubbo<span style="color:#719e07">-</span>rpc<span style="color:#719e07">-</span>api<span style="color:#719e07">/</span>src<span style="color:#719e07">/</span>main<span style="color:#719e07">/</span>java<span style="color:#719e07">/</span>org<span style="color:#719e07">/</span>apache<span style="color:#719e07">/</span>dubbo<span style="color:#719e07">/</span>rpc<span style="color:#719e07">/</span>proxy<span style="color:#719e07">/</span>AbstractProxyFactory<span style="color:#719e07">.</span>java |
| </span></span><span style="display:flex;"><span>@Override |
| </span></span><span style="display:flex;"><span>public <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> T getProxy(Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker, boolean generic) throws RpcException { |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>Class<span style="color:#719e07">&lt;</span>?<span style="color:#719e07">&gt;&gt;</span> interfaces <span style="color:#719e07">=</span> new ArrayList<span style="color:#719e07">&lt;&gt;</span>(); |
| </span></span><span style="display:flex;"><span> <span style="color:#cb4b16">String</span> config <span style="color:#719e07">=</span> invoker<span style="color:#719e07">.</span>getUrl()<span style="color:#719e07">.</span>getParameter(<span style="color:#719e07">*</span>INTERFACES<span style="color:#719e07">*</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (config <span style="color:#719e07">!=</span> null <span style="color:#719e07">&amp;&amp;</span> config<span style="color:#719e07">.</span>length() <span style="color:#719e07">&gt;</span> <span style="color:#2aa198">0</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#cb4b16">String</span>[] types <span style="color:#719e07">=</span> <span style="color:#719e07">*</span>COMMA_SPLIT_PATTERN<span style="color:#719e07">*.</span>split(config); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#cb4b16">String</span> type : types) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">//</span> <span style="color:#719e07">*</span>TODO can we <span style="color:#b58900">load</span> successfully <span style="color:#719e07">for</span> a different classloader?<span style="color:#719e07">.*</span> |
| </span></span><span style="display:flex;"><span> interfaces<span style="color:#719e07">.</span>add(ReflectUtils<span style="color:#719e07">.*</span>forName<span style="color:#719e07">*</span>(type)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">//......</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The service here has multiple interfaces which have to be in order when requesting proxy. Set does not fulfill the requirement so we use ArrayList instead.</p> |
| <p>Major modifications to dubbo source code are listed above.</p></description></item><item><title>Blog: Dubbo's Load Balance</title><link>https://dubbo.apache.org/en/blog/2018/08/10/dubbos-load-balance/</link><pubDate>Fri, 10 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/10/dubbos-load-balance/</guid><description> |
| <h2 id="background">Background</h2> |
| <p>Dubbo is a distributed service framework that avoids single point of failure and horizontal expansion of support services. A service typically deploys multiple instances. How to select a call from a cluster of multiple service providers involves a load balancing strategy.</p> |
| <h2 id="concepts">Concepts</h2> |
| <p>Before discussing load balancing, I will explain these three concepts first.</p> |
| <ol> |
| <li>Load Balancing</li> |
| <li>Fault-tolerant Cluster</li> |
| <li>Service Route</li> |
| </ol> |
| <p>These three concepts are confusing. They all describe how to choose from multiple Providers to make calls. So what is the difference between them? Let me give a simple example and explain these concepts clearly.</p> |
| <p>There is a Dubbo user service, 10 deployed in Beijing and 20 deployed in Shanghai. A service consumer in Hangzhou initiated a call and then the following steps executed:</p> |
| <ol> |
| <li>According to the configured routing rule, if the call is initiated by Hangzhou, it will be routed to the nearest 20 Providers in Shanghai.</li> |
| <li>According to the configured random load balancing strategy, one of the 20 Providers is randomly selected to be called, assuming that the 7th Provider is randomly selected.</li> |
| <li>As a result, calling the 7th Provider failed.</li> |
| <li>Retried other servers according to the configured Fault-tolerant Cluster mode.</li> |
| <li>The call to the 13th Provider was successful.</li> |
| </ol> |
| <p>Steps 1, 2, and 4 above correspond to routing, load balancing, and fault-tolerant cluster. In Dubbo, a subset is selected by routing from multiple Providers according to routing rules, then a Provider selected from the subset according to load balancing to make this call. If the call fails, Dubbo retry or schedule retransmission or fail-fast according to the Fault-tolerant Cluster policy. You can see the routes in Dubbo, load balancing and Fault-tolerant Cluster exectute at different stages of an RPC call. The first stage is routing, then load balancing, and finally cluster fault tolerance. This document only discusses load balancing, routing and cluster fault tolerance are described in other documents.</p> |
| <h2 id="dubbos-internal-load-balancing-strategy">Dubbo&rsquo;s Internal Load Balancing Strategy</h2> |
| <p>Dubbo has four Internal Load Balancing Strategies:</p> |
| <ol> |
| <li>RandomLoadBalance: Random load balancing. Choose a Provider randomly. It is Dubbo&rsquo;s default load balancing strategy.</li> |
| <li>Round Robin Load Balancing: Polling load balancing, then chooses one Provider.</li> |
| <li>LeastActiveLoadBalance: The minimum number of active calls, the random number of the same active number. The active number refers to the difference before and after the call. Make slow providers receive fewer requests, because the slower Provider before and after the difference of calls will be larger.</li> |
| <li>ConsistentHashLoadBalance: Consistent hash load balancing. Requests with the same parameters always fall on the same machine.</li> |
| </ol> |
| <h3 id="1-random-load-balancing">1. Random Load Balancing</h3> |
| <p>As the name implies, the random load balancing strategy is to select one from multiple Providers randomly. However, random load balancing in Dubbo has a weighting concept that sets the random probability according to the weight. For example, there are 10 Providers, it&rsquo;s not to say that the probability of each Provider is the same, but to assign the probability by combining the weights of these 10 providers.</p> |
| <p>In Dubbo, you can set weights on the Provider. For example, if the performance of the machine is better, you can set a larger weight. If the performance is poorer, you can set a smaller weight. Weights have an impact on load balancing. The weight of provider can be set in Dubbo Admin.</p> |
| <h4 id="weight-based-load-balancing-algorithm">Weight-based Load Balancing Algorithm</h4> |
| <p>The stochastic strategy will determine whether the weights of all the invokers are the same at first. If they are all the same, then the processing is relatively simple. Using <code>random.nexInt(length)</code>, you can randomly generate an invoker serial number, and select the corresponding invoker according to the serial number. If the service provider not set weight in Dubbo Admin, then all the invokers have the same weight, the default is 100. If the weights are different, then you need to combine the weights to set the random probability. The algorithm is probably as follows: If there are 4 invokers</p> |
| <table> |
| <thead> |
| <tr> |
| <th>Invoker</th> |
| <th>Weight</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>A</td> |
| <td>10</td> |
| </tr> |
| <tr> |
| <td>B</td> |
| <td>20</td> |
| </tr> |
| <tr> |
| <td>C</td> |
| <td>20</td> |
| </tr> |
| <tr> |
| <td>D</td> |
| <td>30</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>The total weight of A, B, C and D is 10 + 20 + 20 + 30 = 80. Spread 80 numbers in the following diagram:</p> |
| <div class="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>+-----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>| | | | | |
| </span></span><span style="display:flex;"><span>+-----------------------------------------------------------------------------------+ |
| </span></span><span style="display:flex;"><span>1 10 30 50 80 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>|-----A----|---------B----------|----------C---------|---------------D--------------| |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>---------------------15 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>-------------------------------------------37 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>-----------------------------------------------------------54 |
| </span></span></code></pre></div><p>There are four areas in the above picture, and the lengths are the weights of A, B, C and D, respectively. Use <code>random.nextInt(10 + 20 + 20 + 30)</code> to randomly select one of the 80 numbers. Then determine which area the number is distributed in. For example, if random to 37, 37 is distributed in the C region, then select inboker C. 15 is in the B area, 54 is in the D area.</p> |
| <h4 id="random-load-balancing-source-code">Random load balancing Source code</h4> |
| <p>Below is the source code for random load balancing. For ease of reading and understanding, I removed the extraneous parts.</p> |
| <div class="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>public <span style="color:#719e07">class</span> RandomLoadBalance <span style="color:#719e07">extends</span> AbstractLoadBalance { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> private final Random random <span style="color:#719e07">=</span> new Random(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> protected <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> doSelect(List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers, URL url, Invocation invocation) { |
| </span></span><span style="display:flex;"><span> <span style="color:#cb4b16">int</span> length <span style="color:#719e07">=</span> invokers<span style="color:#719e07">.</span>size(); <span style="color:#719e07">//</span> total invoker |
| </span></span><span style="display:flex;"><span> <span style="color:#cb4b16">int</span> totalWeight <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span>; <span style="color:#719e07">//</span> Sum of invokers<span style="color:#2aa198">&#39; weights</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">//</span> Determine <span style="color:#719e07">if</span> all the invokers have the same weight |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">//</span> If the weights are the same, it is simple to generate an index directly from Random<span style="color:#719e07">.</span> |
| </span></span><span style="display:flex;"><span> boolean sameWeight <span style="color:#719e07">=</span> <span style="color:#268bd2">true</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#cb4b16">int</span> i <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span>; i <span style="color:#719e07">&lt;</span> length; i<span style="color:#719e07">++</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#cb4b16">int</span> weight <span style="color:#719e07">=</span> getWeight(invokers<span style="color:#719e07">.</span>get(i), invocation); |
| </span></span><span style="display:flex;"><span> totalWeight <span style="color:#719e07">+=</span> weight; <span style="color:#719e07">//</span> Sum |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (sameWeight <span style="color:#719e07">&amp;&amp;</span> i <span style="color:#719e07">&gt;</span> <span style="color:#2aa198">0</span> <span style="color:#719e07">&amp;&amp;</span> weight <span style="color:#719e07">!=</span> getWeight(invokers<span style="color:#719e07">.</span>get(i <span style="color:#719e07">-</span> <span style="color:#2aa198">1</span>), invocation)) { |
| </span></span><span style="display:flex;"><span> sameWeight <span style="color:#719e07">=</span> <span style="color:#268bd2">false</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (totalWeight <span style="color:#719e07">&gt;</span> <span style="color:#2aa198">0</span> <span style="color:#719e07">&amp;&amp;</span> <span style="color:#719e07">!</span>sameWeight) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">//</span> If <span style="color:#719e07">not</span> all of the invoker weights are the same, <span style="color:#b58900">load</span> balancer will randomly choose invoker based on its weight<span style="color:#719e07">.</span> The greater the weight, the greater the probability of being selected |
| </span></span><span style="display:flex;"><span> <span style="color:#cb4b16">int</span> offset <span style="color:#719e07">=</span> random<span style="color:#719e07">.</span>nextInt(totalWeight); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#cb4b16">int</span> i <span style="color:#719e07">=</span> <span style="color:#2aa198">0</span>; i <span style="color:#719e07">&lt;</span> length; i<span style="color:#719e07">++</span>) { |
| </span></span><span style="display:flex;"><span> offset <span style="color:#719e07">-=</span> getWeight(invokers<span style="color:#719e07">.</span>get(i), invocation); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (offset <span style="color:#719e07">&lt;</span> <span style="color:#2aa198">0</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invokers<span style="color:#719e07">.</span>get(i); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">//</span> If all invokers have the same weight |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invokers<span style="color:#719e07">.</span>get(random<span style="color:#719e07">.</span>nextInt(length)); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="2-round-robin-load-balancing">2. Round Robin Load Balancing</h3> |
| <p>Round Robin Load Balancing, is to call all Providers in turn. As with random load balancing strategies, Round Robin Load Balancing policies also has a weighting concept. The Round Robin Load Balancing algorithm allows RPC calls to be allocated exactly as we set. Whether it is a small or large number of calls. However, there are also some shortcomings in the Round Robin Load Balancing algorithm. There is a problem that the slow provider accumulates the request. For example, the second machine is slow, but it is not crashed. When the request is transferred to the second machine, it is stuck. Over time, all The request get stuck on the second machine, causing the entire system to slow down.</p> |
| <h3 id="3-minimum-active-call-load-balancing">3. Minimum Active Call Load Balancing</h3> |
| <p>Official explanation:</p> |
| <blockquote> |
| <p>The active number refers to the difference between the counts before and after the call. Select the machine with the minimum number of active calls or choose a random one among machines with the same active number, so that the slower machine can receives less requests.</p> |
| </blockquote> |
| <p>This explanation seems to be ambigious. We know the purpose is to ensure the slower machine receive less requests, but it is not clear how to achieve it. An example is here: each service maintains an active number counter. When A machine starts processing the request, the counter is incremented by 1. At this time, A is still processing. If the processing is completed, the counter is decremented by 1. B machine processes very quickly after receiving the request. Then the active numbers of A and B are 1,0 respectively. When a new request is generated, the B machine is selected for execution (as B has the minimum active number), so that the slower machine A receives fewer requests.</p> |
| <p>When processing a new request, Consumer will check the active number of all Providers. If there is only one Invoker with the minimum active number, the Invoker is returned directly.</p> |
| <div class="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>if (leastCount == 1) { |
| </span></span><span style="display:flex;"><span> // if there is only one minimum value then return directly |
| </span></span><span style="display:flex;"><span> return invokers.get(leastIndexs[0]); |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>If there are multiple Invokers with the minimum active number, plus the weights are not equal and the total weight is greater than 0, then generate a random weight ranging from 0 to totalWeight. Finally, the Invoker is selected based on the randomly generated weights.</p> |
| <div class="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>if (! sameWeight &amp;&amp; totalWeight &gt; 0) { |
| </span></span><span style="display:flex;"><span> // if the weights are not equal and the toatl weight is greater than 0 then choose randomly according to total weight |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> int offsetWeight = random.nextInt(totalWeight); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> // and determine which segment the random value falls on. |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> for (int i = 0; i &lt; leastCount; i++) { |
| </span></span><span style="display:flex;"><span> int leastIndex = leastIndexs[i]; |
| </span></span><span style="display:flex;"><span> offsetWeight -= getWeight(invokers.get(leastIndex), invocation); |
| </span></span><span style="display:flex;"><span> if (offsetWeight &lt;= 0) |
| </span></span><span style="display:flex;"><span> return invokers.get(leastIndex); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="4-consistent-hash-algorithm">4. Consistent Hash Algorithm</h3> |
| <p>Use consistent hash algorithm to ensure that requests with same parameters are always sent to the same Provider. When a Provider crashes, requests originally sent to the Provider is spread evenly to other Providers based on the virtual node without causing drastic changes. The algorithm can be seen at: <a href="http://en.wikipedia.org/wiki/Consistent_hashing">http://en.wikipedia.org/wiki/Consistent_hashing</a></p> |
| <p>By default, only the first parameter is hashed. Configure if you would like to modify it:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&lt;dubbo:parameter key=&#34;hash.arguments&#34; value=&#34;0,1&#34; /&gt; |
| </span></span></code></pre></div><p>By default, 160 virtual nodes are used. Configure if you would like to modify it:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&lt;dubbo:parameter key=&#34;hash.nodes&#34; value=&#34;320&#34; /&gt; |
| </span></span></code></pre></div><p>Consistent hash algorithms can be used in conjunction with caching mechanisms. For example, there is a service getUserInfo(String userId). After the hash algorithm is set, the same userId call is sent to the same Provider. This Provider can cache user data in memory, reducing the number of accesses to the database or distributed cache. If this part of the data is allowed to be inconsistent for some time, this approach can be considered. The number of dependencies and accesses to middleware such as databases, caches, etc. and network IO operations is reduced, while the system performance is improved.</p> |
| <h2 id="load-balancing-configuration">Load Balancing Configuration</h2> |
| <p>If load balancing is not specified, random load balancing is used by default. Load balancing can also be explicitly specified based on our needs. Load balancing can be configured in multiple local classes, such as Provider Side, Consumer Side, Service Level, and Method Level.</p> |
| <h3 id="server-side-service-level">Server Side Service Level</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span><span style="color:#719e07">&lt;</span>dubbo:service interface<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span> loadbalance<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;roundrobin&#34;</span> <span style="color:#719e07">/&gt;</span> |
| </span></span></code></pre></div><p>All methods of the service use roundrobin load balancing.</p> |
| <h3 id="client-side-service-level">Client Side Service Level</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span><span style="color:#719e07">&lt;</span>dubbo:reference interface<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span> loadbalance<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;roundrobin&#34;</span> <span style="color:#719e07">/&gt;</span> |
| </span></span></code></pre></div><p>All methods of the service use roundrobin load balancing.</p> |
| <h3 id="server-side-method-level">Server Side Method Level</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span><span style="color:#719e07">&lt;</span>dubbo:service interface<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span><span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>dubbo:method name<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;hello&#34;</span> loadbalance<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;roundrobin&#34;</span><span style="color:#719e07">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">&lt;/</span>dubbo:service<span style="color:#719e07">&gt;</span> |
| </span></span></code></pre></div><p>Only the hello method of the service uses roundrobin load balancing.</p> |
| <h3 id="client-side-method-level">Client Side Method Level</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span><span style="color:#719e07">&lt;</span>dubbo:reference interface<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;...&#34;</span><span style="color:#719e07">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>dubbo:method name<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;hello&#34;</span> loadbalance<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;roundrobin&#34;</span><span style="color:#719e07">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">&lt;/</span>dubbo:reference<span style="color:#719e07">&gt;</span> |
| </span></span></code></pre></div><p>Only the hello method of the service uses roundrobin load balancing.</p> |
| <p>Similar to other Dubbo configurations, multiple configurations are covered:</p> |
| <ol> |
| <li>The method level takes precedence, the interface level is next, and the global configuration comes last.</li> |
| <li>If the level is the same, the Consumer is given priority and the Provider is next</li> |
| </ol> |
| <p>Therefore, the priority of the above four configurations is:</p> |
| <ol> |
| <li>Client side method level configuration.</li> |
| <li>Client side interface level configuration.</li> |
| <li>Server side method level configuration.</li> |
| <li>Server side interface level configuration.</li> |
| </ol> |
| <h2 id="extended-load-balancing">Extended Load Balancing</h2> |
| <p>Four load balancing implementations of Dubbo meet the requirements in most cases. Sometimes, we may need to implement our own load balancing strategy because of the needs of the business. This chapter only explains how to configure the load balancing algorithm. For more on the Dubbo extension mechanism, go to the Dubbo extension mechanism practice.</p> |
| <ol> |
| <li>Implementing the LoadBalance interface</li> |
| </ol> |
| <p>The following is Dubbo&rsquo;s LoadBalance interface:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span>@SPI(RandomLoadBalance<span style="color:#719e07">.</span>NAME) |
| </span></span><span style="display:flex;"><span>public interface LoadBalance { |
| </span></span><span style="display:flex;"><span> @Adaptive(<span style="color:#2aa198">&#34;loadbalance&#34;</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> select(List<span style="color:#719e07">&lt;</span>Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;&gt;</span> invokers, URL url, Invocation invocation) throws RpcException; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>This is the interface of the SPI. The parameters of the select method are as follows:</p> |
| <ul> |
| <li>invokers: A list of all service Providers.</li> |
| <li>url: Some configuration information, such as interface name, check or not, serialization.</li> |
| <li>invocation: Information called by the RPC, including the method name, method parameter type, and method parameters. Here is a LoadBalance implemented by us. The implementation is very simple - Choose the first Invoker:</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-go" data-lang="go"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.demo.dubbo; |
| </span></span><span style="display:flex;"><span>public class DemoLoadBalance implements LoadBalance { |
| </span></span><span style="display:flex;"><span> @Override |
| </span></span><span style="display:flex;"><span> public &lt;T&gt; Invoker&lt;T&gt; <span style="color:#719e07">select</span>(List&lt;Invoker&lt;T<span style="color:#719e07">&gt;&gt;</span> invokers, URL url, Invocation invocation) throws RpcException { |
| </span></span><span style="display:flex;"><span> System.out.<span style="color:#b58900">println</span>(<span style="color:#2aa198">&#34;[DemoLoadBalance]Select the first invoker...&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invokers.<span style="color:#268bd2">get</span>(<span style="color:#2aa198">0</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="2"> |
| <li>Add a resource file</li> |
| </ol> |
| <p>Add a file: |
| <code>src/main/resource/META-INF/dubbo/com.alibaba.dubbo.rpc.cluster.LoadBalance</code> |
| This is a simple text file. The file contents are as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>demo=my=com.demo.dubbo.DemoLoadBalance |
| </span></span></code></pre></div><ol start="3"> |
| <li>Configure to use custom LoadBalance</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-gdscript3" data-lang="gdscript3"><span style="display:flex;"><span><span style="color:#719e07">&lt;</span>dubbo:reference id<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;helloService&#34;</span> interface<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;com.demo.dubbo.api.IHelloService&#34;</span> loadbalance<span style="color:#719e07">=</span><span style="color:#2aa198">&#34;demo&#34;</span> <span style="color:#719e07">/&gt;</span> |
| </span></span></code></pre></div><p>Configure <code>&lt;loadbalance=&quot;demo&quot;&gt;</code> in <code>dubbo:reference</code> at the Consumer side.</p> |
| <p>After 3 steps above, we wrote a custom LoadBalance and told Dubbo to use it. Start Dubbo and we can see that Dubbo has used a custom DemoLoadBalance.</p></description></item><item><title>Blog: Use Annotations In Dubbo</title><link>https://dubbo.apache.org/en/blog/2018/08/07/use-annotations-in-dubbo/</link><pubDate>Tue, 07 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/07/use-annotations-in-dubbo/</guid><description> |
| <p>With the widely promotion and implementation of Microservices Architecture, the Microservices Architecture represented by Spring Boot and Spring Cloud, in Java ecosystem, introduced some brand new programming model, like:</p> |
| <ul> |
| <li>Annotation-Driven</li> |
| <li>External Configuration</li> |
| <li>Auto-Configure</li> |
| </ul> |
| <p>New programming model have some advantages, for example, it does not require <code>XML</code> configuration, it can simplify deployment process, beyond that，it can promote development efficiency. In order to implement the microservice architecture better，Dubbo has provided more perfect support for the above three scenarios since version 2.5.8. This article focuses on introduce annotations rather than discuss the traditional XML configuration approach. There are two kinds of automatic assembly, external configuration and automatic assembly, will be introduced in another aricle.</p> |
| <h2 id="introduce-annotations">Introduce Annotations</h2> |
| <h3 id="enabledubbo">@EnableDubbo</h3> |
| <p>The annotations of <code>@EnableDubbo</code> is a combination of both <code>@EnableDubboConfig</code> and <code>@DubboComponentScan</code>.Related to the annotation driver is <code>@DubboComponentScan</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.config.spring.context.annotation; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubboConfig</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@DubboComponentScan</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">@interface</span> EnableDubbo { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Base packages to scan for annotated @Service classes. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * &lt;p&gt; |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Use {@link #scanBasePackageClasses()} for a type-safe alternative to String-based |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * package names. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return the base packages to scan |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @see DubboComponentScan#basePackages() |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@AliasFor</span>(annotation <span style="color:#719e07">=</span> DubboComponentScan.class, attribute <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;basePackages&#34;</span>) |
| </span></span><span style="display:flex;"><span> String<span style="color:#719e07">[]</span> <span style="color:#268bd2">scanBasePackages</span>() <span style="color:#719e07">default</span> {}; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Type-safe alternative to {@link #scanBasePackages()} for specifying the packages to |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * scan for annotated @Service classes. The package of each class specified will be |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * scanned. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return classes from the base packages to scan |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @see DubboComponentScan#basePackageClasses |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@AliasFor</span>(annotation <span style="color:#719e07">=</span> DubboComponentScan.class, attribute <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;basePackageClasses&#34;</span>) |
| </span></span><span style="display:flex;"><span> Class<span style="color:#719e07">&lt;?&gt;[]</span> scanBasePackageClasses() <span style="color:#719e07">default</span> {}; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>The <code>@bableDubbo</code> can be used to scan Dubbo&rsquo;s service provider (marked by <code>@Service</code>) and Dubbo&rsquo;s service consumer (marked by <code>Reference</code>) under the specified package name (via <code>scanBasePackages</code>) or in the specified class (via <code>scanBasePackageClasses</code>). After Dubbo&rsquo;s service providers and consumers have been scanned, they have been assembled corresponding and been initialized, and finally the service is exposed or referenced, if you do not use <code>External Configuration</code>, you can use <code>@DubboComponentScan</code> directly.</p> |
| <h3 id="service">@Service</h3> |
| <p><code>@service</code> is used to configure Dubbo&rsquo;s Service provider,for example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Service</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AnnotatedGreetingService</span> <span style="color:#268bd2">implements</span> GreetingService { |
| </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>Via <code>@Service</code>&rsquo;s properties, you can customize Dubbo&rsquo;s Service 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-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.config.annotation; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Documented</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Retention</span>(RetentionPolicy.RUNTIME) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Target</span>({ElementType.TYPE}) <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Inherited</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">@interface</span> Service { |
| </span></span><span style="display:flex;"><span> Class<span style="color:#719e07">&lt;?&gt;</span> interfaceClass() <span style="color:#719e07">default</span> <span style="color:#dc322f">void</span>.class; <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">interfaceName</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">version</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #4</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">group</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #5</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">boolean</span> <span style="color:#268bd2">export</span>() <span style="color:#719e07">default</span> <span style="color:#cb4b16">true</span>; <span style="color:#586e75">// #6</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">boolean</span> <span style="color:#268bd2">register</span>() <span style="color:#719e07">default</span> <span style="color:#cb4b16">true</span>; <span style="color:#586e75">// #7</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">application</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #8</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">module</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #9</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">provider</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #10</span> |
| </span></span><span style="display:flex;"><span> String<span style="color:#719e07">[]</span> <span style="color:#268bd2">protocol</span>() <span style="color:#719e07">default</span> {}; <span style="color:#586e75">// #11</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">monitor</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #12</span> |
| </span></span><span style="display:flex;"><span> String<span style="color:#719e07">[]</span> <span style="color:#268bd2">registry</span>() <span style="color:#719e07">default</span> {}; <span style="color:#586e75">// #13</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Which is more important:</p> |
| <ol> |
| <li><strong>@Service</strong>: Can only be defined on a class, represent a service</li> |
| <li><strong>interfaceClass</strong>: specified <code>interface</code>&rsquo;s class implemented by the service provider</li> |
| <li><strong>interfaceName</strong>: specified <code>interface</code>&rsquo;s class name implemented by the service provider</li> |
| <li><strong>version</strong>: specified the version number of the service</li> |
| <li><strong>group</strong>:specified the group of services</li> |
| <li><strong>export</strong>:whether to expose service</li> |
| <li><strong>registry</strong>:Whether to register service to the registry</li> |
| <li><strong>application</strong>:application configuration</li> |
| <li><strong>module</strong>:module configuration</li> |
| <li><strong>provider</strong>:service provider configuration</li> |
| <li><strong>protocol</strong>:protocol configuration</li> |
| <li><strong>monitor</strong>:monitoring center configuration</li> |
| <li><strong>registr</strong>:registry configuration</li> |
| </ol> |
| <p>In addition, it should be noted that, <code>application</code>, <code>module</code>, <code>provider</code>, <code>protocol</code>, <code>monitor</code>, <code>registry</code> (from 8 to 13) need to provide the name of the corresponding <code>spring bean</code>,These bean assembly completed either through traditional XML configuration,or by the modern Java Config. This article will show you how to use <code>Java Config</code>.</p> |
| <h3 id="reference">@Reference</h3> |
| <p><code>@Reference</code> is used to configure Dubbo&rsquo;s Service consumer,for example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><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">GreetingServiceConsumer</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Reference</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> GreetingService greetingService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">doSayHello</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> greetingService.sayHello(name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Via <code>@Reference</code>&rsquo;s properties, you can customize Dubbo&rsquo;s Service consumer:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span><span style="color:#719e07">package</span> org.apache.dubbo.config.annotation; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Documented</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Retention</span>(RetentionPolicy.RUNTIME) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Target</span>({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE}) <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">@interface</span> Reference { |
| </span></span><span style="display:flex;"><span> Class<span style="color:#719e07">&lt;?&gt;</span> interfaceClass() <span style="color:#719e07">default</span> <span style="color:#dc322f">void</span>.class; <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">interfaceName</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">version</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #4</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">group</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #5</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">url</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #6</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">application</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #7</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">module</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #8</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">consumer</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #9</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">protocol</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #10</span> |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">monitor</span>() <span style="color:#719e07">default</span> <span style="color:#2aa198">&#34;&#34;</span>; <span style="color:#586e75">// #11</span> |
| </span></span><span style="display:flex;"><span> String<span style="color:#719e07">[]</span> <span style="color:#268bd2">registry</span>() <span style="color:#719e07">default</span> {}; <span style="color:#586e75">// #12</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Which is more important:</p> |
| <ol> |
| <li><strong>@Reference</strong>:you can define it on a field in a class, you can define it on a method, you can even modify another annotation, it represent a reference to a service.Normally <code>@Reference</code> is defined in one field</li> |
| <li><strong>interfaceClass</strong> : specified <code>interface</code>&rsquo;s class implemented by the service provider</li> |
| <li><strong>interfaceName</strong>: specified <code>interface</code>&rsquo;s class name implemented by the service provider</li> |
| <li><strong>version</strong>: specified the version number of the service</li> |
| <li><strong>group</strong>:pecified the group of services</li> |
| <li><strong>url</strong>: invoking the registry directly by specifying the URL of the service provider</li> |
| <li><strong>application</strong>:application configuration</li> |
| <li><strong>module</strong>:module configuration</li> |
| <li><strong>consumer</strong>:service consumer configuration</li> |
| <li><strong>protocol</strong>:protocol configuration</li> |
| <li><strong>monitor</strong>:monitoring center configuration</li> |
| <li><strong>registr</strong>:registry configuration</li> |
| </ol> |
| <p>In addition, it should be noted that, <code>application</code>, <code>module</code>, <code>consumer</code>, <code>protocol</code>, <code>monitor</code>, <code>registry</code> (from 7 to 12) need to provide the name of the corresponding <code>spring bean</code>,These bean assembly completed either through traditional XML configuration,or by the modern Java Config. This article will show you how to use <code>Java Config</code>.</p> |
| <h2 id="example-practice">Example practice</h2> |
| <p>After learn what <code>@EnableDubbo</code>, <code>@Service</code>, <code>@Reference</code> is, there is a practical example showing how to use the annotation to develop a Dubbo application.The following code can be found at <a href="https://github.com/dubbo/dubbo-samples/tree/master/1-basic/dubbo-samples-annotation">https://github.com/dubbo/dubbo-samples/tree/master/1-basic/dubbo-samples-annotation</a></p> |
| <h3 id="1interface-definition">1.Interface Definition</h3> |
| <p>Define a simple <code>GreetingService</code> interface with only a simple method <code>sayHello</code> to the caller.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GreetingService</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><h3 id="2serverservice-implementation">2.Server:Service Implementation</h3> |
| <p>Implement the <code>GreetingService</code> interface, and mark it as a service for Dubbo via @Service.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span><span style="color:#268bd2">@Service</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AnnotatedGreetingService</span> <span style="color:#268bd2">implements</span> GreetingService { |
| </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><h3 id="3serverassembly-service-provider">3.Server:Assembly Service Provider</h3> |
| <p>You can discover, assemble, and provide Dubbo&rsquo;s services through the Java config technology (@Configuration) and annotation scan (@EnableDubbo) in Spring.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span><span style="color:#268bd2">@Configuration</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span>(scanBasePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.impl&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">static</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderConfiguration</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Bean</span> <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ProviderConfig <span style="color:#268bd2">providerConfig</span>() { |
| </span></span><span style="display:flex;"><span> ProviderConfig providerConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProviderConfig(); |
| </span></span><span style="display:flex;"><span> providerConfig.setTimeout(1000); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> providerConfig; |
| </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">@Bean</span> <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ApplicationConfig <span style="color:#268bd2">applicationConfig</span>() { |
| </span></span><span style="display:flex;"><span> ApplicationConfig applicationConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span> applicationConfig.setName(<span style="color:#2aa198">&#34;dubbo-annotation-provider&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> applicationConfig; |
| </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">@Bean</span> <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> RegistryConfig <span style="color:#268bd2">registryConfig</span>() { |
| </span></span><span style="display:flex;"><span> RegistryConfig registryConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig(); |
| </span></span><span style="display:flex;"><span> registryConfig.setProtocol(<span style="color:#2aa198">&#34;zookeeper&#34;</span>); |
| </span></span><span style="display:flex;"><span> registryConfig.setAddress(<span style="color:#2aa198">&#34;localhost&#34;</span>); |
| </span></span><span style="display:flex;"><span> registryConfig.setPort(2181); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> registryConfig; |
| </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">@Bean</span> <span style="color:#586e75">// #4</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ProtocolConfig <span style="color:#268bd2">protocolConfig</span>() { |
| </span></span><span style="display:flex;"><span> ProtocolConfig protocolConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ProtocolConfig(); |
| </span></span><span style="display:flex;"><span> protocolConfig.setName(<span style="color:#2aa198">&#34;dubbo&#34;</span>); |
| </span></span><span style="display:flex;"><span> protocolConfig.setPort(20880); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> protocolConfig; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Description：</p> |
| <ul> |
| <li>Scan all classes marked with <code>@Service</code> under <code>com.alibaba.dubbo.samples.impl</code> with <code>@EnableDubbo</code></li> |
| <li>Via @Configuration, all @Beans in the ProviderConfiguration are assembled using the way of <code>Java Config</code> and then injected into the Dubbo service, which means the class marked with <code>@Service</code>.Which included: |
| i. <strong>ProviderConfig</strong>:Service provider configuration |
| ii. <strong>ApplicationConfig</strong>:Application configuration |
| iii.<strong>RegistryConfig</strong>:registry configuration |
| iv. <strong>ProtocolConfig</strong>:Protocol configuration</li> |
| </ul> |
| <h3 id="4serverstart-service">4.Server:Start Service</h3> |
| <p>In the <code>main</code> method to provide external <code>Dubbo</code> service by starting a <code>Spring Context</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:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderBootstrap</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> Exception { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">new</span> EmbeddedZooKeeper(2181, <span style="color:#cb4b16">false</span>).start(); <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span> AnnotationConfigApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AnnotationConfigApplicationContext(ProviderConfiguration.class); <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> context.start(); <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> System.in.read(); <span style="color:#586e75">// #4</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Description：</p> |
| <ol> |
| <li>Start an embedded <code>zookeeper</code> and provide service registry on port <code>2181</code></li> |
| <li>Initialize an example of an AnnotationConfigApplicationContext and pass the <code>ProviderConfiguration</code> into the example to complete the automatic discovery and assembly of the <code>Dubbo</code> service.</li> |
| <li>Start the <code>Spring Context</code> and start providing external <code>Dubbo</code> services.</li> |
| <li>Because it is a server, you need to prevent the process exit by blocking the main thread.</li> |
| </ol> |
| <p>Start the <code>main</code> method of the server, you will see the following output, on behalf of the server startup success, and registered the <code>GreetingService</code> service in the <code>ZookeeperRegistry</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-sh" data-lang="sh"><span style="display:flex;"><span><span style="color:#719e07">[</span>01/08/18 02:12:51:051 CST<span style="color:#719e07">]</span> main INFO transport.AbstractServer: <span style="color:#719e07">[</span>DUBBO<span style="color:#719e07">]</span> Start NettyServer <span style="color:#b58900">bind</span> /0.0.0.0:20880, <span style="color:#b58900">export</span> /192.168.99.1:20880, dubbo version: 2.6.2, current host: 192.168.99.1 |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>01/08/18 02:12:51:051 CST<span style="color:#719e07">]</span> main INFO zookeeper.ZookeeperRegistry: <span style="color:#719e07">[</span>DUBBO<span style="color:#719e07">]</span> Register: dubbo://192.168.99.1:20880/com.alibaba.dubbo.samples.api.GreetingService?anyhost<span style="color:#719e07">=</span>true&amp;<span style="color:#268bd2">application</span><span style="color:#719e07">=</span>dubbo-annotation-provider&amp;default.timeout<span style="color:#719e07">=</span>1000&amp;<span style="color:#268bd2">dubbo</span><span style="color:#719e07">=</span>2.6.2&amp;<span style="color:#268bd2">generic</span><span style="color:#719e07">=</span>false&amp;<span style="color:#268bd2">interface</span><span style="color:#719e07">=</span>com.alibaba.dubbo.samples.api |
| </span></span></code></pre></div><h3 id="5serverreference-service">5.Server:Reference Service</h3> |
| <p>Marking the member variable of the <code>GreetingService</code> via <code>@Reference</code> .The <code>greetingService</code> is a reference to the <code>Dubbo</code> service, which means that it can simply provide through the interface to the remote party to initiate service calls, and the client does not implement <code>GreetingService</code> interface.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span><span style="color:#268bd2">@Component</span>(<span style="color:#2aa198">&#34;annotatedConsumer&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">GreetingServiceConsumer</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Reference</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> GreetingService greetingService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">doSayHello</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> greetingService.sayHello(name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h3 id="6serverassembly-service-consumer">6.Server:Assembly Service consumer</h3> |
| <p>Just like <strong>3. Server:Assembly Service Provider</strong> You can discover, assemble, and provide Dubbo&rsquo;s service consumer through the Java config technology (@Configuration) and annotation scan (@EnableDubbo) in Spring.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span><span style="color:#268bd2">@Configuration</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span>(scanBasePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.action&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@ComponentScan</span>(value <span style="color:#719e07">=</span> {<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.action&#34;</span>}) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">static</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ConsumerConfiguration</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Bean</span> <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ApplicationConfig <span style="color:#268bd2">applicationConfig</span>() { |
| </span></span><span style="display:flex;"><span> ApplicationConfig applicationConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ApplicationConfig(); |
| </span></span><span style="display:flex;"><span> applicationConfig.setName(<span style="color:#2aa198">&#34;dubbo-annotation-consumer&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> applicationConfig; |
| </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">@Bean</span> <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> ConsumerConfig <span style="color:#268bd2">consumerConfig</span>() { |
| </span></span><span style="display:flex;"><span> ConsumerConfig consumerConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConsumerConfig(); |
| </span></span><span style="display:flex;"><span> consumerConfig.setTimeout(3000); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> consumerConfig; |
| </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">@Bean</span> <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> RegistryConfig <span style="color:#268bd2">registryConfig</span>() { |
| </span></span><span style="display:flex;"><span> RegistryConfig registryConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> RegistryConfig(); |
| </span></span><span style="display:flex;"><span> registryConfig.setProtocol(<span style="color:#2aa198">&#34;zookeeper&#34;</span>); |
| </span></span><span style="display:flex;"><span> registryConfig.setAddress(<span style="color:#2aa198">&#34;localhost&#34;</span>); |
| </span></span><span style="display:flex;"><span> registryConfig.setPort(2181); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> registryConfig; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Description：</p> |
| <ul> |
| <li>Scan all classes marked with <code>@Service</code> under <code>com.alibaba.dubbo.samples.impl</code> with <code>@Reference</code></li> |
| <li>Via @Configuration, all @Beans in the ProviderConfiguration are assembled using the way of <code>Java Config</code> and then injected into the Dubbo service, which means the class marked with <code>@Reference</code>.Which included: |
| i. <code>ApplicationConfig</code>: Application configuration |
| ii. <code>ConsumerConfig</code>:Service consumer configuration |
| iii.<code>RegistryConfig</code>:Registry configuration.Note:The configuration here needs to be consistent with the configuration information of the EmbeddedZooKeeper when started by the service provider.</li> |
| </ul> |
| <h3 id="7server-initiate-remote-calls">7.Server: Initiate Remote Calls</h3> |
| <p>In the <code>main</code> method, you can start a <code>Spring Context</code> to find the service consumer of the assembled <code>Dubbo</code> from it, and initiate a remote call.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-Java" data-lang="Java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ConsumerBootstrap</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> AnnotationConfigApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AnnotationConfigApplicationContext(ConsumerConfiguration.class); <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span> context.start(); <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> GreetingServiceConsumer greetingServiceConsumer <span style="color:#719e07">=</span> context.getBean(GreetingServiceConsumer.class); <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> String hello <span style="color:#719e07">=</span> greetingServiceConsumer.doSayHello(<span style="color:#2aa198">&#34;annotation&#34;</span>); <span style="color:#586e75">// #4</span> |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;result: &#34;</span> <span style="color:#719e07">+</span> hello); <span style="color:#586e75">// #5</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Description：</p> |
| <ul> |
| <li>Initialize an example of an AnnotationConfigApplicationContext and pass the <code>ProviderConfiguration</code> into the example to complete the automatic discovery and assembly of the <code>Dubbo</code> service consumer.</li> |
| <li>start <code>Spring Context</code>.</li> |
| <li>Find <code>bean</code> which type is <code>GreetingServiceConsumer</code> from <code>Context</code>.</li> |
| <li>Call the <code>doSayHello</code> method and finally initiate a remote call via Dubbo&rsquo;s service reference (marked by @Reference)</li> |
| <li>Print call result |
| Start the Server&rsquo;s <code>main</code> method, you will see the following output, which returns the <code>result</code>: hello, annotation:</li> |
| </ul> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span><span style="color:#719e07">[</span>01/08/18 02:38:40:040 CST<span style="color:#719e07">]</span> main INFO config.AbstractConfig: <span style="color:#719e07">[</span>DUBBO<span style="color:#719e07">]</span> Refer dubbo service com.alibaba.dubbo.samples.api.GreetingService from url zookeeper://localhost:2181/com.alibaba.dubbo.registry.RegistryService?anyhost<span style="color:#719e07">=</span>true&amp;<span style="color:#268bd2">application</span><span style="color:#719e07">=</span>dubbo-annotation-consumer&amp;<span style="color:#268bd2">check</span><span style="color:#719e07">=</span>false&amp;default.timeout<span style="color:#719e07">=</span>3000&amp;<span style="color:#268bd2">dubbo</span><span style="color:#719e07">=</span>2.6.2&amp;<span style="color:#268bd2">generic</span><span style="color:#719e07">=</span>false&amp;<span style="color:#268bd2">interface</span><span style="color:#719e07">=</span>com.alibaba.dubbo.samples.api.GreetingService&amp;<span style="color:#268bd2">methods</span><span style="color:#719e07">=</span>sayHello&amp;<span style="color:#268bd2">pid</span><span style="color:#719e07">=</span>33001&amp;register.ip<span style="color:#719e07">=</span>192.168.99.1&amp;remote.timestamp<span style="color:#719e07">=</span>1533105502086&amp;<span style="color:#268bd2">side</span><span style="color:#719e07">=</span>consumer&amp;<span style="color:#268bd2">timestamp</span><span style="color:#719e07">=</span>1533105519216, dubbo version: 2.6.2, current host: 192.168.99.1 |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>01/08/18 02:38:40:040 CST<span style="color:#719e07">]</span> main INFO annotation.ReferenceBeanBuilder: &lt;dubbo:reference <span style="color:#268bd2">object</span><span style="color:#719e07">=</span><span style="color:#2aa198">&#34;com.alibaba.dubbo.common.bytecode.proxy0@673be18f&#34;</span> <span style="color:#268bd2">singleton</span><span style="color:#719e07">=</span><span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">interface</span><span style="color:#719e07">=</span><span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.api.GreetingService&#34;</span> <span style="color:#268bd2">uniqueServiceName</span><span style="color:#719e07">=</span><span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.api.GreetingService&#34;</span> <span style="color:#268bd2">generic</span><span style="color:#719e07">=</span><span style="color:#2aa198">&#34;false&#34;</span> <span style="color:#268bd2">id</span><span style="color:#719e07">=</span><span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.api.GreetingService&#34;</span> /&gt; has been built. |
| </span></span><span style="display:flex;"><span>result: hello, annotation |
| </span></span></code></pre></div><h2 id="conclusion">Conclusion</h2> |
| <p>By studying this article, the reader can master the basic concepts of <code>Dubbo</code>&rsquo;s exclusive <code>annotations</code> , <code>@EnableDubbo</code>, <code>@Service</code>, <code>@Reference</code>, and master it&rsquo;s basic usage through a simple <code>Dubbo</code> application.</p> |
| <p>In addition to traditional <code>XML</code> configuration, <code>Spring</code> offers more modern configurations such as annotation drivers, externalization, and auto-assembly.This article focuses on the development of <code>Dubbo</code> applications through annotations. You can be seen that annotation mode programming is more concise and simple than XML configuration. In future, we will introduce the use of externalization configuration and automatic assembly in <code>Dubbo</code> further.</p></description></item><item><title>Blog: Using Zookeeper in Dubbo</title><link>https://dubbo.apache.org/en/blog/2018/08/07/using-zookeeper-in-dubbo/</link><pubDate>Tue, 07 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/07/using-zookeeper-in-dubbo/</guid><description> |
| <h2 id="introduction-of-zookeeper">Introduction of Zookeeper</h2> |
| <h3 id="the-basic-concept">The basic concept</h3> |
| <p>In the mordern distrbuted applications, there are multiple coordination problems between nodes and nodes, including: leader election, group service, locking, configuration management, naming and synchronization. Apache Zookeeper, as its name implied, is a distributed, open-source coordination service framwork to address these demand.</p> |
| <p>In order to ensure the high performance, highly available and strictly ordered access, the performance aspects of ZooKeeper means it can be used in large, distributed systems and can also be deployed in cluster mode, which called &lsquo;ZooKeeper ensemble&rsquo;. In ZooKeeper ensemble, all write requests from clients are forwarded to a single server, called the leader, through the ZAB(Zookeeper Atomic Broadcast Protocol) to make sure the message in each nodes are same. Clients can access any one of the clusters to read and write data without worrying about inconsistencies in the data.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/zk-emsemble.png" alt="Diagram shows client-server architecture of ZooKeeper"> |
| <em>Image Credit : ebook -Zookeeper-Distributed Process Coordination from O&rsquo;Reilly</em></p> |
| <p>The method to store the data in Zookeeper is similar as the standard UNIX file system, as a data model styled after the familiar directory tree structure of file systems. When we talking about ZooKeeper data nodes, we call it Znodes to clarify it.</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/zk-tree.png" alt="zk-tree"> |
| <em>Image Credit : ebook -Zookeeper-Distributed Process Coordination from O&rsquo;Reilly</em></p> |
| <h3 id="basic-implementation">Basic Implementation</h3> |
| <p>You could donwload and install Zookeeper directly<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup>. |
| Or you could use Homebrew <sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup> <code>brew install zookeeper</code> to install Zookeeper in Mac OS. |
| Considering the versatility, we run the Zookeeper by using docker in this blog. If you have not installed the docker yet, please prepare the docker environment first. <sup id="fnref:3"><a href="#fn:3" class="footnote-ref" role="doc-noteref">3</a></sup></p> |
| <h4 id="1-running-the-zookeeper">1. Running the Zookeeper</h4> |
| <p>Execute the command to run zookeeper in a docker container</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>docker run --rm --name zookeeper -p 2181:2181 zookeeper |
| </span></span></code></pre></div><h4 id="2-entering-the-zookeeper-container">2. Entering the zookeeper container</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>docker <span style="color:#b58900">exec</span> -it zookeeper bash |
| </span></span></code></pre></div><p>In the <code>bin</code> directory, there is a command to start zookeeper <code>zkServer</code> and the Management Console <code>zkCli</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-shell" data-lang="shell"><span style="display:flex;"><span>bash-4.4# ls -l bin |
| </span></span><span style="display:flex;"><span>total <span style="color:#2aa198">36</span> |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">232</span> Mar <span style="color:#2aa198">27</span> 04:32 README.txt |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">1937</span> Mar <span style="color:#2aa198">27</span> 04:32 zkCleanup.sh |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">1056</span> Mar <span style="color:#2aa198">27</span> 04:32 zkCli.cmd |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">1534</span> Mar <span style="color:#2aa198">27</span> 04:32 zkCli.sh |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">1759</span> Mar <span style="color:#2aa198">27</span> 04:32 zkEnv.cmd |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">2696</span> Mar <span style="color:#2aa198">27</span> 04:32 zkEnv.sh |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">1089</span> Mar <span style="color:#2aa198">27</span> 04:32 zkServer.cmd |
| </span></span><span style="display:flex;"><span>-rwxr-xr-x <span style="color:#2aa198">1</span> zookeepe zookeepe <span style="color:#2aa198">6773</span> Mar <span style="color:#2aa198">27</span> 04:32 zkServer.sh |
| </span></span></code></pre></div><h4 id="3-entering-the-zookeeper-management-interface-via-zkcli">3. Entering the zookeeper management interface via zkCli</h4> |
| <p>Since it was started through docker, the process of Zookeeper has been started and will provide the services to the public via port 2181.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>bash-4.4# ps |
| </span></span><span style="display:flex;"><span>PID USER TIME COMMAND |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">1</span> zookeepe 0:02 /usr/lib/jvm/java-1.8-openjdk/jre/bin/java -Dzookeeper.log.dir<span style="color:#719e07">=</span>. -Dzookeeper.root |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">32</span> root 0:00 bash |
| </span></span><span style="display:flex;"><span> <span style="color:#2aa198">42</span> root 0:00 ps |
| </span></span></code></pre></div><p>So, it allows you to access Zookeeper&rsquo;s console directly through <code>zkCli </code> for management.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>bash-4.4# bin/zkCli.sh -server 127.0.0.1:2181 |
| </span></span><span style="display:flex;"><span>Connecting to 127.0.0.1:2181 |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span>WATCHER:: |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>WatchedEvent state:SyncConnected type:None path:null |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: 127.0.0.1:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 0<span style="color:#719e07">]</span> <span style="color:#b58900">help</span> |
| </span></span><span style="display:flex;"><span>ZooKeeper -server host:port cmd args |
| </span></span><span style="display:flex;"><span> stat path <span style="color:#719e07">[</span>watch<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#b58900">set</span> path data <span style="color:#719e07">[</span>version<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> ls path <span style="color:#719e07">[</span>watch<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> delquota <span style="color:#719e07">[</span>-n|-b<span style="color:#719e07">]</span> path |
| </span></span><span style="display:flex;"><span> ls2 path <span style="color:#719e07">[</span>watch<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> setAcl path acl |
| </span></span><span style="display:flex;"><span> setquota -n|-b val path |
| </span></span><span style="display:flex;"><span> <span style="color:#b58900">history</span> |
| </span></span><span style="display:flex;"><span> redo cmdno |
| </span></span><span style="display:flex;"><span> printwatches on|off |
| </span></span><span style="display:flex;"><span> delete path <span style="color:#719e07">[</span>version<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> sync path |
| </span></span><span style="display:flex;"><span> listquota path |
| </span></span><span style="display:flex;"><span> rmr path |
| </span></span><span style="display:flex;"><span> get path <span style="color:#719e07">[</span>watch<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span> create <span style="color:#719e07">[</span>-s<span style="color:#719e07">]</span> <span style="color:#719e07">[</span>-e<span style="color:#719e07">]</span> path data acl |
| </span></span><span style="display:flex;"><span> addauth scheme auth |
| </span></span><span style="display:flex;"><span> quit |
| </span></span><span style="display:flex;"><span> getAcl path |
| </span></span><span style="display:flex;"><span> close |
| </span></span><span style="display:flex;"><span> connect host:port |
| </span></span></code></pre></div><h4 id="4-basic-examples-on-zkcli">4. Basic Examples on zkCli</h4> |
| <p>Create <code>/hello-zone</code> node:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: 127.0.0.1:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 19<span style="color:#719e07">]</span> create /hello-zone <span style="color:#2aa198">&#39;world&#39;</span> |
| </span></span><span style="display:flex;"><span>Created /hello-zone |
| </span></span></code></pre></div><p>List the child nodes under <code>/</code> and confirm that <code>hello-zone</code> is created:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: 127.0.0.1:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 20<span style="color:#719e07">]</span> ls / |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>zookeeper, hello-zone<span style="color:#719e07">]</span> |
| </span></span></code></pre></div><p>List the child nodes for <code>/hello-zone</code> and verify that it is empty:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: 127.0.0.1:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 21<span style="color:#719e07">]</span> ls /hello-zone |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[]</span> |
| </span></span></code></pre></div><p>Get the data stored on the <code>/hello-zone</code> node:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: 127.0.0.1:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 22<span style="color:#719e07">]</span> get /hello-zone |
| </span></span><span style="display:flex;"><span>world |
| </span></span></code></pre></div><h2 id="using-zookeeper-in-dubbo">Using Zookeeper in Dubbo</h2> |
| <p>Zookeeper is used for service registration discovery and configuration management in Dubbo, and the structure of data in Zookeeper is shown in the following figure:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-in-zk.jpg" alt="dubbo-in-zk"></p> |
| <p>First, all data related to Dubbo is organized under the root node of <code>/dubbo</code>.</p> |
| <p>The secondary directory is the service name like <code>com.foo.BarService</code>.</p> |
| <p>The three-level directory has two child nodes, <code>providers</code> and <code>consumers</code>, representing the supplier and customers of the service.</p> |
| <p>The URL information for each application instance associated with the service will be recorded by the Level 4 directory. The <code>providers</code> and <code>consumer</code> will stored the providers information and the consumers information of the services seperately.<br> |
| For example, the service provider of <code>com.foo.BarService</code> will register its URL Information to <code>/dubbo/com.foo.BarService/providers</code>; Similarly, service consumers will register their information under the corresponding <code>consumer</code> node. At the same time, consumers will subscribe to the corresponding <code>providers</code> node to be able to detect the changes of the service provider address list.</p> |
| <h3 id="prepare-the-sample-code">Prepare the sample code</h3> |
| <p>The code in this document can be found in <a href="https://github.com/dubbo/dubbo-samples/tree/master/3-extensions/registry/dubbo-samples-zookeeper">https://github.com/dubbo/dubbo-samples/tree/master/3-extensions/registry/dubbo-samples-zookeeper</a>.</p> |
| <h4 id="1-interface-definition">1. Interface definition</h4> |
| <p>Define a simple <code>greetingservice</code> interface with only one simple method named <code>sayHello</code> to greet to the caller.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GreetingService</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><h4 id="2-server-implementation">2. Server: Implementation</h4> |
| <p>Implement the <code>GreetingService</code> interface and mark it as a service for Dubbo via <code>@Service</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:#268bd2">@Service</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AnnotatedGreetingService</span> <span style="color:#268bd2">implements</span> GreetingService { |
| </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><h4 id="3-server-assembly">3. Server: Assembly</h4> |
| <p>Define ProviderConfiguration to assemble Dubbo services.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Configuration</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span>(scanBasePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.impl&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@PropertySource</span>(<span style="color:#2aa198">&#34;classpath:/spring/dubbo-provider.properties&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">static</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderConfiguration</span> {} |
| </span></span></code></pre></div><p>Dubbo-provider.properties is an external configuration in a spring application, as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">demo-provider</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://$DOCKER_HOST:2181</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">20880</span> |
| </span></span></code></pre></div><p>Since zookeeper runs in a docker container, please be noted that:</p> |
| <ul> |
| <li>We assumes that Dubbo applications is running on the host machine (outside the docker container) in this document, and needs to replace the PATH of Zookeeper with the IP address of the Environment Variable <em>${DOCKER_HOST}</em>. Please find more detail in the official Docker documentation.</li> |
| <li>When the Dubbo application is a docker application, the container&rsquo;s name is equivalent to Zookeeper&rsquo;s. The container&rsquo;s name is ** zookeeper ** in this document.</li> |
| <li>Of course, if you don&rsquo;t want to run the Zookeeper in a container mode, just simply replace <em>$DOCKER_HOST</em> with <strong>localhost</strong>.</li> |
| </ul> |
| <h4 id="4-server-starting-service">4. Server: Starting Service</h4> |
| <p>In the <code>main</code> method, you could provide the Dubbo service by running a Spring Context.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ProviderBootstrap</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> Exception { |
| </span></span><span style="display:flex;"><span> AnnotationConfigApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AnnotationConfigApplicationContext(ProviderConfiguration.class); |
| </span></span><span style="display:flex;"><span> context.start(); |
| </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>Start the <code>main</code> method of server, you will get the following output, which represents the success of the server&rsquo;s startup, and the <code>GreetingService</code> service is registered on the ZookeeperRegistry:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span><span style="color:#719e07">[</span>03/08/18 10:50:33:033 CST<span style="color:#719e07">]</span> main INFO zookeeper.ZookeeperRegistry: <span style="color:#719e07">[</span>DUBBO<span style="color:#719e07">]</span> Register: dubbo://192.168.99.1:20880/com.alibaba.dubbo.samples.api.GreetingService?anyhost<span style="color:#719e07">=</span>true&amp;<span style="color:#268bd2">application</span><span style="color:#719e07">=</span>demo-provider&amp;<span style="color:#268bd2">dubbo</span><span style="color:#719e07">=</span>2.6.2&amp;<span style="color:#268bd2">generic</span><span style="color:#719e07">=</span>false&amp;<span style="color:#268bd2">interface</span><span style="color:#719e07">=</span>com.alibaba.dubbo.samples.api.GreetingService&amp;<span style="color:#268bd2">methods</span><span style="color:#719e07">=</span>sayHello&amp;<span style="color:#268bd2">pid</span><span style="color:#719e07">=</span>12938&amp;<span style="color:#268bd2">side</span><span style="color:#719e07">=</span>provider&amp;<span style="color:#268bd2">timestamp</span><span style="color:#719e07">=</span>1533264631849, dubbo version: 2.6.2, current host: 192.168.99.1 |
| </span></span></code></pre></div><p>You could find the registration information of the service provider through the Zookeeper management terminal:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>$ docker <span style="color:#b58900">exec</span> -it zookeeper bash |
| </span></span><span style="display:flex;"><span>bash-4.4# bin/zkCli.sh -server localhost:218 |
| </span></span><span style="display:flex;"><span>Connecting to localhost:2181 |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span>Welcome to ZooKeeper! |
| </span></span><span style="display:flex;"><span>JLine support is enabled |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: localhost:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 0<span style="color:#719e07">]</span> ls /dubbo/com.alibaba.dubbo.samples.api.GreetingService/providers |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>dubbo%3A%2F%2F192.168.99.1%3A20880%2Fcom.alibaba.dubbo.samples.api.GreetingService%3Fanyhost%3Dtrue%26application%3Ddemo-provider%26dubbo%3D2.6.2%26generic%3Dfalse%26interface%3Dcom.alibaba.dubbo.samples.api.GreetingService%26methods%3DsayHello%26pid%3D12938%26side%3Dprovider%26timestamp%3D1533264631849<span style="color:#719e07">]</span> |
| </span></span></code></pre></div><p>You could find that the Dubbo services just registered its URL address at the <code>providers</code> node as follows: |
| <em>dubbo://192.168.99.1:20880/com.alibaba.dubbo.samples.api.GreetingService?anyhost=true&amp;application=demo-provider&amp;dubbo=2.6.2&amp;generic=false&amp;interface=com.alibaba.dubbo.samples.api.GreetingService&amp;methods=sayHello&amp;pid=12938&amp;side=provider&amp;timestamp=1533264631849</em></p> |
| <h4 id="5-client-reference-service">5. Client: Reference Service</h4> |
| <p>You could declare the reference service by @Reference, while it will generate a full call. The target address of the service could be queried by the Zookeeper&rsquo;s <code>provider</code> node.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Component</span>(<span style="color:#2aa198">&#34;annotatedConsumer&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">GreetingServiceConsumer</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Reference</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> GreetingService greetingService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">doSayHello</span>(String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> greetingService.sayHello(name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><h4 id="6-client-assembling">6. Client: Assembling</h4> |
| <p>Define the ConsumerConfiguration to assemble Dubbo service.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Configuration</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@EnableDubbo</span>(scanBasePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.action&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@PropertySource</span>(<span style="color:#2aa198">&#34;classpath:/spring/dubbo-consumer.properties&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@ComponentScan</span>(value <span style="color:#719e07">=</span> {<span style="color:#2aa198">&#34;com.alibaba.dubbo.samples.action&#34;</span>}) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">static</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ConsumerConfiguration</span> {} |
| </span></span></code></pre></div><p>&ldquo;dubbo-consumer.properties&rdquo; is a method of external configuration in a Spring application, as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-properties" data-lang="properties"><span style="display:flex;"><span>dubbo.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">demo-consumer</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address<span style="color:#719e07">=</span><span style="color:#2aa198">zookeeper://$DOCKER_HOST:2181</span> |
| </span></span><span style="display:flex;"><span>dubbo.consumer.timeout<span style="color:#719e07">=</span><span style="color:#2aa198">3000</span> |
| </span></span></code></pre></div><p>Same as <strong>3. Server: Assembling</strong>, You need to modify <em>$DOCKER_HOST</em> defined in <em>dubbo.registry.address</em> according to your own environment. You could find more instructions in step 3.</p> |
| <h4 id="7-client-initiating-a-remote-call">7. Client: Initiating A Remote Call</h4> |
| <p>Run <code>main</code> to initiate a remote call from a existed service provider. Dubbo first subscribes to the zookeeper service address and then selects one from the list of returned addresses to invoke the client:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ConsumerBootstrap</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:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">ConsumerBootstrap</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> AnnotationConfigApplicationContext context <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> AnnotationConfigApplicationContext(ConsumerConfiguration.class); |
| </span></span><span style="display:flex;"><span> context.start(); |
| </span></span><span style="display:flex;"><span> GreetingServiceConsumer greetingServiceConsumer <span style="color:#719e07">=</span> context.getBean(GreetingServiceConsumer.class); |
| </span></span><span style="display:flex;"><span> String hello <span style="color:#719e07">=</span> greetingServiceConsumer.doSayHello(<span style="color:#2aa198">&#34;zookeeper&#34;</span>); |
| </span></span><span style="display:flex;"><span> System.out.println(<span style="color:#2aa198">&#34;result: &#34;</span> <span style="color:#719e07">+</span> hello); |
| </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>The output are as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span><span style="color:#719e07">[</span>03/08/18 01:42:31:031 CST<span style="color:#719e07">]</span> main INFO zookeeper.ZookeeperRegistry: <span style="color:#719e07">[</span>DUBBO<span style="color:#719e07">]</span> Register: consumer://192.168.99.1/com.alibaba.dubbo.samples.api.GreetingService?application<span style="color:#719e07">=</span>demo-consumer&amp;<span style="color:#268bd2">category</span><span style="color:#719e07">=</span>consumers&amp;<span style="color:#268bd2">check</span><span style="color:#719e07">=</span>false&amp;default.timeout<span style="color:#719e07">=</span>3000&amp;<span style="color:#268bd2">dubbo</span><span style="color:#719e07">=</span>2.6.2&amp;<span style="color:#268bd2">interface</span><span style="color:#719e07">=</span>com.alibaba.dubbo.samples.api.GreetingService&amp;<span style="color:#268bd2">methods</span><span style="color:#719e07">=</span>sayHello&amp;<span style="color:#268bd2">pid</span><span style="color:#719e07">=</span>82406&amp;<span style="color:#268bd2">side</span><span style="color:#719e07">=</span>consumer&amp;<span style="color:#268bd2">timestamp</span><span style="color:#719e07">=</span>1533274951195, dubbo version: 2.6.2, current host: 192.168.99.1 <span style="color:#586e75">#1</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>03/08/18 01:42:31:031 CST<span style="color:#719e07">]</span> main INFO zookeeper.ZookeeperRegistry: <span style="color:#719e07">[</span>DUBBO<span style="color:#719e07">]</span> Subscribe: consumer://192.168.99.1/com.alibaba.dubbo.samples.api.GreetingService?application<span style="color:#719e07">=</span>demo-consumer&amp;<span style="color:#268bd2">category</span><span style="color:#719e07">=</span>providers,configurators,routers&amp;default.timeout<span style="color:#719e07">=</span>3000&amp;<span style="color:#268bd2">dubbo</span><span style="color:#719e07">=</span>2.6.2&amp;<span style="color:#268bd2">interface</span><span style="color:#719e07">=</span>com.alibaba.dubbo.samples.api.GreetingService&amp;<span style="color:#268bd2">methods</span><span style="color:#719e07">=</span>sayHello&amp;<span style="color:#268bd2">pid</span><span style="color:#719e07">=</span>82406&amp;<span style="color:#268bd2">side</span><span style="color:#719e07">=</span>consumer&amp;<span style="color:#268bd2">timestamp</span><span style="color:#719e07">=</span>1533274951195, dubbo version: 2.6.2, current host: 192.168.99.1 <span style="color:#586e75">#2</span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span>result: hello, zookeeper |
| </span></span></code></pre></div><p>Description:</p> |
| <ol> |
| <li><strong>Register</strong>: consumer://192.168.99.1/&hellip;&amp;<strong>category=consumers</strong>&amp;： In Zookeeper, consumers could register their information and store it at the <code>consumers</code> node</li> |
| <li><strong>Subscribe</strong>: consumer://192.168.99.1/&hellip;&amp;<strong>category=providers,configurators,routers</strong>&amp;：Consumers subscribe <code>providers</code>, <code>configurators</code>, <code>routers</code> from Zookeepers. The <code>configurations</code> is related to the Dubbo configuration, and <code>routers</code> is related to routing rules. The providers node subscription should be noted. When a new service provider to join, due to the relationship between the subscription, the new address list will be pushed to the subscriber. So service consumers also dynamically perceive changes in address lists.</li> |
| </ol> |
| <p>You could find the registration information of the service provider through the Zookeeper management terminal:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>$ docker <span style="color:#b58900">exec</span> -it zookeeper bash |
| </span></span><span style="display:flex;"><span>bash-4.4# bin/zkCli.sh -server localhost:218 |
| </span></span><span style="display:flex;"><span>Connecting to localhost:2181 |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span>Welcome to ZooKeeper! |
| </span></span><span style="display:flex;"><span>JLine support is enabled |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>zk: localhost:2181<span style="color:#719e07">(</span>CONNECTED<span style="color:#719e07">)</span> 4<span style="color:#719e07">]</span> ls /dubbo/com.alibaba.dubbo.samples.api.GreetingService/consumers |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>consumer%3A%2F%2F192.168.99.1%2Fcom.alibaba.dubbo.samples.api.GreetingService%3Fapplication%3Ddemo-consumer%26category%3Dconsumers%26check%3Dfalse%26default.timeout%3D3000%26dubbo%3D2.6.2%26interface%3Dcom.alibaba.dubbo.samples.api.GreetingService%26methods%3DsayHello%26pid%3D82406%26side%3Dconsumer%26timestamp%3D1533274951195<span style="color:#719e07">]</span> |
| </span></span></code></pre></div><p>You could see that consumers of Dubbo&rsquo;s servicehas registered its URL address at the <code>consumers</code> node:</p> |
| <p><em>consumer://192.168.99.1/com.alibaba.dubbo.samples.api.GreetingService?application=demo-consumer&amp;category=providers,configurators,routers&amp;default.timeout=3000&amp;dubbo=2.6.2&amp;interface=com.alibaba.dubbo.samples.api.GreetingService&amp;methods=sayHello&amp;pid=82406&amp;side=consumer&amp;timestamp=1533274951195</em></p> |
| <h2 id="summary">Summary</h2> |
| <p>This document focuses on how to use ZooKeeper as a registry in Dubbo. This document also mentioned that the Zookeeper could be a configuration center and a service management in Dubbo. Zookeeper is a single-node, standalone mode. However, developers always bulid a Zookeeper server cluster called * Zookeeper ensemble * in the real world.</p> |
| <p>Through this document, readers can learn:</p> |
| <ul> |
| <li>Basic concepts and applications of ZooKeeper</li> |
| <li>The function of Zookeeper in Dubbo application</li> |
| <li>Learn about Zookeeper&rsquo;s interaction through practical sample codes</li> |
| <li>The storage of service registration and consumption information of Dubbo with ZooKeeper</li> |
| </ul> |
| <div class="footnotes" role="doc-endnotes"> |
| <hr> |
| <ol> |
| <li id="fn:1"> |
| <p><a href="https://www.apache.org/dyn/closer.cgi/zookeeper/">https://www.apache.org/dyn/closer.cgi/zookeeper/</a>&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:2"> |
| <p><a href="https://brew.sh">https://brew.sh</a>&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| <li id="fn:3"> |
| <p><a href="https://www.docker.com/community-edition">https://www.docker.com/community-edition</a>&#160;<a href="#fnref:3" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p> |
| </li> |
| </ol> |
| </div></description></item><item><title>Blog: Your First Dubbo Demo</title><link>https://dubbo.apache.org/en/blog/2018/08/07/dubbo-101/</link><pubDate>Tue, 07 Aug 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/08/07/dubbo-101/</guid><description> |
| <h2 id="java-rmi-introduction">Java RMI Introduction</h2> |
| <p>Java RMI (Remote Method Invocation) is a mechanism that allows users to access or invocate an object and a method running on another JVM (Java Virtual Machine). RMI is an implementation of RPC (Remote Procedure Call) in java with support of OOP (Object Oriented Paradigms). Instead of bothering IDL (Interface Define Language), users can build distributed applications by depending on interfaces in an easy and natural way.</p> |
| <h3 id="java-rmi-work-flow">Java RMI Work Flow</h3> |
| <p>Here is how a typical RMI invocation usually works:</p> |
| <ol> |
| <li>The server registers service from RMI and binds its address.</li> |
| <li>The client registers service from RMI and obtains target address.</li> |
| <li>The client invokes methods of local stub object in the same way of invoking other local objects.</li> |
| <li>Local stub object zips invoking information and send it to the server via network.</li> |
| <li>The Skeleton object of server receives the network request and unzips the information.</li> |
| <li>Server runs invocation on the target object based on the information and return the zipped results back to client via network.</li> |
| </ol> |
| <p><img src="https://dubbo.apache.org/imgs/blog/rmi-flow.png" alt="RMI Flow"></p> |
| <p>(source：https://www.cs.rutgers.edu/~pxk/417/notes/images/rpc-rmi_flow.png)</p> |
| <h3 id="java-rmi-concepts">Java RMI Concepts</h3> |
| <p>Java RMI is a technique foundation stone of creating distributed applications in Java. The following EJB techniques and current framework of distributed services still inherit the fundamental concepts of Java RMI. In RMI invocation, there are some core concepts：</p> |
| <ol> |
| <li>The invocation is run remotely on <strong>interface</strong>.</li> |
| <li>Disguise remote invocation as local invocation by <strong>Stub object</strong> on client and <strong>Skeleton object</strong> on server.</li> |
| <li>The service is registered and looked up by <strong>RMI</strong> registry service.</li> |
| </ol> |
| <p>For 1. users are dependent on interfaces which should be implemented by server.</p> |
| <p>For 2. In J2SE 1.5 version and before, it needs to pre-compile Stub on client and Skeleton on server by rmic. In the later versions there is no need to do so.</p> |
| <p>The following is a code example of registry and look-up in RMI.</p> |
| <h4 id="server-service-registry">Server service registry</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Hello obj <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> HelloImpl(); <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span>Hello stub <span style="color:#719e07">=</span> (Hello) UnicastRemoteObject.exportObject(obj, 0); <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span>Registry registry <span style="color:#719e07">=</span> LocateRegistry.createRegistry(1099); <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span>registry.rebind(<span style="color:#2aa198">&#34;Hello&#34;</span>, stub); <span style="color:#586e75">// #4</span> |
| </span></span></code></pre></div><p>Notes:</p> |
| <ol> |
| <li> |
| <p>Initiate service object instance.</p> |
| </li> |
| <li> |
| <p>Create stub object to communicate with the server by UnicastRemoteObject.exportObject.</p> |
| </li> |
| <li> |
| <p>Create a local RMI registry service on port 1099 which is run on server. It can also be registered as an independent process.</p> |
| </li> |
| <li> |
| <p>Bind stub object into registry so the client can find the remote object by looking up Hello.</p> |
| </li> |
| </ol> |
| <h4 id="client-service-look-up">Client service look-up</h4> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span>Registry registry <span style="color:#719e07">=</span> LocateRegistry.getRegistry(); <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span>Hello stub <span style="color:#719e07">=</span> (Hello) registry.lookup(<span style="color:#2aa198">&#34;Hello&#34;</span>); <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span>String response <span style="color:#719e07">=</span> stub.sayHello(); <span style="color:#586e75">// #3</span> |
| </span></span></code></pre></div><p>Notes:</p> |
| <ol> |
| <li>Acquire registry service instances. In this case, there is no input parameters so it is assumed that the acquired instance is located on port 1099.</li> |
| <li>Look up the remote object named Hello in registry service.</li> |
| <li>Run a RMI invocation via acquired Stub object and get results. |
| Understand the work flow and basic concepts of RMI is helpful to handle current framework of distributed service. It is recommended to refer to RMI official documents for further information[^1].</li> |
| </ol> |
| <h2 id="basic-concepts-of-dubbo">Basic Concepts of Dubbo</h2> |
| <p>The basic concepts of current framework of distributed service is similar to the one of RMI. They both use Java interface as service contract, register and look up by registry center and use agency to block the details of remote communications. Specifically, Dubbo has following four types of roles to play when running：</p> |
| <ol> |
| <li>Serve the provider – Expose service at assigned ports at initialization and register the service address and ports at registry center</li> |
| <li>Serve the consumer – Subscribe the service of interests at registry center at initialization to acquire the list of addresses provided by the service provider.</li> |
| <li>Registry center – Register and look up service. Store the address provided by the service provider and send it to the consumer.</li> |
| <li>Monitor center – Collect and monitor running status of providers and consumers, e.g., times of invocations, delay of invocations, etc.</li> |
| <li>Running container – Initialize and load the provider and manage the lifecycle of running.</li> |
| </ol> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-architecture.png" alt="dubbo-architecture"></p> |
| <p><strong>Deploy stage</strong></p> |
| <ul> |
| <li>Service providers expose service at assigned ports and register information of service at registry center.</li> |
| <li>Service consumers subscribe the list of service addresses from registry center.</li> |
| </ul> |
| <p><strong>Run stage</strong></p> |
| <ul> |
| <li>Registry center sends the address to service consumers.</li> |
| <li>After receiving the list of addresses, service consumers select one of them and invoke an object service.</li> |
| <li>During invocation, the running status of service providers and consumers is reported to the monitor center.</li> |
| </ul> |
| <h2 id="dubbo-applications-based-on-api">Dubbo Applications Based on API</h2> |
| <p>The applications of Dubbo are usually assembled by Spring. To obtain an available Dubbo application quickly, the example shown here abandons complex configurations but to create service provider and consumer in Dubbo API oriented way. Additionally, the registry center and monitor center do not need installation or configuration in this example.</p> |
| <p>In production environment, the service of Dubbo usually requires cooperation with a distributed service registry center, such as ZooKeeper. For convenience, Dubbo offers two ways to avoid extra work of building registry center, namely direct connection [2] and assembled podcast [3] respectively. In this example, the latter way is applied to register and look up service.</p> |
| <h3 id="define-service-contract">Define Service Contract</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">GreetingsService</span> { |
| </span></span><span style="display:flex;"><span> String <span style="color:#268bd2">sayHi</span>(String name); <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p><strong>Notes</strong>：</p> |
| <ol> |
| <li>The codes define a simple service contract where there is only one function, sayHi, can be invoked. The type of input parameter and return value are both String.</li> |
| </ol> |
| <h3 id="provide-contract-implementation">Provide Contract Implementation</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">GreetingsServiceImpl</span> <span style="color:#268bd2">implements</span> GreetingsService { <span style="color:#586e75">// #1</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">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:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p><strong>Notes</strong>：</p> |
| <ol> |
| <li>Service providers need to implement the interface of service contract, GreetingsService.</li> |
| <li>This function simply returns a welcome message. For example, if the input value is <em>dubbo</em>，it will return <em>hi, dubbo</em>.</li> |
| </ol> |
| <h3 id="implement-dubbo-service-provider">Implement Dubbo Service Provider</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">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> 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 style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span> service.setApplication(<span style="color:#719e07">new</span> ApplicationConfig(<span style="color:#2aa198">&#34;first-dubbo-provider&#34;</span>)); <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> service.setRegistry(<span style="color:#719e07">new</span> RegistryConfig(<span style="color:#2aa198">&#34;multicast://224.5.6.7:1234&#34;</span>)); <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> service.setInterface(GreetingsService.class); <span style="color:#586e75">// #4</span> |
| </span></span><span style="display:flex;"><span> service.setRef(<span style="color:#719e07">new</span> GreetingsServiceImpl()); <span style="color:#586e75">// #5</span> |
| </span></span><span style="display:flex;"><span> service.export(); <span style="color:#586e75">// #6</span> |
| </span></span><span style="display:flex;"><span> System.in.read(); <span style="color:#586e75">// #7</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p><strong>Notes</strong>：</p> |
| <ol> |
| <li>Create an instance <em>ServiceConfig</em> with service interface type as generics parameters, which is <em>GreetingsService</em> in this example.</li> |
| <li>Generate an instance of <em>ApplicationConfig</em> and assemble it into <em>ServiceConfig</em>.</li> |
| <li>Generate an instance <em>RegistryConfig</em> and assemble it into <em>ServiceConfig</em>. Since the assembled way is applied here, the parameter should be <code>multicast://224.5.6.7:1234</code>. The valid range of assembled address is <em>224.0.0.0 - 239.255.255.255</em></li> |
| <li>Assemble the service contract <em>GreetingsService</em> into <em>ServiceConfig</em>.</li> |
| <li>Assemble the instance with implementation of <em>GreetingsServicelmpl</em> provided by service providers into <em>ServiceConfig</em>.</li> |
| <li><em>ServiceConfig</em> starts to expose itself at default ports <em>20880</em>. after being equipped with enough information.</li> |
| <li>Press any key or <em>ctrl-C</em> to exit to avoid server halt.</li> |
| </ol> |
| <h3 id="implement-dubbo-service-consumer">Implement Dubbo Service Consumer</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#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> 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 style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span> reference.setApplication(<span style="color:#719e07">new</span> ApplicationConfig(<span style="color:#2aa198">&#34;first-dubbo-client&#34;</span>)); <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> reference.setRegistry(<span style="color:#719e07">new</span> RegistryConfig(<span style="color:#2aa198">&#34;multicast://224.5.6.7:1234&#34;</span>)); <span style="color:#586e75">// #3</span> |
| </span></span><span style="display:flex;"><span> reference.setInterface(GreetingsService.class); <span style="color:#586e75">// #4</span> |
| </span></span><span style="display:flex;"><span> GreetingsService greetingsService <span style="color:#719e07">=</span> reference.get(); <span style="color:#586e75">// #5</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 style="color:#586e75">// #6</span> |
| </span></span><span style="display:flex;"><span> System.out.println(message); <span style="color:#586e75">// #7</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p><strong>Notes</strong>：</p> |
| <ol> |
| <li>Create an instance of <em>ReferenceConfig</em> with service interface type as generics parameters, which is <em>GreetingsService</em> in this example.</li> |
| <li>Create an instance of <em>ApplicationConfig</em>, and assemble it into <em>ReferenceConfig</em>.</li> |
| <li>Generate an instance <em>RegistryConfig</em>, and assemble it into <em>ReferenceConfig</em>. Note that the address information here should be the same as the one of the service provider.</li> |
| <li>Assemble the service contract <em>GreetingsService</em> into <em>ReferenceConfig</em>.</li> |
| <li>Obtain the agency of <em>GreetingsService</em> from <em>ReferenceConfig</em>.</li> |
| <li>Invoke a remote call through <em>GreetingsSerive</em>’s agency and pass in <code>dubbo</code> as input parameter.</li> |
| <li>Return and print results <code>hi, dubbo</code>.</li> |
| </ol> |
| <h3 id="run">Run</h3> |
| <p>The complete example can be found at <a href="https://github.com/apache/dubbo-samples/tree/master/1-basic/dubbo-samples-api">https://github.com/apache/dubbo-samples/tree/master/1-basic/dubbo-samples-api</a>. In the complete version, it is convenient to execute by maven in command line with the configuration of <em>exec-maven-plugin</em>. Of course, it can also be executed directly in IDE. However, there is one noteworthy thing that because of using assembled way to look up service, it needs to assign <em>-Djava.net.preferIPv4Stack=true</em> when running.</p> |
| <h4 id="build-example">Build Example</h4> |
| <p>Synchronize the example codes and build by the following command lines:</p> |
| <ol> |
| <li>Synchronize the example codes: git clone <a href="https://github.com/apache/dubbo-samples.git">https://github.com/apache/dubbo-samples.git</a></li> |
| <li>Build：mvn clean package</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-bash" data-lang="bash"><span style="display:flex;"><span>$ git clone https://github.com/apache/dubbo-samples.git |
| </span></span><span style="display:flex;"><span>$ <span style="color:#b58900">cd</span> dubbo-samples/java/dubbo-samples-api/ |
| </span></span><span style="display:flex;"><span>$ mvn clean package |
| </span></span><span style="display:flex;"><span>INFO<span style="color:#719e07">]</span> Scanning <span style="color:#719e07">for</span> projects... |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Building dubbo-samples-api 1.0-SNAPSHOT |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> --- maven-clean-plugin:2.5:clean <span style="color:#719e07">(</span>default-clean<span style="color:#719e07">)</span> @ dubbo-samples-api --- |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> BUILD SUCCESS |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Total time: 2.182 s |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Finished at: 2018-05-28T14:56:08+08:00 |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Final Memory: 20M/353M |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span></code></pre></div><p>The build is finished when it shows <code>BUILD SUCCESS</code>. Then comes the running stage.</p> |
| <h4 id="run-the-server">Run the server</h4> |
| <p>Run the service provider by the following maven command lines:</p> |
| <div class="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>$ mvn -Djava.net.preferIPv4Stack<span style="color:#719e07">=</span><span style="color:#b58900">true</span> -Dexec.mainClass<span style="color:#719e07">=</span>org.apache.dubbo.samples.provider.Application exec:java |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Scanning <span style="color:#719e07">for</span> projects... |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Building dubbo-samples-api 1.0-SNAPSHOT |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> --- exec-maven-plugin:1.6.0:java <span style="color:#719e07">(</span>default-cli<span style="color:#719e07">)</span> @ dubbo-samples-api --- |
| </span></span><span style="display:flex;"><span>log4j:WARN No appenders could be found <span style="color:#719e07">for</span> logger <span style="color:#719e07">(</span>org.apache.dubbo.common.logger.LoggerFactory<span style="color:#719e07">)</span>. |
| </span></span><span style="display:flex;"><span>log4j:WARN Please initialize the log4j system properly. |
| </span></span><span style="display:flex;"><span>log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig <span style="color:#719e07">for</span> more info. |
| </span></span><span style="display:flex;"><span>first-dubbo-provider is running. |
| </span></span></code></pre></div><p>When <em>first-dubbo-provider is running</em> appears, the service provider is ready to be called by the client.</p> |
| <h4 id="run-the-client">Run the client</h4> |
| <p>Run the service consumer by the following maven command lines:</p> |
| <div class="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>$ mvn -Djava.net.preferIPv4Stack<span style="color:#719e07">=</span><span style="color:#b58900">true</span> -Dexec.mainClass<span style="color:#719e07">=</span>org.apache.dubbo.samples.consumer.Application exec:java |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Scanning <span style="color:#719e07">for</span> projects... |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> Building dubbo-samples-api 1.0-SNAPSHOT |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> ------------------------------------------------------------------------ |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">[</span>INFO<span style="color:#719e07">]</span> --- exec-maven-plugin:1.6.0:java <span style="color:#719e07">(</span>default-cli<span style="color:#719e07">)</span> @ dubbo-samples-api --- |
| </span></span><span style="display:flex;"><span>log4j:WARN No appenders could be found <span style="color:#719e07">for</span> logger <span style="color:#719e07">(</span>org.apache.dubbo.common.logger.LoggerFactory<span style="color:#719e07">)</span>. |
| </span></span><span style="display:flex;"><span>log4j:WARN Please initialize the log4j system properly. |
| </span></span><span style="display:flex;"><span>log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig <span style="color:#719e07">for</span> more info. |
| </span></span><span style="display:flex;"><span>hi, dubbo |
| </span></span></code></pre></div><p><code>hi, dubbo</code> is the execution results from service provider.</p> |
| <h2 id="quick-creation-of-a-dubbo-application">Quick Creation of A Dubbo Application</h2> |
| <p>Dubbo also provides a public platform that can create a Dubbo application quickly based on Spring Boot. Visit <a href="http://start.dubbo.io">http://start.dubbo.io</a> and follow the figure below to create an example project:</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/dubbo-initializr.png" alt="dubbo initializr"></p> |
| <p><strong>Notes</strong>：</p> |
| <ol> |
| <li>Provide maven groupId in <em>Group</em> with default value <code>com.example</code>.</li> |
| <li>Provide maven artifactId in <em>Artifact</em> with default value <code>demo</code>.</li> |
| <li>Provide the name of service in <em>DubboServiceName</em> with default value <code>com.example.HelloService</code>.</li> |
| <li>Provide the version of service in <em>DubboServiceVersion</em> with default value <code>1.0.0</code>.</li> |
| <li>Choose server or client in <em>Client/Server</em> with default value <code>server</code>.</li> |
| <li><em>embeddedZookeeper</em> is selected by default as service registry look up.</li> |
| <li>qos ports activation is not selected by default but if it is, it can be accessed by port <em>22222</em>.</li> |
| <li>Click <em>Generate Project</em> to download the generated project.</li> |
| </ol> |
| <p>This example shows how to generate a server. Similarly, it can generate a <em>client</em> by selecting client on the generation interface.</p> |
| <h3 id="run-1">Run</h3> |
| <p>Open the generated project with an IDE and to see the application is a typical Spring Boot application with the following program entry:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@SpringBootApplication</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoApplication</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:#719e07">new</span> EmbeddedZooKeeper(2181, <span style="color:#cb4b16">false</span>).start(); <span style="color:#586e75">// #1</span> |
| </span></span><span style="display:flex;"><span> SpringApplication.run(DemoApplication.class, args); <span style="color:#586e75">// #2</span> |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p><strong>Notes</strong>：</p> |
| <ol> |
| <li>Launch embedded <em>ZooKeeper</em> on port <em>2181</em>.</li> |
| <li>Launch the context of <em>Spring Boot</em>.</li> |
| </ol> |
| <p>Run it directly in IDE and here are the results:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>2018-05-28 16:59:38.072 INFO <span style="color:#2aa198">59943</span> --- <span style="color:#719e07">[</span> main<span style="color:#719e07">]</span> a.b.d.c.e.WelcomeLogoApplicationListener : |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> ████████▄ ███ █▄ ▀█████████▄ ▀█████████▄ ▄██████▄ |
| </span></span><span style="display:flex;"><span> ███ ▀███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ▄███▄▄▄██▀ ▄███▄▄▄██▀ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ▀▀███▀▀▀██▄ ▀▀███▀▀▀██▄ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ███ ██▄ ███ ██▄ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ▄███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ████████▀ ████████▀ ▄█████████▀ ▄█████████▀ ▀██████▀ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> :: Dubbo Spring Boot <span style="color:#719e07">(</span>v0.1.0<span style="color:#719e07">)</span> : https://github.com/dubbo/dubbo-spring-boot-project |
| </span></span><span style="display:flex;"><span> :: Dubbo <span style="color:#719e07">(</span>v2.0.1<span style="color:#719e07">)</span> : https://github.com/alibaba/dubbo |
| </span></span><span style="display:flex;"><span> :: Google group : http://groups.google.com/group/dubbo |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>2018-05-28 16:59:38.079 INFO <span style="color:#2aa198">59943</span> --- <span style="color:#719e07">[</span> main<span style="color:#719e07">]</span> e.OverrideDubboConfigApplicationListener : Dubbo Config was overridden by externalized configuration <span style="color:#719e07">{</span>dubbo.application.name<span style="color:#719e07">=</span>dubbo-demo-server, dubbo.application.qosAcceptForeignIp<span style="color:#719e07">=</span>false, dubbo.application.qosEnable<span style="color:#719e07">=</span>true, dubbo.application.qosPort<span style="color:#719e07">=</span>22222, dubbo.registry.address<span style="color:#719e07">=</span>zookeeper://localhost:2181?client<span style="color:#719e07">=</span>curator, dubbo.registry.id<span style="color:#719e07">=</span>my-registry, dubbo.scan.basePackages<span style="color:#719e07">=</span>com.example<span style="color:#719e07">}</span> <span style="color:#586e75">#1</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>... |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>2018-05-28 16:59:39.624 INFO <span style="color:#2aa198">59943</span> --- <span style="color:#719e07">[</span> main<span style="color:#719e07">]</span> com.example.demo.DemoApplication : Started DemoApplication in 1.746 seconds <span style="color:#719e07">(</span>JVM running <span style="color:#719e07">for</span> 2.963<span style="color:#719e07">)</span> |
| </span></span></code></pre></div><p><strong>Notes</strong>：</p> |
| <ol> |
| <li>In the printouts, the configuration starting with <code>dubbo.</code> Is defined in <em>main/resources/application.properties</em>.</li> |
| </ol> |
| <h3 id="manage-service-by-telnet">Manage service by Telnet</h3> |
| <p>If <em>qos</em> is activated during generation, the service can be watched and managed by <em>telnet</em> or <em>nc</em>.</p> |
| <div class="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>$ telnet localhost <span style="color:#2aa198">22222</span> |
| </span></span><span style="display:flex;"><span>Trying 127.0.0.1... |
| </span></span><span style="display:flex;"><span>Connected to localhost. |
| </span></span><span style="display:flex;"><span>Escape character is <span style="color:#2aa198">&#39;^]&#39;</span>. |
| </span></span><span style="display:flex;"><span> ████████▄ ███ █▄ ▀█████████▄ ▀█████████▄ ▄██████▄ |
| </span></span><span style="display:flex;"><span> ███ ▀███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ▄███▄▄▄██▀ ▄███▄▄▄██▀ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ▀▀███▀▀▀██▄ ▀▀███▀▀▀██▄ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ███ ███ ███ ███ ██▄ ███ ██▄ ███ ███ |
| </span></span><span style="display:flex;"><span> ███ ▄███ ███ ███ ███ ███ ███ ███ ███ ███ |
| </span></span><span style="display:flex;"><span> ████████▀ ████████▀ ▄█████████▀ ▄█████████▀ ▀██████▀ |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>dubbo&gt; |
| </span></span><span style="display:flex;"><span>dubbo&gt;ls |
| </span></span><span style="display:flex;"><span>As Provider side: |
| </span></span><span style="display:flex;"><span>+------------------------------+---+ |
| </span></span><span style="display:flex;"><span>| Provider Service Name |PUB| |
| </span></span><span style="display:flex;"><span>+------------------------------+---+ |
| </span></span><span style="display:flex;"><span>|com.example.HelloService:1.0.0| Y | |
| </span></span><span style="display:flex;"><span>+------------------------------+---+ |
| </span></span><span style="display:flex;"><span>As Consumer side: |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span><span style="display:flex;"><span>|Consumer Service Name|NUM| |
| </span></span><span style="display:flex;"><span>+---------------------+---+ |
| </span></span></code></pre></div><p>Currently, <em>qos</em> supports following command lines. For more information please refer to the official document. [^4]:</p> |
| <ul> |
| <li><em>ls</em>：List the information of client and server.</li> |
| <li><em>online</em>：Bring the service online.</li> |
| <li><em>offline</em>：Bring the service offline.</li> |
| <li><em>help</em>：View online help.</li> |
| </ul> |
| <h2 id="summary">Summary</h2> |
| <p>In this tutorial, we start with RMI and introduce the basic concepts in Java distributed invocations. Based on interface programming, it disguises remote calls as local by agency and run the service registry and looking up by registry center.</p> |
| <p>Then for simplicity, we introduce how to develop a complete Dubbo demo in an easy way of assembled registry and direct Dubbo API oriented programming. Additionally, we look into the usage of <em>ServiceConfig</em> and <em>RefenceConfig</em>, which is of great help for further using Spring XML configuration and the programming pattern of Spring Boot.</p> |
| <p>Eventually, we give an outline of how to create a Dubbo application quickly based on Spring Boot using the public resources, start.dubbo.io, provided by the Dubbo development team and operate and maintain the Dubbo service by <em>qos</em>.</p> |
| <hr> |
| <ol> |
| <li><a href="https://docs.oracle.com/javase/6/docs/technotes/guides/rmi/hello/hello-world.html">Getting Started Using JavaTM RMI</a></li> |
| <li><a href="https://dubbo.apache.org/en/docs/v2.7/user/examples/explicit-target/">Explicit target</a></li> |
| <li><a href="https://dubbo.apache.org/en/docs/v2.7/user/references/registry/multicast/">Multicast Registry</a></li> |
| <li><a href="https://dubbo.apache.org/en/docs/v2.7/user/references/qos/">Online QOS command</a></li> |
| </ol></description></item><item><title>Blog: The third Dubbo meetup has been held in Shenzhen</title><link>https://dubbo.apache.org/en/blog/2018/07/30/the-third-dubbo-meetup-has-been-held-in-shenzhen/</link><pubDate>Mon, 30 Jul 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/07/30/the-third-dubbo-meetup-has-been-held-in-shenzhen/</guid><description> |
| <p>The third Dubbo meetup has successfully been held in Shenzhen, over 2000 people submitted registration, and over 700 were present, more than 17,000 watched the live online.</p> |
| <p>Please enjoy the slides of the topics:</p> |
| <ul> |
| <li>Zhixuan Chen: Dubbo-present-and-2.7-update (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201807%40shenzhen/dubbo-present-and-2.7-update.pdf">slides</a></li> |
| <li>Bin Kang: Microservice-in-lexinfintech (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201807%40shenzhen/microservice-in-lexinfintech.pdf">slides</a></li> |
| <li>Jialiang lin: sentinel (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201807%40shenzhen/sentinel.pdf">slides</a></li> |
| </ul></description></item><item><title>Blog: Sentinel: The flow sentinel of Dubbo services</title><link>https://dubbo.apache.org/en/blog/2018/07/27/sentinel-the-flow-sentinel-of-dubbo-services/</link><pubDate>Fri, 27 Jul 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/07/27/sentinel-the-flow-sentinel-of-dubbo-services/</guid><description> |
| <p>In large clusters there may be thousands of Dubbo service instances in production, with continuous traffic coming in. However, in distributed systems, some services may be unavailable due to various of failure such as traffic surge, high system load, and network latency. If no control actions are performed, this may cause cascading failure, affecting the availability of the service. So we need a powerful library - Sentinel, which can guarantee the stability of the service, to protect the Dubbo service.</p> |
| <h2 id="introduction-to-sentinel">Introduction to Sentinel</h2> |
| <p><a href="https://github.com/alibaba/Sentinel">Sentinel</a> is a powerful library opensourced by Alibaba Middleware Team. Sentinel takes &ldquo;<strong>flow</strong>&rdquo; as the breakthrough point, and covers multiple fields including flow control, concurrency, circuit breaking and load protection to protect service stability.</p> |
| <p>There are mainly three features in Sentinel:</p> |
| <ul> |
| <li><strong>Flow Control</strong>: Sentinel can control the traffic flow of resource calls based on different runtime metrics (such as QPS, number of threads, system load, etc.), for different invocation paths, and adjust random traffic to appropriate shapes (e.g. uniform speed).</li> |
| <li><strong>Circuit Breaking</strong>: When a resource in the invocation chain is unstable (average RT increase or exception ratio increase), Sentinel will fast-fail the call request for this resource to avoid affecting other resources, causing cascade failure.</li> |
| <li><strong>System Load Protection</strong>: Sentinel can be used to protect your server in case the system load goes too high. It helps you to achieve a good balance between system load and incoming requests.</li> |
| </ul> |
| <p>The commonly used circuit breaker/isolation library in production is <a href="https://github.com/Netflix/Hystrix">Netflix Hystrix</a>. Hystrix focuses on the concept of isolation, which isolates dependencies (that is resource in Sentinel) through thread pools or semaphores. The benefit of Hystrix thread pool isolation is that the isolation is thorough, but the downside is that you have to create a lot of thread pools, pre-divide dependencies, and allocate thread pools to each dependency. Sentinel provides another idea for resource isolation: it is controlled by <strong>the number of concurrent threads</strong>. In this way, developer does not need to specify the size of the thread pool in advance, and there is less loss of thread context switching. When the resource is in an unstable state, the response time becomes longer and the number of threads gradually increases. When the number of threads of a resource is raised to a threshold, traffic flow limit is triggered until the stacked thread completes the task and then continues to accept the requests.</p> |
| <p>Hystrix uses Circuit Breaker Pattern to automatically fast-fail the service when exception ratio exceeds the threshold. Sentinel&rsquo;s circuit breaking feature is more versatile, which supports two metrics: average response time and failure ratio. Sentinel also provides various invocation chain path and flow control effects support, as well as the ability to adjust the traffic in real time according to the system load to protect the system. At the same time, Sentinel also provides a real-time monitoring API and dashboard, which allows developers to quickly understand the current state of the system and understand the stability of the service. The scenarios are more abundant.</p> |
| <h2 id="best-practice-for-using-dubbo-with-sentinel">Best Practice for using Dubbo with Sentinel</h2> |
| <p><a href="https://github.com/dubbo/dubbo-sentinel-support">Sentinel Dubbo Adapter</a> provides service consumer filter and provider filter for Dubbo services. We can add the following dependency in <code>pom.xml</code> (if you are using 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-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.alibaba.csp<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>sentinel-dubbo-adapter<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>x.y.z<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>The two filters are enabled by default. Once you add the dependency, the Dubbo services and methods will become protected resources in Sentinel, which can leverage Sentinel&rsquo;s flow control and guard ability when rules are configured. If you don&rsquo;t want to enable the filter, you can manually disable it. For example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Bean</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> ConsumerConfig <span style="color:#268bd2">consumerConfig</span>() { |
| </span></span><span style="display:flex;"><span> ConsumerConfig consumerConfig <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConsumerConfig(); |
| </span></span><span style="display:flex;"><span> consumerConfig.setFilter(<span style="color:#2aa198">&#34;-sentinel.dubbo.consumer.filter&#34;</span>); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> consumerConfig; |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>We&rsquo;ve provided sereval demos, you can check here: <a href="https://github.com/alibaba/Sentinel/tree/master/sentinel-demo/sentinel-demo-dubbo">sentinel-demo-dubbo</a>。</p> |
| <h3 id="service-provider">Service Provider</h3> |
| <p>Dubbo service providers provide services for outside world and handle requests from consumers. To protect the service provider from suffering the proliferation of traffic flow, you can set flow rules in <strong>QPS mode</strong> to the service provider. Thus, when the number of requests per second exceeds the threshold, new requests are automatically rejected.</p> |
| <p>The flow control for Dubbo services has two granularities: service interface and service method.</p> |
| <ul> |
| <li>Service interface：resourceName format is <code>interfaceName</code>，e.g. <code>com.alibaba.csp.sentinel.demo.dubbo.FooService</code></li> |
| <li>Service method：resourceName format is <code>interfaceName:methodSignature</code>，e.g. <code>com.alibaba.csp.sentinel.demo.dubbo.FooService:sayHello(java.lang.String)</code></li> |
| </ul> |
| <p>For the detail of flow rule configuration and flow control, please refer to <a href="https://github.com/alibaba/Sentinel/wiki/Flow-Control">Flow Control | Sentinel</a>.</p> |
| <p>Let&rsquo;s take a look at the effect of the QPS flow control. Assume that we have a service interface <code>com.alibaba.csp.sentinel.demo.dubbo.FooService</code>, which contains a method <code>sayHello(java.lang.String)</code>. We set flow rule for service provider (QPS count = 10). Then we do RPC 15 times at service consumer continuously in 1s. We can see the blocked metrics in the log. The log of blocked calls is located in <code>~/logs/csp/sentinel-block.log</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>2018-07-24 17:13:43|1|com.alibaba.csp.sentinel.demo.dubbo.FooService:sayHello(java.lang.String),FlowException,default,|5,0 |
| </span></span></code></pre></div><p>Log messages will also appear in provider&rsquo;s metric log：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>1532423623000|2018-07-24 17:13:43|com.alibaba.csp.sentinel.demo.dubbo.FooService|15|0|15|0|3 |
| </span></span><span style="display:flex;"><span>1532423623000|2018-07-24 17:13:43|com.alibaba.csp.sentinel.demo.dubbo.FooService:sayHello(java.lang.String)|10|5|10|0|0 |
| </span></span></code></pre></div><p>In many circumstances, it&rsquo;s also significant to control traffic flow based on the <strong>caller</strong>. For example, assuming that there are two services A and B, both of them initiate remote call requests to the service provider. If we want to limit the calls from service B only, we can set the <code>limitApp</code> of flow rule as the identifier of service B (e.g. service name). The Sentinel Dubbo Adapter will automatically resolve the Dubbo consumer&rsquo;s <em>application name</em> as the caller&rsquo;s name (<code>origin</code>), and will bring the caller&rsquo;s name when doing resource protection. If <code>limitApp</code> of flow rules is not configured (<code>default</code>), flow control will take effects on all callers. If <code>limitApp</code> of a flow rule is configured with a caller, then the corresponding flow rule will only take effect on the specific caller.</p> |
| <blockquote> |
| <p>Note: Dubbo consumer does not provide its Dubbo application name when doing RPC, so developers should manually put the application name into <em>attachment</em> at consumer side, then extract it at provider side. Sentinel Dubbo Adapter has implemented a filter where consumer can carry application name information to provider automatically. If the counsmer does not use Sentinel Dubbo Adapter but requires flow control based on caller, developers can manually put the application name into attachment with the key <code>dubboApplication</code>.</p> |
| </blockquote> |
| <p>The <code>sentinel-block.log</code> will also record caller name. For example:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>2018-07-25 16:26:48|1|com.alibaba.csp.sentinel.demo.dubbo.FooService:sayHello(java.lang.String),FlowException,default,demo-consumer|5,0 |
| </span></span></code></pre></div><p>The <code>demo-consumer</code> in the log is the caller name (origin).</p> |
| <h3 id="service-consumer">Service Consumer</h3> |
| <p>Dubbo service consumers act as a client to invoke the remote service. Each service may depend on several downstream services. If a service A depends on the downstream service B, and service B is unstable (i.e. the response time becomes longer), the number of threads where service A invokes service B will accumulate, thus may eventually run out of service A&rsquo;s thread pool. We use the thread count to control access to downstream service B. This can ensure service itself not affected by others when downstream services are not stable and reliable. Based on this scenario, it is recommended to set flow rules with <strong>thread count mode</strong> to consumers so that it&rsquo;s not affected by unstable services.</p> |
| <p>The thread-count-based flow control mode does not require us to explicitly perform thread pool isolation. Sentinel will control the number of threads of the resource, and the excess requests will be rejected directly until the stacked tasks are completed.</p> |
| <h3 id="sentinel-dashboard">Sentinel Dashboard</h3> |
| <p>For ease of use, Sentinel provides a Dashboard for configuring rules, viewing monitoring metrics, machine discovery, and more. We only need to start the dashborad according to the <a href="https://github.com/alibaba/Sentinel/wiki/Dashboard">Sentinel dashboard documentation</a>, then add the appropriate parameters to the corresponding application and launch it. For example, the startup parameters of the service provider demo in this article is:</p> |
| <div class="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>-Djava.net.preferIPv4Stack<span style="color:#719e07">=</span><span style="color:#b58900">true</span> -Dcsp.sentinel.api.port<span style="color:#719e07">=</span><span style="color:#2aa198">8720</span> -Dcsp.sentinel.dashboard.server<span style="color:#719e07">=</span>localhost:8080 -Dproject.name<span style="color:#719e07">=</span>dubbo-provider-demo |
| </span></span></code></pre></div><p>After launching the service provider demo, we can find our application in the Sentinel dashboard. It&rsquo;s convenient to configure the rules in the dashboard：</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/sentinel-dashboard-view-rules.png" alt="Rule List"></p> |
| <p>Or view real-time metrics：</p> |
| <p><img src="https://dubbo.apache.org/imgs/blog/sentinel-dashboard-metrics.png" alt="Real-time metrics monitoring"></p> |
| <h2 id="summary">Summary</h2> |
| <p>This blog post only introduces the simplest scenario in Sentinel - Traffic Flow Control. Sentinel can handle more complex scenarios like circuit breaking, cold starting and uniform traffic flow. For more scenarios, you can dig into <a href="https://github.com/alibaba/Sentinel/wiki">Sentinel Wiki</a>.</p></description></item><item><title>Blog: Tracking with Pinpoint</title><link>https://dubbo.apache.org/en/blog/2018/07/12/tracking-with-pinpoint/</link><pubDate>Thu, 12 Jul 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/07/12/tracking-with-pinpoint/</guid><description> |
| <p>After using Dubbo to serve or integrate applications, assuming that a service backstage log shows an exception and that the service is invoked by multiple applications, it is often difficult to determine which application is called, and what is the cause of the problem, so we need a set of distributed tracking systems to quickly locate the problem. Pinpoint can help us quickly locate problems (of course, there are more than one solution).</p> |
| <h2 id="what-is-pinpoint">What is Pinpoint</h2> |
| <p><a href="https://github.com/naver/pinpoint">Pinpoint</a> is an APM (Application Performance Management) tool for large-scale distributed systems written in Java. Inspired by Dapper, Pinpoint provides a solution to help analyze the overall structure of the system and how components within them are interconnected by tracing transactions across distributed applications.</p> |
| <p>You should definitely check Pinpoint out If you want to</p> |
| <p>understand your application topology at a glance |
| monitor your application in Real-Time |
| gain code-level visibility to every transaction |
| install APM Agents without changing a single line of code |
| have minimal impact on the performance (approximately 3% increase in resource usage)</p> |
| <h3 id="servermap">ServerMap</h3> |
| <p>Understand the topology of any distributed systems by visualizing how their components are interconnected. Clicking on a node reveals details about the component, such as its current status, and transaction count.</p> |
| <h3 id="realtime-active-thread-chart">Realtime Active Thread Chart</h3> |
| <p>Monitor active threads inside applications in real-time.</p> |
| <h3 id="requestresponse-scatter-chart">Request/Response Scatter Chart</h3> |
| <p>Visualize request count and response patterns over time to identify potential problems. Transactions can be selected for additional detail by dragging over the chart.</p> |
| <h3 id="callstack">CallStack</h3> |
| <p>Gain code-level visibility to every transaction in a distributed environment, identifying bottlenecks and points of failure in a single view.</p> |
| <h3 id="inspector">Inspector</h3> |
| <p>View additional details on the application such as CPU usage, Memory/Garbage Collection, TPS, and JVM arguments.</p> |
| <h3 id="supported-modules-last-updated-20180401">Supported Modules (last updated 2018/04/01)</h3> |
| <ul> |
| <li>JDK 6+</li> |
| <li>Tomcat 6/7/8, Jetty 8/9, JBoss EAP 6, Resin 4, Websphere 6/7/8, Vertx 3.3/3.4/3.5</li> |
| <li>Spring, Spring Boot (Embedded Tomcat, Jetty)</li> |
| <li>Apache HTTP Client 3.x/4.x, JDK HttpConnector, GoogleHttpClient, OkHttpClient, NingAsyncHttpClient</li> |
| <li>Thrift Client, Thrift Service, DUBBO PROVIDER, DUBBO CONSUMER</li> |
| <li>ActiveMQ, RabbitMQ</li> |
| <li>MySQL, Oracle, MSSQL, CUBRID,POSTGRESQL, MARIA</li> |
| <li>Arcus, Memcached, Redis, CASSANDRA</li> |
| <li>iBATIS, MyBatis</li> |
| <li>DBCP, DBCP2, HIKARICP</li> |
| <li>gson, Jackson, Json Lib</li> |
| <li>log4j, Logback</li> |
| </ul> |
| <h2 id="pinpoint-and-dubbo">Pinpoint and Dubbo</h2> |
| <h3 id="quickstart-pinpoint">Quickstart Pinpoint</h3> |
| <p><a href="https://pinpoint-apm.github.io/pinpoint/quickstart.html">Quick start</a>（No neet to start TestApp）</p> |
| <h3 id="dubbo-demo">Dubbo demo</h3> |
| <h4 id="create-api-module">Create API module</h4> |
| <p>pom.xml</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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;project</span> xmlns=<span style="color:#2aa198">&#34;http://maven.apache.org/POM/4.0.0&#34;</span> |
| </span></span><span style="display:flex;"><span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;modelVersion&gt;</span>4.0.0<span style="color:#268bd2">&lt;/modelVersion&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.example<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>demo-api<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.0.1-SNAPSHOT<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/project&gt;</span> |
| </span></span></code></pre></div><p>Create API interface：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-go" data-lang="go"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.example.demoapi; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span>public <span style="color:#268bd2">interface</span> HelloService { |
| </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><h4 id="dubbo-provider">Dubbo provider</h4> |
| <p>pom.xml</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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;project</span> xmlns=<span style="color:#2aa198">&#34;http://maven.apache.org/POM/4.0.0&#34;</span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;modelVersion&gt;</span>4.0.0<span style="color:#268bd2">&lt;/modelVersion&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.example<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>demo-provider<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.0.1-SNAPSHOT<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;packaging&gt;</span>jar<span style="color:#268bd2">&lt;/packaging&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;name&gt;</span>demo-provider<span style="color:#268bd2">&lt;/name&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;parent&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-parent<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>2.0.3.RELEASE<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;relativePath/&gt;</span> <span style="color:#586e75">&lt;!-- lookup parent from repository --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/parent&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><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;project.reporting.outputEncoding&gt;</span>UTF-8<span style="color:#268bd2">&lt;/project.reporting.outputEncoding&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;java.version&gt;</span>1.8<span style="color:#268bd2">&lt;/java.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;repositories&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;repository&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;id&gt;</span>sonatype-nexus-snapshots<span style="color:#268bd2">&lt;/id&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;url&gt;</span>https://oss.sonatype.org/content/repositories/snapshots<span style="color:#268bd2">&lt;/url&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;releases&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;enabled&gt;</span>false<span style="color:#268bd2">&lt;/enabled&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/releases&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;snapshots&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;enabled&gt;</span>true<span style="color:#268bd2">&lt;/enabled&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/snapshots&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/repository&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/repositories&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>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 style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.alibaba.boot<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;version&gt;</span>0.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>com.example<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>demo-api<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.0.1-SNAPSHOT<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.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-test<span style="color:#268bd2">&lt;/artifactId&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;/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;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;/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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/project&gt;</span> |
| </span></span></code></pre></div><ol> |
| <li><code>HelloService</code> interface：</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.example.demoprovider.provider; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.alibaba.dubbo.config.annotation.Service; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.example.demoapi.HelloService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@Service</span>(version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${demo.service.version}&#34;</span>, |
| </span></span><span style="display:flex;"><span> application <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${dubbo.application.id}&#34;</span>, |
| </span></span><span style="display:flex;"><span> protocol <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${dubbo.protocol.id}&#34;</span>, |
| </span></span><span style="display:flex;"><span> registry <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${dubbo.registry.id}&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">HelloServiceImpl</span> <span style="color:#268bd2">implements</span> HelloService { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">static</span> <span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> 0; |
| </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> i<span style="color:#719e07">++</span>; |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (i <span style="color:#719e07">%</span> 3 <span style="color:#719e07">==</span> 0) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> RuntimeException(<span style="color:#2aa198">&#34;ex&#34;</span>); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> <span style="color:#2aa198">&#34;Hello &#34;</span> <span style="color:#719e07">+</span> name <span style="color:#719e07">+</span> <span style="color:#2aa198">&#34;!&#34;</span>; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="2"> |
| <li>Spring Boot bootstrap：</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.example.demoprovider; |
| </span></span><span style="display:flex;"><span> |
| </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">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoProviderApplication</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(DemoProviderApplication.class, args); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="3"> |
| <li><code>application.properties</code>：</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-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75"># Spring boot application</span> |
| </span></span><span style="display:flex;"><span>spring.application.name <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo-provider-demo</span> |
| </span></span><span style="display:flex;"><span>server.port <span style="color:#719e07">=</span> <span style="color:#2aa198">9090</span> |
| </span></span><span style="display:flex;"><span>management.port <span style="color:#719e07">=</span> <span style="color:#2aa198">9091</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Service version</span> |
| </span></span><span style="display:flex;"><span>demo.service.version <span style="color:#719e07">=</span> <span style="color:#2aa198">1.0.0</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Base packages to scan Dubbo Components (e.g @Service , @Reference)</span> |
| </span></span><span style="display:flex;"><span>dubbo.scan.basePackages <span style="color:#719e07">=</span> <span style="color:#2aa198">com.example.demoprovider</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Dubbo Config properties</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## ApplicationConfig Bean</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.id <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo-provider-demo</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.name <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo-provider-demo</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## ProtocolConfig Bean</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.id <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.name <span style="color:#719e07">=</span> <span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port <span style="color:#719e07">=</span> <span style="color:#2aa198">12345</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## RegistryConfig Bean</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.id <span style="color:#719e07">=</span> <span style="color:#2aa198">my-registry</span> |
| </span></span><span style="display:flex;"><span>dubbo.registry.address <span style="color:#719e07">=</span> <span style="color:#2aa198">N/A</span> |
| </span></span></code></pre></div><h4 id="dubbo-consumer">Dubbo consumer</h4> |
| <p>pom.xml</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#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;project</span> xmlns=<span style="color:#2aa198">&#34;http://maven.apache.org/POM/4.0.0&#34;</span> xmlns:xsi=<span style="color:#2aa198">&#34;http://www.w3.org/2001/XMLSchema-instance&#34;</span> |
| </span></span><span style="display:flex;"><span> xsi:schemaLocation=<span style="color:#2aa198">&#34;http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd&#34;</span><span style="color:#268bd2">&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;modelVersion&gt;</span>4.0.0<span style="color:#268bd2">&lt;/modelVersion&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>com.example<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>demo-consumer<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.0.1-SNAPSHOT<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;packaging&gt;</span>jar<span style="color:#268bd2">&lt;/packaging&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;name&gt;</span>demo-consumer<span style="color:#268bd2">&lt;/name&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;parent&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-parent<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>2.0.3.RELEASE<span style="color:#268bd2">&lt;/version&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;relativePath/&gt;</span> <span style="color:#586e75">&lt;!-- lookup parent from repository --&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/parent&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><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;project.reporting.outputEncoding&gt;</span>UTF-8<span style="color:#268bd2">&lt;/project.reporting.outputEncoding&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;java.version&gt;</span>1.8<span style="color:#268bd2">&lt;/java.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;repositories&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;repository&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;id&gt;</span>sonatype-nexus-snapshots<span style="color:#268bd2">&lt;/id&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;url&gt;</span>https://oss.sonatype.org/content/repositories/snapshots<span style="color:#268bd2">&lt;/url&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;releases&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;enabled&gt;</span>false<span style="color:#268bd2">&lt;/enabled&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/releases&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;snapshots&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;enabled&gt;</span>true<span style="color:#268bd2">&lt;/enabled&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/snapshots&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/repository&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/repositories&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>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-web<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>com.alibaba.boot<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;version&gt;</span>0.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>com.example<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>demo-api<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;version&gt;</span>0.0.1-SNAPSHOT<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.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-test<span style="color:#268bd2">&lt;/artifactId&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;/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;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;configuration&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;classifier&gt;</span>exec<span style="color:#268bd2">&lt;/classifier&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;/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><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/project&gt;</span> |
| </span></span></code></pre></div><ol> |
| <li><code>@Reference</code> injection <code>HelloService</code></li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.example.democonsumer.controller; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.alibaba.dubbo.config.annotation.Reference; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> com.example.demoapi.HelloService; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.web.bind.annotation.RequestMapping; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.web.bind.annotation.RequestParam; |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">import</span> org.springframework.web.bind.annotation.RestController; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">@RestController</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoConsumerController</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Reference</span>(version <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${demo.service.version}&#34;</span>, |
| </span></span><span style="display:flex;"><span> application <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;${dubbo.application.id}&#34;</span>, |
| </span></span><span style="display:flex;"><span> url <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;dubbo://&lt;Real IP Address&gt;:12345&#34;</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> HelloService helloService; |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@RequestMapping</span>(<span style="color:#2aa198">&#34;/sayHello&#34;</span>) |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">sayHello</span>(<span style="color:#268bd2">@RequestParam</span> String name) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> helloService.sayHello(name); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="2"> |
| <li>Spring Boot bootstrap:</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#719e07">package</span> com.example.democonsumer; |
| </span></span><span style="display:flex;"><span> |
| </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">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DemoConsumerApplication</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(DemoConsumerApplication.class, args); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><ol start="3"> |
| <li><code>application.properties</code>:</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-properties" data-lang="properties"><span style="display:flex;"><span><span style="color:#586e75"># Spring boot application</span> |
| </span></span><span style="display:flex;"><span>spring.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo-consumer-demo</span> |
| </span></span><span style="display:flex;"><span>server.port<span style="color:#719e07">=</span><span style="color:#2aa198">8080</span> |
| </span></span><span style="display:flex;"><span>management.port<span style="color:#719e07">=</span><span style="color:#2aa198">8081</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Service Version</span> |
| </span></span><span style="display:flex;"><span>demo.service.version<span style="color:#719e07">=</span><span style="color:#2aa198">1.0.0</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75"># Dubbo Config properties</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## ApplicationConfig Bean</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.id<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo-consumer-demo</span> |
| </span></span><span style="display:flex;"><span>dubbo.application.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo-consumer-demo</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">## ProtocolConfig Bean</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.id<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.name<span style="color:#719e07">=</span><span style="color:#2aa198">dubbo</span> |
| </span></span><span style="display:flex;"><span>dubbo.protocol.port<span style="color:#719e07">=</span><span style="color:#2aa198">12345</span> |
| </span></span></code></pre></div><h3 id="using-pinpoint-agent-to-start-dubbo-provider-and-dubbo-consumer">Using Pinpoint-agent to start <code>Dubbo provider</code> and <code>Dubbo consumer</code></h3> |
| <ol> |
| <li>Maven clean package</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 clean package |
| </span></span></code></pre></div><ol start="2"> |
| <li>Start provider</li> |
| </ol> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>java -jar -javaagent:$AGENT_PATH/pinpoint-bootstrap-$VERSION.jar -Dpinpoint.agentId=demo-provider -Dpinpoint.applicationName=DP target/demo-provider-0.0.1-SNAPSHOT.jar |
| </span></span></code></pre></div><ol start="3"> |
| <li>Start consumer</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>java -jar -javaagent:$AGENT_PATH/pinpoint-bootstrap-$VERSION.jar -Dpinpoint.agentId=demo-consumer -Dpinpoint.applicationName=DC target/demo-comsumer-0.0.1-SNAPSHOT-exec.jar |
| </span></span></code></pre></div><ol start="4"> |
| <li>Access the consumer address to simulate user requests</li> |
| </ol> |
| <p><code>http://localhost:8080/sayHello?name=ABC</code></p> |
| <h2 id="using-pinpoint-locate-problems">Using Pinpoint locate problems</h2> |
| <h3 id="homepage">Homepage</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/en_pinpoint-home.png" alt="/admin-guide/images/pinpoint-home.png"></p> |
| <blockquote> |
| <p>The user request here is double the number of requests for DubboProvider, because the favicon.ico icon request is recorded.</p> |
| </blockquote> |
| <h3 id="call-tree">Call tree</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/en_pinpoint-calltree.png" alt="/admin-guide/images/pinpoint-calltree.png"></p> |
| <h3 id="mixed-view">Mixed view</h3> |
| <p><img src="https://dubbo.apache.org/imgs/blog/en_pinpoint-mixedview.png" alt="/admin-guide/images/pinpoint-mixedview.png"></p> |
| <h3 id="other">Other</h3> |
| <p>The example simply simulates the provision and call of Dubbo, and does not carry out the application of other middleware such as database. For detailed use, please refer to the Pinpoint document.</p></description></item><item><title>Blog: Your First Dubbo Filter</title><link>https://dubbo.apache.org/en/blog/2018/07/01/your-first-dubbo-filter/</link><pubDate>Sun, 01 Jul 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/07/01/your-first-dubbo-filter/</guid><description> |
| <h3 id="overview">Overview</h3> |
| <p>In overall design of Dubbo, Filter is a very important concept, most of Dubbo&rsquo;s functions are based on this |
| extension point, and the Filter interception will be executed during each call.</p> |
| <h4 id="extension-mechanism-of-dubbo-filter">Extension Mechanism of Dubbo Filter</h4> |
| <p>There are already about 20 Filters implemented in Dubbo. Their entry is ProtocolFilterWrapper, ProtocolFilterWrapper |
| makes a Wrapper on Protocol and will be loaded when the extension is loaded. Then, let&rsquo;s see how |
| the Filter chain is constructed.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#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">//ProtocolFilterWrapper.java</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">refer</span>(Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> type, URL url) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> protocol.refer(type, url); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> buildInvokerChain(protocol.refer(type, url), Constants.REFERENCE_FILTER_KEY, Constants.CONSUMER); |
| </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">private</span> <span style="color:#268bd2">static</span> <span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">buildInvokerChain</span>(<span style="color:#268bd2">final</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> invoker, String key, String group) { |
| </span></span><span style="display:flex;"><span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> last <span style="color:#719e07">=</span> invoker; |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>Filter<span style="color:#719e07">&gt;</span> filters <span style="color:#719e07">=</span> ExtensionLoader.getExtensionLoader(Filter.class).getActivateExtension(invoker.getUrl(), key, group); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (filters.size() <span style="color:#719e07">&gt;</span> 0) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> filters.size() <span style="color:#719e07">-</span> 1; i <span style="color:#719e07">&gt;=</span> 0; i <span style="color:#719e07">--</span>) { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> Filter filter <span style="color:#719e07">=</span> filters.get(i); |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">final</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> next <span style="color:#719e07">=</span> last; |
| </span></span><span style="display:flex;"><span> last <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Invoker<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span>() { |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Class<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">getInterface</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invoker.getInterface(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> URL <span style="color:#268bd2">getUrl</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invoker.getUrl(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">boolean</span> <span style="color:#268bd2">isAvailable</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invoker.isAvailable(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Result <span style="color:#268bd2">invoke</span>(Invocation invocation) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> filter.invoke(next, invocation); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">destroy</span>() { |
| </span></span><span style="display:flex;"><span> invoker.destroy(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> String <span style="color:#268bd2">toString</span>() { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invoker.toString(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> }; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> last; |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><h4 id="activation-mechanism-of-dubbo-filter">Activation Mechanism of Dubbo Filter</h4> |
| <p>Through the above code we can see that, in the method buildInvokerChain, first get all |
| activated chains, the chain here is already sorted. Then construct a call chain of Filter |
| through the Invoker, finally the constructed call chain can be roughly expressed as: Filter1-&gt;Filter2-&gt;Filter3-&gt;&hellip;&hellip;-&gt;Invoker, |
| now let&rsquo;s see the detailed flow of the activated chain in the above step.</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> <span style="color:#268bd2">public</span> List<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">getActivateExtension</span>(URL url, String key, String group) { |
| </span></span><span style="display:flex;"><span> String value <span style="color:#719e07">=</span> url.getParameter(key); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> getActivateExtension(url, value <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">||</span> value.length() <span style="color:#719e07">==</span> 0 <span style="color:#719e07">?</span> <span style="color:#cb4b16">null</span> : Constants.COMMA_SPLIT_PATTERN.split(value), group); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> List<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> <span style="color:#268bd2">getActivateExtension</span>(URL url, String<span style="color:#719e07">[]</span> values, String group) { |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> exts <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ArrayList<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span> names <span style="color:#719e07">=</span> values <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">?</span> <span style="color:#719e07">new</span> ArrayList<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">&gt;</span>(0) : Arrays.asList(values); |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span> names.contains(Constants.REMOVE_VALUE_PREFIX <span style="color:#719e07">+</span> Constants.DEFAULT_KEY)) { |
| </span></span><span style="display:flex;"><span> getExtensionClasses(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (Map.Entry<span style="color:#719e07">&lt;</span>String, Activate<span style="color:#719e07">&gt;</span> entry : cachedActivates.entrySet()) { |
| </span></span><span style="display:flex;"><span> String name <span style="color:#719e07">=</span> entry.getKey(); |
| </span></span><span style="display:flex;"><span> Activate activate <span style="color:#719e07">=</span> entry.getValue(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (isMatchGroup(group, activate.group())) { |
| </span></span><span style="display:flex;"><span> T ext <span style="color:#719e07">=</span> getExtension(name); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span> names.contains(name) <span style="color:#719e07">&amp;&amp;</span> <span style="color:#719e07">!</span> names.contains(Constants.REMOVE_VALUE_PREFIX <span style="color:#719e07">+</span> name) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&amp;&amp;</span> isActive(activate, url)) { |
| </span></span><span style="display:flex;"><span> exts.add(ext); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> Collections.sort(exts, ActivateComparator.COMPARATOR); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> List<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span> usrs <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ArrayList<span style="color:#719e07">&lt;</span>T<span style="color:#719e07">&gt;</span>(); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> (<span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> 0; i <span style="color:#719e07">&lt;</span> names.size(); i <span style="color:#719e07">++</span>) { |
| </span></span><span style="display:flex;"><span> String name <span style="color:#719e07">=</span> names.get(i); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (<span style="color:#719e07">!</span> name.startsWith(Constants.REMOVE_VALUE_PREFIX) |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">&amp;&amp;</span> <span style="color:#719e07">!</span> names.contains(Constants.REMOVE_VALUE_PREFIX <span style="color:#719e07">+</span> name)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (Constants.DEFAULT_KEY.equals(name)) { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (usrs.size() <span style="color:#719e07">&gt;</span> 0) { |
| </span></span><span style="display:flex;"><span> exts.addAll(0, usrs); |
| </span></span><span style="display:flex;"><span> usrs.clear(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">else</span> { |
| </span></span><span style="display:flex;"><span> T ext <span style="color:#719e07">=</span> getExtension(name); |
| </span></span><span style="display:flex;"><span> usrs.add(ext); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (usrs.size() <span style="color:#719e07">&gt;</span> 0) { |
| </span></span><span style="display:flex;"><span> exts.addAll(usrs); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> exts; |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>Through the above code we can see that, some of the Filters configured by the user are activated by default, |
| and some need to be activated by the configuration file. The loading order of all Filters is to process Dubbo&rsquo;s |
| default Filter first, and then to process the Filter defined by the user. With the &ldquo;-&rdquo; configuration, Dubbo&rsquo;s defualt Filter |
| can be replaced, with this configuration, the user can flexibly replace or modify the Filter&rsquo;s load order.</p> |
| <h4 id="built-in-filter-of-dubbo">Built-in Filter of Dubbo</h4> |
| <p>Dubbo has lots of built-in Filter. RpcContext, accesslog and other functions can be implemented by Dubbo. |
| Now let&rsquo;s see the ConsumerContextFilter which used by the Consumer side for context delivery:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> Result <span style="color:#268bd2">invoke</span>(Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker, Invocation invocation) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> RpcContext.getContext() |
| </span></span><span style="display:flex;"><span> .setInvoker(invoker) |
| </span></span><span style="display:flex;"><span> .setInvocation(invocation) |
| </span></span><span style="display:flex;"><span> .setLocalAddress(NetUtils.getLocalHost(), 0) |
| </span></span><span style="display:flex;"><span> .setRemoteAddress(invoker.getUrl().getHost(), |
| </span></span><span style="display:flex;"><span> invoker.getUrl().getPort()); |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> (invocation <span style="color:#719e07">instanceof</span> RpcInvocation) { |
| </span></span><span style="display:flex;"><span> ((RpcInvocation)invocation).setInvoker(invoker); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> { |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invoker.invoke(invocation); |
| </span></span><span style="display:flex;"><span> } <span style="color:#719e07">finally</span> { |
| </span></span><span style="display:flex;"><span> RpcContext.getContext().clearAttachments(); |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span> } |
| </span></span></code></pre></div><p>This Filter records the state information during call, and passes the attachments parameter set |
| by the client to the server through the invocation object, and these parameters will be cleared |
| after the call is completed, which is why the request status information can be recorded by times |
| and delivered.</p> |
| <h4 id="implement-a-dubbo-filter">Implement A Dubbo Filter</h4> |
| <p>Because of Dubbo&rsquo;s flexible design and good scalability, we can implement business logic |
| in the call chain by implementing our own Dubbo Filter, such as time-consuming statistics, monitor information statistics, etc. |
| Now, let&rsquo;s implement a simple Filter:</p> |
| <p>Maven project structure:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>src |
| </span></span><span style="display:flex;"><span> |-main |
| </span></span><span style="display:flex;"><span> |-java |
| </span></span><span style="display:flex;"><span> |-com |
| </span></span><span style="display:flex;"><span> |-xxx |
| </span></span><span style="display:flex;"><span> |-XxxFilter.java (impelement Filter interface) |
| </span></span><span style="display:flex;"><span> |-resources |
| </span></span><span style="display:flex;"><span> |-META-INF |
| </span></span><span style="display:flex;"><span> |-dubbo |
| </span></span><span style="display:flex;"><span> |-com.alibaba.dubbo.rpc.Filter (Plain text file with content：xxx=com.xxx.XxxFilter) |
| </span></span></code></pre></div><p>XxxFilter.java：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxFilter</span> <span style="color:#268bd2">implements</span> Filter { |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Result <span style="color:#268bd2">invoke</span>(Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker, Invocation invocation) <span style="color:#268bd2">throws</span> RpcException { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// before filter ...</span> |
| </span></span><span style="display:flex;"><span> Result result <span style="color:#719e07">=</span> invoker.invoke(invocation); |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// after filter ...</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> result; |
| </span></span><span style="display:flex;"><span> } |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>META-INF/dubbo/com.alibaba.dubbo.rpc.Filter：</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>xxx=com.xxx.XxxFilter |
| </span></span></code></pre></div><p>configure in xml as:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- Consumer call process interception --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:reference</span> filter=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- Consumer call process default interception，intercept all reference --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:consumer</span> filter=<span style="color:#2aa198">&#34;xxx&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- Provider call process interception --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:service</span> filter=<span style="color:#2aa198">&#34;xxx&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- Provider call process default interception，intercept all service --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:provider</span> filter=<span style="color:#2aa198">&#34;xxx&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span></code></pre></div><p>or use annotation as:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Activate</span>(group <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;consumer&#34;</span>) |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">XxxFilter</span> <span style="color:#268bd2">implements</span> Filter { |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// ...</span> |
| </span></span><span style="display:flex;"><span>} |
| </span></span></code></pre></div><p>Using xml configuration is more flexible and granular.</p> |
| <p>In before and after, you can implement your own business logic to give the filter a certain function. |
| Once written and configured, the filter is activated by the Dubbo and executed in the call chain.</p></description></item><item><title>Blog: The second Dubbo Shanghai meetup has been held successfully</title><link>https://dubbo.apache.org/en/blog/2018/06/23/the-second-dubbo-shanghai-meetup-has-been-held-successfully/</link><pubDate>Sat, 23 Jun 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/06/23/the-second-dubbo-shanghai-meetup-has-been-held-successfully/</guid><description> |
| <p>The sencond Dubbo meetup has successfully been held in Shanghai, over 700 people submitted registration, and over 300 were present, more than 10,000 watched the live online.</p> |
| <p>Please enjoy the slides of the topics:</p> |
| <ul> |
| <li>Jerrick Zhu: Dubbo Status and Roadmap (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201806%40Shanghai/dubbo-status-and-roadmap.pdf">slides</a></li> |
| <li>Mercy Ma: Dubbo Cloud Native Practices and Thoughts (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201806%40Shanghai/dubbo-cloud-native-practices-and-thoughts.pdf">slides</a></li> |
| <li>Ping Guo: Nacos Open Source Initiative (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201806%40Shanghai/nacos-open-source-initiative.pdf">slides</a></li> |
| <li>Zhiwei Pan: Dubbo Practices on Internet Finance Industries (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/blob/master/slides/meetup/201806%40Shanghai/dubbo-practices-on-internet-finance-industries.pdf">slides</a></li> |
| </ul></description></item><item><title>Blog: The first Dubbo meetup has been held in Beijing</title><link>https://dubbo.apache.org/en/blog/2018/05/12/the-first-dubbo-meetup-has-been-held-in-beijing/</link><pubDate>Sat, 12 May 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/05/12/the-first-dubbo-meetup-has-been-held-in-beijing/</guid><description> |
| <p>The first Dubbo meetup has successfully been held in Beijing, over 400+ people were present. What a great event!</p> |
| <p>Please enjoy the slides of the topics:</p> |
| <ul> |
| <li>Ian Luo: Dubbo&rsquo;s present and future (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/raw/master/slides/meetup/201805%40Beijing/dubbo-present-and-future.pdf">slides</a></li> |
| <li>Jun Liu: Introduction to the 4th Aliware Performance Challenge (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/raw/master/slides/meetup/201805%40Beijing/introduction-to-4th-aliware-performance-challenge.pdf">slides</a></li> |
| <li>Zhixuan Chen: Quickly building Microservice with Dubbo and Spring-boot (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/raw/master/slides/meetup/201805%40Beijing/quickly-building-microservice-with-dubbo-and-springboot.pdf">slides</a></li> |
| <li>Xin Wang: Dubbo and Weidian&rsquo;s Practice on Microservice Architecture (Chinese) <a href="https://github.com/dubbo/awesome-dubbo/raw/master/slides/meetup/201805%40Beijing/dubbo-and-weidian's-practice-on-microservice-architecture.pdf">slides</a></li> |
| </ul></description></item><item><title>Blog: The ApacheCon NA schedule has been announced</title><link>https://dubbo.apache.org/en/blog/2018/05/02/the-apachecon-na-schedule-has-been-announced/</link><pubDate>Wed, 02 May 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/05/02/the-apachecon-na-schedule-has-been-announced/</guid><description> |
| <p>Ian Luo(PMC) and Jun Liu(PMC) will talk about &ldquo;Introducing Apache Dubbo(Incubating): What is Dubbo and How it Works&rdquo; at ApacheCon NA this year in Montréal! Please check out the schedule <a href="https://apachecon.dukecon.org/acna/2018/#/scheduledEvent/b8db9dc580d85853f">here</a> and register <a href="https://www.eventbrite.com/e/apachecon-north-america-2018-registration-43200327342">here</a>.</p></description></item><item><title>Blog: The GSoC(Google Summer of Code) 2018</title><link>https://dubbo.apache.org/en/blog/2018/04/25/the-gsocgoogle-summer-of-code-2018/</link><pubDate>Wed, 25 Apr 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/04/25/the-gsocgoogle-summer-of-code-2018/</guid><description> |
| <p>The GSoC(Google Summer of Code) 2018 projects has been announced, Raghu Reddy&rsquo;s project &ldquo;Extending Serialization protocols support for Apache Dubbo&rdquo; has been <a href="https://summerofcode.withgoogle.com/projects/#4747840161579008">accepted</a>! Congratulations!</p></description></item><item><title>Blog: Dubbo roadmap is announced in QCon Beijing 2018</title><link>https://dubbo.apache.org/en/blog/2018/04/22/dubbo-roadmap-is-announced-in-qcon-beijing-2018/</link><pubDate>Sun, 22 Apr 2018 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/2018/04/22/dubbo-roadmap-is-announced-in-qcon-beijing-2018/</guid><description> |
| <p>Ian Luo has delivered a great talk at QCon Beijing 2018, where the roadmap of Dubbo has also be announced. Please enjoy the <a href="https://github.com/dubbo/awesome-dubbo/raw/master/slides/qcon2018/dubbo-present-and-future.pdf">slides</a>!</p></description></item><item><title>Blog: Application-Level Service Discovery</title><link>https://dubbo.apache.org/en/blog/1/01/01/application-level-service-discovery/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/blog/1/01/01/application-level-service-discovery/</guid><description/></item></channel></rss> |
