[TIL] 221103 - SpringBoot Part1 - 애플리케이션 속성 관리

SpringBoot Part1 (4) 

 

1. Enviroment profile

ApplicationContext는 EnvironmentCapable 인터페이스를 상속받으며 getEnvironment() 메소드를 제공한다.

profile에 따라 환경이 바뀌고 그에 따라 properties가 바뀐다.

 

properties

: 다양한 애플리케이션 속성을 property로 정의하고 설정한다. 다양한 방식으로 설정이 가능하다.

 

resources > application.properties

: springboot에서 default로 사용하는 property 파일

: key/value 형식으로 작성

version = v1.0.0
kdt.version = v1.0.0
kdt.support-vendors = a,b,c,d,e,f,g
kdt.minimum-order-amount = 1

 

properties 파일 읽어오기

• Configuration class에 PropertySource 추가

@Configuration
@ComponentScan
@PropertySource("application.properties")
public class AppConfiguration {

}

public static void main(String[] args) {

      var applicationContext = new AnnotationConfigApplicationContext(AppConfiguration.class);

      var environment = applicationContext.getEnvironment();
      var version = environment.getProperty("kdt.version");
      var minimunOrderAmount = environment.getProperty("kdt.minimum-order-amount", Integer.class);
      var supportVendeor = environment.getProperty("kdt.supportVendors", List.class);
}

 

• Value 어노테이션으로 사용하여 환경변수 사용

@Component
public class OrderProperties implements InitializingBean {

    @Value("v.1.1.1") // 생성자를 만들지 않고 값을 주입
    private String version;

    @Value("${kdt.minimum-order-amount:8}") //properties 값 주입 : default값
    private String minimumOrderAmount;

    private List<String> supportVendors;

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println(MessageFormat.format("version -> {0}", version));
        System.out.println(MessageFormat.format("minimumOrderAmount -> {0}", minimumOrderAmount));
        System.out.println(MessageFormat.format("supportVendors -> {0}", supportVendors));
    }
}

시스템 환경 변수도 사용이 가능하며 동일한 이름일 경우 우선순위가 높다.

 

 

• 환경변수를 정의하는 class 만들기

필요한 시스템 속성들을 제공해주는 목적의 class를 만들어 property를 정의한다.

@Component
@PropertySource("version.properties")
public class VersionProvider {
    private final String version;

    public VersionProvider(@Value("${version:v0.0.0}") String version) {
        this.version = version;
        System.out.println(version);
    }
}

 

 

2. YAML로 프로퍼티작성

YAML

: 또 다른 마크업 언어. 데이터 중심

: 오늘날 XML, JSON이 데이터 직렬화에 주로 쓰이기 시작하면서, 많은 사람들이 YAML을 ‘가벼운 마크업 언어’로 사용하려 한다.

YAML 문법

kdt:
  version: "v1.0"
  minimum-order-amount: 1
  support-vendors:
    - a
    - b
    - c
    - d
  description: |
    line 1 hello world
    line 2 xxx
    line 3

 

Spring 프레임워크는 PropertySource 에서 YAML을 지원하지않아 PropertySourceFactory를 구현해야한다.

public class YamlPropertiesFactory implements PropertySourceFactory {
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
        var yamlPropertiesFactoryBean = new YamlPropertiesFactoryBean();
        yamlPropertiesFactoryBean.setResources(resource.getResource());

        var properties = yamlPropertiesFactoryBean.getObject();
        return new PropertiesPropertySource(resource.getResource().getFilename(), properties);

    }
}

 

yaml에서 List를 바인딩하기 위해 SpringBoot에서 제공해주는 ConfigurationProperties를 사용해야한다.

@Configuration
@ComponentScan
@PropertySource(value = "application.yaml", factory = YamlPropertiesFactory.class)
@EnableConfigurationProperties // SpringBoot에 ConfigurationProperties를 쓰겠다.
public class AppConfiguration {

}

@Configuration
@ConfigurationProperties(prefix = "kdt") // SpringBoot 어노테이
public class OrderProperties implements InitializingBean {

    private String version;

    private int minimumOrderAmount;

