代码学习与实践 (二):Spring Boot 集成 Dubbo
原文: https://testerhome.com/topics/11360
在上一章代码学习与实践(一):Spring Boot多模块项目创建与配置中，我们配置了一个dubbo项目，包含两个模块springboot-dubbo-server和springboot-dubbo-client，并且在pom中都添加了对dubbo及zk的依赖，在springboot-dubbo-client模块的pom中还添加了对springboot-dubbo-server模块的依赖。
下面我们一起来实践下dubbo服务端及客户端的简单设置，以及在dubbo admin中查看服务的注册及消费情况。
1 环境搭建
dubbo环境的搭建可参考文章环境搭建(一):Dubbo环境搭建，包括基于docker的zookeeper安装及dubbo admin的安装。
2 dubbo服务提供方配置
2.1 创建xml配置文件
不能直接在spring boot默认的配置文件application.properties中配置dubbo的属性，因为spring boot官方没有dubbo对应的starter，所以spring boot不能解析dubbo的属性。有网友编写了spring-boot-starter-dubbo，让我们可以使用spring boot的方式方便地开发dubbo程序，有需要的同学可以去了解一些。
本文实践的目的，是为了学习dubbo在spring boot中的配置，不是更方便地开发，所以我们这里还是选用原始的xml配置文件的方式来进行dubbo的配置，然后使用@ImportResource注解来加载xml配置。
下面是服务提供方的配置文件provider.xml。
有两种方式可以暴露dubbo服务，一是通过注解方式，二是通过xml配置方式，区别就在最后几行配置上。
使用注解方式，在类上打@service注解，就必须要用dubbo:annotation指定启动扫描路径。下面的provider.xml使用就是这种方式。
使用xml配置方式用dubbo:service申明要暴露的单个接口，就不需要再指定dubbo:annotation了。
provider.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://code.alibabatech.com/schema/dubbo" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd"> <!-- 应用配置，服务提供方和消费方都有--> <dubbo:application name="DubboWithSpringBoot-Server"/> <!-- 注册中心配置，使用zookeeper注册中心暴露服务地址 --> <dubbo:registry address="zookeeper://10.165.124.69:2181" timeout="60000" group="dubbo-test"/> <!-- 协议配置，由服务提供方指定，消费方被动接受。这里指定在20889端口暴露服务，默认端口在20880--> <dubbo:protocol name="dubbo" port="20889"/> <!-- 暴露dubbo服务的方式一--> <!-- 使用注解方式暴露接口，会自动扫描package下所有包中dubbo相关的注解，这样就不用在xml中再针对每个服务接口配置dubbo:service interface--> <dubbo:annotation package="com.practice.springboot.dubbo.server"/></beans>
如果要用xml配置方式暴露接口，将上面的dubbo:annotation一行替换成如下配置即可。
<!-- 暴露dubbo服务的方式二 --><!-- 使用xml配置方式申明暴露一个接口服务，在程序启动的时候会自动注册到zookeeper。 等同于在类上打@service注解，打了注解就必须要用annotation指定启动扫描路径，使用这种方式，就不需要指定annotation了--><dubbo:service interface="com.practice.springboot.dubbo.server.ItemService" ref="itemService" group="dubbo-test"/><!-- 具体的实现bean，id与上面的ref要一致--><bean id="itemService" class="com.practice.springboot.dubbo.server.ItemServiceImpl" />
2.2 创建测试接口及测试类
服务提供方提供一个checkItemStatus方法，用来检查一个商品是否可售。
接口定义类 ItemService.java
package com.practice.springboot.dubbo.server;public interface ItemService {
//检查商品是否可售
boolean checkItemStatus(String id);}接口实现类 ItemServiceImpl.java
package com.practice.springboot.dubbo.server;import com.alibaba.dubbo.config.annotation.Service;@Service //该Service注解是dubbo的注解，不是spring的。若使用xml配置方式暴露接口，则不需要该注解。public class ItemServiceImpl implements ItemService {
@Override
public boolean checkItemStatus(String id) {
if (id.contains("111")) {
return true;
} else {
return false;
}
}}2.3 编写启动类
启动类 SpringbootDubboServerApplication.java
package com.practice.springboot.dubbo.server;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.context.annotation.ImportResource;@SpringBootApplication@ImportResource("classpath:provider.xml") //加载xml文件public class SpringbootDubboServerApplication {
public static void main(String[] args) throws Exception {
SpringApplication.run(SpringbootDubboServerApplication.class, args);
Thread.sleep(Long.MAX_VALUE); //pom中没有加spring-boot-starter-web依赖，启动时没有tomcat容器，会自动退出，所以加了一个sleep防止自动退出
}}这里的classpath指的是各模块下的target/classes目录，该目录不仅包括java文件编译后的class文件，还包括resources目录下的配置文件。以本模块为例，target/classes包含了以下内容：
3 dubbo服务消费方配置
3.1 创建xml配置文件
创建远程服务代理和暴露dubbo服务一样，也有两种方式，一是使用注解方式，二是使用xml配置方式。下面的consumer.xml中使用的是第一种方式。
consumer.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://code.alibabatech.com/schema/dubbo" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd"> <!-- 应用配置，不要与提供方相同 --> <dubbo:application name="DubboWithSpringBoot-Client"/> <!-- 注册中心配置，使用zookeeper注册中心暴露服务地址 --> <dubbo:registry address="zookeeper://10.165.124.69:2181" timeout="60000" /> <!--关闭服务消费方所有服务的启动检查。dubbo缺省会在启动时检查依赖的服务是否可用，不可用时会抛出异常，阻止Spring初始化完成。--> <dubbo:consumer check="false" /> <!-- 使用注解方式创建远程服务代理--> <dubbo:annotation package="com.practice.springboot.dubbo.client"/></beans>
如果使用xml配置方式创建远程服务代理，将dubbo:annotation一行替换成如下配置即可。
<!-- 使用xml配置方式创建远程服务代理，id即为provider.xml中暴露的服务的id--><!-- 等同于dubbo:annotation 加上代码里的@Reference注解--><dubbo:reference id="itemService" interface="com.practice.springboot.dubbo.client.OrderService"/>
3.2 创建测试类
OrderService.java
package com.practice.springboot.dubbo.client;import com.alibaba.dubbo.config.annotation.Reference;import com.practice.springboot.dubbo.server.ItemService;import org.springframework.stereotype.Component;@Componentpublic class OrderService {
//注入服务提供方暴露的接口，通过@Reference注解，dubbo会在扫描的时候自动代理接口，然后通过rpc调用远程服务。
//如果用xml配置方式，需要将@Reference换成@Autowired。
@Reference
ItemService itemService;
public String checkBuyStatus(String id) {
boolean flag = itemService.checkItemStatus(id);
if (flag) {
return "can buy!";
} else {
return "can not buy!";
}
}}3.3 编写启动类
SpringbootDubboClientApplication.java
package com.practice.springboot.dubbo.client;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.context.annotation.ImportResource;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestParam;import org.springframework.web.bind.annotation.RestController;@SpringBootApplication@ImportResource("classpath:consumer.xml") //加载xml配置文件@RestControllerpublic class SpringbootDubboClientApplication {
@Autowired
OrderService orderService;
@RequestMapping("/canbuy")
public String canBuy(@RequestParam("id") String id){
return orderService.checkBuyStatus(id);
}
public static void main(String[] args) throws Exception{
SpringApplication.run(SpringbootDubboClientApplication.class, args);
}}4 测试
我们先后运行SpringbootDubboServerApplication.java和SpringbootDubboClientApplication.java，启动dubbo服务提供方和调用方。
在浏览器中输入dubbo admin的安装地址，如127.0.0.1:8089，打开dubbo admin界面，在服务治理-服务界面，可以看到我们注册的dubbo服务。状态“正常”，表示提供者和消费者都有。如果有乙方没有，在状态栏都会显示出来。
服务治理-应用页面，可以看到提供者DubboWithSpringBoot-Server和消费者DubboWithSpringBoot-Client。
在浏览器中调用canbuy接口，正常返回结果，说明我们的配置都生效啦~~~
到这里，Spring Boot集成Dubbo的内容都讲完啦。这样一个过程实践下来，再去看代码，就轻松多啦~~至少我们可以很快地完成以下三件事：
1、找到并看懂dubbo的配置文件
2、识dubbo服务的提供方和消费方
3、在admin中查看服务的状态
参考文档
Dubbo基于注解方式的配置
dubbo 配置文件详解
通过Dubbo注解实现RPC调用
标签:
上一篇: 代码学习与实践(一): Spring Boot 多模块项目创建与配置
下一篇: jQuery Validate
