스프링 외부 설정 사용 방법 (Environment)

 

스프링 외부 설정 방법 (커맨드 라인 인수, 커맨드 라인 옵션 인수, 스프링 통합) (tistory.com)

스프링 외부 설정 방법 (커맨드 라인 인수, 커맨드 라인 옵션 인수, 스프링 통합)

스프링 외부 설정 방법 (외부 데이터) (tistory.com)

스프링 외부 설정 방법 (외부 데이터)

스프링에서 외부 설정 하는 방법으론 4가지 정도 있다. 

- OS 환경 변수

- 자바 시스템 속성 

- 커맨드 라인 인수 

- 설정 데이터 (application.properties) 

 

그리고 이 외부 설정을 읽는 방법으로 지금까지는 Environment 를 사용하는 방법에 대해서 알아봤는데 스프링은 Environment 말고도 2가지 방법을 더 제공한다. 

 

* 외부 설정 조회 방법 

- Environment 

- @Value 

- @ConfigurationProperties : 타입 안전한 설정 속성 

 

 

 

0️⃣ 외부 설정 조회 방법 : Environment 

외부 설정들은 스프링이 제공하는 Environment를 통해서 일관된 방식으로 값을 조회하고 사용할 수 있다. 

 

MyDataSource 

@Slf4j
public class MyDataSource
{
   private String url;
   private String username;
   private String password;
   private int maxConnection;
   private Duration timeout;
   private List<String> options;
   
   public MyDataSource(String url, String username, String password,
         int maxConnection, Duration timeout, List<String> options)
   {
      this.url = url;
      this.username = username;
      this.password = password;
      this.maxConnection = maxConnection;
      this.timeout = timeout;
      this.options = options;
   }
   
   @PostConstruct
   public void init()
   {
      // 설정된 값 출력
      log.info("url={}", url);
      log.info("username={}", username);
      log.info("password={}", password);
      log.info("maxConnection={}", maxConnection);
      log.info("timeout={}", timeout);
      log.info("options={}", options);
      
   }
}

예제는 필요한 속성들(url, username...) 들을 외부 설정값으로 채운 다음 스프링 빈으로 등록하고 사용하는 예제이다. 

(실제 DB에 접근하지는 않음, 단순 예제) 

 

@PostConstruct

: 설정된 값들을 확인하기 위해서 사용 

 

 

application.properties 

my.datasource.url=local.db.com
my.datasource.username=username
my.datasource.password=password
my.datasource.etc.max-connection=1
my.datasource.etc.timeout=3500ms
my.datasource.etc.options=CACHE,ADMIN

외부 속성은 application.properties에 설정해두고 사용한다. 

 

👾 그리고 application.properties에서는 낙타 표기법이 아닌 케밥 표기법을 주로 사용하고 properties에는 케밥 표기법을 권장한다.

케밥 표기법은 소문자 - (dash)를 사용하는 방법이다. 

 

 

MyDataSourceEnvConfig

@Slf4j
@Configuration
public class MyDataSourceEnvConfig
{
   private final Environment environment;
   
   public MyDataSourceEnvConfig(Environment environment)
   {
      this.environment = environment;
   }
   
   @Bean
   public MyDataSource myDataSource()
   {
      String url = environment.getProperty("my.datasource.url");
      String username = environment.getProperty("my.datasource.username");
      String password = environment.getProperty("my.datasource.password");
      int maxConnection = environment.getProperty("my.datasource.etc.max-connection", Integer.class);
      Duration timeout = environment.getProperty("my.datasource.etc.timeout", Duration.class);
      List options = environment.getProperty("my.datasource.etc.options", List.class);
      
      return new MyDataSource(url, username, password, maxConnection, timeout, options);
   }
}

MyDatasource를 만들고 이를 빈으로 등록하기 위한 설정 파일이다. 

Environment를 사용하면 외부 설정을 어떤 방식을 사용했던 일관된 코드를 통해서 외부 설정을 조회할 수 있다. 

Environment.getProperty(key, type) 를 호출할 때 타입 정보를 주면 해당 타입으로 변환해준다.  (스프링은 타입에 대해서 기본 변환 기능을 제공한다.) 

 

 

@Import(MyDataSourceEnvConfig.class)
@SpringBootApplication(scanBasePackages = "hello.datasource")
public class ExternalReadApplication {

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

}

MyDataSourceEnvConfig 설정 파일을 빈으로 등록해서 사용하기 위해서 @Import 로 추가를 해주고, 

@SpringBootApplication(scanBasePackages = "hello.datasource") 를 통해 컴포넌트 스캔 범위를 제한했다. 

