跳至主要內容

SpringMVC4升级为SpringBoot2实战

ycyin2022年6月7日大约 14 分钟SpringSpringSpringMVCSpring Boot

前言

SpringMVC4升级为SpringBoot2.6.7，根据SpringBoot的最小配置原则，其升级主要就是将xml的配置方式改为配置文件、Bean配置或者不配置。

该项目原先为一个Spring4+SpringMVC4+JPA+Ehcache配置的Maven多模块项目，打包后使用War包部署，为了不做太大的改动，仅在原先项目上修改，修改后仍然是一个Maven多模块项目，采用SpringBoot方式运行项目部署也只需要部署Jar包。

项目根pom.xml文件处理

相关依赖处理

1.项目根路径下添加spring-boot-starter-parent:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.6.7</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

2.添加必要的dependency：

3.删除不需要的依赖包，比如：Spring相关：spring-web，spring-webmvc，spring-core，spring-beans，spring-context等、Hibernate相关：hibernate-core，hibernate-ehcache等SpringBoot的多个Starter会自动依赖的jar。

移除多profiles配置

移除多profiles配置，改为SpringBoot后直接在yaml配置文件中指定spring.profiles.active即可。

添加打包插件

在根pom.xml中添加打包插件，并指定SpringBoot的启动类路径mainClass

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <mainClass>com.xxx.Application</mainClass>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>repackage</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Web模块处理

相关依赖处理

1.修改打包方式为Jar

<packaging>jar</packaging> <!-- <packaging>war</packaging> -->

2.修改build插件为spring-boot-maven-plugin

<build>
    <finalName>XXX</finalName>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <!--
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
             -->
        </plugin>
    </plugins>
</build>

3.同根pom.xml中一样，移除多profiles配置

添加启动类

添加SpringBoot Main函数启动,一般将该类添加到其它类的父包中(否则可能SpringBoot自动扫描不到其它类)

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

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

}

配置文件转化

将原先的web.xml（JaveWeb配置文件）、applicationContext.xml和springmvc-servlet.xml（Spring相关xml配置）中的配置转换为配置yaml文件、Java配置或者直接删除由SpringBoot自动完成。

最终会将webapp目录删除，包括web.xml、resources下的所有applicationContext*.xml等与Spring相关的xml配置文件都不需要了

如果有静态(前端页面文件)文件也由webapp移动到resources目录下，最终的resources目录结构树如下：

Boot配置文件与静态文件

resources目录用于存放SpringBoot下的配置文件、静态资源等。并根据系统情况创建配置文件application.yaml、application-dev.yaml、application-pro.yaml

在application-dev.yaml和application-pro.yaml中分别配置测试和生产的配置，在application.yaml中使用spring.profiles.active或者打包时使用命令覆盖激活特定配置文件。

例如：在application-dev.yaml中的liquibase配置使用的是classpath:/dev/目录下的文件

spring:
  liquibase:
    change-log: classpath:/dev/liquibase/master.xml
    database-change-log-table: xxx_CONFIG_BASELOG
    database-change-log-lock-table: xxx_CONFIG_BASELOGLOCK

在application-pro.yaml中的liquibase配置使用的是classpath:/pro/目录下的文件

spring:
  liquibase:
    change-log: classpath:/dev/liquibase/master.xml
    database-change-log-table: xxx_CONFIG_BASELOG
    database-change-log-lock-table: xxx_CONFIG_BASELOGLOCK

在application.yaml中激活dev环境配置：

spring:
  profiles:
    active:
    - dev

这在原先的配置中也是有的，位于web.xml中：

<context-param>
    <param-name>spring.profiles.active</param-name>
    <param-value>dev</param-value>
</context-param>

Servlet、Filter、Listener

号称JavaWeb三剑客的Servlet、Filter、Listener原先注册在web.xml中，Filter过滤器修改为使用注解实现、Servlet也修改为使用代码方式注册，而Listener原先只配置了spring提供的几个Listener（org.springframework.web.context.ContextLoaderListener，org.springframework.web.util.IntrospectorCleanupListener，org.springframework.web.util.WebAppRootListener），没有自定义可以不用再配置了。

Servlet：原先在web.xml中的配置如下

<servlet>
    <display-name>验证码</display-name>
    <servlet-name>catcha</servlet-name>
    <servlet-class>com.xxx.common.NewRandomServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>catcha</servlet-name>
    <url-pattern>/api/checkCode/get.html</url-pattern>
</servlet-mapping>

修改：

@Configuration
public class ServletConfig {

    @Bean
    public ServletRegistrationBean myServletRegistrationBean(){
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new NewRandomServlet(),"/api/checkCode/get.html");
        return servletRegistrationBean;
    }
}

Filter：比如下面这个refererFilter，在web.xml中配置如下

<filter>
    <filter-name>refererFilter</filter-name>
    <filter-class>com.xxx.common.HttpRefererFilter</filter-class>
    <init-param>
        <param-name>domains</param-name>
        <param-value>省略</param-value>
    </init-param>
