Spring6.1 부터 변경된 Parameter Name Retention

1. 배경 : 유연하게 분산락 키 값 설정하기

 각 좌석 선점 상황의 경합 상황을 해결하기 위해 Redisson library 를 활용해 분산락을 적용하는 방안을 선택했다. 기존의 setnx, setex 명령어 기반의 lecttuce library 는 setnx, setex 명령어 기반의 스핀락으로 동작하기 때문에 락 해체, 요청 과정에서 Redis 의 부하가 증가할 수 있다. 반면 Redisson 은 pub/sub 기반으로 동작하기 하여 구독만 하고 있다면 락을 해제했다는 신호만 받고 락 시도를 획득할 수 있어 상대적으로 Redis의 부하를 개선할 수 있기 때문이다.

 

분산락 로직을 스프링 기반으로 구현하기 위해 @DistributedLock 커스텀 어노테이션을 조인 포인트으로 설정해 분산락 에스펙트를 구현했다. 좌석의 키 값을 시계열 기반의 UUID version7 을 사용하고 있어 분산락의 키 값으로 활용하고, 메서드 아규먼트를 통해 전달받기 때문에 아규먼트 값을 파싱하는 방식으로 구현했다.

 

seatId argument 를 전달하는 방법

 

 

2.  문제  : 조인포인트 파라미터 값이 null 이 반환된다?

Spel(Spring Expression Language) 을 기반으로 동작하도록 구성했는데 joinPoint 에서 메서드 아규먼트를 주입하는 과정에서 계속해서 에러가 발생했다. joinpoint.getSigniture() 부분을 디버깅해보니 파라미터 이름이 전달되지 않고 null 을 반환했다. Spring 5 버전에서는 (Spring Boot 2.x) 발생하지 않았던 문제가 Spring6 버전에서 발생해 당황했지만 원인을 찾아보았다. 원인은 버전 업에 따른 파라미터 이름 관리 범위가 변경된 이유였다.

1. DistributedLock aspect : 조인포인트 아규먼트를 키 값으로 넘기기

 

2. CustomSpringELParser : 파라미터 이름에 값을 주입하기 위한 유틸 클래스

paratemer name 이 null 이 들어온다라... (사용 버전은 Spring 6.2)

 

 

3.  원인  : Spring 6.1 부터 Parameter Name Retention 변경됐다.

Spring 6.1 버전부터 더 이상 바이트코드를 파싱하여 매개변수 이름을 추론하려고 시도하지 않는다.

 

이전 버전의 Spring 은 LocalVariableTableParameterNameDiscover 이라는 구현체에서 컴파일된 .class 파일의 LocalVariableTable 라는 공간에서 메서드 파라미터 이름을 조회했다.

 

하지만, Spring 6.1 버전부터 StandardReflectionParameterNameDiscoverer 으로 JDK 의 Reflection 기능을 활용해 메서드 파라미터 이름을 조회하는 방식으로 변경되어 컴파일러의 `-parameter` 플래그에 의존한다.

 

https://github.com/spring-projects/spring-framework/wiki/Spring-Framework-6.1-Release-Notes#parameter-name-retention

 

4.  해결  : -parameters 컴파일 옵션 추가하기

(1) Gradle 환경에서 -parameters 컴파일 옵션을 추가하는 방법

Gradle 을 기반으로 스프링 프로젝트를 빌드하는 경우에는 자바 컴파일 시점에 -parameters 를 추가해 해결할 수 있다. 아래와 같이 컴파일 아규먼트를 추가하면 프로젝트 빌드 시에 `-parameters` 옵션을 추가하여 빌드하므로 파라미터가 주입되지 않는 문제를 해결할 수 있다.

tasks.withType<JavaCompile>(){
    options.compilerArgs.add("-parameters")
}

 

(2) Intellij 에서 설정하는 방법

위치 : Settings > Build, Execution, Deployment > Compiler > Java Compiler > Additional command line parameters

 

위와 같은 위치에 접속하여 `-parameters` 옵션을 설정하고 rebuild (cmd + shift + F9) 할 경우, 해당 컴파일러 옵션을 추가할 수 있다.

intellij > settings

 

해당 설정들 추가하고 확인

 

 

Reference

• 풀필먼트 입고 서비스팀에서 분산락을 사용하는 방법 - Spring Redisson
• Spring Framework 6.1 Release Notes - parameter name retention
• [쿠키의 개발 블로그] Spring 6.1에서 변경된 Parameter Name Retention