    private List<String> supportVendors;
    private String description;

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println(MessageFormat.format("version -> {0}", version));
        System.out.println(MessageFormat.format("minimumOrderAmount -> {0}", minimumOrderAmount));
        System.out.println(MessageFormat.format("supportVendors -> {0}", supportVendors));
        System.out.println(MessageFormat.format("description -> {0}", description));
    }

		// 값을 주입하기 위해서 setter 필요
    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public int getMinimumOrderAmount() {
        return minimumOrderAmount;
    }

    public void setMinimumOrderAmount(int minimumOrderAmount) {
        this.minimumOrderAmount = minimumOrderAmount;
    }

    public List<String> getSupportVendors() {
        return supportVendors;
    }

    public void setSupportVendors(List<String> supportVendors) {
        this.supportVendors = supportVendors;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

public static void main(String[] args) {

      var applicationContext = new AnnotationConfigApplicationContext(AppConfiguration.class);

      var orderProperties = applicationContext.getBean(OrderProperties.class);
      System.out.println("test -- "+orderProperties.getVersion());
}

어렵다.

 

3. profile

: 특정한 속성으로 그룹화

: 설정이나 Bean들을 그룹화해서 하나의 profile로 정의하고 여러개의 profile 중 원하는 profile로 애플리케이션을 구동할 수 있다.

 

 

Profile 어노테이션을 이용해 이름을 설정

@Repository
@Profile("dev")
public class JdbcVoucherRepository implements VoucherRepository{
    @Override
    public Optional<Voucher> findById(UUID voucherId) {
        return Optional.empty();
    }

    @Override
    public Voucher insert(Voucher voucher) {
        return null;
    }
}

public static void main(String[] args) {

      var applicationContext = new AnnotationConfigApplicationContext();
      applicationContext.register(AppConfiguration.class);
      var environment = applicationContext.getEnvironment();
      environment.setActiveProfiles("local"); //profile 선택
      applicationContext.refresh(); //profile이 재대로 적용될 수 있게 refresh
}

 

 

YAML 파일에도 profile 정의 가능 - springboot 기능

---
spring.config.activate.on-profile : local
kdt:
  version: "v1.0"
  minimum-order-amount: 1
  support-vendors:
    - a
    - b
    - c
    - d
  description: |
    line 1 hello world
    line 2 xxx
    line 3
---
spring.config.activate.on-profile : dev
kdt:
  version: "v1.0-dev"
  minimum-order-amount: 1
  support-vendors:
    - a
    - b
    - c
    - d
  description: |
    line 1 hello world
    line 2 dev
    line 3 dev
---

: 하나의 파일에서 여러 profile을 구성할 수도 있고 여러개의 파일을 만들어서 적용 할 수도 있다.

 

@SpringBootApplicateion : 실행 런처가 다르다.

@SpringBootApplication
public class KdtApplication {

    public static void main(String[] args) {

        var springApplication = new SpringApplication(KdtApplication.class);
        springApplication.setAdditionalProfiles("local");
        var applicationContext = springApplication.run(args);

        //var applicationContext = SpringApplication.run(KdtApplication.class, args);
    }

}

: run/debug 구성 파일에서 Activate profiles 혹은 arguments로 profile을 적용할 수 있다.

 

 

4. Resource

Spring은 외부 리소스(이미지, 테스트, key 파일 등)를 하나의 API로 읽어올 수 있도록 인터페이스를 제공한다.

→ Resource / ResourceLoader 인터페이스

: ResourceLoader를 통해 Resource를 가져올 수 있다.

: 모든 ApplicationContext가 ResourceLoader를 구현하고 있다. (Resource 객체를 가져올 수 있다. )

 

public static void main(String[] args) throws Exception{

      var applicationContext = new AnnotationConfigApplicationContext(AppConfiguration.class);

      var resource = applicationContext.getResource("application.yaml"); //working directory 기준, classpath 가 기본값
      var resource2 = applicationContext.getResource("file:test/sample.txt"); //
      var resource3 = applicationContext.getResource("<https://stackoverflow.com/>");

      System.out.println(resource.getClass().getCanonicalName());

      var file = resource2.getFile();
      var strings = Files.readAllLines(file.toPath());
      System.out.println(strings.stream().reduce("",(a,b)->a+"\\n"+b));

      var readableByChannel = Channels.newChannel(resource3.getURL().openStream());
      var bufferedReader = new BufferedReader(Channels.newReader(readableByChannel, StandardCharsets.UTF_8));
      var contents = bufferedReader.lines().collect(Collectors.joining("\\n"));
      System.out.println(contents);
}

 

 

---

Daliy Mssion

• 고객 블랙 리스트 명단 작성
  • customer_blacklist.csv 파일을 만들고 조회할 수 있다. → parsing
• YAML 프라퍼티를 만들고 어떤 설정을 만들수 있을지 고민해보기
• 바이처를 메모리에서 관리하는 레포는 개발 프로파일에서만 동작하게 해보기