Spring Boot 1.x -> 2.x Mirgration 진행하면서

버전 업그레이드 배경

프로젝트에서 U2L(Unix To Linux) 작업을 진행하며 최신 Linux에서 권장하고 또한 보안 취약점 검사 통과를 위해 JDK 버전으로 올려야 하는 일이 발생했다.

해당 과정에서, 하는김에 관련된 서브 시스템의 Spring Boot 버전도 같이 올리게 되었고, Migration 계획을 세우면서 공부했던 것들을 공유하고자 한다.

 

 

내가 원하는 버전은 2.7.18버전이었고, 단계별로 버전을 업그레이드 하면서 진행하려고 했으나 서브 시스템이기에 코드양도 많지 않고 수정할 부분이 많지 않을 것으로 판단하여 한 번에 올리게 되었다.
(이렇게 해서 문제가 발생하지는 않았지만, 여러분들은 큰 업데이트가 있었던 버전들을 차례대로 업그레이드 하는 것을 추천한다.)

 

마이그레이션 순서

1. 마이그레이션 support Dependency 추가 (끝나면 삭제)

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-properties-migrator</artifactId>
    <scope>runtime</scope>
</dependency>

 

 

2. Spring Boot 와 JDK 버전 변경

현재 사용하고 있는 WAS가 지원해주는 JDK 버전이 11이 최대여서 아래처럼 결정했다.

Spring Boot 2.7.18
JDK 11

 

 

3. Dependency 업그레이드 or 변경

아래 공식 문서에서 제공해주는 Spring Boot 2.7.18에서 관리하는 Dependency 버전을 확인하고 수정했다.

https://docs.spring.io/spring-boot/docs/2.7.x/reference/html/dependency-versions.html#appendix.dependency-versions

Dependency Versions

 

4. application.yml 수정

warning 표시에 따라서 최신 설정에 맞게 수정을 진행했으며, Spring Boot 2.x 부터는 Bean Overriding 옵션이 디폴트로 "false"로 설정되어 있기 때문에, Bean Overriding을 사용하려면 설정을 통해 "true"로 변경해야 한다.

이외에도, actuator•swagger•profile•driver-class-name 설정 등 여러 부분에서 수정이 발생했다.

spring:
	main:
    	allow-bean-definition-overriding: true

 

 

5. logback.xml 수정

SizeAndTimeBasedFNATP 정책이 Max file size를 필수로 입력하도록 변경되어서 추가로 설정하게 되었다.
이때, 적절한 사이즈를 선택하기 위해 현재 운영 로그가 어느 정도의 크기로 매일 생성되는지 확인하여 가장 큰 사이즈보다 조금 더 크게 설정하였다.

 

 

5. Import 변경 및 코드 변경

많은 부분에서 변경이 발생했지만,
주요한 것 중 하나는 Spring Boot 2.7 버전에서 DBCP 중 가장 우선순위가 높고 Performance가 높은 HikariCP로 변경하게 되었다는 것이고, 다른 하나는 Spring Security 버전이 올라가면서 SecurityFilterChain Bean 생성 메서드를 만드는 것으로 변경되었다는 점이다.

1. Datasource 변경 
tomcat Datasource -> Hikari Datasource 변경

2. WebSecurity 설정 변경 (Spring Security 버전 변경 때문)
     WebSecurityConfigurerAdapter Depreacted로 삭제하고 SecurityFilterChain Bean 생성 메서드 추가
     
3. FilterRegistrationBean import 경로 변경
    org.springframework.boot.context.embedded.FilterRegistrationBean
 -> org.springframework.boot.web.servlet.FilterRegistrationBean

4. EmbeddedServletContainerCustomizer 인터페이스 Depreacted
     WebServerFactoryCustomizer<ConfigurableWebServerFactory> 인터페이스로 변경
     
5. WebMvcConfigureAdapter 클래스 Deprecated
     WebMvcConfigurer 인터페이스로 변경
     
6. swagger import 변경
     현재 관리되고 있지 않은 spring-fox-swagger에서 springdoc-openapi-ui-swagger로 변경하면서 코드 변경

 

 

6.  통합 테스트 진행

미리 작성되어 있던 통합 테스트 코드를 실행해서 쿼리 결과가 잘 받아와지는 등을 체크했고, Security 설정이나 다른 코드가 잘 변경되었는지 JUnit을 이용해서 테스트를 실행한다.

 

 

7. 변경사항 정리 및 리뷰

가장 중요한 단계이다..
꼼꼼하게 확인했음에도 불구하고, 이 부분에서 다른 사람들의 리뷰를 통해 잘못된 부분이나 추가적으로 수정해야 하는 부분을 찾을 수 있었다.

 

 

https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.0-Migration-Gui

Spring Boot 2.0 Migration Guide