两小时学会使用dubbo(直接API、spring、注解、springboot)

本文链接：https://blog.youkuaiyun.com/2401_87705318/article/details/142917451

什么是Dubbo

Dubbo是一个分布式、高性能、透明化的RPC服务框架，提供服务自动注册、自动发现等高效服务治理方案，可以和Spring框架无缝集成。Dubbo最常用的应用就是远程调用。

Dubbo中服务端最核心的对象有四个：

ApplicationConfig：配置当前应用信息
ProtocolConfig：配置提供服务的协议信息
RegistryConfig：配置注册相关信息
ServiceConfig：配置暴露的服务信息

Dubbo客户端中核心的对象有两个：

ApplicationConfig：配置当前应用信息
ReferenceConfig：配置引用的服务信息

Dubbo的主要应用场景

透明化的远程方法调用，就像调用本地方法一样调用远程方法，只需简单配置，没有任何API侵入。

软负载均衡及容错机制，可在内网替代F5等硬件负载均衡器，降低成本，减少单点。（F5负载均衡器我也是百度来的）。

服务自动注册与发现，不再需要写死服务提供方地址，注册中心基于接口名查询服务提供者的IP地址，并且能够平滑添加或删除服务提供者。

Dubbo的使用

接下来通过四种方式入门Dubbo。首先会通过原生API直接展示dubbo的直连和注册中心实现方式，接着使用Spring、注解和SpringBoot的方式分别展示如何使用Dubbo。

案例源码点击这里

在写dubbo相关代码前，首先要定义一个公共的api服务，这个服务里存放的是service接口。服务提供者引入这个工程，写实现类，提供dubbo接口；服务消费者引入这个工程，通过这个工程的service接口调用。

User类：

arduino

代码解读

复制代码

@Data //RPC调用一般不建议使用lombok注解，容易出很多bug，这里使用是为了方便 public class User implements Serializable { private static final long serialVersionUID = -9206514891359830486L; private Long id; private String name; private String sex; }

UserService：

kotlin

代码解读

复制代码

public interface UserService { User getUser(Long id); }

原生API

通过原生API的方式生成一个dubbo服务，并且用另外一个类去调用这个dubbo服务：

引入依赖

核心依赖就两个，一个dubbo的依赖，另外一个上面的公共接口方法，服务提供方和消费者都需要引入这两个依赖

xml

代码解读

复制代码

<dependencies> <dependency> <groupId>org.apache.dubbo</groupId> <artifactId>dubbo</artifactId> <version>2.7.4.1</version> </dependency> <dependency> <artifactId>dubbo-api</artifactId> <groupId>com.seven.direct-dubbo-demo.api</groupId> <version>1.0-SNAPSHOT</version> </dependency> </dependencies>

服务提供者

服务提供者主要配置以下几个属性：

application：设置应用的名称等信息
protocol ：设置服务的协议
register：设置服务的连接方式
service：将需要暴露的服务注册出来

scss

代码解读

复制代码