(왜냐하면 뒤에 예제를 하면서 @Import 로 설정 정보를 계속 변경할 예정이기 때문에 설정 정보를 바꾸면서 사용하기 위해서 hello.config 는 컴포넌트 스캔을 하지 못하게 제한했다. ) 

 

 

💌 application.properties에 필요한 외부 설정 값들을 추가해주고, 그 다음 Environment 를 통해서 해당 값들을 조회해서 MyDataSource를 만들었다. 

근데 Environment를 통해서 외부 설정 값들을 조회할 때는 getProperty를 통해서 필요한 값들을 계속 꺼내는 과정을 반복해야 한다는 단점이 있다. 

 

 

 

 

1️⃣ 외부 설정 조회 방법 : @Value 

스프링이 제공하는 @Value 를 사용하면 Enviroment를 사용할 때 getProperty 이런 반복되는 과정이 없어도 외부 설정값을 편리하게 주입받을 수 있다. 

 

MyDataSourceValueConfig

@Slf4j
@Configuration
public class MyDataSourceValueConfig
{
   
   @Value("${my.datasource.url}")
   private String url;
   @Value("${my.datasource.username}")
   private String username;
   @Value("${my.datasource.password}")
   private String password;
   @Value("${my.datasource.etc.max-connection}")
   private int maxConnection;
   @Value("${my.datasource.etc.timeout}")
   private Duration timeout;
   @Value("${my.datasource.etc.options}")
   private List<String> options;
   
   @Bean
   public MyDataSource myDataSource1()
   {
       return new MyDataSource(url, username, password, maxConnection, timeout, options);
   }
   
   // @Value를 파라미터로 사용할 수도 있다.
   @Bean
   public MyDataSource myDataSource2(
         @Value("${my.datasource.url}") String url,
         @Value("${my.datasource.username}") String username,
         @Value("${my.datasource.password}") String password,
         @Value("${my.datasource.etc.max-connection}") int maxConnection,
         @Value("${my.datasource.etc.timeout}") Duration timeout,
         @Value("${my.datasource.etc.options}") List<String> options
         )
   {
      return new MyDataSource(url, username, password, maxConnection, timeout, options);
   }
}

@Value("${}") {} 안에 키 값을 넣어줌녀 원하는 값을 주입받을 수 있다. 

MyDataSource1과 MyDataSource2에서도 알 수 있듯이, @Value는 필드에 사용할 수도 있고, 파라미터에 사용할 수도 있다. 

 

* 기본값 

만약 @Value로 값을 가져올 때 값이 없다면 @Value("${my.datasource.max-connection:1}")  : 뒤에 기본 값을 적어주면 된다. 

 

 

💌 이번에는 application.properties에 외부 설정 값을 추가해두고, @Value 를 통해서 해당 값들을 읽어서 MyDataSource를 만들었다. 

@Value를 사용하는 방법 역시 편리하지만 보면 설정 데이터를 하나하나 @Value로 키 값을 입력하고 주입 받아야하는 부분은 역시나 번거롭다. 

 

 

 

2️⃣ 외부 설정 조회 방법 : @ConfigurationProperties 

Type-safe Configuration Properties 

: 스프링은 타입 안전한 설정 속성이라고 외부 설정의 묶음 정보를 객체로 변환하는 기능을 제공한다. 

왜 타입 안전한 설정 속성이라고 하느냐 하면 객체를 사용하면 타입을 사용할 수 있는데, 이러면 실수로 잘못된 타입이 들어오는 문제를 금방 감지하고 방지할 수 있기 때문이다. 

 

 

MyDataSourcePropertiesV1

@Data
@ConfigurationProperties("my.datasource")
public class MyDataSourcePropertiesV1
{
   private String url;
   private String username;
   private String password;
   private Etc etc;
   
   @Data
   public static class Etc {
      private int maxConnection;
      private Duration timeout;
      private List<String> options = new ArrayList<>();
   }
}

application.properties에 설정 데이터를 보면 하나하나 분리된 값들이 아니라 my.datasource로 묶여 있는 것을 확인할 수 있다. 

MyDataSourcePropertiesV1은 외부 설정 정보를 주입 받을 객체로 각 필드를 외부 설정 키 값에 맞추어 생성해둔다. 

 

@ConfigurationProperties 이 어노테이션이 있으면 외부 설정을 주입 받는 객체라는 뜻으로 객체로 묶을 시작점(?)인 my.datasource를 키 값으로 적어준다. 

 

 

MyDataSourceConfigV1

@Slf4j
@EnableConfigurationProperties(MyDataSourcePropertiesV1.class)
public class MyDataSourceConfigV1
{
   private final MyDataSourcePropertiesV1 propertiesV1;
   
