文 | 平哥 日期 | 20201013
具體代碼詳見GitHub倉庫:點我跳轉
項目簡介
此項目為自己學習Dubbo+Zookeeper,搭建的第一個項目,主要架構就是一個父項目、三個子Module:dubbo_provider、 dubbo_consumer 和 dubbo_api,三個子Module分別繼承父項目。
Dubbo的遠程訪問是基于接口的。Consumer和Provider使用同一個接口,可以實現(xiàn)遠程訪問。
- Provider給接口寫實現(xiàn),提供服務。
- Consumer使用接口,并通過Dubbo創(chuàng)建的動態(tài)代理對象,遠程訪問Provider。
- 把接口獨立定義在一個工程(dubbo_api)中,做依賴管理。
p.s. 此項目重點是練習Dubbo+Zookeeper,故沒有寫連接數(shù)據庫的內容,只是模擬了訪問數(shù)據庫。
Step 1 創(chuàng)建項目并編寫父項目Maven依賴
1.1 創(chuàng)建項目
用IDEA創(chuàng)建項目,創(chuàng)建完項目目錄如下:

1.2 編寫父項目Maven依賴
直接上代碼:
<?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>
<groupId>com.gcp</groupId>
<artifactId>dubbo_pro01</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>dubbo_provider</module>
<module>dubbo_consumer</module>
<module>dubbo_api</module>
</modules>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.4.RELEASE</version>
</parent>
<dependencies>
<!--springboot 啟動器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!--lombok依賴-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--dubbo springboot啟動器-->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>2.7.8</version>
</dependency>
<!--curator依賴-->
<!--Curator提供了一套Java類庫, 可以更容易的使用ZooKeeper。 -->
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-recipes</artifactId>
<version>5.1.0</version>
</dependency>
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-framework</artifactId>
<version>5.1.0</version>
</dependency>
</dependencies>
</project>
Step 2 編寫dubbo_api
2.1 定義POJO類
package com.gcp.pojo;
import lombok.Data;
@Data
public class User {
private Long id;
private String name;
private String password;
}
2.2 定義Service接口
package com.gcp.service;
import com.gcp.pojo.User;
/**
* 用戶服務接口
*/
public interface UserService {
void register(User user);
User getUserById(Long id);
}
Step 3 編寫dubbo_provider
說明
- Dubbo服務提供者Provider,是不需要定義Controller的,是直接通過Service提供服務的。
- 使用Dubbo框架提供的注解@DubboService,聲明當前的類型的對象,是一個Dubbo服務提供者。
- 讓Spring容器初始化、管理,并通過curator框架,把服務信息注冊到Zookeeper中。
- 在老版本的Dubbo(2.6(含)以前)中,注解命名是@Service。所以使用老版本開發(fā)的時候,注意導入的注解的包。
- 需要提供一個application.yml配置文件,說明Dubbo使用的注冊中心是什么,地址是什么。
3.1 配置pom.xml
在pom.xml文件中添加依賴:
<dependencies>
<dependency>
<groupId>com.gcp</groupId>
<artifactId>dubbo_api</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
3.2 定義Mapper接口和類
UserMapper接口:
import com.gcp.pojo.User;
/**
* 模擬數(shù)據庫訪問
*/
public interface UserMapper {
void insert(User user);
User selectById(Long id);
}
UserMapperImpl實現(xiàn)類:
@Repository
public class UserMapperImpl implements UserMapper {
@Override
public void insert(User user) {
System.out.println("數(shù)據庫訪問:新增用戶 - " + user);
}
@Override
public User selectById(Long id) {
User user = new User();
user.setId(id);
user.setName("name" + id);
user.setPassword("password" + id);
System.out.println("數(shù)據庫訪問:主鍵查詢用戶 - " + user);
return user;
}
}
3.3 定義Service實現(xiàn)類
@DubboService(loadbalance = "roundrobin"), 其中 loadbalance = "roundrobin" 意思是如果此服務有集群將采用輪詢的方式進行負載均衡訪問,
默認是 random:隨機
@DubboService(loadbalance = "roundrobin")
public class UserServiceImpl implements UserService {
@Autowired
private UserMapper userMapper;
@Override
public void register(User user) {
System.out.println("UserService 實現(xiàn)類中:注冊用戶");
userMapper.insert(user);
}
@Override
public User getUserById(Long id) {
System.out.println("UserService 實現(xiàn)類中:根據id查詢用戶");
return userMapper.selectById(id);
}
}
3.4 配置application.yml
說明:
- dubbo中,對每個服務提供者和消費者的管理,都是基于應用級別的。
- 都是使用命名作為唯一標記的。
- 同名的服務提供者或消費者,自動組成集群。
- dubbo應用默認使用的協(xié)議是dubbo協(xié)議,使用的端口默認為20880。協(xié)議是可以配置的。
在 resources 文件夾下創(chuàng)建application.yml:
dubbo: # dubbo配置根節(jié)點
registry: # 配置dubbo的注冊中心 registry
address: zookeeper://192.168.40.170:2181 # 提供注冊中心的訪問地址。
application: # 配置本dubbo應用信息
name: gcp-dubbo-first-provider # 配置本dubbo的應用名稱,名稱組成是:字母,數(shù)字,'-',字母開頭
protocol: # 協(xié)議,協(xié)議自定義配置的時候,所有的默認值失效。
name: dubbo # 協(xié)議名
port: 20880 # 端口,默認20880
如何安裝Zookeeper可以詳見我另一篇文章
3.5 創(chuàng)建SpringBoot啟動程序
- 啟動的每個Dubbo應用,一定會在注冊中心中注冊信息。
- 服務提供者注冊的是/dubbo/xxx/providers
- 服務消費者注冊的是/dubbo/xxx/consumers
- Dubbo啟動器(dubbo-spring-boot-starter)默認不生效。
- 必須通過@EnableDubbo讓啟動器生效。
- 在2.7.2-以前版本中,部分配置默認不加載,需要使用@EnableDubboConfig讓全部配置生效。
- 負載均衡策略:
- 設置負載均衡策略,可以在@DubboService或者@DubboReference注解上
- 加屬性loadbalance進行配置。
- 消費者默認是不考慮負載均衡策略的,是使用提供者定義的負載均衡策略。
- 如果消費者配置了負載均衡策略,則忽略提供者配置的負載均衡策略。
在com.gcp包下創(chuàng)建SpringBoot啟動類:
@SpringBootApplication
@EnableDubbo
// @EnableDubboConfig
public class DbProviderApplication {
public static void main(String[] args) {
SpringApplication.run(DbProviderApplication.class,args);
}
}
此時可啟動,測試看Zookeeper中是否成功注冊上服務,訪問Linux服務器,利用Zookeeper客戶端工具查看:

