<aside> 1️⃣ 개념설명

</aside>

• API 키와 같은 민감한 정보를 코드 또는 설정 파일에 직접 작성하는 것은 보안 문제를 야기한다. 이러한 정보는 외부에 노출되면 공격자가 API를 오용하거나 악의적인 행동을 취할 수 있기 때문이다.
• 따라서, **Spring Boot**에서는 이러한 민감한 정보를 외부 설정으로 분리하고 이를 응용 프로그램에서 안전하게 읽어들일 수 있는 방법을 제공한다.
  1. 환경 변수 사용:
     • 먼저 고려해볼 수 있는 방법은 환경 변수를 사용하는 것이다. 이 방법은 서버의 환경 변수에 API 키를 저장하고 Spring Boot 애플리케이션에서 이를 읽어들인다. 예를 들어, 애플리케이션.properties 또는 애플리케이션.yml 파일에 **${API_KEY}**와 같이 환경 변수를 참조할 수 있다.
  2. Spring Cloud Config:
     • 이것은 중앙화된 서버에서 설정을 관리하고 불러오는 기능을 제공한다. 이를 사용하면 보안 정보가 노출되지 않고 필요한 설정을 응용 프로그램에 제공할 수 있다.
  3. Spring Boot의 Secret Management 기능:
     • 일부 클라우드 플랫폼은 Secret Management 서비스를 제공하며, **Spring Boot**는 이러한 서비스와 통합할 수 있다. 예를 들어, **Kubernetes**에서는 Secrets 또는 **Google Cloud**에서는 **Secret Manager**와 같은 기능을 사용할 수 있다.
  4. 외부 파일 또는 .env 파일 사용:
     • API 키 같은 정보를 포함하는 별도의 파일을 만들고 이를 .gitignore 파일에 추가하여 코드 저장소에는 추가되지 않게 할 수 있다. 그런 다음, Spring Boot 애플리케이션에서 이 파일을 읽어 들여 해당 정보를 사용할 수 있다.
• 최적의 방법은 환경과 요구사항에 따라 다르므로, 개발 환경과 배포 환경, 그리고 사용 가능한 도구를 고려하여 가장 적합한 방법을 선택하는 것이 중요하다.

<aside> 2️⃣ yaml 대신 클래스로 환경변수를 작성하는 방식이 좋은 방법인가?

</aside>

• API 키나 비밀번호 같은 민감한 정보를 소스 코드에 직접 적는 것은 매우 좋지 않다. 이것은 보안 위협을 초래할 수 있으며, 누군가가 해당 정보에 악용할 수 있게 만든다.
• Spring Boot는 @Value 어노테이션 또는 **@ConfigurationProperties**를 사용하여 외부 YML 또는 properties 파일에서 설정 값을 불러올 수 있다. 이 방법은 민감한 정보를 소스 코드 밖에 위치한 설정 파일에 저장하는데 도움이 된다.
• application.yml 파일에 설정을 저장하고, 이 값들을 자바 클래스에 주입하는 방법을 보자

# application.yml
thirdparty:
  api:
    key: ${API_KEY}

• 이제 이 값을 읽어오는 설정 클래스를 생성한다.

@Configuration
@ConfigurationProperties(prefix = "thirdparty.api")
public class ThirdPartyApiProperties {
    private String key;

    // getters and setters
}

• 이렇게 하면 API_KEY 환경 변수의 값을 ThirdPartyApiProperties 클래스의 key 필드에 주입할 수 있다.
• 환경 변수를 사용하면 민감한 정보를 소스 코드 밖에 두고, 동시에 보안을 유지하면서 값을 불러올 수 있다.
• 이 방법은 로컬 개발 환경에서는 .env 파일을 사용하고, 프로덕션 환경에서는 환경 변수 또는 시크릿 관리 서비스를 사용하여 환경별로 다른 설정을 적용할 수 있게 한다.
• 이것은 Spring Boot가 제공하는 타입 안전한 속성 바인딩의 장점을 활용하면서, 동시에 민감한 정보를 보호하는 좋은 방법이다.

<aside> 3️⃣ @ConfigurationProperties를 사용하는 장점은 무엇인가?

</aside>

• 환경에 따라 다르지만, **@ConfigurationProperties**를 사용해 클래스로 환경 설정을 불러오는 것은 여러 가지 이점이 있다.
  1. 타입 안전성:
     • 클래스에 직접 매핑하는 경우, 컴파일 타임에 타입 검사를 할 수 있다. 예를 들어, 설정 값이 정수여야 하는데 문자열을 설정한 경우 이를 컴파일 타임에 알 수 있다. 이는 잘못된 설정을 조기에 잡아낼 수 있게 한다.
  2. 자동 완성과 문서화:
     • IDE에서 @ConfigurationProperties 클래스를 사용하면, 자동 완성을 통해 사용 가능한 속성을 쉽게 찾을 수 있다. 또한, 스프링 부트 설정 메타데이터 생성기를 사용하면, 이 클래스에 있는 모든 속성에 대한 메타데이터를 JSON 형식으로 생성할 수 있다. 이 메타데이터는 문서화에 사용할 수 있다.
  3. 계층적인 속성 그룹화:
     • **@ConfigurationProperties**를 사용하면, 속성을 계층적으로 그룹화하여 관리할 수 있다. 이는 복잡한 애플리케이션에서 설정을 더 잘 구조화하고 관리하는 데 도움이 된다.
  4. 유효성 검사:
     • @ConfigurationProperties 클래스에서는 JSR-303의 @Validated 어노테이션을 사용하여 설정 값에 대한 유효성 검사를 할 수 있다.
  5. 복잡한 타입 지원:
     • **@ConfigurationProperties**는 리스트나 맵과 같은 복잡한 타입도 지원한다.
• 물론, @Value 어노테이션을 사용하여 필요한 값을 직접 주입하는 것이 더 간단할 수 있다. 하지만 위에서 언급한 이유로 인해, **@ConfigurationProperties**를 사용하는 것이 더 많은 이점을 제공한다.
• 필요한 설정이 많거나, 애플리케이션의 복잡도가 높아질수록 **@ConfigurationProperties**를 사용하는 것이 더 효율적일 수 있다.