PropertySource

• Spring 3.1 M1: Unified Property Management
• Spring 3.1 부터 생기기 시작한 통합 프라퍼티 관리 시스템
• 시스템 프라퍼티, 환경변수, JNDI 등을 모두 하나의 공간에 넣고 그 값을 읽고 설정할 수 있게 해준다.
• Custom PropertySource in Spring 3.1 : 프라퍼티 소스에 Redis의 데이터를 추가하는 예제
• ${... } placeholders support in @Value annotations in Spring

• 일반 프라퍼티 파일의 경우
  • Java 클래스 설정에서는 @PropertySource로 프라퍼티 파일을 지정하거나,
  • <context:property-placeholder> tag를 사용해 넣을 수 있다. - 이거 안 된다. 하단 참조.

• MyPropertySource가 PropertySource 구현체 일 때

ConfigurableApplicationContext ctx = new GenericApplicationContext();
MutablePropertySources sources = ctx.getEnvironment().getPropertySources();
sources.addFirst(new MyPropertySource());

• web.xml

  <context-param>
      <param-name>contextInitializerClasses</param-name>
      <param-value>com.bank.MyInitializer</param-value>
  </context-param>

• TestContext에서 web.xml없이 Java Code로 등록하기

  @ContextConfiguration(initializers = MyInitializer.class)

• MyInitializer.java

  public class MyInitializer implements ApplicationContextInitializer<ConfigurableWebApplicationContext> {
      public void initialize(ConfigurableWebApplicationContext ctx) {
          PropertySource ps = new MyPropertySource();
          ctx.getEnvironment().getPropertySources().addFirst(ps);
          // perform any other initialization of the context ...
      }
  }

• java - ApplicationContextInitializer in a non-web Spring Context?

  // Create context, but dont initialize with configuration by calling 
  // the empty constructor. Instead, initialize it with the Context Initializer.
  AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
  MyAppContextInitializer initializer = new MyAppContextInitializer();
   
  // ApplicationContextInitializer가 ApplicationContext를 초기화해주는 형태
  initializer.initialize( ctx );
   
  // @Configuration 클래스를 등록하고 초기화
  ctx.register( com.my.classpath.StackOverflowConfiguration.class );
  ctx.refresh()

3.2 최신 버전에서는 이 기법을 사용할 필요가 없다. ApplicationContextInitializer를 사용하자. 현재(3.1.2) @PropertySource를 통해서는 XML 프라퍼티를 등록할 수 없는 상태인데, @Configuration Java 클래스에서 직접 등록할 수 있다. ConfigurableApplicationContext를 주입 받은 것에 주의하라. ApplicationContext로 주입 받으면 안 된다. 프라퍼티 소스의 이름도 겹치면 안 된다.

@Configuration
public class SpringConfig {
 
  @Autowired
  private org.springframework.context.ConfigurableApplicationContext applicationContext;
 
  @Autowired
  private org.springframework.core.io.ResourceLoader resourceLoader;
 
  @PostConstruct
  public void addXmlProperties() throws Exception {
    addXmlProperties("classpath:my-properties.xml");
    addXmlProperties("classpath:my-properties2.xml");
  }
 
  private void addXmlProperties(String location) throws IOException,
      InvalidPropertiesFormatException {
    Resource resource = resourceLoader.getResource(location);
 
    Properties properties = new Properties();
    properties.loadFromXML(resource.getInputStream());
    applicationContext
        .getEnvironment()
        .getPropertySources()
        .addLast(
            new PropertiesPropertySource(
                getNameForResource(resource), properties));
  }
 
  // from ResourcePropertySource
  private static String getNameForResource(Resource resource) {
    String name = resource.getDescription();
    if (!StringUtils.hasText(name)) {
      name = resource.getClass().getSimpleName() + "@"
          + System.identityHashCode(resource);
    }
    return name;
  }
 
  @Bean
  public static PropertySourcesPlaceholderConfigurer placeholderConfigurer() {
    return new PropertySourcesPlaceholderConfigurer();
  }
}

PropertySource에 등록된 프라퍼티들을 @Value(“${property.name}”) 형태로 사용하려면 PropertySourcesPlaceholderConfigurer 등록이 필요하다.

• Java 코드 설정시

  @Configuration
  @PropertySource("my.properties")
  public class SpringConfig {
    @Bean
    public static PropertySourcesPlaceholderConfigurer placeholderConfigurer() {
      return new PropertySourcesPlaceholderConfigurer();
    }
  }

• XML로 설정시

    <context:property-placeholder location="classpath:my-properties.xml"/>
    <!--
        <context:property-placeholder/>는 Spring 3.1에서는 PropertySourcePlaceholderConfigurer 로 초기화된다.
        이 때 location에 지정된 프라퍼티도 place-holder로 적용하게 된다.
        현재(Spring 3.1.2)에는 XML Property를 못 추가하는 버그가 있는데 이를 통해 우회 가능하다.
        단, 이렇게 location에 들어간 프라퍼티는 공식 Environment의 PropertySource로 추가되지는 않는다.
        따라서 org.springframework.core.env.Environment.getProperty()로는 읽을 수 없다.
        가능하면 위에 설명한 @Configuration Java 클래스에서 프라퍼티 소스 등록하기 예제를 사용하는게 낫다.
        @ 확인 필요 : 이 경우 자식 ApplicationContext에서도 location에 지정된 프라퍼티는 place-holder로 사용할 수 없을 것이다. @
    -->

• @Autowired ResourceLoader resourceLoader 로 현재 애플리케이션 컨텍스트의 ResourceLoader를 획득하여 사용할 수 있다.
• 단, classpath:/package/to/**/*.xml 처럼 Pattern화된 Resource를 로딩할 때는 ResourcePatternResolver를 주입받아서 ResourcePatternResolver#getResources() 메소드로 패턴을 해석한 결과를 획득해야 한다.
• 그냥 속 편하게 ApplicationContext를 주입 받으면 이것 자체가 ResourcePatternResolver를 구현하므로 이를 사용하도 된다.

• spring - Inject date using @Value annotation - Stack Overflow

  @Value("#{new java.text.SimpleDateFormat(\"yyyyMMdd\").parse(\"${PROP_DATE}\")}")
  private Date date;

• Using Spring @Value with Defaults