dubbo-spring-boot-project

by apache

Spring Boot Project for Apache Dubbo

4.8K Stars 1.6K Forks Last release: 3 months ago (2.7.8) Apache License 2.0 279 Commits 13 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Apache Dubbo Spring Boot Project

Build Status codecov license

Apache Dubbo Spring Boot Project makes it easy to create Spring Boot application using Dubbo as RPC Framework. What's more, it also provides: * auto-configure features (e.g., annotation-driven, auto configuration, externalized configuration). * production-ready features (e.g., security, health checks, externalized configuration).

Apache Dubbo |ˈdʌbəʊ| is a high-performance, light weight, java based RPC framework. Dubbo offers three key functionalities, which include interface based remote call, fault tolerance & load balancing, and automatic service registration & discovery.

中文说明

Released version

You can introduce the latest

dubbo-spring-boot-starter
to your project by adding the following dependency to your pom.xml ```xml 2.3.0.RELEASE 2.7.7

<!-- Spring Boot --> org.springframework.boot spring-boot-dependencies ${spring-boot.version} pom import

    
    
        org.apache.dubbo
        dubbo-dependencies-bom
        ${dubbo.version}
        pom
        import
    


<!-- Dubbo Spring Boot Starter --> org.apache.dubbo dubbo-spring-boot-starter 2.7.7
```

If your project failed to resolve the dependency, try to add the following repository:

xml

    
        apache.snapshots.https
        Apache Development Snapshot Repository
        https://repository.apache.org/content/repositories/snapshots
        
            false
        
        
            true
        
    

Legacy Versions

If you still use the legacy Dubbo whose version is less than 2.7.0, please use the following Spring Boot starters:

| Dubbo Spring Boot | Dubbo | Spring Boot | | ----------------- | ------ | ----------- | | 0.2.1.RELEASE | 2.6.5+ | 2.x | | 0.1.2.RELEASE | 2.6.5+ | 1.x |

Build from Source

If you'd like to attempt to experience the latest features, you also can build from the source code as follow:

  1. Maven install current project in your local repository. > Maven install =
    mvn install

Getting Started

If you don't know about Dubbo, please take a few minutes to learn http://dubbo.apache.org/. After that you could dive deep into dubbo user guide.

Usually, There are two usage scenarios for Dubbo applications, one is Dubbo service(s) provider, another is Dubbo service(s) consumer, thus let's get a quick start on them.

First of all, we suppose an interface as Dubbo RPC API that a service provider exports and a service client consumes:

public interface DemoService {

String sayHello(String name);

}

Dubbo service(s) provider

  1. Service Provider implements

    DemoService
    @Service(version = "1.0.0")
    public class DefaultDemoService implements DemoService {
    
    
    /**
     * The default value of ${dubbo.application.name} is ${spring.application.name}
     */
    @Value("${dubbo.application.name}")
    private String serviceName;
    
    public String sayHello(String name) {
        return String.format("[%s] : Hello, %s", serviceName, name);
    }

    }

  2. Provides a bootstrap class

    @EnableAutoConfiguration
    public class DubboProviderDemo {
    
    
    public static void main(String[] args) {
        SpringApplication.run(DubboProviderDemo.class,args);
    }

    }

  3. Configures the

    application.properties
    :
    # Spring boot application
    spring.application.name=dubbo-auto-configuration-provider-demo
    # Base packages to scan Dubbo Component: @org.apache.dubbo.config.annotation.Service
    dubbo.scan.base-packages=org.apache.dubbo.spring.boot.sample.provider.service
    
    

    Dubbo Application

    The default value of dubbo.application.name is ${spring.application.name}

    dubbo.application.name=${spring.application.name}

    Dubbo Protocol

    dubbo.protocol.name=dubbo dubbo.protocol.port=12345

    Dubbo Registry

    dubbo.registry.address=N/A

Dubbo service(s) consumer

  1. Service consumer also provides a bootstrap class to reference

    DemoService
    @EnableAutoConfiguration
    public class DubboAutoConfigurationConsumerBootstrap {
    
    
    private final Logger logger = LoggerFactory.getLogger(getClass());
    
    @Reference(version = "1.0.0", url = "dubbo://127.0.0.1:12345")
    private DemoService demoService;
    
    public static void main(String[] args) {
        SpringApplication.run(DubboAutoConfigurationConsumerBootstrap.class).close();
    }
    
    @Bean
    public ApplicationRunner runner() {
        return args -&gt; {
            logger.info(demoService.sayHello("mercyblitz"));
        };
    }

    }

  2. configures

    application.yml
    spring:
      application:
        name: dubbo-auto-configure-consumer-sample
    

If

DubboProviderDemo
works well, please make sure
DubboProviderDemo
is started.

More details, please refer to Samples.

Getting help

Having trouble with Dubbo Spring Boot? We’d like to help!

Building from Source

If you want to try out the latest features of Dubbo Spring Boot, it can be easily built with the maven wrapper. Your JDK is 1.8 or above.

$ ./mvnw clean install

Modules

There are some modules in Apache Dubbo Spring Boot Project, let's take a look at below overview:

dubbo-spring-boot-parent

The main usage of

dubbo-spring-boot-parent
is providing dependencies management for other modules.

dubbo-spring-boot-autoconfigure

dubbo-spring-boot-autoconfigure
uses Spring Boot's
@EnableAutoConfiguration
which helps core Dubbo's components to be auto-configured by
DubboAutoConfiguration
. It reduces code, eliminates XML configuration.

dubbo-spring-boot-actuator

dubbo-spring-boot-actuator
provides production-ready features (e.g., health checks, endpoints, and externalized configuration).

dubbo-spring-boot-starter

dubbo-spring-boot-starter
is a standard Spring Boot Starter, which contains dubbo-spring-boot-autoconfigure and dubbo-spring-boot-actuator. It will be imported into your application directly.

dubbo-spring-boot-samples

The samples project of Dubbo Spring Boot that includes:

License

Apache Dubbo spring boot project is under the Apache 2.0 license. See the LICENSE file for details.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.