   public MyDataSourceConfigV1(MyDataSourcePropertiesV1 propertiesV1)
   {
      this.propertiesV1 = propertiesV1;
   }
   
   @Bean
   public MyDataSource dataSource()
   {
      return new MyDataSource(propertiesV1.getUrl(),
                        propertiesV1.getUsername(),
                        propertiesV1.getPassword(),
                        propertiesV1.getEtc().getMaxConnection(),
                        propertiesV1.getEtc().getTimeout(),
                        propertiesV1.getEtc().getOptions());
   }
}

@EnableConfigurationProperties(MyDataSourcePropertiesV1.class)

: 이 어노테이션을 사용해서 스프링에게 MyDataSourcePropertiesV1을 ConfigurationProperties로 사용할 것이라고 알려줘야 한다. 

그러면 이 클래스는 스프링 빈으로 등록되고 필요한 곳에서 주입받아서 사용할 수 있다. 

 

 

💌 @ConfigurationProperties를 사용하면 타입 안전한 설정 속성을 사용할 수 있다. 

만약 max-connection에 숫자가 아닌 dkafj 뭐 이런 문자열이 들어갔다고 하면 실행할 때 오류가 발생해서 타입이 다르다고 알려준다. 

따라서 실수로 숫자를 넣어야하는 곳에 문자를 넣는 실수를 방지할 수 있다. 

 

이번 방법은 application.properties에 외부 설정 값을 넣어두고, @ConfigurationProperties를 사용해서 MyDataSourcePropertivesV1 에 외부 설정 값들을 설정해 MyDataSource를 만들었다. 

 

 

* 그리고 이때 application.properties는 케밥 표기법이고, MyDatasourcePropertiesV1에서는 낙타 표기법으로 maxConnection을 다루고 잇는데 스프링은 케밥 표기법을 낙타표기법으로 중간에서 자동으로 변환해주기 때문에 따로 신경쓸 필요는 없다. 

 

 

@ConfigurationPropertiesScan

@ConfigurationProperties를 하나하나 등록할 때는 @EnableConfigurationProperties를 사용하면 되지만 만약 특정 범위로 자동 등록하고 싶을 때는 메인 메서드에 @ConfigurationPropertiesScan 어노테이션을 사용해주면 된다. 

@ConfigurationPropertiesScan
@SpringBootApplication(scanBasePackages = "hello.datasource")
public class ExternalReadApplication {

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

}

 

 

MyDataSourcePropertiesV2

@Getter
@ConfigurationProperties("my.datasource")
public class MyDataSourcePropertiesV2
{
   private String url;
   private String username;
   private String password;
   private Etc etc;
   
   public MyDataSourcePropertiesV2(String url, String username, String password, Etc etc)
   {
      this.url = url;
      this.username = username;
      this.password = password;
      this.etc = etc;
   }
   
   @Getter
   public static class Etc {
      private int maxConnection;
      private Duration timeout;
      private List<String> options = new ArrayList<>();
      
      public Etc(int maxConnection, Duration timeout, @DefaultValue("DEFAULT") List<String> options)
      {
         this.maxConnection = maxConnection;
         this.timeout = timeout;
         this.options = options;
      }
   }
}

위의 MyDatasourcePropertiesV1은 Getter, Setter를 통해 값을 읽고 쓰고 하고 있는데 Setter 가 존재하기 때문에 외부 설정 값으로 가져왔는데도 불구하고 값을 변경할 수 있다. 

보통 외부 설정 값을 가져와서 사용한다는 것은 한번 조회해서 값을 입력하고 나면 더 이상 변경할 일이 없다는 건데 Setter가 존재하기 때문에 어느 포인트에서 값이 변경될지 모른다는 위험이 있다. 

 

 

따라서 Getter, Setter 방식이 아닌  MyDatasourcePropertiesV2 처럼 생성자를 통해 겍체를 만드는 것이 더 안전한 방법이다. 

(대신 객체를 조회할 수는 있어야 하기 때문에 @Getter만 남겨둔다. )

 

@DefaultValue

: 해당 값을 찾을 수 없는 경우에 기본 값을 사용하도록 지정해주는 어노테이션 

@DefaultValue("DEFAULT") List<String> options 로 해주면 options에 값이 없는 경우에는 DEFAULT 를 기본 값으로 사용한다. 

 

 

MyDataSourceConfigV2

@Slf4j
@EnableConfigurationProperties(MyDataSourcePropertiesV2.class)
public class MyDataSourceConfigV2
{
   private final MyDataSourcePropertiesV2 propertiesV2;
   
