[spring boot] 외부 설정

 

https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-external-config

외부 설정이란?

애플리케이션에서 사용하는 여러 설정 값들을 애플리케이션 안 또는 밖에다가 정의할 수 있는 기능

application.properties

가장 중요한 설정 파일은 application.properties 파일이다.

spring boot가 자동으로 로딩하는 파일 이름으로, 규약(convention)이다.

key value 형태로 정의한다. 다 문자열이다.

springboot intializr 시 자동으로 생성되는 파일로, 밑의 우선순위에서 15순위에 해당한다.

Spring Boot의 외부 설정 종류

• properties

• YAML

• 환경 변수

• 커맨드 라인 아규먼트

⚡ 프로퍼티 우선 순위

1. 유저 홈 디렉토리에 있는 spring-boot-dev-tools.properties

2. @TestPropertySource(locations="classpath:/test.properties") ㅡ> 내가 쓰고 정리한 코드 # , + 아래와 같이 properties 속성도 쓸 수 있다.

3. @SpringBootTest(properties="jueun.name=jueun3") ㅡ> 내가 쓰고 정리한 코드 #

4. 커맨드 라인 아규먼트 ㅡ> java -jar target/demo-0.0.1-SNAPSHOT.jar --jueun.name=hoit1302

5. SPRING_APPLICATION_JSON (환경 변수 또는 시스템 프로티) 에 들어있는 프로퍼티

6. ServletConfig 파라미터

7. ServletContext 파라미터

8. java:comp/env JNDI 애트리뷰트

9. System.getProperties() 자바 시스템 프로퍼티

10. OS 환경 변수

11. RandomValuePropertySource

12. JAR 밖에 있는 특정 프로파일용 application properties

13. JAR 안에 있는 특정 프로파일용 application properties ㅡ> application-{profile}.properties #

14. JAR 밖에 있는 application properties

15. JAR 안에 있는 application properties ㅡ> springboot intializr 시 자동으로 생성되는 파일

16. @PropertySource

17. 기본 프로퍼티 (SpringApplication.setDefaultProperties) ㅡ> 아무것도 안 썼을 때

 

test/resources/application.properties 있을 때

testApplication을 실행 시

빌드를 할 때 src 밑에 있는 것(src/main/java, src/main/resources)을 빌드를 해서 classpath에 놓고 그 다음에 test 코드를 빌드해서 classpath에 놓는다. 그 때 application.properties가 test 폴더 밑에 있는 것으로 오버라이딩된다.

이 코딩 방식은 큰 단점이 있다. #

test/resources/test.properties 있을 때 #

우선 순위 2순위인 @TestPropertySource(locations="classpath:/test.properties") 와 연결되는 이야기이다.

test/resources에 application.properties를 지우고 test.properties을 썼다.
빌드를 할 때 src 밑에 있는 것(src/main/java, src/main/resources)을 빌드를 해서 classpath에 놓고
그 다음에 test 코드를 빌드해서 classpath에 놓는다.
그 때 application.properties와 test 폴더 밑에 있는 test.properties는 파일 명이 다르기 때문에 둘 다 온전히 있다.
그런데 실행한 이 테스트에서 @TestPropertySource(locations = "classpath:/test.properties")로
추가로 test.properties을 사용하라고 한다.
2순위로 우선순위가 높기에 동일한 키값이 있을 때만, 오버라이딩한다.
그래서 main 밑 application.properties 에 있는 JUEUN이 아닌, test.properties에 있는 jueun22가 확인된다.

⚡ application.properties 우선 순위

1. file:./config/

2. file:./

3. classpath:/config/

4. classpath:/

프로퍼티의 값을 참조하는 @Value

@Component
public class SampleRunner implements ApplicationRunner {

    @Value("${jueun.name}")
    private String name;


    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("=====================");
        System.out.println(name);
        System.out.println("=====================");
    }
}

 

SpringEL 을 사용할 수 있지만 에 있는 밑에서 설명하는 Property Type Conversion, @Validated 기능들은 전부 사용 못한다.

* 보충

랜덤값 설정하기

• ${random.int}, ${random.double}

• ${random.int(0,100)} ㅡ> 공백이 있으면 에러난다.

• 주의, 포트번호는 0으로 설정하는 것이 랜덤값!

 

플레이스 홀더

• jueun.id=hoit1302

• jueun.email=${jueun.id}@ewhain.net

Command Line Properties false

• SpringApplication.setAddCommandLineProperties(false)

test 폴더에 resources 만들기

Project Structure > Module, Content Root에 text/resources 없다면 추가하기

 

 

@ConfigurationProperties

타입-세이프 프로퍼티

여러 프로퍼티를 묶어서 읽어올 수 있다.

빈으로 등록해서 다른 빈에 주입할 수 있다.

원래 ConfigurationProperties을 사용하려면 EnableConfigurationProperties(JueunProperties.class) 설정해주어야 하지만 이미 내부적으로 @EnableConfigurationProperties 등록이 되어 있다.
우리가 해야 할 일은 @Component 또는 @Bean을 붙여주는 일이다.

 

@Component 

@Component
@ConfigurationProperties("jueun") // jueun이라는 키 값으로 프로퍼티 사용. getter/setter 필요
public class JueunProperties {

    private String name;
    private int age;
    private String fullName;
    
    // getter/setter 생성
    
}

jueun.name=JUEUN
jueun.age=${random.int(0,100)}
jueun.fullName=${jueun.name} Park

@Component
public class SampleRunner implements ApplicationRunner {

    @Autowired
    JueunProperties jueunProperties;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("=====================");
        System.out.println(jueunProperties.getName());
        System.out.println(jueunProperties.getAge());
        System.out.println(jueunProperties.getFullName());
        System.out.println("=====================");
    }
}

@Bean

Third-party Configuration 시 사용한다.

흔하게 쓰이는 case는 아니다.

@SpringBootApplication
public class Application {

    // Third-party Configuration
    // 이 애플리케이션 안에 있는 것이 아니라 JAR 파일 안에 있거나 
    // 스프링이 제공하는 프로퍼티클래스는 @Component를 못 붙이니까 @Bean으로.
    @ConfigurationProperties("server")
    @Bean
    public ServerProperties serverProperties(){
        return new ServerProperties();
    }

    public static void main(String[] args) {
        SpringApplication app = new SpringApplication(Application.class);
        app.setWebApplicationType(WebApplicationType.NONE);
        app.run(args);
    }

}

 Relaxed Binding

• context-path
• context_path
• contextPath
• CONTEXTPATH

Property Type Conversion

@DurationUnit을 사용하는 방법

@DurationUnit(ChronoUnit.SECONDS)
private Duration sessionTimeout = Duration.ofSeconds(30);

jueun.sessionTimeout=25

@DurationUnit을 사용하지 않고 suffix로 해결하는 방법

private Duration sessionTimeout = Duration.ofSeconds(30);

jueun.sessionTimeout=25s

 

@Validated

 

<!-- dependency 추가 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

JSR-303 ( @NotNull, @NotEmpty, @Size(min=0, max=100) )

@Component
@ConfigurationProperties("jueun") // jueun이라는 키 값으로 프로퍼티 사용. getter/setter 필요
@Validated // Properties 에 들어오는 값들을 검증할 수 있다.
public class JueunProperties {

    @NotEmpty
    private String name;
    
}

비어있도록 설정해주면

jueun.name=

Failure Analyzer로 예쁘게 오류를 출력해준다.