366 lines
12 KiB
Markdown
366 lines
12 KiB
Markdown
# spring boot 整合 dubbo
|
||
|
||
## 目录<br/>
|
||
<a href="#一-项目结构说明">一、 项目结构说明</a><br/>
|
||
<a href="#二关键依赖">二、关键依赖</a><br/>
|
||
<a href="#三公共模块boot-dubbo-common">三、公共模块（boot-dubbo-common）</a><br/>
|
||
<a href="#四-服务提供者boot-dubbo-provider">四、 服务提供者（boot-dubbo-provider）</a><br/>
|
||
<a href="#41-提供方配置">4.1 提供方配置</a><br/>
|
||
<a href="#42--使用注解Service暴露服务">4.2 使用注解@Service暴露服务</a><br/>
|
||
<a href="#五服务消费者boot-dubbo-consumer">五、服务消费者（boot-dubbo-consumer）</a><br/>
|
||
<a href="#1消费方的配置">1.消费方的配置</a><br/>
|
||
<a href="#2使用注解Reference引用远程服务">2.使用注解@Reference引用远程服务</a><br/>
|
||
<a href="#六项目构建的说明">六、项目构建的说明</a><br/>
|
||
<a href="#七关于dubbo新版本管理控制台的安装说明">七、关于dubbo新版本管理控制台的安装说明</a><br/>
|
||
## 正文<br/>
|
||
|
||
|
||
|
||
|
||
## 一、 项目结构说明
|
||
|
||
1.1 按照 dubbo 文档推荐的服务最佳实践，建议将服务接口、服务模型、服务异常等均放在 API 包中，所以项目采用 maven 多模块的构建方式，在 spring-boot-dubbo 下构建三个子模块：
|
||
|
||
1. boot-dubbo-common 是公共模块，用于存放公共的接口和 bean,被 boot-dubbo-provider 和 boot-dubbo-consumer 在 pom.xml 中引用；
|
||
2. boot-dubbo-provider 是服务的提供者，提供商品的查询服务；
|
||
3. boot-dubbo-consumer 是服务的消费者，调用 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-boot-dubbo.png"/> </div>
|
||
|
||
|
||
|
||
## 二、关键依赖
|
||
|
||
在父工程的项目中统一导入依赖 dubbo 的 starter，父工程的 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">
|
||
<modelVersion>4.0.0</modelVersion>
|
||
<packaging>pom</packaging>
|
||
|
||
<modules>
|
||
<module>boot-dubbo-common</module>
|
||
<module>boot-dubbo-consumer</module>
|
||
<module>boot-dubbo-provider</module>
|
||
</modules>
|
||
|
||
<parent>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-starter-parent</artifactId>
|
||
<version>2.1.1.RELEASE</version>
|
||
<relativePath/> <!-- lookup parent from repository -->
|
||
</parent>
|
||
<groupId>com.heibaiying</groupId>
|
||
<artifactId>spring-boot-dubbo</artifactId>
|
||
<version>0.0.1-SNAPSHOT</version>
|
||
<name>spring-boot-dubbo</name>
|
||
<description>Demo project for Spring Boot</description>
|
||
|
||
<properties>
|
||
<java.version>1.8</java.version>
|
||
</properties>
|
||
|
||
<dependencies>
|
||
<dependency>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-starter-freemarker</artifactId>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-starter-web</artifactId>
|
||
</dependency>
|
||
|
||
<dependency>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-devtools</artifactId>
|
||
<scope>runtime</scope>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.projectlombok</groupId>
|
||
<artifactId>lombok</artifactId>
|
||
<optional>true</optional>
|
||
</dependency>
|
||
<dependency>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-starter-test</artifactId>
|
||
<scope>test</scope>
|
||
</dependency>
|
||
<!--引入 dubbo start 依赖-->
|
||
<dependency>
|
||
<groupId>com.alibaba.boot</groupId>
|
||
<artifactId>dubbo-spring-boot-starter</artifactId>
|
||
<version>0.2.0</version>
|
||
</dependency>
|
||
</dependencies>
|
||
|
||
</project>
|
||
```
|
||
|
||
|
||
|
||
## 三、公共模块（boot-dubbo-common）
|
||
|
||
- api 下为公共的调用接口；
|
||
- bean 下为公共的实体类。
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/boot-dubbo-common.png"/> </div>
|
||
|
||
## 四、 服务提供者（boot-dubbo-provider）
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/boot-dubbo-provider.png"/> </div>
|
||
|
||
#### 4.1 提供方配置
|
||
|
||
```yaml
|
||
dubbo:
|
||
application:
|
||
name: boot-duboo-provider
|
||
# 指定注册协议和注册地址 dubbo 推荐使用 zookeeper 作为注册中心，并且在 start 依赖中引入了 zookeeper 的 java 客户端 Curator
|
||
registry:
|
||
protocol: zookeeper
|
||
address: 127.0.0.1:2181
|
||
protocol.name: dubbo
|
||
```
|
||
|
||
#### 4.2 使用注解@Service暴露服务
|
||
|
||
需要注意的是这里的@Service 注解不是 spring 的注解，而是 dubbo 的注解 com.alibaba.dubbo.config.annotation.Service
|
||
|
||
```java
|
||
package com.heibaiying.dubboprovider.service;
|
||
|
||
import com.alibaba.dubbo.config.annotation.Service;
|
||
import com.heibaiying.api.IProductService;
|
||
import com.heibaiying.bean.Product;
|
||
|
||
import java.util.ArrayList;
|
||
import java.util.Date;
|
||
import java.util.List;
|
||
|
||
/**
|
||
* @author : heibaiying
|
||
* @description : 产品提供接口实现类
|
||
*/
|
||
@Service(timeout = 5000)
|
||
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;
|
||
}
|
||
}
|
||
|
||
```
|
||
|
||
## 五、服务消费者（boot-dubbo-consumer）
|
||
|
||
<div align="center"> <img src="https://github.com/heibaiying/spring-samples-for-all/blob/master/pictures/boot-dubbo-consumer1.png"/> </div>
|
||
|
||
#### 1.消费方的配置
|
||
|
||
```yaml
|
||
dubbo:
|
||
application:
|
||
name: boot-duboo-provider
|
||
# 指定注册协议和注册地址 dubbo 推荐使用 zookeeper 作为注册中心，并且在 start 依赖中引入了 zookeeper 的 java 客户端 Curator
|
||
registry:
|
||
protocol: zookeeper
|
||
address: 127.0.0.1:2181
|
||
protocol.name: dubbo
|
||
# 关闭所有服务的启动时检查 (没有提供者时报错）视实际情况设置
|
||
consumer:
|
||
check: false
|
||
server:
|
||
port: 8090
|
||
```
|
||
|
||
#### 2.使用注解@Reference引用远程服务
|
||
|
||
```java
|
||
package com.heibaiying.dubboconsumer.controller;
|
||
|
||
import com.alibaba.dubbo.config.annotation.Reference;
|
||
import com.heibaiying.api.IProductService;
|
||
import com.heibaiying.bean.Product;
|
||
import org.springframework.stereotype.Controller;
|
||
import org.springframework.ui.Model;
|
||
import org.springframework.web.bind.annotation.PathVariable;
|
||
import org.springframework.web.bind.annotation.RequestMapping;
|
||
|
||
import java.util.List;
|
||
|
||
@Controller
|
||
@RequestMapping("sell")
|
||
public class SellController {
|
||
|
||
// dubbo 远程引用注解
|
||
@Reference
|
||
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">
|
||
<modelVersion>4.0.0</modelVersion>
|
||
|
||
<parent>
|
||
<artifactId>spring-boot-dubbo</artifactId>
|
||
<groupId>com.heibaiying</groupId>
|
||
<version>0.0.1-SNAPSHOT</version>
|
||
</parent>
|
||
|
||
<artifactId>boot-dubbo-consumer</artifactId>
|
||
<version>0.0.1-SNAPSHOT</version>
|
||
<name>boot-dubbo-consumer</name>
|
||
<description>dubbo project for Spring Boot</description>
|
||
|
||
<properties>
|
||
<java.version>1.8</java.version>
|
||
</properties>
|
||
|
||
<!--引入对公共模块的依赖-->
|
||
<dependencies>
|
||
<dependency>
|
||
<groupId>com.heibaiying</groupId>
|
||
<artifactId>boot-dubbo-common</artifactId>
|
||
<version>0.0.1-SNAPSHOT</version>
|
||
<scope>compile</scope>
|
||
</dependency>
|
||
</dependencies>
|
||
|
||
<build>
|
||
<plugins>
|
||
<plugin>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-maven-plugin</artifactId>
|
||
</plugin>
|
||
</plugins>
|
||
</build>
|
||
|
||
</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">
|
||
<modelVersion>4.0.0</modelVersion>
|
||
|
||
<parent>
|
||
<artifactId>spring-boot-dubbo</artifactId>
|
||
<groupId>com.heibaiying</groupId>
|
||
<version>0.0.1-SNAPSHOT</version>
|
||
</parent>
|
||
|
||
|
||
<artifactId>boot-dubbo-provider</artifactId>
|
||
<version>0.0.1-SNAPSHOT</version>
|
||
<name>boot-dubbo-provider</name>
|
||
<description>dubbo project for Spring Boot</description>
|
||
|
||
<properties>
|
||
<java.version>1.8</java.version>
|
||
</properties>
|
||
|
||
<!--引入对公共模块的依赖-->
|
||
<dependencies>
|
||
<dependency>
|
||
<groupId>com.heibaiying</groupId>
|
||
<artifactId>boot-dubbo-common</artifactId>
|
||
<version>0.0.1-SNAPSHOT</version>
|
||
<scope>compile</scope>
|
||
</dependency>
|
||
</dependencies>
|
||
|
||
<build>
|
||
<plugins>
|
||
<plugin>
|
||
<groupId>org.springframework.boot</groupId>
|
||
<artifactId>spring-boot-maven-plugin</artifactId>
|
||
</plugin>
|
||
</plugins>
|
||
</build>
|
||
|
||
</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
|
||
```
|