</filter>

原来的com.xxx.common.HttpRefererFilter类：

修改：只需要加上@Component注解，init-param则可以直接通过@Value注解从配置文件中加载，@Order(3)则根据该Filter在web.xml中的配置顺序指定。

@Component
@Order(3)
public class HttpRefererFilter implements Filter {
   private String[] trustDomains;

   @Value("${httpRefererFilter.domainsConfig}")
   private String domainsConfig;

   @Override
   public void init(FilterConfig filterConfig) throws ServletException {
      trustDomains = StringUtils.split(domainsConfig,",");
   }
}

Interceptor与静态资源

拦截器和静态资源原先配置在SpringMVC的配置文件中，修改为使用注解+覆盖WebMvcConfigurer中方法实现。

原先的springmvc-servlet.xml文件中的配置

修改为：为拦截器添加注解

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

@Component
public class LogInterceptor implements HandlerInterceptor {
}

WebMVC配置，覆写WebMvcConfigurer中的addResourceHandlers方法进行静态资源配置，覆写addInterceptors方法注册拦截器：

关于敏感数据加密

项目中用到的用户名密码等敏感信息，比如数据库、Redis的用户名密码通常是使用加密存储在配置文件中的，但是在设置到数据库连接、缓存连接时需要解密。比如原先项目中使用c3p0数据连接池连接数据库，则使用了如下方法：

在application-database.xml文件中：

其它敏感信息也类似，这种方式在SpringBoot中不方便。

我们将其进行改造，使用一个第三方包：

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.4</version>
</dependency>

解密类：

注册解密类：

@Bean
public EncryptablePropertyResolver encryptablePropertyResolver() {
    return new MyEncryptPropertyResolver();
}

使用时只需要将密码加上在解密类中配置好的前缀到配置文件中即可。

spring:
  datasource:
    password: PASS-9EKJH8L1KA8L3iaA

关于Redis缓存

原先的配置：

可以看到主要配置有cacheTemplate、redisTemplate、jedisPoolConfig、sentinelConfiguration、jedisConnectionFactory等，其中jedisPoolConfig、sentinelConfiguration、jedisConnectionFactory是关于Redis连接信息和JedisPool相关的，直接放到yaml配置文件中：

cacheTemplate由之前的xml配置改为注解配置

@Component("cacheTemplate")
public class RedisCacheSupport implements CacheTemplate {

   @Autowired
   private RedisTemplate<String, Object> redisTemplate;
   @Autowired
   private StringRedisTemplate stringRedisTemplate;
   // ...
}

redisTemplate由之前的xml配置改为@ConfigurationBean注入

关于单元测试问题

// Controller层的测试由
@WebAppConfiguration
@ContextConfiguration({"classpath*:/applicationContexts/applicationContext*.xml","classpath:springmvc-servlet.xml"})
@ActiveProfiles("test")
// 改为
@ActiveProfiles("test")
@RunWith(SpringRunner.class)
@SpringBootTest

发现单元测试不报错也不执行，是因为maven-surefire-plugin 不支持以前的 Test 注解了，需要依赖 junit-jupiter-api:5.7.0，使用里面的测试注解。[1]

具体区别如下：

注释位于 org.junit.jupiter.api 包中。

断言位于 org.junit.jupiter.api.Assertions 类中。

假设位于 org.junit.jupiter.api.Assumptions 类中。

@Before 和 @After 不再存在；使用 @BeforeEach 和 @AfterEach 代替。

@BeforeClass 和 @AfterClass 不再存在；使用 @BeforeAll 并改为 @AfterAll。

@Ignore 不再存在；使用 @Disabled 或其他内置功能之一 执行条件代替

@Category 不再存在；改用 @Tag。

@RunWith 不再存在；被 @ExtendWith 取代。

@Rule 和 @ClassRule 不再存在；被 @ExtendWith 取代，并且 @RegisterExtension

配置监控暴露点

在SpringBoot中配置简单的监控暴露点[2]，如果只需要监控JVM、接口调用时间等基本信息只需要做如下配置即可。

添加jar包：

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

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

MicroMeter配置：

Spring Boot 默认提供了一个/actuator/promethues端点用于服务指标数据拉取，端点暴露的数据中可能包含应用敏感数据，通过以下配置可以限制端点数据暴露（exclude 优先级高于 include 优先级）。

PropertyDefault
management.endpoints.jmx.exposure.exclude
management.endpoints.jmx.exposure.include*
management.endpoints.web.exposure.exclude
management.endpoints.web.exposure.includehealth

启动服务，访问http://localhost:8800/actuator/prometheus可以看到服务指标数据

疑难解决

1.restful接口后缀为.html无法访问

由于历史原因，该项目中的restful接口有的不带后缀，有的后缀名是.html，与静态资源.html冲突，导致访问restful接口时会被识别去寻找html静态资源导致404。

