295 lines
10 KiB
Markdown
295 lines
10 KiB
Markdown
# spring 整合 dubbo（xml配置方式）
|
||
|
||
## 目录<br/>
|
||
<a href="#一-项目结构说明">一、 项目结构说明</a><br/>
|
||
<a href="#二项目依赖">二、项目依赖</a><br/>
|
||
<a href="#三公共模块dubbo-common">三、公共模块（dubbo-common）</a><br/>
|
||
<a href="#四-服务提供者dubbo-provider">四、 服务提供者（dubbo-provider）</a><br/>
|
||
<a href="#41--productService是服务的提供者-商品数据用模拟数据展示">4.1 productService是服务的提供者（ 商品数据用模拟数据展示）</a><br/>
|
||
<a href="#42-在dubboxml暴露服务">4.2 在dubbo.xml暴露服务</a><br/>
|
||
<a href="#五服务消费者dubbo-consumer">五、服务消费者（dubbo-consumer）</a><br/>
|
||
<a href="#1在dubboxml调用远程的服务">1.在dubbo.xml调用远程的服务</a><br/>
|
||
<a href="#2消费服务">2.消费服务</a><br/>
|
||
<a href="#六项目构建的说明">六、项目构建的说明</a><br/>
|
||
<a href="#七关于dubbo新版本管理控制台的安装说明">七、关于dubbo新版本管理控制台的安装说明</a><br/>
|
||
## 正文<br/>
|
||
|
||
|
||
## 一、 项目结构说明
|
||
|
||
1.1 按照 dubbo 文档推荐的服务最佳实践，建议将服务接口、服务模型、服务异常等均放在 API 包中，所以项目采用 maven 多模块的构建方式，在 spring-dubbo 下构建三个子模块：
|
||
|
||
1. dubbo-common 是公共模块，用于存放公共的接口和 bean,被 dubbo-provider 和 dubbo-provider 在 pom.xml 中引用；
|
||
2. dubbo-provider 是服务的提供者，提供商品的查询服务；
|
||
3. dubbo-provider 是服务的消费者，调用 provider 提供的查询服务。
|
||
|
||
1.2 本项目 dubbo 的搭建采用 zookeeper 作为注册中心， 关于 zookeeper 的安装和基本操作可以参见我的手记[Zookeeper 基础命令与 Java 客户端](https://github.com/heibaiying/LearningNotes/blob/master/notes/%E4%B8%AD%E9%97%B4%E4%BB%B6/ZooKeeper/ZooKeeper%E9%9B%86%E7%BE%A4%E6%90%AD%E5%BB%BA%E4%B8%8EJava%E5%AE%A2%E6%88%B7%E7%AB%AF.md)
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/spring-dubbo.png"/> </div>
|
||
|
||
|
||
|
||
## 二、项目依赖
|
||
|
||
**在父工程的项目中统一导入依赖 dubbo 依赖的的 jar 包**
|
||
|
||
这里需要注意的是 ZooKeeper 3.5.x 和 ZooKeeper 3.4.x 是存在不兼容的情况 详见官网解释[ZooKeeper Version Compatibility](https://curator.apache.org/zk-compatibility.html), zookeeper 3.5 目前是 beta 版本，所以 zookeeper 我选择的版本是 zookeeper-3.4.9 作为服务端。但默认情况下 curator-framework 自动引用的最新的 3.5 的版本客户端，会出现 KeeperException$UnimplementedException 异常
|
||
|
||
```xml
|
||
<!--dubbo 依赖-->
|
||
<groupId>com.alibaba</groupId>
|
||
<artifactId>dubbo</artifactId>
|
||
<version>2.6.2</version>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.apache.curator</groupId>
|
||
<artifactId>curator-framework</artifactId>
|
||
<version>4.0.0</version>
|
||
<exclusions>
|
||
<exclusion>
|
||
<groupId>org.apache.zookeeper</groupId>
|
||
<artifactId>zookeeper</artifactId>
|
||
</exclusion>
|
||
</exclusions>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.apache.zookeeper</groupId>
|
||
<artifactId>zookeeper</artifactId>
|
||
<version>3.4.13</version>
|
||
</dependency>
|
||
```
|
||
|
||
|
||
|
||
## 三、公共模块（dubbo-common）
|
||
|
||
- api 下为公共的调用接口；
|
||
- bean 下为公共的实体类。
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/dubbo-common.png"/> </div>
|
||
|
||
## 四、 服务提供者（dubbo-provider）
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/dubbo-provider.png"/> </div>
|
||
|
||
#### 4.1 productService是服务的提供者（ 商品数据用模拟数据展示）
|
||
|
||
注：这里实现的接口 IProductService 来源于公共模块
|
||
|
||
```java
|
||
/**
|
||
* @author : heibaiying
|
||
* @description : 产品提供接口实现类
|
||
*/
|
||
@Service
|
||
public class ProductService implements IProductService {
|
||
|
||
private static List<Product> productList = new ArrayList<>();
|
||
|
||
static {
|
||
for (int i = 0; i < 20; i++) {
|
||
productList.add(new Product(i, "产品" + i, i / 2 == 0, new Date(), 66.66f * i));
|
||
}
|
||
}
|
||
|
||
public Product queryProductById(int id) {
|
||
for (Product product : productList) {
|
||
if (product.getId() == id) {
|
||
return product;
|
||
}
|
||
}
|
||
return null;
|
||
}
|
||
|
||
|
||
public List<Product> queryAllProducts() {
|
||
return productList;
|
||
}
|
||
}
|
||
```
|
||
|
||
#### 4.2 在dubbo.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-4.3.xsd
|
||
http://dubbo.apache.org/schema/dubbo
|
||
http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
|
||
|
||
<!-- 提供方应用信息，用于计算依赖关系 -->
|
||
<dubbo:application name="dubbo-provider"/>
|
||
|
||
<!-- 使用 zookeeper 注册中心暴露服务地址 如果是集群配置 用, 分隔地址 -->
|
||
<dubbo:registry protocol="zookeeper" address="127.0.0.1:2181"/>
|
||
|
||
<!-- 用 dubbo 协议在 20880 端口暴露服务 -->
|
||
<dubbo:protocol name="dubbo" port="20880"/>
|
||
|
||
<!-- 声明需要暴露的服务接口 -->
|
||
<dubbo:service interface="com.heibaiying.api.IProductService" ref="productService"/>
|
||
|
||
<!-- 和本地 bean 一样实现服务 -->
|
||
<bean id="productService" class="com.heibaiying.service.ProductService"/>
|
||
</beans>
|
||
```
|
||
|
||
## 五、服务消费者（dubbo-consumer）
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/dubbo-consumer.png"/> </div>
|
||
|
||
#### 1.在dubbo.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-4.3.xsd
|
||
http://dubbo.apache.org/schema/dubbo
|
||
http://dubbo.apache.org/schema/dubbo/dubbo.xsd">
|
||
|
||
<!-- 消费方应用名，用于计算依赖关系，不是匹配条件，不要与提供方一样 -->
|
||
<dubbo:application name="dubbo-consumer">
|
||
<dubbo:parameter key="shutdown.timeout" value="60000"/> <!-- 单位毫秒 -->
|
||
</dubbo:application>
|
||
|
||
<!--Dubbo 缺省会在启动时检查依赖的服务是否可用，不可用时会抛出异常，阻止 Spring 初始化完成，以便上线时，能及早发现问题，默认 check="true"。-->
|
||
<!--可以关闭所有服务的启动时检查 -->
|
||
<dubbo:consumer check="false" />
|
||
|
||
<!-- 使用 zookeeper 注册中心暴露发现服务地址 -->
|
||
<dubbo:registry protocol="zookeeper" address="127.0.0.1:2181"/>
|
||
|
||
<!-- 生成远程服务代理，可以和本地 bean 一样使用 demoService -->
|
||
<dubbo:reference id="sellService" interface="com.heibaiying.api.IProductService"/>
|
||
|
||
|
||
</beans>
|
||
```
|
||
|
||
#### 2.消费服务
|
||
|
||
```java
|
||
@Controller
|
||
@RequestMapping("sell")
|
||
public class SellController {
|
||
|
||
@Autowired
|
||
private IProductService productService;
|
||
|
||
@RequestMapping
|
||
public String productList(Model model) {
|
||
List<Product> products = productService.queryAllProducts();
|
||
model.addAttribute("products", products);
|
||
return "products";
|
||
}
|
||
|
||
@RequestMapping("product/{id}")
|
||
public String productDetail(@PathVariable int id, Model model) {
|
||
Product product = productService.queryProductById(id);
|
||
model.addAttribute("product", product);
|
||
return "product";
|
||
}
|
||
}
|
||
```
|
||
|
||
## 六、项目构建的说明
|
||
|
||
因为在项目中，consumer 和 provider 模块均依赖公共模块,所以在构建 consumer 和 provider 项目前需要将 common 模块安装到本地仓库，**依次**对**父工程**和**common 模块**执行：
|
||
|
||
```shell
|
||
mvn install -Dmaven.test.skip = true
|
||
```
|
||
|
||
consumer 中 pom.xml 如下
|
||
|
||
```xml
|
||
<?xml version="1.0" encoding="UTF-8"?>
|
||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||
<parent>
|
||
<artifactId>spring-dubbo</artifactId>
|
||
<groupId>com.heibaiying</groupId>
|
||
<version>1.0-SNAPSHOT</version>
|
||
</parent>
|
||
<modelVersion>4.0.0</modelVersion>
|
||
|
||
<artifactId>dubbo-consumer</artifactId>
|
||
|
||
<dependencies>
|
||
<dependency>
|
||
<groupId>com.heibaiying</groupId>
|
||
<artifactId>dubbo-common</artifactId>
|
||
<version>1.0-SNAPSHOT</version>
|
||
<scope>compile</scope>
|
||
</dependency>
|
||
</dependencies>
|
||
|
||
</project>
|
||
```
|
||
|
||
provider 中 pom.xml 如下
|
||
|
||
```xml
|
||
<?xml version="1.0" encoding="UTF-8"?>
|
||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||
<parent>
|
||
<artifactId>spring-dubbo</artifactId>
|
||
<groupId>com.heibaiying</groupId>
|
||
<version>1.0-SNAPSHOT</version>
|
||
</parent>
|
||
<modelVersion>4.0.0</modelVersion>
|
||
|
||
<artifactId>dubbo-provider</artifactId>
|
||
|
||
<dependencies>
|
||
<dependency>
|
||
<groupId>com.heibaiying</groupId>
|
||
<artifactId>dubbo-common</artifactId>
|
||
<version>1.0-SNAPSHOT</version>
|
||
<scope>compile</scope>
|
||
</dependency>
|
||
</dependencies>
|
||
|
||
</project>
|
||
```
|
||
|
||
## 七、关于dubbo新版本管理控制台的安装说明
|
||
|
||
安装:
|
||
|
||
```sh
|
||
git clone https://github.com/apache/incubator-dubbo-ops.git /var/tmp/dubbo-ops
|
||
cd /var/tmp/dubbo-ops
|
||
mvn clean package
|
||
```
|
||
|
||
配置：
|
||
|
||
```sh
|
||
配置文件为：
|
||
dubbo-admin-backend/src/main/resources/application.properties
|
||
主要的配置有 默认的配置就是 127.0.0.1:2181：
|
||
dubbo.registry.address=zookeeper://127.0.0.1:2181
|
||
```
|
||
|
||
启动:
|
||
|
||
```sh
|
||
mvn --projects dubbo-admin-backend spring-boot:run
|
||
```
|
||
|
||
访问:
|
||
|
||
```
|
||
http://127.0.0.1:8080
|
||
```
|