🔨 Spring Boot 에서 properties 값 주입받기

[jaeuk520]

Update

• @ConstructorBinding deprecated in Spring Boot 3.0

@Value

• 가장 간단하게 값을 주입하는 방식
• 사용 방법:
  • @Value 어노테이션에 값을 가리키고 있는 placeholder를 명시해주거나 SpEL 명시

    external:
    record-year: 2020
    api:
    name: kakao
    key: 123123

placeholder 방식

• ${app.name}와 같이 ${} 내부에 값의 위치를 적어서 @Value에 값을 주입하는 방식

  • String, Integer 등의 타입 값을 주입하여 사용할 수 있다.

    
    @Service
    public class ExternalService {
    @Value("${external.record-year}")
    private String recordYear;

  @Value("${external.api.name}") private String apiName;

  @Value("${external.api.key}") private Integer apiKey; }

SpEL 방식

• SpEL은 Spring Expression Language의 약자이다.

  • Spring에서 제공하는 특수한 표현 식으로 이러한 표현 식을 이용해 @Value에 값을 주입할 수 있다.
  • placeholder방식과는 다르게 다른 Spring Bean을 참조해서 값을 주입할 수 있다.

    
    @SpringBootTest
    public class SpELTest {

  @Value("#{1 eq 1}") private boolean spelBoolean;

  @Value("#{externalService.apiName eq 'kakao'}") private String spelNameString;

  @Test void spelTest() { assertThat(spelBoolean).isTrue(); assertThat(spelNameString).isEqualTo("true"); } }

문제점

• @Value 방식에는 안타깝게도 문제점이 있다.

  • 위 예제에서 true값이 String으로도 Boolean으로도 사용되는 것을 확인할 수 있다.

타입 안정성

external:
  value: true

• 개발자의 의도:
  • value를boolean값으로 사용

@SpringBootTest
public class ValueProblemTest {
    @Value("${external.value}")
    private String stringValue;

    @Value("${external.value}")
    private boolean booelanValue;

    @Test
    void problemTest() {
        assertThat(stringValue).isEqualTo("true");
        assertThat(booelanValue).isEqualTo(true);
    }
}
// Test Success!

• 문제점

  • value를 String으로도 boolean으로도 사용할 수 있다.

    • 개발자의 의도와 어긋남!

  • .yml에 설정해둔 값을 서로 다른 클래스에서 @Value를 이용해서 산발적으로 사용한다면?

    • 설정값을 boolean으로 가져다 쓴다면 다행
    • 모든 개발자가 String으로 불러다 쓰는 실수를 범하지 않을 것이라는 확신 X
    • 타입에 대한 안정성을 가지기 힘들다!

@ConfigurationProperties

• 타입 안정성을 가지는 방법
• 클래스를 정의해 놓고 값을 주입해서 사용한다!

external:
  record-year: 2020
  api:
    name: kakao
    key: 123123

Properties 클래스 정의

@Getter
@Setter
@Configuration
@ConfigurationProperties("external")
public class TypeSafeProperties {
    private String recordYear;
    private Api api;

    @Getter
    @Setter
    public static class Api {
        private String name;
        private Integer key;
    }
}

• @ConfigurationProperties의 value로 prefix를 적어줘야 한다.

  • 중첩 클래스(ex. Api)를 사용하게 되는 경우 이름을 똑같이 일치시켜줘야 하는 것을 주의해야 한다!

• Setter를 반드시 정의해주어야 한다.

  • Setter가 없다면 Caused by: java.lang.IllegalStateException: No setter found for property이 발생한다.

@Value도 똑같이 할 수 있지 않나?

• 가능하다. 하지만 불편하다!

  @Getter
  @RequiredArgsConstructor
  @Configuration
  public class ExternalProperties {
  @Value("${external.record-year}")
  private String recordYear;
  private final Api api;
  
  @Getter
  @Configuration
  public static class Api {
      @Value("${external.api.name}")
      private String apiName;
      @Value("${external.api.key}")
      private Integer apiKey;
  }
  }

• @Value에 계속해서 중복된 값(external.api)를 적어줘야 하는 불편함이 있고 중첩 클래스를 Bean으로 생성해서 의존성 주입을 해줘야 한다.

• @Value에서는 Snake case로 작성된 값들을 토씨 하나 틀리지 않고 적어줘야 했지만 @ConfigurationProperties를 사용하면 Camel case로 작성한 변수를 찾아 알아서 주입해준다.

문제점

불변성 (공통)

• 불변이 아니라는 문제점이 있다!

• final 한 필드로 인스턴스 변수를 생성할 수 없기 때문에 불변성을 유지할 수가 없다.

• 심지어 @ConfigurationProperties는 개발자 입장에서 불필요한 setter가 공개 되어 있어 중간에 값이 변경될 위험성이 크게 남아있다.

@ConstructorBinding

• 불변성 문제를 해결하고자 Spring Boot 2.3이후 생성자 주입방식으로 불변성을 가지고 Properties 파일을 만들 수 있는 방식이 추가되었다.