   public MyDataSourceConfigV2(MyDataSourcePropertiesV2 propertiesV2)
   {
      this.propertiesV2 = propertiesV2;
   }
   
   @Bean
   public MyDataSource dataSource()
   {
      return new MyDataSource(propertiesV2.getUrl(),
                        propertiesV2.getUsername(),
                        propertiesV2.getPassword(),
                        propertiesV2.getEtc().getMaxConnection(),
                        propertiesV2.getEtc().getTimeout(),
                        propertiesV2.getEtc().getOptions());
   }
}

MyDataSourceProperties를 빈으로 등록하고 외부 설정 값을 사용하기 위해서 @EnableConfigurationProperties 어노테이션을 사용한다. 

 

 

💌 MyDataSourcePropertiesV2에서보면 application.properties 에서 외부 설정 값을 추가해주고, 그 다음 @ConfigurationProperties 의 생성자 주입을 통해서 이 외부 설정 값을 읽어온다. Setter가 아닌 생성자를 통해서 외부 설정 값을 읽어오기 때문에 이제 중간에 변경될 일은 발생하지 않는다! 

 

 

 

3️⃣ @ConfigurationProperties 검증 

@ConfigurationProperties 타입 안전 설정 속성을 통해서 외부 설정을 그룹으로 묶어서 객체로 변환해주기 때문에 숫자가 들어가야하는 부분에 문자가 들어가고 이런 문제는 방지할 수 있지만, 숫자의 범위나 문자 길이에 대해서는 검증이 어렵다. 

(물론 코드로 직접 작성해서 검증할  수도 있지만 이렇게 하려면 하나하나 검증 코드를 넣어야 해서 번거롭고 코드도 지저분해진다. 

대신 자바 빈 검증기 (Java Bean Validation) 을 통해서 검증할 수 있다.) 

 

implementation 'org.springframework.boot:spring-boot-starter-validation'

우선 build.gradle에 추가해주고 reload 해준다. 

 

 

MyDataSourcePropertiesV3

@Getter
@ConfigurationProperties("my.datasource")
@Validated
public class MyDataSourcePropertiesV3
{
   @NotEmpty
   private String url;
   @NotEmpty
   private String username;
   @NotEmpty
   private String password;
   private Etc etc;
   
   public MyDataSourcePropertiesV3(String url, String username, String password, Etc etc)
   {
      this.url = url;
      this.username = username;
      this.password = password;
      this.etc = etc;
   }
   
   @Getter
   public static class Etc {
      @Min(1) @Max(999)
      private int maxConnection;
      @DurationMin(seconds = 1)
      @DurationMax(seconds = 60)
      private Duration timeout;
      private List<String> options = new ArrayList<>();
      
      public Etc(int maxConnection, Duration timeout, List<String> options)
      {
         this.maxConnection = maxConnection;
         this.timeout = timeout;
         this.options = options;
      }
   }
}

- url, username, password에는 @NotEmpty를 줘서 항상 값이 있도록 한다. 

- maxConnection 에는 @Min(1), @Max(999)로 값을 제한해서 최소 1, 최대 999로 값을 허용해 그 값을 넘거나 부족하면 에러가 나도록 한다. 

- timeout에는 @DurationMin(seconds =1), @DurationMax(seconds = 60) 을 줘서 최소 1초, 최대 60초로 제한한다. 

 

 

MyDataSourceConfigV3

@Slf4j
@EnableConfigurationProperties(MyDataSourcePropertiesV3.class)
public class MyDataSourceConfigV3
{
   private final MyDataSourcePropertiesV3 propertiesV3;
   
   public MyDataSourceConfigV3(MyDataSourcePropertiesV3 propertiesV3)
   {
      this.propertiesV3 = propertiesV3;
   }
   
   @Bean
   public MyDataSource dataSource()
   {
      return new MyDataSource(propertiesV3.getUrl(),
                        propertiesV3.getUsername(),
                        propertiesV3.getPassword(),
                        propertiesV3.getEtc().getMaxConnection(),
                        propertiesV3.getEtc().getTimeout(),
                        propertiesV3.getEtc().getOptions());
   }
}

이렇게 값 제한을 하고 나서 실행할 때 application.properties에 maxConnection을 만약 0으로 실수로 설정을 했다면 

이런식으로 에러가 발생한다. 

 

 

 

📚 ConfigurationProperties  정리 

@ConfigurationProperties 를 사용하면 외부 설정을 객체로 변환해서 편리하게 사용할 수 있고, 외부 설정을 타입 안전하게 사용하며 검증기를 사용할 수 있다.