학습 목표

• .properties 다루기

---

.properties

• Key-Value 형태로 변수를 정의하면 이것을 Application에서 참조해서 사용할 수 있다.
• 랜덤 값 주기
  • .properties에 변수 key-value 값을 정의할 때 랜덤 값을 주는 방법
    : ${random.dateType}
  • 값의 범위 지정도 가능하다.
    • ex. ${random.int(1,100)}
• Place Holder
  • 이미 정의 된 변수를 다른 새로운 변수를 정의 하면서 재사용 하는 기술

ex. Place Holder

linger0310.name = BoongYe
linger0310.fullName = ${linger0310.name} Ch

application.properties

• 가장 흔하게 springboot에서 접할 수 있는 외부 설정 파일.
• springboot가 Application을 실행할 때 자동으로 load 한다.
• application.properties 우선 순위
  1. 프로젝트 Root/config/
  2. 프로젝트 Root/
  3. classpath:/config/
  4. classpath:/

Ex. properties Key-Value 참조

변수 정의

application.properties에 'linger0310.name'이라는 변수를 정의한다.

변수 참조 방법 : @Value annotation

@Value annotation을 사용하면 .properties에서 정의했던 변수를 참조하여
사용할 수 있다.

SimpleProperties.java

@Component
public class SimpleProperties implements ApplicationRunner {
    @Value("${linger0310.name}")
    private String name;


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

Application.java

@SpringBootApplication
public class Application {

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

properties 우선순위

1. Devtools global settings properties on your home directory
   (~/.spring-boot-devtools.properties when devtools is active).
2. @TestPropertySource annotations on your tests.
3. @SpringBootTest properties annotation attribute on your tests.
4. Command line arguments.
5. Properties from SPRING_APPLICATION_JSON
   (inline JSON embedded in an environment variable or system property)
6. ServletConfig init parameters.
7. ServletContext init parameters.
8. JNDI attributes from java:comp/env.
9. Java System properties (System.getProperties()).
10. OS environment variables.
11. A RandomValuePropertySource that only has properties in random.*.
12. Profile-specific application properties outside of your packaged jar
    (application-{profile}.properties and YAML variants)
13. Profile-specific application properties packaged inside your jar
    (application-{profile}.properties and YAML variants)
14. Application properties outside of your packaged jar
    (application.properties and YAML variants).
15. Application properties packaged inside your jar
    (application.properties and YAML variants).
16. @PropertySource annotations on your @Configuration classes.
17. Default properties
    (specified using SpringApplication.setDefaultProperties).

프로젝트의 src/main/resources에 있는 application.properties는 15위에 속한다.

Ex. 우선순위를 이용한 properties 값 override

4순위인 Command line arguments로 15순위인 application.properties 값을 override 해보자.

방법1 : IDE Run/Debug Config

기존 application.properties

IDE Run/Debug Config

결과

방법2 : jar로 Application 실행

기존 application.properties

Command Line에서 배포한 jar 파일로 argument와 함께 Application 실행

application.properties Test

Test에서 properties에 대한 정보는 @AutoWird로 Environment 객체를 주입받아서
이를 통해서 얻을 수 있다.

아래와 같은 Test Code로 application.properties에서 정의한 변수의 값이
내가 원하는 값이 맞는지 Test할 수 있다.

import org.springframework.core.env.Environment;
import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;

@SpringBootTest
class ApplicationTests {
    @Autowired
    Environment environment;

    @Test
    void contextLoads() {
        assertThat(environment.getProperty("linger0310.name"))
                .isEqualTo("BoongYe");
    }
}

Test application.properties override

'src/test/resources/' 경로에 application.properties를 생성하면
Test Code 빌드 및 실행 시에 override가 일어나, 'src/main/resources'의
application.properties의 내용은 무시된다.

• Test Code Build 과정

  1. 'src/main/' 코드 빌드
  2. 'src/main/' 코드들이 class path 에 load 된다.
  3. 'src/test/' 코드 빌드
  4. 'src/test/' 코드들을 class path 에 load 된다.
     이 과정에서 application.properties 파일에 대해 override가 일어난다.

• 불편한 점 & 유의해야 할 점

  • application.properties에 대한 Test Code를 작성한다면,
    main 측에서 정의한 property 변수는 반드시 test 측에서도 정의 해줘야 한다.
    main에는 있고 test에는 없는 변수에 대한 test를 진행할 경우 오류가 발생할 수 있으니까.

• 개선 방법

  • @TestPropertySource 사용

ex. Test Code override

src/main/resources/application.properties

src/test/resources/application.properties

Test Code 실행 결과

@TestPropertySource

• .properties 파일 없이 test code에서 @TestPropertySource(properties = "key=value") 와
  같은 형식으로 property 변수의 key-value를 정의 및 변경 할 수 있다.
  • 입력할 변수가 여러 개라면 쉼표(,)로 구분한다.
• .properties 파일에서 property 변수를 정의하고,
  이 파일을 @TestPropertySource(locations = "classpath:/.properties 파일 이름")의 형식으로
  연결 시킬 수 있다.

ex. @TestPropertySource(properties = key=value)

src/main/resources/application.properties

테스트 코드에서 @TestPropertySource 어노테이션의
properties를 사용하여 property 변수(linger0310.name) 값 변경

@TestPropertySource(properties = "linger0310.name=Bloom")
@SpringBootTest
class ApplicationTests {
    @Autowired
    Environment environment;
    @Test
    void contextLoads() {
        assertThat(environment.getProperty("linger0310.name"))
                .isEqualTo("Bloom");
    }
}

테스트 코드 실행 결과

ex. @TestPropertySource(locations = "classpath:/~)

src/main/resources/application.properties

src/test/resources/test.properties

테스트 코드에서 @TestPropertySource 어노테이션의
locations를 사용하여 test.properties 파일을 연결해서
변수(linger0310.name, linger0310.fullName) 값들 변경

@TestPropertySource(locations = "classpath:/test.properties")
@SpringBootTest
class ApplicationTests {
    @Autowired
    Environment environment;
    @Test
    void contextLoads() {
        assertThat(environment.getProperty("linger0310.fullName"))
                .isEqualTo("Yerin Baek");
    }
}

테스트 코드 실행 결과