dubbo与springboot的集成和使用dubbo-spring-boot-starter

dubbo最近更新了dubbo-spring-boot-starter的jar包，废话不多少，看看如何使用。

首先我们可以通过github编译打包最新的starter，

Git地址为：https://github.com/alibaba/dubbo-spring-boot-starter.git

在springboot项目的pom.xml中新增，添加maven的依赖。

1. <!--dubbo-springBoot依赖-->
2. < dependency>
3. < groupId>com.alibaba.spring.boot</ groupId>
4. < artifactId>dubbo-spring-boot-starter</ artifactId>
5. < version>2.0.1-SNAPSHOT</ version>
6. </ dependency>

可以新建一个springboot-dubbo-api工程，用来做接口定义，方便provider和consumer端使用，避免重复编码

接口定义示例：
 

1. import com.xq.live.dubbo.common.BaseResp;
2. import com.xq.live.dubbo.common.Pager;
3. import com.xq.live.dubbo.model.Shop;
4. import com.xq.live.dubbo.service.BaseSerivce;
5. import com.xq.live.dubbo.vo.ShopInVo;
7. /**
8. * @package: com.xq.live.dubbo.api
9. * @description: 商家接口定义
10. * @author: zhangpeng32
11. * @date: 2018/3/25 12:18
12. * @version: 1.0
13. */
14. public interface ShopApi extends BaseSerivce< Shop>{
15. /**
16. * 分页查询
17. * @param shopInVo
18. * @return
19. */
20. public BaseResp< Pager< Shop>> queryWithPg(ShopInVo shopInVo);
21. }

在这里我定义了一个BaseService，用来定义一些通用的接口方法，包含了简单的增删改查，也可以把分页的方法写在里面。

1. /**
2. * @package: com.xq.live.dubbo.common
3. * @description: 基础接口类
4. * @author: zhangpeng32
5. * @date: 2018/3/25 12:27
6. * @version: 1.0
7. */
8. public interface BaseSerivce< T> {
9. /**
10. * 新增记录
11. * @param t
12. * @return
13. */
14. public BaseResp< Long> create(T t);
16. /**
17. * 根据主键删除
18. * @param pk
19. * @return
20. */
21. public BaseResp< Integer> delete(Long pk);
23. /**
24. * 根据主键更新记录
25. * @param t
26. * @return
27. */
28. public BaseResp< Integer> update(T t);
30. /**
31. * 根据主键查询
32. * @param pk
33. * @return
34. */
35. public BaseResp< T> get(Long pk);
36. }

在springboot-dubbo-provider项目中，首先做好dubbo和springboot的集成配置：

1. ## dubbo springboot 配置
2. spring.dubbo.application.id=live-dubbo-provider
3. spring.dubbo.application.name=live-dubbo-provider
4. spring.dubbo.registry.address=zookeeper://127.0.0.1:2181
5. spring.dubbo.server=true
6. spring.dubbo.protocol.name=dubbo
7. spring.dubbo.protocol.port=20880

在springboot的启动类添加@EnableDubboConfiguration注解：

1. @MapperScan( "com.xq.live.dubbo.dao")
2. @EnableDubboConfiguration
3. @SpringBootApplication
4. public class DubboServerApplication {
5. public static void main(String[] args) {
6. SpringApplication.run(DubboServerApplication.class, args);
7. }
8. }

ShopApi接口实现类，示例如下：

