欢迎访问Spring Cloud中国社区

《重新定义Spring Cloud实战》由Spring Cloud中国社区倾力打造,基于Spring Cloud的Finchley.RELEASE版本,本书内容宽度足够广、深度足够深,而且立足于生产实践,直接从生产实践出发,包含大量生产实践的配置。欢迎加微信Software_King进群答疑,国内谁在使用Spring Cloud?欢迎登记

Dubbo迁移到SpringCloud

xiepeng · 6月前 · 5216 ·

1. 背景

    历史项目使用Dubbo进行服务构建,并基于Spring集成了一些所需的开源组件。
    在考虑新一轮的架构目标时,我们基于Dubbo和SpringCloud分别进行了方案规划,并结合自身状况评估后发现,基于Dubbo进行架构升级时,部分组件的集成或研发成本太大,而SpringCloud的生态系统则能够以较低的成本满足新的架构诉求。我们最终决定将整体的技术栈转换为SpringCloud,并对已有的业务系统进行迁移。

1.1 Dubbo工程现状概要

关键依赖版本
JDK 1.8 、Dubbo 2.5.3 、Spring 4.3.8

工程结构
使用maven构建,采用dubbo通用套路。
user
    user-api dubbo接口
    user-service 服务实现
    pom.xml

配置管理
运维配置写入文件,通过profile管理dev/test/mo/prod环境;业务配置使用自研配置系统管理。

Spring配置
绝大部分组件集成均使用spring的xml配置方式,并对xml文件进行了一定的切分。如:spring-dubbo.xml、spring-beans.xml、spring-*.xml。

Dubbo接口规范
返回数据进行了统一封装,入参过多时使用封装对象提交 。
Response<Integer> commitResourceDymaic(ResourceDymaic resourceDymaic);

1.2 迁移目标

1,使用springcloud的eureka、config、zuul构建基础架构,dubbo项目迁移到新架构中。

2,使用springboot+core(自研框架核心包)作为基础框架。初步阶段完成对已有项目的springboot集成调整,最终全面使用springboot与core统一实现AutoConfig。


2. 准备工作

2.1 dubbo快速集成验证springboot

如果有项目已经集成了springboot,并开始使用它所提供的start来自动装配,那么该步骤可以就此略过。

而对于还未集成spirngboot的项目,实施改造并没有看起来的那么复杂。单纯的集成springboot框架,仅完成以下调整就足够了,在改造前期,可以通过这种方式快速对项目进行依赖和配置的梳理调整。

maven依赖中父工程pom文件

<dependencyManagement>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>${spring.boot.version}</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
</dependencyManagement>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

dubbo的service工程pom文件

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

添加启动类和配置文件,在service的相应package下添加springboot启动类。

@SpringBootApplication
public class ApplicationSupport {
    public static void main(String[] args) {
        SpringApplication.run(ApplicationSupport.class, args);
    }
}

在resources下新增application.yml

spring:
    application:
        name: user

替换原项目启动方式,废弃原web.xml等配置文件,在启动类中通过注解加载spring的xml配置。
@ImportResource("classpath:spring-root.xml")

2.2 集成springboot

我们的最终目标中包含springboot框架来简化开发,例如使用springboot内置及dubbo等外部提供的一些starter,不过实际上他们与迁移并无依赖或冲突干扰,可以按照实际状况
进行基础的AutoConfig。

在初次集成时尽可能使用自动装配,去掉spring的xml配置。

使用@EnableTransactionManagement@ComponentScan等注解取代xml相关配置;

使用dubbo-spring-boot-starter及注解取代dubbo的xml配置,git地址

maven依赖

<dependency>
    <groupId>com.alibaba.boot</groupId>
    <artifactId>dubbo-spring-boot-starter</artifactId>
    <version>0.1.0</version>
</dependency>

自定义注解及AutoConfig取代三方组件的xml配置,例如elasticjob

@Configuration
@ConditionalOnClass(ElasticJob.class)
public class ElasticJobAutoConfig {
    @Autowired
    private ConfigurableApplicationContext configurableContext;

    @Bean(initMethod = "init")
    public ZookeeperRegistryCenter zookeeperRegistryCenter(@Value("${job.reg.address}") final String serverList, @Value("${job.reg.namespace}") final String namespace) {
        return new ZookeeperRegistryCenter(new ZookeeperConfiguration(serverList, namespace));
    }
}

2.3 搭建springcloud基础服务

部署config、eureka、zuul,有大量的资料供参考实施,略过。

在集成springboot后的项目上引入springcloud,完成eureka、config的相关配置,略过。


三、服务迁移

在准备工作中,我们已经完成了对工程的调整并接入springcloud,服务在保持dubbo正常工作的基础上,同时能够连接到eureka进行服务提供。接下来,服务迁移的核心包含两部分:
1,使原有的dubbo服务提供Restful规范接口
2,服务调用方接入调整

3.1 dubbo与springcloud独立共存方案

初始状态结构

共存状态结构:保持原dubbo的service实现不变,额外基于service改造提供Restful接口。

该方式能够最大程度保证原服务稳定运行,但会额外增加开发成本,长期保持共存也容易导致消费方的调用混乱。

3.2 基于Feign的切换方案

修改原dubbo provider,同时向dubbo registry和eureka注册相同服务。
修改原dubbo consumer,根据配置方式支持dubbo或http调用。

切换过程中,服务状态如下:

具体实现思路:

1,修改原dubbo服务定义的api接口,支持feign调用。

@FeignClient("demo")
public interface DemoService {

    @RequestMapping(value = "/{version}/pt/demos/{appId}", method = RequestMethod.GET)
    Response<Integer> post(@PathVariable("appId") String appId);
}

2,修改原dubbo服务的实现类,添加@RestController对外提供Restful接口

@Service
@RestController
public class DemoServiceImpl implements DemoService {

    @Override
    public Response<Integer> post(String appId) {
        return null;
    }
}

3,消费者切换调用方式,如果原dubbo消费者使用了@Refrence注解,直接更改为@Autowoired即可。若使用了xml配置refrence则注解即可。

@Reference
private DemoService demoService;

//更改为
@Autowired
private DemoService demoService;

存在的问题:spring MVC不支持继承接口中方法参数的组件,dubbo接口转换Restful接口时可能无法适应等。
参考查看http://springcloud.cn/view/42