@Value

코딩냥이·2024년 9월 10일

Springboot value 어노테이션

Annotation

목록 보기

12/34

@Value

@Value는 스프링 프레임워크에서 프로퍼티의 값을 필드, 메서드, 생성자 파라미터에 주입할 때 사용하는 어노테이션입니다.

기능

외부 프로퍼티 파일, 환경 변수, 시스템 프로퍼티 등의 값을 주입합니다.
SpEL(Spring Expression Language)을 사용하여 복잡한 표현식도 지원합니다.
기본값 설정이 가능합니다.

사용 방법

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DatabaseConfig {

    @Value("${database.url}")
    private String url;

    @Value("${database.username}")
    private String username;

    @Value("${database.password}")
    private String password;

    // getter, setter, 기타 메서드...
}

주요 특징

프로퍼티 주입: application.properties 또는 application.yml 파일의 값을 주입할 수 있습니다.
SpEL 지원: 복잡한 표현식을 사용할 수 있습니다.
기본값 설정: 프로퍼티가 없을 경우 사용할 기본값을 지정할 수 있습니다.
타입 변환: 문자열로 정의된 프로퍼티 값을 적절한 타입으로 자동 변환합니다.

다양한 사용 예제

1. 기본값 설정

@Value("${app.timeout:30}")
private int timeout;

여기서 app.timeout 프로퍼티가 정의되지 않았다면 기본값 30이 사용됩니다.

2. 시스템 프로퍼티 사용

@Value("#{systemProperties['user.home']}")
private String userHome;

3. 다른 빈의 프로퍼티 참조

@Value("#{serverConfig.url}")
private String url;

4. SpEL을 이용한 계산

@Value("#{2 * 4}")
private int calculatedValue;

5. 환경 변수 사용

@Value("${JAVA_HOME}")
private String javaHome;

@Value vs @ConfigurationProperties

@Value는 개별 프로퍼티를 주입할 때 유용하지만, 관련된 여러 프로퍼티를 하나의 클래스로 바인딩할 때는 @ConfigurationProperties가 더 적합할 수 있습니다.

// @Value 사용
@Component
public class AppConfig {
    @Value("${app.name}")
    private String appName;

    @Value("${app.description}")
    private String appDescription;
}

// @ConfigurationProperties 사용
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private String description;

    // getter, setter
}

프로파일별 값 설정

@Value와 프로파일을 함께 사용하여 환경별로 다른 값을 설정할 수 있습니다:

@Value("${message:Default Hello}")
private String message;

그리고 application-dev.properties와 application-prod.properties 파일에서 각각 다른 값을 설정할 수 있습니다.

컬렉션 타입 주입

@Value를 사용하여 컬렉션 타입의 값도 주입할 수 있습니다:

@Value("${server.ports}")
private List<Integer> serverPorts;

이 경우 application.properties에서 다음과 같이 정의할 수 있습니다:

server.ports=8080,8081,8082

테스트

@Value로 주입된 값을 테스트할 때는 @TestPropertySource를 사용할 수 있습니다:

@SpringBootTest
@TestPropertySource(properties = {
    "database.url=jdbc:h2:mem:testdb",
    "database.username=sa",
    "database.password="
})
class DatabaseConfigTest {

    @Autowired
    private DatabaseConfig databaseConfig;

    @Test
    void testDatabaseProperties() {
        assertEquals("jdbc:h2:mem:testdb", databaseConfig.getUrl());
        assertEquals("sa", databaseConfig.getUsername());
        assertEquals("", databaseConfig.getPassword());
    }
}

주의사항

순환 참조: @Value를 사용할 때 순환 참조가 발생하지 않도록 주의해야 합니다.
지연 초기화: @Value는 빈 생성 시점에 값을 주입하므로, 지연 초기화가 필요한 경우 다른 방법을 고려해야 합니다.
Null 안전성: 프로퍼티가 없을 경우 null이 주입될 수 있으므로, 필요하다면 기본값을 설정하거나 null 체크를 해야 합니다.

베스트 프랙티스

의미 있는 기본값: 가능한 경우 의미 있는 기본값을 제공하세요.
타입 안전성: 가능한 한 명시적인 타입 변환을 사용하세요.
중앙화된 설정: 관련 설정을 하나의 설정 클래스로 그룹화하는 것을 고려하세요.
문서화: 주입되는 프로퍼티의 의미와 예상 값 범위를 문서화하세요.
민감한 정보 처리: 비밀번호 등 민감한 정보는 환경 변수나 보안 저장소를 사용하세요.

결론

@Value 어노테이션은 스프링 애플리케이션에서 외부 설정 값을 쉽게 주입할 수 있게 해주는 강력한 도구입니다. 이를 통해 애플리케이션의 구성을 외부화하고, 다양한 환경에서 유연하게 동작하도록 만들 수 있습니다. 그러나 너무 많은 @Value 사용은 코드를 복잡하게 만들 수 있으므로, 적절한 상황에서 사용하는 것이 중요합니다.