Spring MVC项目改造Spring Boot项目

最近在公司需要把一个老的Spring Mvc项目升级为Spring Boot项目，升级后将一些无用代码去除，在升级过程遇到了一些问题，特此记录。

引入Spring Boot的相关依赖

首先需要在pom文件中引入Spring Boot的相关依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.5.RELEASE</version>
</parent>

• 注意：如果工程本身已经含有一个parent了，可以使用一下方法引入Spring Boot的相关依赖

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

在导入Spring Boot项目多parent依赖时，需要注意如果只是单纯将新的parent声明为dependency类型，则会在maven导入jar包时出现unknown。如果Spring Boot项目为父子工程，则可在子工程中的pom文件中引入所依赖的Spring Boot的模块依赖，如下所示：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

去除web.xml文件

在引入了Spring Boot的相关依赖后，可以去除Spring Boot工程中所不存在的web.xml文件，如果有自定义的filter过滤器，应该需要处理一下，托管给spring容器去加载。

创建Spring Boot入口类

创建Spring Boot的主入口类xxxApplication，在此入口类extends SpringBootServletInitializer并重写configure方法，如下所示：

package com.tujia.up;

import com.tujia.framework.dubbo.healthcheck.HealthServletContextListener;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ImportResource;

/**
 * @author: lixinghao
 * @date: 2019/12/3 11:34 上午
 * @Description:
 */
@SpringBootApplication(scanBasePackages = {"com.tujia.up"})
@ImportResource(locations = "bean/spring-config.xml")
@Slf4j
public class BdUserPermissionApplication extends SpringBootServletInitializer {
    public static void main(String[] args) {
        SpringApplication.run(BdUserPermissionApplication.class, args);
    }

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(BdUserPermissionApplication.class);
    }

    @Bean
    public ServletListenerRegistrationBean servletListenerRegistrationBean() {
        ServletListenerRegistrationBean servletListenerRegistrationBean = new ServletListenerRegistrationBean();
        servletListenerRegistrationBean.setListener(new HealthServletContextListener());
        servletListenerRegistrationBean.setOrder(1);
        return servletListenerRegistrationBean;
    }
}

启动类继承自SpringBootServletInitializer方可正常部署至常规tomcat下，其主要能够起到web.xml的作用。因为我们将服务上线时，还是会采用jenkins自动化部署到常规Tomcat下，所以还是实现该接口为好。

遇到的问题：

• 升级过程中由于影响元素众多，可能无法快速定位问题出现在哪里，可以采取控制变量法。先注释掉所有的配置文件，逐渐开放相关的配置文件。先放在一些比较独立的不依赖其他配置的配置文件，主键缩小确定的范围。
• 在升级过程中，可能会遇到一些类、方法不存在的问题，需要同学们更换Spring Boot的jar包版本。