public class DubboProvider { public static void main(String[] args) throws IOException { //暴露UserService服务 //1、application ApplicationConfig applicationConfig = new ApplicationConfig("sample-provider"); //2、protocol -dubbo协议 ProtocolConfig protocolConfig = new ProtocolConfig(); protocolConfig.setName("dubbo"); protocolConfig.setPort(20880); //3、register //直连的方式，不暴露到注册中心 RegistryConfig registryConfig = new RegistryConfig(RegistryConfig.NO_AVAILABLE); //4、service ServiceConfig serviceConfig = new ServiceConfig(); serviceConfig.setInterface(UserService.class); serviceConfig.setRef(new UserServiceImpl()); //5、将application、protocol、register注册到service serviceConfig.setRegistry(registryConfig); serviceConfig.setProtocol(protocolConfig); serviceConfig.setApplication(applicationConfig); serviceConfig.export(); System.out.println("服务已经暴露"); System.in.read(); } }

服务消费者

消费者的实现主要就三步：

配置application：设置应用的名称等信息
配置reference：主要配置要引用的信息
获取到接口，调用服务。

java

代码解读

复制代码

public class DubboConsumer { public static void main(String[] args) { //1、application ApplicationConfig applicationConfig =new ApplicationConfig("sample-consumer"); //2、配置reference ReferenceConfig referenceConfig = new ReferenceConfig(); referenceConfig.setApplication(applicationConfig); referenceConfig.setInterface(UserService.class); referenceConfig.setUrl("dubbo://127.0.0.1:20880/com.seven.directdubbodemo.api.service.UserService?anyhost=true&application=sample&bind.ip=127.0.0.1&bind.port=20880&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=com.seven.directdubbodemo.api.service.UserService&methods=getUser&pid=5936&release=2.7.4.1&side=provider&timestamp=1728390413736"); UserService userService = (UserService) referenceConfig.get(); User user = userService.getUser(1L); System.out.println(user); } }

先启动提供者，再启动消费者，如果user信息打印出来了就说明调用成功。

使用zookeeper作为注册中心

上面的Register使用的是直连的方式，也可以使用注册中心，这里以zookeeper为例。首先在项目中引入zookeeper相关依赖：

xml

代码解读

复制代码

 <dependency> <groupId>org.apache.curator</groupId> <artifactId>curator-recipes</artifactId> <version>2.13.0</version> </dependency> <dependency> <groupId>org.apache.curator</groupId> <artifactId>curator-framework</artifactId> <version>2.13.0</version> </dependency>

服务提供者修改一处地方，将RegistryConfig修改为zookeeper的连接方式

ini

代码解读

复制代码

//register //直连的方式，不暴露到注册中心 //RegistryConfig registryConfig=new RegistryConfig(RegistryConfig.NO_AVAILABLE); //通过注册中心暴露dubbo RegistryConfig registryConfig = new RegistryConfig("zookeeper://127.0.0.1:2181");

消费者同样修改一处位置，将referenceConfig中的setUrl方法替换为zookeeper：

ini

代码解读

复制代码

RegistryConfig registryConfig = new RegistryConfig("zookeeper://127.0.0.1:2181"); ReferenceConfig referenceConfig = new ReferenceConfig(); referenceConfig.setRegistry(registryConfig); referenceConfig.setApplication(applicationConfig); referenceConfig.setInterface(UserService.class); //referenceConfig.setUrl("dubbo://127.0.0.1:20880/com.seven.directdubbodemo.api.service.UserService?anyhost=true&application=sample&bind.ip=127.0.0.1&bind.port=20880&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=com.seven.directdubbodemo.api.service.UserService&methods=getUser&pid=5936&release=2.7.4.1&side=provider&timestamp=1728390413736");

Spring集成dubbo

通过Spring的方式只不过是把上面写在Java中的代码拿到配置文件中去，并把接口注入到Bean容器中

引入spring相关依赖

在provider和consumer的模块下额外引入spring相关依赖

xml

代码解读

复制代码

<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>5.3.37</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>5.3.37</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>5.3.37</version> </dependency>

在resource文件夹下新建两个配置文件

provider.xml

xml

代码解读

复制代码

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:dubbo="http://dubbo.apache.org/schema/dubbo" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd">  <dubbo:application name="spring-provider"/>  <dubbo:registry address="zookeeper://127.0.0.1:2181"/>  <dubbo:protocol name="dubbo" port="20880"/>  <dubbo:service interface="com.seven.springdubbodemo.springdubboapi.service.UserService" ref="userService" loadbalance="roundrobin"/>  <bean id="userService" class="com.seven.springdubbodemo.springdubboprovider.impl.UserServiceImpl"/> </beans>

consumer.xml

ini

代码解读

复制代码

启动类

这里的配置文件和上方的代码均一一对应。服务的提供者和消费者：

SpringDubboProvider：

java

代码解读

复制代码

public class SpringDubboProvider { public static void main(String[] args) throws IOException { ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("provider.xml"); System.out.println("服务已经暴露"); System.in.read(); } }

SpringDubboConsumer

arduino

代码解读

复制代码

public class SpringDubboConsumer { public static void main(String[] args) { ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("consumer.xml"); UserService bean = context.getBean(UserService.class); System.out.println(bean.getUser(1L)); } }

纯注解版

注解的方式就是不在xml文件中注入bean，xml文件中只需要写包名即可

provider修改 provider.xml

xml

代码解读

复制代码

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:dubbo="http://dubbo.apache.org/schema/dubbo" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://dubbo.apache.org/schema/dubbo http://dubbo.apache.org/schema/dubbo/dubbo.xsd">  <dubbo:application name="anno-provider"/>  <dubbo:registry address="zookeeper://127.0.0.1:2181"/>  <dubbo:protocol name="dubbo" port="20880"/>  <dubbo:annotation package="com.seven.annotationdubbodemo.annodubboprovider.impl"/> </beans>

UserService实现类

java

代码解读

复制代码

import org.apache.dubbo.config.annotation.Service; @Service //dubbo的@Service注解 public class UserServiceImpl implements UserService { @Override public User getUser(Long id) { User user = new User(); user.setId(id); user.setName("Seven"); user.setSex("男"); return user; } }

consumer修改 consumer.xml

ini

代码解读

复制代码

controller类

java

代码解读

复制代码

@Controller public class UserController { @Reference //import org.apache.dubbo.config.annotation.Reference; private UserService userService; public User getUser(long id){ return userService.getUser(id); } }

SpringBoot集成dubo

引入dubbo和springboot的核心依赖

xml

代码解读

复制代码

