[Spring] application.properties 와 @Value 어노테이션

application.properties

스프링 프레임워크에서 application.properties 파일은 애플리케이션 구성 설정을 정의하는 데 사용된다. 이 파일에는 애플리케이션 실행에 필요한 환경별 설정, 외부 서비스 연결 정보, 다양한 커스텀 설정 값 등이 포함될 수 있다.

주요 역할은 다음과 같다:

1. 데이터베이스 설정: 데이터베이스 연결 정보, 사용자 이름, 비밀번호 등 데이터베이스 관련 설정을 지정한다.
2. 서버 구성: 서버 포트, 콘텍스트 경로, 세션 타임아웃 등 서버 관련 설정을 정의한다.
3. 로깅 설정: 로그 수준, 로그 파일 경로와 같은 로깅 설정을 관리한다.
4. 애플리케이션 매개변수: 애플리케이션 내부에서 사용할 매개변수를 정의하여 코드에서 참조할 수 있게 한다.
5. 스프링 부트 자동 구성: 스프링 부트의 자동 구성에 영향을 미치는 속성을 조정한다.
6. 프로파일 관리: 개발, 테스트, 프로덕션 등의 다른 환경에 적합한 설정을 정의하고 적용한다.
7. 국제화 및 지역화 설정: 다양한 지역 설정과 메시지 소스를 통해 애플리케이션의 국제화를 지원한다.
8. 보안 설정: 스프링 시큐리티 설정 등 보안 관련 프레임워크의 설정을 포함한다.
9. 외부 서비스 연동: 메일 서버 설정, 소셜 로그인 정보, API 키 등 외부 서비스와의 연동에 필요한 정보를 포함한다.

 

스프링 부트를 사용하는 프로젝트에서는 이 파일을 통해 선언적으로 설정을 관리하며, src/main/resources 디렉토리 아래에 위치한다. application.properties 대신 YAML 형식의 application.yml 파일을 사용하는 것도 가능하다.

 

스프링 사이트에서 application.properties 파일 또는 application.yml 에 사용되는 Common Application Properties 들을 확인할 수 있다.

 

@Value

스프링 프레임워크에서 @Value 어노테이션은 프로퍼티 파일, 환경 변수, 어노테이션에 명시된 기본값 등에서 값을 주입받기 위해 사용된다. 이 어노테이션은 필드 레벨, 메소드 파라미터 레벨, 그리고 생성자 파라미터 레벨에 적용될 수 있다. 주입하고자 하는 값의 출처는 리터럴 값, 프로퍼티 파일, 시스템 프로퍼티, 환경 변수 등이 될 수 있다.

 

사용 예시는 다음과 같다:

@Component
public class SomeClass {

    @Value("${some.property.name}")
    private String propertyValue;

    @Value("${some.missing.property:default value}")
    private String propertyWithDefaultValue;

    @Value("#{systemProperties['some.system.property']}")
    private String systemPropertyValue;

    // 생성자에서의 사용 예시
    public SomeClass(@Value("${some.constructor.property}") String constructorValue) {
        // ...
    }
}

위의 예시에서는 다음과 같은 방법으로 @Value 어노테이션을 사용한다:

1. 프로퍼티 파일에서 값 주입: @Value("${some.property.name}")는 프로퍼티 파일에 정의된 some.property.name 키에 해당하는 값을 propertyValue 필드에 주입한다.
2. 기본값을 가진 프로퍼티: @Value("${some.missing.property:default value}")는 some.missing.property 키에 해당하는 값이 없을 경우 default value를 propertyWithDefaultValue 필드에 주입한다.
3. 시스템 프로퍼티에서 값 주입: @Value("#{systemProperties['some.system.property']}")는 시스템 프로퍼티에서 some.system.property 키에 해당하는 값을 systemPropertyValue 필드에 주입한다.
4. 생성자 파라미터로 값 주입: 생성자 파라미터에 @Value 어노테이션을 사용하여 프로퍼티 값을 주입할 수도 있다.

 

@Value 어노테이션을 사용할 때 주의해야 할 점은 주입하려는 값이 프로퍼티 파일에 없을 경우 에러가 발생할 수 있다는 것이다. 그러나 기본값을 제공함으로써 이러한 문제를 방지할 수 있다. 또한, 스프링 표현 언어 (SpEL)을 사용하여 보다 복잡한 값의 주입도 가능하다.

 

 

 

함께 보면 좋은 링크

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html

Common Application Properties

https://docs.spring.io/spring-framework/reference/core/beans/annotation-config/value-annotations.html

Using @Value :: Spring Framework