Step 4 編寫dubbo_consumer
4.1 配置pom.xml
在pom.xml文件中添加依賴:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.gcp</groupId>
<artifactId>dubbo_api</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
4.2 創(chuàng)建consumer本地Service接口和實現(xiàn)類
有人可能會疑惑,Zookeeper注冊中心中已經有提供的Service服務了,怎么本地還需要Service?
說明: 其實,dubbo遠程服務調用,是為了 封裝通用規(guī)則,但各個子項目有自己的個性邏輯
如:用戶的注冊邏輯,在一個企業(yè)中是統(tǒng)一的。提供一個Provider實現(xiàn)注冊邏輯;
對于consumer來說,是不同的,可以提供若干入口。如騰訊的用戶注冊,可以通過QQ、QQ音樂、QQ空間等實現(xiàn)注冊或登錄。底層的用戶是相同的。
LocalUserService接口:
package com.gcp.service;
import com.gcp.pojo.User;
/**
* consumer子Module的本地Service
*/
public interface LocalUserService {
void register(User user);
User getById(Long id);
}
LocalUserServiceImpl實現(xiàn)類:
@Service
public class LocalUserServiceImpl implements LocalUserService {
/**
* 遠程服務的接口。通過注解@DubboReference實現(xiàn)動態(tài)代理創(chuàng)建
* 規(guī)則:
* 1、 通知Dubbo框架,根據配置找注冊中心,發(fā)現(xiàn)服務的地址。
* 拿接口名稱作為zookeeper中節(jié)點的命名規(guī)則,獲取地址。
* 2、 通知Spring,根據Dubbo框架的特性,創(chuàng)建接口的動態(tài)代理對象,并維護
* 在Spring容器中。
* 3、 類似@Autowired,把代理對象注入到當前的變量中。
*/
@DubboReference
private UserService userService;
@Override
public void register(User user) {
System.out.println("準備調用遠程服務,服務對象類型是:" + userService.getClass().getName());
System.out.println("注冊的用戶是: " + user);
userService.register(user);
}
@Override
public User getById(Long id) {
System.out.println("根據主鍵查詢用戶,主鍵是: " + id);
return userService.getUserById(id);
}
}
4.3 創(chuàng)建Controller類
UserController類:
@RestController
public class UserController {
@Autowired
private LocalUserService localUserService;
@RequestMapping("findUser")
public User findUser(Long id){
return localUserService.getById(id);
}
@RequestMapping("registerUser")
public String register(User user){
localUserService.register(user);
return "注冊用戶成功";
}
}
4.4 配置注冊中心地址
在 resources 文件夾下創(chuàng)建 application.yml:
dubbo:
registry:
address: zookeeper://192.168.40.170:2181
4.5 創(chuàng)建Springboot啟動類
在 com.gcp 包下創(chuàng)建 DbConsumerApplication:
@SpringBootApplication
@EnableDubbo
public class DbConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(DbConsumerApplication.class,args);
}
}
4.6 啟動測試
啟動consumer的啟動類,查看Zookeeper注冊中心是否注冊成功:

Step 5 項目整體測試
打開瀏覽器,輸入consumer訪問地址,測試是否可以正常訪問:

后臺輸出:
consumer 子 Module:

provider 子 Module:

至此,項目搭建創(chuàng)建成功,大家可以自己多復制幾個provider和consumer子Module的啟動類,把端口都改成不一樣試試集群輪詢、隨機訪問的效果。
具體代碼詳見GitHub倉庫:點我跳轉