 <dependency> <groupId>org.apache.dubbo</groupId> <artifactId>dubbo-spring-boot-starter</artifactId> <version>2.7.5</version> </dependency>  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>2.7.5</version> </dependency>

服务提供者provider 这里的配置都写在application.properties中：

yaml

代码解读

复制代码

#当前服务/应用的名字 dubbo: application: name: springboot-provider #注册中心的协议和地址 registry: protocol: zookeeper address: 127.0.0.1:2181 #通信规则（通信协议和接口） protocol: name: dubbo port: 20880 # 负载均衡算法 provider: loadbalance: roundrobin

服务提供者需要写服务的实现类，这里需要注意@Service注解采用的是dubbo包下：

java

代码解读

复制代码

import com.seven.springbootdubbodemo.api.entity.User; import com.seven.springbootdubbodemo.api.service.UserService; import org.apache.dubbo.config.annotation.Service; @Service public class UserServiceImpl implements UserService { @Override public User getUser(Long id) { User user = new User(); user.setId(id); user.setName("Seven"); user.setSex("男"); return user; } }

接着在启动类上添加一个@EnableDubbo注解即可。

less

代码解读

复制代码

@EnableDubbo @SpringBootApplication public class App{ public static void main(String[] args) { SpringApplication.run(App.class, args); } }

服务的消费者consumer

配置文件：

yaml

代码解读

复制代码

#避免和provider端口冲突，设为8081端口访问 server: port: 8081 #当前服务/应用的名字 dubbo: application: name: springboot-consumer #注册中心的协议和地址 registry: protocol: zookeeper address: 127.0.0.1:2181 #通信规则（通信协议和接口） protocol: name: dubbo port: 20880 # 负载均衡算法 consumer: loadbalance: roundrobin

接着通过@Reference注解将service对象引进来

typescript

代码解读

复制代码

@SpringBootApplication public class App{ @Reference UserService userService; public static void main(String[] args) { SpringApplication.run(App.class, args); } @Bean public ApplicationRunner getBean(){ return args -> { System.out.println(userService.getUser(1L)); }; } }

dubbo的常用配置

xml配置

makefile

代码解读

复制代码

<dubbo:application/> 用于配置当前应用信息 <dubbo:register/> 用于配置连接注册相关信息 <dubbo:protocol/> 用于配置提供服务的协议信息，提供者指定协议，消费者被动接受 <dubbo:service/> 用于暴露一个服务，一个服务可以用多个协议暴露，一个服务也可以注册到多个注册中心。provider端配置 <dubbo:reference/> 用于创建一个远程服务代理。consumer端配置