1. import com.alibaba.dubbo.config.annotation.Service;
2. import com.xq.live.dubbo.api.ShopApi;
3. import com.xq.live.dubbo.common.BaseResp;
4. import com.xq.live.dubbo.common.Pager;
5. import com.xq.live.dubbo.common.ResultEnums;
6. import com.xq.live.dubbo.dao.ShopDao;
7. import com.xq.live.dubbo.model.Shop;
8. import com.xq.live.dubbo.vo.ShopInVo;
9. import org.springframework.beans.factory.annotation.Autowired;
10. import org.springframework.stereotype.Component;
12. /**
13. * @package: com.xq.live.dubbo.handler
14. * @description: 商家dubbo服务实现类
15. * @author: zhangpeng32
16. * @date: 2018/3/25 12:40
17. * @version: 1.0
18. */
19. @Service(interfaceClass = ShopApi.class)
20. @Component
21. public class ShopHandler implements ShopApi {
23. @Autowired
24. private ShopDao shopDao;
26. @Override
27. public BaseResp<Long> create(Shop shop) {
28. return null;
29. }
31. @Override
32. public BaseResp<Integer> delete(Long pk) {
33. return null;
34. }
36. @Override
37. public BaseResp<Integer> update(Shop shop) {
38. return null;
39. }
41. @Override
42. public BaseResp<Shop> get(Long pk) {
43. Shop shop = shopDao.selectByPrimaryKey(pk);
44. return new BaseResp<Shop>(ResultEnums.SUCCESS, shop);
45. }
47. @Override
48. public BaseResp<Pager<Shop>> queryWithPg(ShopInVo shopInVo) {
49. return null;
50. }
51. }

启动本地的zookeeper: 在 \zookeeper-3.4.11\bin目录下执行zkServer.bat，启动zookeeper。

启动dubbo-admin可以用户查看服务注册情况以及权重调整等。

源码可以在这里获取：GitHub - apache/dubbo: Apache Dubbo is a high-performance, java based, open source RPC framework.

启动后界面如下：

启动springboot-dubbo-provider应用，可以通过dubbo-admin看到服务注册成功。

消费端

消费端application.properties配置为：

1. ## 避免和 server 工程端口冲突
2. server.port=8081
4. ## Dubbo 服务消费者配置
5. spring.dubbo.application.name=live-dubbo-consumer
6. spring.dubbo.application.id=live-dubbo-consumer
7. spring.dubbo.protocol.port=20800
8. spring.dubbo.protocol.name=dubbo
9. spring.dubbo.registry.address=zookeeper://127.0.0.1:2181

接口实例化和调用示例：

1. import com.alibaba.dubbo.config.annotation.Reference;
2. import com.xq.live.dubbo.api.ShopApi;
3. import com.xq.live.dubbo.common.BaseResp;
4. import com.xq.live.dubbo.model.Shop;
5. import org.springframework.stereotype.Component;
7. /**
8. * @package: com.xq.live.dubbo.service
9. * @description: TODO
10. * @author: zhangpeng32
11. * @date: 2018/3/25 12:58
12. * @version: 1.0
13. */
14. @Component
15. public class ShopDubboService {
17. @Reference
18. private ShopApi shopApi;
20. public BaseResp<Shop> get(Long id){
21. return shopApi.get(id);
22. }
23. }

下面是消费端的springboot启动类配置：

1. import com.alibaba.dubbo.spring.boot.annotation.EnableDubboConfiguration;
2. import com.xq.live.dubbo.common.BaseResp;
3. import com.xq.live.dubbo.model.Shop;
4. import com.xq.live.dubbo.service.ShopDubboService;
5. import org.springframework.beans.factory.annotation.Autowired;
6. import org.springframework.boot.SpringApplication;
7. import org.springframework.boot.autoconfigure.SpringBootApplication;
8. import org.springframework.web.bind.annotation.RequestMapping;
9. import org.springframework.web.bind.annotation.RestController;
11. @SpringBootApplication
12. @RestController
13. @EnableDubboConfiguration
14. public class DubboClientApplication {
16. @Autowired
17. private ShopDubboService shopDubboService;
19. public static void main(String[] args) {
20. SpringApplication.run(DubboClientApplication.class, args);
21. }
23. @RequestMapping(value = "/")
24. public String hello(){
25. BaseResp<Shop> baseResp = shopDubboService.get( 1L);
26. return "hello "+ baseResp.getCode()+ ": NAME : "+baseResp.getData().getShopName();
27. }
28. }

启动消费端，我这里使用的端口是8081，服务器采用的springboot内置的tomcat.启动后可以在dubbo-admin看到消费端注册成功。

总结：

1、dubbo和springboot的结合非常简单，引入dubbo的starter即可。

2、application.properties配置清晰简单，各配置都非常完整。

3、本示例中用到的各种工具类可以忽略，我只是为了统一返回需要做的一个定义。

4、目前没遇到什么问题，如果有，可以发消息我一起探讨。