Springboot整合Dubbo和Zookeeper
Dubbo是一款由阿里巴巴开发的远程服务调用框架(RPC),其可以透明化的调用远程服务,就像调用本地服务一样简单。截至目前,Dubbo发布了基于Spring Boot构建的版本,版本号为0.2.0,这使得其与Spring Boot项目整合变得更为简单方便。而Zookeeper在这里充当的是服务注册中心的角色,我们将各个微服务提供的服务通过Dubbo注册到Zookeeper中,然后服务消费者通过Dubbo从Zookeeper中获取相应服务并消费。本文案例的架构图可以简单用下图表示:
本文案例最终项目结构如下图所示:
项目采用Maven构建,各模块的作用:
模块 | 描述 |
---|---|
common-api | 统一定义接口,供其余子模块引用 |
server-provider | 服务提供者,实现common-api模块中的接口,然后暴露到Zookeeper中,供服务消费者使用 |
server-consumer | 服务消费者,通过Dubbo从Zookeeper中获取服务并消费 |
环境准备
Zookeeper安装
在搭建项目之前需要启动Zookeeper服务,Zookeeper下载地址:http://zookeeper.apache.org/releases.html#download。
下载后解压,将config目录下的zoo_sample.cfg重命名为zoo.cfg(Zookeeper配置文件,默认端口为2181,可根据实际进行修改)。然后双击bin目录下的zkServer.cmd启动即可。
构建父模块
新建一个Maven项目,groupId为cc.mrbird
,artifactId为dubbo-boot
,packaging指定为pom。然后引入Spring Boot,dubbo-spring-boot-starter和Zookeeper相关依赖:
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 | <?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>cc.mrbird</groupId> <artifactId>dubbo-boot</artifactId> <packaging>pom</packaging> <version>1.0</version> <name>dubbo-boot</name> <description>Spring Boot-Dubbo-ZooKeeper</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.4.RELEASE</version> <relativePath/> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> <project.version>1.0</project.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- dubbo --> <dependency> <groupId>com.alibaba.boot</groupId> <artifactId>dubbo-spring-boot-starter</artifactId> <version>0.2.0</version> </dependency> <!-- zookeeper --> <dependency> <groupId>org.apache.zookeeper</groupId> <artifactId>zookeeper</artifactId> <version>3.4.8</version> </dependency> <dependency> <groupId>com.101tec</groupId> <artifactId>zkclient</artifactId> <version>0.10</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <configuration> <source>${java.version}</source> <target>${java.version}</target> <encoding>${project.build.sourceEncoding}</encoding> </configuration> </plugin> </plugins> </build></project> |
构建Common-api
新建一个Maven模块,artifactId为common-api
,目录结构如下所示:
pom.xml:
12345678910111213 | <?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>dubbo-boot</artifactId> <groupId>cc.mrbird</groupId> <version>1.0</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>common-api</artifactId></project> |
项目只包含一个HelloService接口:
12345 | package cc.mrbird.common.api;public interface HelloService { String hello(String message);} |
至此我们可以开始构建服务提供者和服务消费者了。
构建Server-Provider
新建一个Maven模块,用于暴露Dubbo服务,artifactId为server-provider
,目录结构如下所示:
pom内容如下:
123456789101112131415161718192021 | <?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 大专栏 Springboot整合Dubbo和Zookeeper:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>dubbo-boot</artifactId> <groupId>cc.mrbird</groupId> <version>1.0</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>server-provider</artifactId> <dependencies> <dependency> <groupId>cc.mrbird</groupId> <artifactId>common-api</artifactId> <version>${project.version}</version> </dependency> </dependencies></project> |
这里我们引入了common-api模块,用于后续实现相应的服务。
在Spring Boot启动类中我们加入@EnableDubbo
注解,表示要开启dubbo功能:
123456789101112 | import com.alibaba.dubbo.config.spring.context.annotation.EnableDubbo;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@EnableDubbo@SpringBootApplicationpublic class ProviderApplicaiton { public static void main(String[] args) { SpringApplication.run(ProviderApplicaiton.class, args); System.out.println("complete"); }} |
接着在applicaiton.yml中配置Dubbo:
12345678910111213141516 | server: port: 8080dubbo: application: # 服务名称,保持唯一 name: server-provider # zookeeper地址,用于向其注册服务 registry: address: zookeeper://127.0.0.1:2181 #暴露服务方式 protocol: # dubbo协议,固定写法 name: dubbo # 暴露服务端口 (默认是20880,不同的服务提供者端口不能重复) port: 20880 |
如果Zookeeper是集群的话,spring.dubbo.registry.address
配置为:
1234 | spring: dubbo: registry: address: zookeeper://127.0.0.1:2181?backup=127.0.0.1:2180,127.0.0.1:2182 |
接下来我们在cc.mrbird.provider.service
路径下创建一个HelloService
接口的实现类:
123456789101112 | import cc.mrbird.common.api.HelloService;import com.alibaba.dubbo.config.annotation.Service;import org.springframework.stereotype.Component;@Service(interfaceClass = HelloService.class)@Componentpublic class HelloServiceImpl implements HelloService { @Override public String hello(String message) { return "hello," + message; }} |
值得注意的是@Service
注解为Dubbo提供的com.alibaba.dubbo.config.annotation.Service
,而非Spring的那个。其中interfaceClass
是指要发布服务的接口。
通过上面的配置,我们已经将HelloService
接口的实现暴露到Zookeeper中了,接下来我们继续创建一个服务消费者,来消费这个服务。
搭建Server-Consumer
新建一个Maven模块,用于消费Dubbo服务,artifactId为server-consumer
,目录结构如下所示:
pom内容如下:
123456789101112131415161718192021 | <?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>dubbo-boot</artifactId> <groupId>cc.mrbird</groupId> <version>1.0</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>server-consumer</artifactId> <dependencies> <dependency> <groupId>cc.mrbird</groupId> <artifactId>common-api</artifactId> <version>${project.version}</version> </dependency> </dependencies></project> |
同样的,我们也在Spring Boot启动类中我们加入@EnableDubbo
注解,表示要开启dubbo功能。
接着在applicaiton.yml中配置Dubbo:
12345678910111213 | server: port: 8081dubbo: application: # 服务名称,保持唯一 name: server-consumer # zookeeper地址,用于从中获取注册的服务 registry: address: zookeeper://127.0.0.1:2181 protocol: # dubbo协议,固定写法 name: dubbo |
同服务提供者,我们需要指定Zookeeper的地址,协议为dubbo。
接着我们定义一个TestController
,演示服务消费:
1234567891011121314151617 | import cc.mrbird.common.api.HelloService;import com.alibaba.dubbo.config.annotation.Reference;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.PathVariable;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class HelloController { @Reference private HelloService helloService; @GetMapping("/hello/{message}") public String hello(@PathVariable String message) { return this.helloService.hello(message); }} |
通过Dubbo的@Reference
注解注入需要使用的interface,类似于Spring的@Autowired
。
测试
分别启动Server-Provider和Server-Consumer,访问http://localhost:8081/hello/mrbird:
说明远程服务调用已经成功。
这里只是通过Spring Boot和Dubbo的整合来简单了解Dubbo的使用,仅作抛砖引玉,更为详细的Dubbo配置可以查看官方文档:http://dubbo.apache.org/zh-cn/docs/user/quick-start.html