• final 필드에 대해 값을 주입해준다!

  • 중첩 클래스가 있다면 자동으로 중첩 클래스의 final 필드 또한 자동으로 값을 주입하는 대상이 된다.
  • final 키워드를 명시하지 않는다면 setter를 이용해서 값을 binding 하려하기 때문에 setter가 없다는 exception이 발생한다.

@Getter
@RequiredArgsConstructor
@ConstructorBinding
@ConfigurationProperties("external")
public final class ConstructorProperties {
    private final String recordYear;
    private final Api api;

    @Getter
    @RequiredArgsConstructor
    public static final class Api {
        private final String name;
        private final Integer key;
    }
}

• 위 방식을 사용하면 Properties 클래스에 직접적으로 @Configuration을 이용해서 직접적으로 Spring Bean으로 만들어주지 않는다.

• 대신 PropertiesConfiguration 클래스에 @EnableConfigurationProperties을 이용해서 생성할 Properties 클래스의 클래스 타입을 명시해주면 Spring Bean으로 등록된다.

@Configuration
@EnableConfigurationProperties(value = {ConstructorProperties.class})
public class PropertiesConfiguration {
}

• 이렇게 @ConstructorBinding을 이용하여 불필요한 setter를 사용하지 않게 되면서 불변성을 유지할 수 있게 되었다.

@EnableConfigurationProperties의 한계점

• @EnableConfigurationProperties를 이용해 설정 프로퍼티 클래스(@ConfigurationProperties)를 사용하는 경우

  • 해당 클래스들이 많아질 경우 코드가 상당히 무거워지는 한계가 있다!

• SpringBoot 2.2부터는 이러한 문제점들을 해결하기 위해 @ConfigurationPropertiesScan이라는 어노테이션을 제공하고 있다.

@ConfigurationPropertiesScan

• @ComponentScan과 상당히 유사하다.

• 패키지를 기반으로 @ConfigurationPropertiesScan이 등록된 클래스들을 찾아 값들을 주입하고 빈으로 등록해준다!

• 스캔을 실행할 패키지 또는 클래스를 지정해줄 수 있다.

• 필요한 경우 Base Package를 지정해준다.

@Configuration
@ConfigurationPropertiesScan("com.mang.atdd.membership")
public class SpringBootApplication {
}

• 위와 같이 설정을 해주면 com.mang.atdd.membership과 그 하위 패키지들에 대해 @ConfigurationProperties 이 붙은 클래스들에 값을 주입하고 빈으로 등록해준다.

• 등록해주어야 하는 클래스가 많다면 @EnableConfigurationProperties가 아닌 @ConfigurationPropertiesScan을 이용하는 것도 좋다!

정리

• @Value를 사용하여 값을 주입하는 방식과 @ConfigurationProperties를 이용하여 외부 설정 파일에 존재하는 값을 주입하는 방법이 있다.

• 가급적이면 불변성을 유지할 수 있는 @ConfigurationProperties와 @ConstructorBinding을 같이 사용하는 것이 좋아 보이지만 [[Spring Batch]]를 사용하면 Late Bidning을 위해 @Value를 사용해야 하는 경우도 발생한다.

• 상황에 따라 알맞게 적절한 어노테이션을 선택해서 사용하자!

Update

Improved @ConstructorBinding Detection

• @ConfigurationProperties, @ConstructorBinding을 같이 사용했었는데, Spring Boot 3.0부터 생성자가 1개만 있는 경우에는 ConstructorBinding을 생략할 수 있다!

[david-parkk]

springboot 3 에서 @ConsturctBinding 불변성을 위한 @ConstructingBinding 관련 이슈 @ConstructingBinding deprecated

• 요약하자면 @ConfigurationProperties 선언후 별도의 @ConstructorBinding 을 선언할 필요없이 생성자 주입이 가능하다는 내용입니다.

• 만약 @ConstructorBinding을 명시하고자 하는 경우 해당 생성자에 선언할 수 있습니다.

  @ConfigurationProperties(prefix = "spring.security.oauth2.client.registration.google")
  @Getter
  public class GoogleOAuthProperties {
  private final String clientId;
  private final String clientSecret;
  
  @ConstructorBinding
  public GoogleOAuthProperties(String clientId, String clientSecret) {
      this.clientId = clientId;
      this.clientSecret = clientSecret;
  }
  }

[david-parkk]

• 작업 중 하나 발견된것이 build를 Intellij IDEA로 하는 경우 properties 클래스를 생성하지 못하는 java.lang.IllegalStateException 가 발생하는데 build를 gradle로 바꿔주세요. 몇시간 삽질했네요

[david-parkk]

@ConfigurationProperties(prefix = "spring.security.oauth2.client.registration.google")
@Getter
@Setter
public class GoogleOAuthProperties {
    private String clientId;
    private String clientSecret;
}

intellij IDEA build에는 setter는 정상적으로 동작하는데 생성자 주입은 안되네요