dubbo是一个分布式服务框架,将服务实现与调用分开部署,实现了最大程度的服务复用。
关于dubbo的进一步学习,可以参考官网的介绍,本文的目的是带大家建立一个我认为已经十分简单的dubbo项目。希望大家可以通过这篇博文对dubbo有一个初步的理解和认识,以便后续的继续深入。
上面的这个图展示了我们这个项目大致的描述。
需要部署一个tomcat-provider,用于提供服务的实现。部署另一个tomcat-consumer来调用服务,看清楚是另一个tomcat。这里需要另外一台机器用于配置dubbo的服务注册中心。
先带大家部署一个dubbo的服务注册中心。
首先需要一个linux的虚拟机,安装JDK以及配置环境变量的部分我就省略了。
上传zookeeper的压缩包,这里我用的是3.4.6的版本。
解压缩,进入conf目录,修改配置文件为zoo.cfg,原来里面有一个sample配置文件,直接改名就可以,配置里面的内容,如下:
其他的配置项目不需要改,重点修改dataDir属性,其中我配置的/root/zookeepdata,这个目录必须手动创建。
配置完成后进入bin目录
其中./zkServer.sh start用于启动zookeeper,使用status命令来查看状态,看到standalone表示启动已经成功了。
这里展示一下服务器的IP地址,后续有用。
dubbo提供了一个免费的工具,用于管理服务。
在这台机器上安装一个tomcat,在webapp下放上dubboo-admin的war包,启动tomcat服务器就可以,如果该tomcat和zookeeper在同一台机器上,不需要做任何的配置就可以使用。
启动完成后,访问dubbo管理页面,用户名和密码默认都是root。
这样dubbo服务注册中心的部分就已经好了。
下面开始建立工程,需要三个工程,
dubbo-interface,普通的JAR工程,用于提供公共的接口。
dubbo-provider,普通的WAR工程,用于提供接口的实现,依赖dubbo-interface工程。
dubbo-consumer,普通的WAR工程,用于调用接口的实现,依赖dubbo-interface工程。
下面先看一下dubbo-interface的工程结构。
下面是pom文件,主要是修改了编译的版本,意义不大。
<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.kingdz.dubbo</groupId>
<artifactId>dubbo-interface</artifactId>
<version>0.0.1-SNAPSHOT</version>
<build>
<finalName>dubbo-service</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.2</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
定义了一个简单的接口
package com.kingdz.dubbo;
public interface HelloWorld {
String sayHello();
}
下面来看一下dubbo-provider工程结构。
这是一个web工程,首先看一下pom文件,主要定义了对dubbo-interface工程的依赖,引入的spring、dubbo、zookeeper、log4j。
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.kingdz.dubbo</groupId>
<artifactId>dubbo-provider</artifactId>
<packaging>war</packaging>
<version>0.0.1-SNAPSHOT</version>
<name>dubbo-provider Maven Webapp</name>
<url>http://maven.apache.org</url>
<properties>
<jsp-api.version>2.0</jsp-api.version>
<jstl.version>1.2</jstl.version>
<servlet-api.version>2.5</servlet-api.version>
<spring.version>4.3.5.RELEASE</spring.version>
</properties>
<dependencies>
<dependency>
<groupId>com.kingdz.dubbo</groupId>
<artifactId>dubbo-interface</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<!-- Spring -->
<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>
<!-- JSP相关 -->
<dependency>
<groupId>jstl</groupId>
<artifactId>jstl</artifactId>
<version>${jstl.version}</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>${servlet-api.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jsp-api</artifactId>
<version>${jsp-api.version}</version>
<scope>provided</scope>
</dependency>
<!-- dubbo -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dubbo</artifactId>
<version>2.5.3</version>
<exclusions>
<exclusion>
<artifactId>spring</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
</exclusions>
</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>
</dependencies>
<build>
<finalName>dobbo-provider</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.2</version>
<configuration>
<source>1.7</source>
<target>1.7</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
下面看一下接口的实现。
package com.kingdz.dubbo.impl;
import org.apache.log4j.Logger;
import org.springframework.stereotype.Service;
import com.kingdz.dubbo.HelloWorld;
@Service
public class HelloWorldImpl implements HelloWorld {
private static Logger log = Logger.getLogger(HelloWorldImpl.class);
@Override
public String sayHello() {
String str = "Hello dubbo";
log.info("调用成功,输出" + str);
return str;
}
}
为了方便,加入了日志用于观察是否调用成功。
关键是applicationContext.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:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jee="http://www.springframework.org/schema/jee"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
xsi:schemaLocation="
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">
<!-- 自动扫描 -->
<context:component-scan base-package="com.kingdz.dubbo.impl" />
<!-- 使用 dubbo 发布服务 -->
<!-- 提供方应用信息, 用于计算依赖关系 -->
<dubbo:application name="dubbo-provider" />
<dubbo:registry protocol="zookeeper" address="192.168.8.102:2181" />
<!-- 用 dubbo 协议在 20880 端口暴露服务 -->
<dubbo:protocol name="dubbo" port="20880" />
<!-- 声明需要暴露的服务接口 -->
<dubbo:service interface="com.kingdz.dubbo.HelloWorld"
ref="helloWorldImpl" />
</beans>
在上面的配置文件中定义了zookeeper的ip地址,端口是2181。以及暴露的接口的服务实现。其中20880端口是自定义的可以改。
下面是web.xml中的内容。
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<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>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>
下面看最后一个dubbo-consumer的工程结构。
和dubbo-provider类似,没有什么太多的区别,这是一个springmvc的工程,实际实现中省略的页面的配置。
pom文件和dubbo-provider类似,没有什么区别,这里就不展示了。
下面看一下控制层的调用。
package com.kingdz.dubbo.controller;
import javax.annotation.Resource;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import com.kingdz.dubbo.HelloWorld;
@Controller
public class HelloWorldController {
@Resource
private HelloWorld helloWorld;
@RequestMapping("/test")
public void test() {
helloWorld.sayHello();
}
}
spring-mvc.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:mvc="http://www.springframework.org/schema/mvc" xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd
http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
<!-- 自动扫描该包,使SpringMVC认为包下用了@controller注解的类是控制器 -->
<context:component-scan base-package="com.kingdz.dubbo.controller" />
<!-- 添加注解驱动 -->
<mvc:annotation-driven enable-matrix-variables="true" />
<mvc:default-servlet-handler />
<!-- 定义跳转的文件的前后缀 ,视图模式配置 -->
<bean
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>
重点是applicationContext.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:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
xsi:schemaLocation="
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">
<!-- 引用 dubbo 服务 -->
<dubbo:application name="dubbo-consumer" />
<dubbo:registry protocol="zookeeper" address="192.168.8.102:2181" />
<dubbo:reference interface="com.kingdz.dubbo.HelloWorld"
id="helloWorld" />
</beans>
下面是web.xml中的内容。
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<display-name>Archetype Created Web Application</display-name>
<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>
<!-- 编码过滤器 -->
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<async-supported>true</async-supported>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!-- Spring监听器 -->
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- 防止Spring内存溢出监听器 -->
<listener>
<listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
</listener>
<!-- Spring MVC servlet -->
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
<async-supported>true</async-supported>
</servlet>
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<!-- 此处可以可以配置成*.do,对应struts的后缀习惯 -->
<url-pattern>/</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>/index.html</welcome-file>
<welcome-file>/index.jsp</welcome-file>
</welcome-file-list>
</web-app>
到此为止,所有的内容都已经展示完毕了。
下面开始实际的应用。
首先将dubbo-provider部署到tomcat上启动。
这是可以看到服务com.kingdz.dubbo.HelloWorld已经上线了。
下面将dubbo-consumer部署到另一台tomcat上启动。
看到消费者也已经上线了。
这时访问http://localhost:8080/dubbo-consumer/test后,我们会看到一个404的页面,不过这是正常的,因为我没有配置页面。但是日志上已经有输出了。
到此一个简单的dubbo应用就已经完成了。
下面有几个我在搭建工程式遇到的问题再此提示一下:
1,如果需要在本机上启动两个tomcat,一个tomcat保持默认配置不变,另一个tomcat如果希望正常启动,需要改三个端口的配置,不只是8080端口。
2,log4j的maven依赖和日志配置文件是一定要加的,否则你完全不知道哪里出错了。
3,如果希望在这个项目上进一步丰富,比如加入实体类,在此提醒实体类必须是可序列化的。
4,linux上有防火墙的设置,一定要将8080的tomcat端口以及2181的zookeeper端口进行开放,否则外部是无法访问的。
最后希望将博文看完的人都会有所收获,觉得我哪里讲的不对,欢迎提问。
个人也是刚接触dubbo,大家一起学习。