搭建一个简单的springboot+dubbo服务
2018-06-03 本文已影响7731人
_Nuuull
本文主要介绍了如何自己动手实践，构建一套springboot+dubbo的分布式服务，帮助自己更好地理解dubbo服务。
1. dubbo环境搭建
dubbo环境搭建可以参见我之前写的文章 Dubbo环境搭建
2. 在springboot中集成dubbo服务
dubbo服务作为一款优秀的分布式开源框架，其最大的特色是采用了一种分层的架构，来达到解耦的目的。其服务主要是围绕着两个节点：服务提供方和服务消费方，服务提供方实现服务，而服务消费方调用服务。因此，我们需要在springboot中分别搭建服务的提供者和消费者。
2.1 创建父模块
首先创建spring-boot工程，本文中使用的是IDEA，在界面左上角选择File->New->Project后，选择Spring Initializr，默认选择jdk1.8，工程名自取，一路点next即可。
创建父模块.png
2.2 创建dubbo-provider
在刚刚创建的工程上右键New->module，Name设置为springboot-dubbo-provider，和父模块的创建步骤一致，一路next。
2.3 创建dubbo-consumer
再次在刚刚创建的工程上右键New->module，Name设置为springboot-dubbo-consumer，再一路next即可。
最后创建完的工程结构如图下图所示，再把mvnw、mvnw.cmd、.mvn文件夹以及父目录下的src这些不用的文件夹删掉，使得项目结构更为清晰。
dubbo目录结构.png
3.dubbo配置
3.1 提供方配置
需要在springboot-dubbo-provider模块下的resource文件下创建dubbo-provider.xml文件
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://code.alibabatech.com/schema/dubbo
http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
<!-- 应用配置，不要与提供方相同 -->
<dubbo:application name="springboot-dubbo-provider"/>
<!-- 注册中心配置，使用zookeeper注册中心暴露服务地址 -->
<dubbo:registry address="zookeeper://127.0.0.1:2181" timeout="60000" />
<!--关闭服务消费方所有服务的启动检查。dubbo缺省会在启动时检查依赖的服务是否可用，不可用时会抛出异常，阻止Spring初始化完成。-->
<dubbo:consumer check="false" />
<!-- 使用注解方式暴露接口，会自动扫描package下所有包中dubbo相关的注解，这样就不用在xml中再针对每个服务接口配置dubbo:service interface-->
<dubbo:annotation package="com.practice.springboot.dubbo.provider"/>
<!--<dubbo:service interface="com.practice.springboot.dubbo.provider.SayHelloImpl" ref="SayHelloImpl"/>-->
</beans>
在该配置文件中配置zookeeper的服务地址（zookeeper用于完成服务对外的统一管理），以及我们需要暴露的dubbo服务接口。暴露接口的方式有两种：一是通过注解方式，二是通过xml配置的方式。这里我采用的是注解的方式，然后在类上打@service注解，这样就不用在xml中再针对每个服务接口配置dubbo:service interface。如果需要采用xml配置的方式，只需把最后一行的代码替换成以下代码即可。
<dubbo:service interface="com.practice.springboot.dubbo.provider.SayHelloImpl" ref="SayHelloImpl"/>
3.2 消费方配置
和提供方的配置步骤相同，在springboot-dubbo-consumer模块下的resources文件夹下创建dubbo-consumer.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:dubbo="http://code.alibabatech.com/schema/dubbo"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://code.alibabatech.com/schema/dubbo
http://code.alibabatech.com/schema/dubbo/dubbo.xsd">
<!-- 应用配置，不要与提供方相同 -->
<dubbo:application name="springboot-dubbo-consumer"/>
<!-- 注册中心配置，使用zookeeper注册中心暴露服务地址 -->
<dubbo:registry address="zookeeper://127.0.0.1:2181" timeout="60000" />
<!-- 使用注解方式创建远程服务代理-->
<dubbo:annotation package="com.practice.springboot.dubbo.consumer"/>
<!--声明服务引用，与服务声明接口类型一致-->
<!--<dubbo:reference interface="com.practice.springboot.dubbo.provider.SayHelloImpl" id="SayHelloImpl"/>-->
</beans>
4.创建provider类及接口
这里只是为了帮助自己理解dubbo服务，所以写了一个很简单的sayHello服务。
4.1 定义sayHello接口
package com.practice.springboot.dubbo.provider;
public interface SayHello {
String sayHello(String name);
}
4.2 sayHello接口实现
package com.practice.springboot.dubbo.provider;
import com.alibaba.dubbo.config.annotation.Service;
@Service
public class SayHelloImpl implements SayHello {
@Override
public String sayHello(String name)
return "Hello " + name + "!";
}
}
4.3 编写启动类
package com.practice.springboot.dubbo.provider;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ImportResource;
@SpringBootApplication
@ImportResource(value = {"classpath:dubbo-provider.xml"})
public class SpringbootDubboProviderApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootDubboProviderApplication.class, args);
try {
//阻塞作用，否则会由于不是web项目，执行main方法后立即停止服务。
System.in.read();
} catch (Exception e) {
e.printStackTrace();
}
}
}
这里需要注意，加入System.in.read()是起阻塞作用的，否则由于pom中没有加spring-boot-starter-web依赖，启动时没有tomcat容器，会自动退出。另一种解决方式就是加入spring-boot-starter-web依赖。
5.创建consumer类
5.1 创建SayService
package com.practice.springboot.dubbo.consumer;
import com.alibaba.dubbo.config.annotation.Reference;
import com.practice.springboot.dubbo.provider.SayHello;
import org.springframework.stereotype.Component;
@Component
public class SayService {
@Reference
SayHello sayHello;
public String say (String name) {
return sayHello.sayHello(name);
}
}
5.2 创建消费者启动类
package com.practice.springboot.dubbo.consumer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ImportResource;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
//@ComponentScan(basePackages = {"com.practice.springboot.dubbo.consumer"})
@ImportResource("classpath:dubbo-consumer.xml")
public class SpringbootDubboConsumerApplication {
@Autowired
SayService sayService;
@RequestMapping("/hello")
public String say(@RequestParam ("name") String name) {
return sayService.say(name);
}
public static void main(String[] args) throws Exception{
ConfigurableApplicationContext context = SpringApplication.run(SpringbootDubboConsumerApplication.class, args);
// System.out.println("ok");
}
}
6.启动服务
6.1 启动zookeeper
进入zookeeper-3.4.10/bin目录下，启动zookeeper。
./zkServer.sh start
6.2 启动Tomcat
进入/ApacheTomcat/bin 目录下，启动Tomcat
./startup.sh
6.3 启动dubbo
分别启动我们的springboot-dubbo-provider和spring-dubbo-consumer。登录dubbo-admin，就可以看到我们的服务。
dubbo-admin
然后我们可以登录zk客户端，可以在zk上看到我们的dubbo服务，说明我们的配置已经生效了。
zk.png
最后再在浏览器中调用一下我们的say接口，如图所示，接口调用成功。
say.png
6. 踩过的坑
springboot启动时报错
org.springframework.beans.factory.xml.XmlBeanDefinitionStoreException: Line 7 in XML document from class path resource [dubbo-provider.xml] is invalid; nested exception is org.xml.sax.SAXParseException; lineNumber: 7; columnNumber: 47; cvc-complex-type.2.4.c: 通配符的匹配很全面, 但无法找到元素 'dubbo:application' 的声明。
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.doLoadBeanDefinitions(XmlBeanDefinitionReader.java:398) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:335) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:303) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java:187) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java:223) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanDefinitionReader.loadBeanDefinitions(AbstractBeanDefinitionReader.java:194) ~[spring-beans-5.0.6.RELEASE.jar:5.0.6.RELEASE]
原因是xmlns地址不对，当时我是通过编辑器自动导入的，作为新手并没有注意这个细节，在此记录一下避免以后再次踩坑。
xmlns地址.png
需要改成
xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
至此，一个简单的dubbo+springboot的服务就搭建完成了，通过这次实践，帮助我对dubbo服务有了进一步的了解，在之后实际项目中能够快速地找到dubbo的配置，更快地看懂开发代码，还是很有收获的，嘻嘻嘻~
