Dubbo框架简介与实战
软件架构的演变,可以参考这一篇博客的前部分:Spring Cloud系列(一)——相关概念及组件简介
简介
Apache Dubbo是一个高性能的RPC框架。
RPC:Remote Procedure Call 即远程过程调用。当两个应用运行在不同的服务器上时,由于应用所在的内存空间不同,因此二者不能直接调用,需要通过网络来表明调用的语义和传达调用的数据。
Dubbo提供的三大核心能力:面向接口的远程方法调用、智能容错和负载均衡、服务自动注册和发现。
Dubbo架构
Dubbo官方给出的架构图:
- Provider:服务提供方
- Consumer:服务消费方/服务调用方
- Comtainer:服务提供方运行的容器
- Registry:注册中心(Dubbo官方推荐使用Zookeeper)
- Monitor:监控中心(统计服务调用次数和调用时间)
Zookeeper:服务注册中心
Zookeeper是一个树形的目录服务,支持变更推送,适合作为Dubbo服务的注册中心,工业强度高,可用于生产环境。
Zookeeper的树形目录服务:
- dubbo
- com.foo.HelloService
- providers
- ip:port
- ip:port
- consumers
- ip
- ip
- com.foo.TestService
- providers
- ip:port
- ip:port
- ...
- consumers
- ip
- ...
dubbo是根目录,在dubbo下是一个个服务提供方暴露的服务接口(xxxService),在服务接口下有providers目录,存放了服务提供方的ip地址等信息,以及consumers目录存放的是服务消费方的ip地址等信息。
Zookeeper安装——虚拟机CentOS8
下载:http://archive.apache.org/dist/zookeeper/
我这里使用的是3.4.6版,下载后将文件放到虚拟机随便一个目录下
-
进入该目录,解压压缩包到
/usr
目录tar -zxvf zookeeper-3.4.6.tar.gz -C /usr
-
进入解压后的zookeeper-3.4.6文件夹,创建data目录
mkdir data
-
进入conf目录,把zoo_sample.cfg改名为zoo.cfg
mv zoo_sample.cfg zoo.cfg
-
修改zoo.cfg文件中的data属性:dataDir=/usr/zookeeper-3.4.6/data
vim zoo.cfg
-
启动、停止Zookeeper
-
启动Zookeeper:进入zookeeper的bin目录,输入如下命令:
./zkServer.sh start
-
停止服务命令
./zkServer.sh stop
-
查看服务状态
./zkServer.sh status
-
客户端连接
./zkCli.sh
-
实战——搭建Dubbo工程
0. 创建一个空工程作为父工程
1. 新建服务提供方(provider)
(1) 新建module,选择maven,不使用模板,命名为provider。
(2) 随后在/src/main
目录下新增webapp目录(创建好后会有一个蓝色小点,表示是Web资源目录),在webapp目录下新建WEB-INF目录
(3) 配置生成web.xml:打开项目结构,添加开发脚本(即web.xml)
(4) 修改web.xml的路径为刚刚创建的WEB-INF文件夹下:
(5) 在pom.xml文件中导入如下内容:
<packaging>war</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<spring.version>5.0.5.RELEASE</spring.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jms</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- dubbo相关 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dubbo</artifactId>
<version>2.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.zookeeper</groupId>
<artifactId>zookeeper</artifactId>
<version>3.4.7</version>
</dependency>
<dependency>
<groupId>com.github.sgroschupf</groupId>
<artifactId>zkclient</artifactId>
<version>0.1</version>
</dependency>
<dependency>
<groupId>javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.12.1.GA</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.47</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.tomcat.maven</groupId>
<artifactId>tomcat7-maven-plugin</artifactId>
<configuration>
<!-- 指定端口 -->
<port>8081</port>
<!-- 请求路径 -->
<path>/</path>
</configuration>
</plugin>
</plugins>
</build>
(6) 配置web.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext*.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
</web-app>
(7) 新建服务接口
package com.xj.service;
/**
* @ClassName HelloService
* @Description
* @Author JingXu
* @Date 3/11/22 7:48 PM
*/
public interface HelloService {
String sayHello(String name);
}
(8) 实现服务接口:注意@Service注解是Dubbo提供的
package com.xj.service.impl;
import com.alibaba.dubbo.config.annotation.Service;
import com.xj.service.HelloService;
/**
* @ClassName HelloServiceImpl
* @Description
* @Author JingXu
* @Date 3/11/22 7:49 PM
*/
@Service
public class HelloServiceImpl implements HelloService {
@Override
public String sayHello(String name) {
return "hello! " + name;
}
}
(9) 在src/main/resources
下创建applicationContext-service.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:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context"
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo" xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
<!-- 当前应用名称,用于注册中心计算应用间依赖关系,注意:消费者和提供者应用名不要一样 -->
<dubbo:application name="dubbo_provider"/>
<!-- 连接服务注册中心zookeeper ip为zookeeper所在服务器的ip地址,端口号默认为2181-->
<dubbo:registry address="zookeeper://192.168.215.128:2181"/>
<!-- 注册 协议和port -->
<dubbo:protocol name="dubbo" port="20881"></dubbo:protocol>
<!-- 扫描指定包,加入@Service注解的类会被发布为服务 -->
<dubbo:annotation package="com.xj.service.impl"/>
</beans>
(10) 启动服务:tomcat7:run
(11) 在虚拟机中,可以连接客户端查看dubbo的树形目录情况,使用命令ls /dubbo/com.xj.service.HelloService
可以看到有子目录providers,再查看providers,可以看到一些ip地址等信息。后面可以使用Dubbo-admin来更直观的看到。
2. 新建服务消费方(consumer)
(1) - (5)步骤同上。
(6) 配置web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 指定加载的配置文件 ,通过参数contextConfigLocation加载 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext-web.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>
</web-app>
(7) 这里直接将服务提供方里的HelloService接口复制到当前项目。实际应当将接口类放在一个单独的工程里进行管理,服务提供方和服务消费方直接通过maven的方式引入该工程即可。
(8) 新建Controller:注意@Reference注解是Dubbo提供的
package com.xj.controller;
import com.alibaba.dubbo.config.annotation.Reference;
import com.xj.service.HelloService;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* @ClassName HelloController
* @Description
* @Author JingXu
* @Date 3/11/22 8:18 PM
*/
@Controller
@RequestMapping("/demo")
public class HelloController {
@Reference // 远程调用的代理接口对象
private HelloService helloService;
@RequestMapping("hello")
@ResponseBody
public String getName(String name) {
// 远程调用
String result = helloService.sayHello(name);
System.out.println(result);
return result;
}
}
(9) 在src/main/resources
下创建applicationContext-web.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:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context"
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo" xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
<!-- 当前应用名称,用于注册中心计算应用间依赖关系,注意:消费者和提供者应用名不要一样 -->
<dubbo:application name="dubbo-consumer"/>
<!-- 连接服务注册中心zookeeper ip为zookeeper所在服务器的ip地址-->
<dubbo:registry address="zookeeper://192.168.215.128:2181"/>
<!-- 扫描的方式暴露接口 -->
<dubbo:annotation package="com.xj.controller"/>
</beans>
(10) 运行测试:tomcat7:run
在浏览器访问:http://localhost:8082/demo/hello.do?name=test 查看输出结果
Dubbo配置负载均衡
负载均衡可以在服务提供方配置,也可以在服务消费方配置。
服务提供方配置:
在**@Service注解**中指定loadbalance属性值,默认为random
,还可以选择轮询、最少活跃调用数、一致性Hash。
@Service(loadbalance = "random") // 配置负载均衡策略
public class HelloServiceImpl implements HelloService {
@Override
public String sayHello(String name) {
return "hello! " + name;
}
}
服务消费方配置:
在**@Referen注解**中指定loadbalance属性值
@Controller
@RequestMapping("/demo")
public class HelloController {
@Reference(loadbalance = "random") // 配置负载均衡策略
private HelloService helloService;
@RequestMapping("hello")
@ResponseBody
public String getName(String name) {
// 远程调用
String result = helloService.sayHello(name);
System.out.println(result);
return result;
}
}
Dubbo管理控制台
将dubbo-admin-2.6.0.war文件部署到tomcat即可访问。
安装
-
下载一个tomcat:https://tomcat.apache.org/download-80.cgi
-
解压到任意文件夹,进入安装目录,并将dubbo-admin的war包修改后缀为zip,解压后放到tomcat的webapp目录下:
- 修改dubbo-admin文件夹下的WEB-INF目录中的dubbo.properties文件,将
dubbo.registry.address
的值改为运行zookeeper的虚拟机的ip地址
-
启动tomcat
进入bin目录,执行:
sudo ./startup.sh
// 想要打印出log,可以执行:
sudo ./catalina.sh
-
这里可能会遇到permission denied的问题,因为tomcat安装目录bin目录下的shell文件没有执行的权限,进入bin目录后执行修改权限命令,再次启动tomcat即可
sudo chmod +x *.sh
-
这里我还遇到了一个报错:
org.springframework.beans.factory.BeanDefinitionStoreException: Unexpected exception parsing XML document from ServletContext resource [/WEB-INF/webx.xml]; nested exception is java.lang.IllegalArgumentException: Unknown flag 0x1000
原因是tomcat使用的是jdk11,需要换回jdk1.8 我另外下载了一个jdk1.8,然后修改tomcat默认的jdk版本即可:在catalina.sh文件和setclasspath.sh文件开头的空白处加上如下两句,后面的路径就填自己电脑上安装的jdk1.8的目录
export JAVA_HOME=/Users/xujing/Library/Java/JavaVirtualMachines/corretto-1.8.0_322/Contents/Home export JRE_HOME=/Users/xujing/Library/Java/JavaVirtualMachines/corretto-1.8.0_322/Contents/Home
重新运行后成功。
运行成功后,访问:http://localhost:8080/dubbo-admin-2.6.0/,输入用户名root和密码root即可进入控制台
-
点击服务可以查看详情
解决:Dubbo无法发布被事务代理的Service问题
问题:如果在服务提供方的Service类上加@Transactional注解进行事务控制,则服务会发布不成功。
原因:因为事务控制的底层是为服务提供类创建代理对象,Spring默认是基于JDK动态代理的方式创建代理对象,而该代理对象的完整类名为com.sun.proxy.$Proxy32(后两位数字不固定),导致Dubbo在发布前进行包匹配的时候不成功,最终发布失败。
解决步骤:
-
指定使用CGLIB代理方式:在applicationContext-service.xml文件中,开启事务控制注解支持中指定proxy-target-class属性的值为true。
<!--开启事务控制的注解支持--> <tx:annotation-driven transaction-manager="transactionManager" proxy-target-class="true"/>
-
指定服务的接口类型,否则会导致发布的服务接口为SpringProxy而不是HelloService:在HelloServiceImpl类的@Service注解中指定interfaceClass属性的值为:HelloService.class
@Service(loadbalance = "random", interfaceClass = HelloService.class) @Transactional public class HelloServiceImpl implements HelloService { @Override public String sayHello(String name) { return "hello! " + name; } }