Apache Dubbo Project

Apache Dubbo is a high-performance, Java-based open-source RPC framework. Please visit theofficial sitefor the quick start guide and documentation, as well as thewikifor news, FAQ, and release notes.

We are now collecting Dubbo user info to help us to improve Dubbo further. Kindly support us by providing your usage information onWanted: who's using dubbo,thanks:)

Architecture

Features

• Transparent interface based RPC
• Intelligent load balancing
• Automatic service registration and discovery
• High extensibility
• Runtime traffic routing
• Visualized service governance

Getting started

The following code snippet comes fromDubbo Samples.You may clone the sample project and step into thedubbo-samples-apisubdirectory before proceeding.

git clone https://github /apache/dubbo-samples.git
cddubbo-samples/1-basic/dubbo-samples-api

There's aREADMEfile underdubbo-samples-apidirectory. We recommend referencing the samples in that directory by following the below-mentioned instructions:

Maven dependency

<properties>
<dubbo.version>3.2.13-SNAPSHOT</dubbo.version>
</properties>

<dependencies>
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
<version>${dubbo.version}</version>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-dependencies-zookeeper</artifactId>
<version>${dubbo.version}</version>
<type>pom</type>
</dependency>
</dependencies>

Define service interfaces

packageorg.apache.dubbo.samples.api;

publicinterfaceGreetingsService{
StringsayHi(Stringname);
}

Seeapi/GreetingsService.javaon GitHub.

Implement service interface for the provider

packageorg.apache.dubbo.samples.provider;

importorg.apache.dubbo.samples.api.GreetingsService;

publicclassGreetingsServiceImplimplementsGreetingsService{
@Override
publicStringsayHi(Stringname) {
return"hi,"+name;
}
}

Seeprovider/GreetingsServiceImpl.javaon GitHub.

Start service provider

packageorg.apache.dubbo.samples.provider;


importorg.apache.dubbo.config.ApplicationConfig;
importorg.apache.dubbo.config.RegistryConfig;
importorg.apache.dubbo.config.ServiceConfig;
importorg.apache.dubbo.samples.api.GreetingsService;

importjava.util.concurrent.CountDownLatch;

publicclassApplication{
privatestaticStringzookeeperHost=System.getProperty("zookeeper.address","127.0.0.1");

publicstaticvoidmain(String[]args)throwsException{
ServiceConfig<GreetingsService>service=newServiceConfig<>();
service.setApplication(newApplicationConfig("first-dubbo-provider"));
service.setRegistry(newRegistryConfig("zookeeper://"+zookeeperHost+":2181"));
service.setInterface(GreetingsService.class);
service.setRef(newGreetingsServiceImpl());
service.export();

System.out.println("dubbo service started");
newCountDownLatch(1).await();
}
}

Seeprovider/Application.javaon GitHub.

Build and run the provider

mvn clean package
mvn -Djava.net.preferIPv4Stack=true -Dexec.mainClass=org.apache.dubbo.samples.provider.Application exec:java

Call remote service in the consumer

packageorg.apache.dubbo.samples.client;


importorg.apache.dubbo.config.ApplicationConfig;
importorg.apache.dubbo.config.ReferenceConfig;
importorg.apache.dubbo.config.RegistryConfig;
importorg.apache.dubbo.samples.api.GreetingsService;

publicclassApplication{
privatestaticStringzookeeperHost=System.getProperty("zookeeper.address","127.0.0.1");

publicstaticvoidmain(String[]args) {
ReferenceConfig<GreetingsService>reference=newReferenceConfig<>();
reference.setApplication(newApplicationConfig("first-dubbo-consumer"));
reference.setRegistry(newRegistryConfig("zookeeper://"+zookeeperHost+":2181"));
reference.setInterface(GreetingsService.class);
GreetingsServiceservice=reference.get();
Stringmessage=service.sayHi("dubbo");
System.out.println(message);
}
}

Seeclient/Application.javaon GitHub.

Build and run the consumer

mvn clean package
mvn -Djava.net.preferIPv4Stack=true -Dexec.mainClass=org.apache.dubbo.samples.client.Application exec:java

The consumer will print outhi, dubboon the screen.

Next steps

• Your first Dubbo application- A 101 tutorial to reveal more details, with the same code above.
• Dubbo user manual- How to use Dubbo and all its features.
• Dubbo developer guide- How to involve in Dubbo development.
• Dubbo admin manual- How to admin and manage Dubbo services.

Building

If you want to try out the cutting-edge features, you can build with the following commands. (Java 1.8 is needed to build the master branch)

mvn clean install

Recommended Test Environment

To avoid intermittent test failures (i.e., flaky tests), it is recommended to have a machine or virtual machine with the following specifications:

• Minimum of 2CPUs.
• Minimum of 2Gb of RAM.

How does the Dubbo Community collaborate?

The Dubbo Community primarily communicates on GitHub through issues, discussions, and pull requests.

• Issues: We use issues to track bugs and tasks. Anywork-relateditem is associated with an issue.
• Discussions: We use discussions for questions, early proposals, and announcements. Anyidea-relateditem is associated with a discussion.
• Pull Requests: We use pull requests to merge a set of changes from contributors into Dubbo.

We have also implementeda project boardto monitor all the items.

Any essential changes should be discussed on the mailing list before they happen.

Seeking for help

If you have questions such as:

• What is Dubbo?
• How do I use Dubbo?
• Why did an unexpected result occur?

Please start a discussion athttps://github /apache/dubbo/discussions.

However, if you encounter the following situations:

• You're certain there's a bug that Dubbo needs to fix,
• You believe a feature could be enhanced,
• You have a detailed proposal for improving Dubbo,

Please open an issue athttps://github /apache/dubbo/issues.

To ask effective questions, we recommend readingHow To Ask Questions The Smart Wayfirst.

Contribution

• Browse the "help wanted" tasks in theDubbo project board.
• Participate in discussions on the mailing list. See the subscriptionguide.
• Respond to queries in thediscussions.
• Resolve bugs reported inissuesand send us a pull request.
• Review existingpull requests.
• Enhance thewebsite.We typically need:
  • Blog posts
  • Translations for documentation
  • Use cases showcasing Dubbo integration in enterprise systems.
• Improve thedubbo-admin.
• Contribute to the projects listed in theecosystem.
• Any other forms of contribution not listed above are also welcome.
• If you're interested in contributing, please send an email to[email protected]to let us know!

For further details, please refer ourguideabout how to contribute Dubbo.

Reporting bugs

Please follow thetemplatefor reporting any issues.

Reporting a security vulnerability

Please report security vulnerabilities tousprivately.

Contact

• Mailing list:

  • dev list: for dev/user discussion.subscribe,unsubscribe,archive,guide

• Bugs:Issues

• Gitter:Gitter channel

• Twitter:@ApacheDubbo

Dubbo ecosystem

• Dubbo Ecosystem Entry- A GitHub groupdubboto gather all Dubbo relevant projects not appropriate inapachegroup yet
• Dubbo Website- Apache Dubbo official website
• Dubbo Samples- samples for Apache Dubbo
• Dubbo Admin- The reference implementation for Dubbo admin
• Dubbo Awesome- Dubbo's slides and video links in Meetup

Language

• Go(recommended)
• Rust
• Node.js
• Python
• PHP
• Erlang

License

Apache Dubbo software is licensed under the Apache License Version 2.0. See theLICENSEfile for details.