[ISSUE] boolean에서 is가 생략되는 문제

🚨 문제 상황

로그인 기능을 구현하다가 만난 이슈입니다.

 

기존 소셜 로그인 응답값은 아래와 같았습니다.

소셜 로그인 후, 회원가입 시 추가 정보를 받기 위해 새로운 유저인지 여부를 `isNewMember` 필드를 통해 표시해주고 있었어요.

@Getter
@AllArgsConstructor
@NoArgsConstructor
public static class SignInResponse {

  private boolean isNewMember;
  private TokenInfo tokenInfo;
}

 

그런데 웹 창으로 로그인을 완료한 후, 나온 응답값을 보면 2가지 문제점을 발견할 수 있었습니다.

{
  "tokenInfo": {
    ...
  },
  "newMember": false,
}

 

(1) `isNewMember`가 `newMember`로 변경된 것

(2) 항상 `newMember`의 값이 `false`로 나오는 것.

 

두 번째 문제는 로직 구현에서의 오류일 수 있으니, 이를 확인하기 위해 로그를 찍어봤습니다.

@Transactional
public SignInResponse signIn(SignInRequest request) {
  ...
  
  log.info("isNewMember = {}", isNewMember);

  return new SignInResponse(isNewMember, tokenInfo);
}

놀랍게도 로그 결과는 `true`로 잘 나왔어요.

그럼 도대체 어디가 문제일까요?

---

✅ 원인 분석

원인은 바로 @Getter 때문이었습니다. 정확하게 말하면, 이 문제는 Lombok과 Jackson의 합작이었습니다.

Lombok은 JavaBeans 표준을 따르기 때문에, JavaBeans의 규칙에 따라 primitive 타입인 boolean 변수에 대해 getter 메서드의 이름이 `is`로 시작한다고 합니다.

그렇다면 변수명이 `is`로 시작하는 경우는 어떨까요?

공식 문서: https://projectlombok.org/features/GetterSetter

 

공식문서에 따르면 boolean 필드가 `is`로 시작하고 그 뒤에 대문자가 바로 오는 경우, 추가적인 접두사 없이 그대로 getter 메서드 이름이 생성됩니다.

즉, `isNewMember` 변수에 대해 getter 메서드가 `getIsNewMember()`가 아닌, `isNewMember()`로 생성되는 것입니다.

"그렇다면 여기서 변수명이 왜 `newMember`로 인식되는 것일까요?"
이 이유는 Spring의 Jackson 라이브러리에 있습니다.

Jackson은 JSON 데이터 구조를 처리해 주는 라이브러리인데, 얘가 JSON 직렬화와 역직렬화 과정에서 클래스의 필드 자체가 아닌 그 필드를 나타내는 getter와 setter 메서드를 사용해 데이터를 처리합니다.

 

따라서 getter 메서드인 `isNewMember()`를 따라 필드를 인식하다 보니 `newMember`라는 필드로 인식된 것입니다.

 

🏷 흐름 정리

1. Lombok의 @Getter 어노테이션은 `isNewMember` 필드에 대해 `isNewMember()`라는 getter 메서드를 생성
2. Jackson은 이 getter 메서드를 바탕으로 `newMember`라는 필드를 인식
3. 하지만 newMember라는 필드의 값을 찾을 수 없었기에 디폴트 값인 `false`로 처리

---

✅ 해결 과정

먼저 getter를 직접 정의해 보았습니다. 

  @AllArgsConstructor
  @NoArgsConstructor
  public static class SignInResponse {

    private boolean isNewMember;
    private TokenInfo tokenInfo;

    public boolean getIsNewMember() {
      return isNewMember;
    }

    public TokenInfo getTokenInfo() {
      return tokenInfo;
    }

결과가 잘 나오는 것을 확인할 수 있었습니다!

---

Getter 어노테이션을 사용하면서 해결할 순 없을까요?
그래서 primitive 타입인 `boolean`을 wrapper 타입인 `Boolean`으로 변경해 보았습니다.

  @Getter
  @AllArgsConstructor
  @NoArgsConstructor
  public static class SignInResponse {
    private Boolean isNewMember;
    private TokenInfo tokenInfo;
  }

이 방식도 결과가 잘 나오는 것을 확인할 수 있었습니다!

그 이유는 공식문서에 가면 확인할 수 있습니다.

출처: https://projectlombok.org/features/GetterSetter

 

boolean 타입은 is 접두사가 붙지만, Boolean과 같은 객체 타입은 is 대신 get 접두사를 사용한다는 것입니다.

하지만 Boolean 필드값이 null일 수 있다는 문제점이 있습니다.

---

다음으로 단순하게 필드명을 `is` 접두사가 없게 변경했습니다.

  @Getter
  @AllArgsConstructor
  @NoArgsConstructor
  public static class SignInResponse {

    private boolean newMember;
    private TokenInfo tokenInfo;
  }

잘 해결된 것을 확인할 수 있었습니다.

---

마지막으로 공식문서를 보면, 이런 설정을 보실 수 있습니다.

 

출처: https://projectlombok.org/features/GetterSetter

 

lombok.getter.noIsPrefix 값을 true로 설정하면 boolean 변수에 대해 getter를 생성할 때, `get`으로 시작하도록 함수 이름을 짓는다는 것입니다.

이것도 하나의 해결방법이 될 수 있겠네요.

---

✅ 해결 방안 정리

정리하자면, 해결방안은 다음과 같습니다.

(1) Getter 직접 정의하기

(2) boolean 대신 Boolean 쓰기

(3) 변수명 is 접두사 없애기

(4) lombok.getter.noIsPrefix = true로 설정하기

 

저는 최종적으로 is 접두사를 없애는 방식을 택했습니다.