在之前的SpringMVC中只需要在web.xml中指定DispatcherServlet的url-pattern为*.html匹配restful接口后缀名是.html的情况

<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*:/springmvc-servlet.xml</param-value>
   </init-param>
   <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
   <servlet-name>springmvc</servlet-name>
   <url-pattern>*.html</url-pattern>
</servlet-mapping>

springmvc-servlet.xml中配置了所有的mvc:resources资源匹配静态资源html、css、js等

<mvc:resources location="/script/" mapping="/script/**" />
<mvc:resources location="/style/" mapping="/style/**" />
<!--省略-->

修改为SpringBoot后：ServletRegistrationBean需要加上"*.html","/*"这两个UrlMapping，如果不加"/*"就会出现访问不到html资源。

2.文件上传与下载问题

项目中提供有Excel模板下载功能，还有文件导入功能，涉及文件上传下载，升级SpringBoot后无法使用。

关于模板文件下载，升级项目之前模板文件是放在项目webapp中的，项目打包为war包，代码中可以直接new File(path)读取然后直接获取输入流，现在SpringBoot的Jar包中使用这种方式无法读取。

// 原来的
File downLoadFile = new File(path);
InputStream fis = new FileInputStream(downLoadFile);
// 需要修改为读取Resource
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
Resource res = resolver.getResource(path);
InputStream fis = res.getInputStream();

在项目中一些读取配置文件预加载的地方也要进行修改

Resource res = new ClassPathResource("6000.txt");
// 改为
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
Resource res = resolver.getResource("6000.txt");

对于文件上传，SpringMVC中需要配置MultipartResolver处理器

<!-- SpringMVC上传文件时，需要配置MultipartResolver处理器 -->
<bean id="multipartResolver"
   class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
   <property name="defaultEncoding" value="UTF-8" />
   <!-- 指定所上传文件的总大小不能超过200*1000*1024KB。注意maxUploadSize属性的限制不是针对单个文件，而是所有文件的容量之和 -->
   <property name="maxUploadSize" value="204800000" />
   <property name="maxInMemorySize" value="40960" />
</bean>

升级SpringBoot后，需要在代码中使用配置类配置MultipartResolver处理器[3]

    /**
     * 文件上传Resolver
     * @return
     */
    @Bean(name="multipartResolver")
    public MultipartResolver multipartResolver(){
        CommonsMultipartResolver resolver = new CommonsMultipartResolver();
        resolver.setDefaultEncoding("UTF-8");
        resolver.setMaxUploadSize(204800000L);
        resolver.setMaxInMemorySize(40960);
        return resolver;
    }

3.Ehcache缓存不生效

原先的Ehcache配置被删除，ehcacheConfig.xml仍然保留

	<!-- ehcache -->
	<bean id="cacheManagerFactory" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">  
       <property name="configLocation">    
            <value>classpath:cache/ehcacheConfig.xml</value>    
       </property>   
    </bean>

在yaml配置文件中配置即可。

spring:
  cache:
    ehcache:
      config: classpath:pro/ehcacheConfig.xml
    type: ehcache

另外，之前的Ehcache工具类中的由net.sf.ehcache.CacheManager变为org.springframework.cache.CacheManager，一些API做相应的改变,例如：

CacheManager CACHEMANAGER = (CacheManager)SpringBeanUtil.getBean("cacheManagerFactory");
// 获取CacheManager由之前配置文件定义的cacheManagerFactory变为Spring自动注入的cacheManager
CacheManager CACHE_MANAGER = (CacheManager) SpringBeanUtil.getBean("cacheManager");


CACHEMANAGER.getCache(COMMON_CACHE).remove(key);
CACHEMANAGER.getCache(SESSION_CACHE).removeAll();
// remove方法修改为evict，removeAll方法修改为clear
CACHE_MANAGER.getCache(COMMON_CACHE).evict(key);
CACHE_MANAGER.getCache(SESSION_CACHE).clear();

4.Sonar单元测试覆盖率

Sonar单元测试覆盖率排除某些包[4]，在pom.xml的properties中添加sonar.coverage.exclusions

<properties>
    <sonar.coverage.exclusions>
       **/src/main/java/com/xxx/xxx/controller/**/*
    </sonar.coverage.exclusions>
</properties>

总结

总体思路是先添加启动类和相关Jar包，项目启动后再一步步修改错误。

参考

  1. Maven的单元测试没有执行的问题_liaowenxiong的博客-CSDN博客_mvn test 不执行 ↩︎

  2. 服务监控 | 万字长文详解Micrometer - 掘金 (juejin.cn) ↩︎

  3. Unable to process parts as no multi-part configuration has been provided解决办法_luffy5459的博客-CSDN博客 ↩︎

  4. Analysis Parameters - SonarQube-7.0 ↩︎

Copyright © 2024 ycyin