현구막

현구막

간만에 spring application properties 덕분에 고생 좀 했다. 정말 뼈저리게 고생했으니, 앞으로 까먹을 일은 없겠다.

요약

aws:  
  s3:  
    bucket:  
      name: test  
      cloudFrontBaseUrl: "https://cloudfront.url"
    mock:  
      enabled: false  
      port: 8111

위와 같이 작성되어 있는 application property 는 사실 아래와 의미가 동일하다.

aws:  
  s3:  
    bucket:  
      name: test  
      cloudFrontBaseUrl: "https://cloudfront.url"  
aws:
  s3:
    mock:  
      enabled: false  
      port: 8111

이 사실을 인지하지 못하고 있다가, 예상치 못한 오류를 만나 반나절을 고생했다.


문제 상황

아래는 spring + kotlin 환경에서 aws s3 client 를 주입받는 설정이 담긴 코드다.

@Configuration  
@EnableConfigurationProperties(AwsS3Properties::class)  
@ComponentScan(basePackages = ["com.package.path"])  
class AwsS3Config(  
  private val awsS3Properties: AwsS3Properties,  
) {  

  @ConditionalOnProperty(  
    prefix = "aws.s3.mock",  
    name = ["enabled"],  
    havingValue = "false",  
    matchIfMissing = true  
  )  
  @Bean  
  fun s3Client(): AmazonS3 =  
    AmazonS3ClientBuilder  
      .standard()  
      .withRegion(Regions.AP_NORTHEAST_2)  
      .build()  


  @Profile(value = ["local"])  
  @ConditionalOnProperty(  
    prefix = "aws.s3.mock",  
    name = ["enabled"],  
    havingValue = "true",  
    matchIfMissing = false  
  )  
  @Bean  
  fun mockS3Client(): AmazonS3 {  
    return AmazonS3ClientBuilder.standard()  
      .withPathStyleAccessEnabled(true)  
      .withEndpointConfiguration(  
        AwsClientBuilder.EndpointConfiguration(  
          "http://localhost:${awsS3Properties.mockS3.port}",  
          Regions.AP_NORTHEAST_2.getName()  
        )  
      )  
      .withCredentials(AWSStaticCredentialsProvider(AnonymousAWSCredentials()))  
      .build()  
  }  
}

s3Client bean 의 @ConditionalOnProperty 설정을 풀어 설명하면 아래와 같다.

  • prefix: aws.s3.mock prefix 인 property 의
  • name: enabled 이름의 설정이
  • havingValue: false 인 경우에 s3Client bean 을 생성 후 주입한다.
  • matchIfMissing: 만약 해당되는 property 가 없어도 비교를 진행한다.
    • (yml property 에서 해당되는 property 들이 없으면 모두 기본 false 로 판단)

mockS3Client bean 의 @ConditionalOnProperty 설정은 아래와 같다.

  • prefix: aws.s3.mock prefix 인 property 의
  • name: enabled 이름의 설정이
  • havingValue: true 인 경우에 mockS3Client bean 을 생성 후 주입한다.
  • matchIfMissing: 만약 해당되는 property 가 없으면 bean 생성을 포기한다.

또한 mockS3Client bean 에는 @Profile(value = ["local"]) 설정이 포함되어 있으므로, local profile 로 실행될 때만 mockS3Client bean 주입을 시도한다.

결국 위 코드대로라면 local profile 에서는 mockS3Client bean 을, 그 외 profile 에서는 실제 s3Client bean 을 주입받게 된다.

기존 정상적으로 동작하는 상황에서 AwsS3Properties 를 통해 불러오는 property 값은 아래와 같았다.

aws:  
  s3:  
    bucket:  
      name: test  
      cloudFrontBaseUrl: "https://default.cloudfront.url"  

---  

spring.config.activate.on-profile: local  
aws:  
  s3:    
    bucket:  
      name: inara-web-management-local  
      cloudFrontBaseUrl: "https://local.cloudfront.url"  
    mock:  
      enabled: true  
      port: 8111
---  

spring.config.activate.on-profile: dev  
aws:  
  s3:  
    bucket:  
      name: inara-web-management-dev  
      cloudFrontBaseUrl: "https://dev.cloudfront.url"

그런데 어느 순간부터 dev profile 의 spring application 이 실행에 실패하고 있었다.

expected at least 1 bean which qualifies as autowire candidate for this dependency. Dependency annotations: {}

dev profile 설정에 의해 s3Client bean 이 정상적으로 로드되었어야했는데, s3Client bean 을 찾을 수 없다는 설정. 심지어는 mockS3Client bean 도 만들지 못하고 있었다. 왜 이런 문제가 갑자기 발생했을까?


원인

한참을 헤매다 application.yml 파일의 커밋로그를 살펴보니, 아래와 같이 변경사항이 추가되어 있었다.

aws:  
  s3:  
    bucket:  
      name: test  
      cloudFrontBaseUrl: "https://default.cloudfront.url"
	mock:            # 추가된 부분
	  enabled: true  # 추가된 부분
	  port: 8111     # 추가된 부분

---  

spring.config.activate.on-profile: local  
aws:  
  s3:    
    bucket:  
      name: inara-web-management-local  
      cloudFrontBaseUrl: "https://local.cloudfront.url"  
    mock:  
      enabled: true  
      port: 8111
---  

spring.config.activate.on-profile: dev  
aws:  
  s3:  
    bucket:  
      name: inara-web-management-dev  
      cloudFrontBaseUrl: "https://dev.cloudfront.url"

오류가 발생하기 전까지만 해도, dev profile 의 spring application 은 application.yml 의 spring.config.activate.on-profile: dev 하위 영역만 spring application 이 읽고 해석을 진행할거라 생각중이었다.

그런데 application.yml 파일은 그 특성상, default 설정 외 profile 별로 직접 property 를 덮어씌우지(override) 않으면 default 설정을 그대로 따른다.

즉, dev profile 에서 인지한 aws.s3 설정은, default 값을 포함해서 아래와 같이 적용된다.

spring.config.activate.on-profile: dev  
aws:  
  s3:  
    bucket:  
      name: inara-web-management-dev  
      cloudFrontBaseUrl: "https://dev.cloudfront.url" 
aws:
  s3:
    mock:
      enabled: true  
      port: 8111

@ConditionalOnProperty 설정에 의해서 s3Client bean 을 만들 수도, @Profile 설정에 의해 mockS3Client bean 을 만들 수도 없어서 bean 예외를 발생시키며 application 실행에 실패한 것이다.

당연하게도 default profile 에 추가된 설정을 지우니 정상적으로 application 이 구동되었다.


예방 방법은 없을까?

사실 spring application properties 는 자신의 역할을 충실히 수행했을 뿐, 아무런 문제가 없다. 인간의 인지 부조화 문제로 생긴 문제일 뿐. 즉 인간이 헷갈리거나 실수할 수 있는 여지를 남겨 놓지 않으면 된다.

@ConditionalOnProperty 을 부정형으로 사용하지 않는다.

현재는 s3Client bean 의 @ConditionalOnProperty 가 mock s3 의 부정형으로 작성되어 있어 헷갈린다.

  @ConditionalOnProperty(  
    prefix = "aws.s3.mock",  
    name = ["enabled"],  
    havingValue = "false",  
    matchIfMissing = true  
  )  
  @Bean  
  fun s3Client(): AmazonS3 =  
    AmazonS3ClientBuilder  
      .standard()  
      .withRegion(Regions.AP_NORTHEAST_2)  
      .build()

명확하게 s3Client bean 을 만들기 위한 property 를 명시하고, 그에 해당되는 값들이 존재할 때 bean 을 생성한다는 조건을 명시하자.

  @ConditionalOnProperty(  
    prefix = "aws.s3.bucket",  
    name = ["enabled"],  
    havingValue = "true",  
    matchIfMissing = false  
  )  
  @Bean  
  fun s3Client(): AmazonS3 =  
    AmazonS3ClientBuilder  
      .standard()  
      .withRegion(Regions.AP_NORTHEAST_2)  
      .build()

default profile 에 property 를 명시한 후엔, 공통적으로 모든 profile 별로 오버라이딩 하거나, 하지 않도록 통일하자.

local 환경에만 불필요하게 중복값이 오버라이드 되어있어 더 헷갈리고 인지에 오랜 시간이 소요되었다. 둘 중 하나의 방식을 채택하여 인지 부조화를 줄이자.

# 아예 모두가 하지 않거나
aws:
  s3:
    bucket:
      name: test
      cloudFrontBaseUrl: "https://default.cloudfront.url"
  mock:            
    enabled: true  
    port: 8111     

---

spring.config.activate.on-profile: local
aws:
  s3:
    bucket:
      name: inara-web-management-local
      cloudFrontBaseUrl: "https://local.cloudfront.url"

---

spring.config.activate.on-profile: dev
aws:
  s3:
    bucket:
      name: inara-web-management-dev
      cloudFrontBaseUrl: "https://dev.cloudfront.url"  

# 할거면 모두가 하는 걸로
aws:
  s3:
    bucket:
      name: test
      cloudFrontBaseUrl: "https://default.cloudfront.url"
  mock:
    enabled: true
    port: 8111

---

spring.config.activate.on-profile: local
aws:
  s3:
    bucket:
      name: inara-web-management-local
      cloudFrontBaseUrl: "https://local.cloudfront.url"
    mock:
      enabled: false
      port: 8111

---

spring.config.activate.on-profile: dev
aws:
  s3:
    bucket:
      name: inara-web-management-dev
      cloudFrontBaseUrl: "https://dev.cloudfront.url"  
    mock:
      enabled: false
      port: 8111


후기

혼자가 아닌 동료 개발자들과 함께 개발하는 환경에서는 어떤 일이 발생할지 예측하기 어렵다. ‘이정도는 괜찮겠지.’ 라는 안일한 생각으로 위험요소를 남겨두지 말자. 아예 실수할 여지를 없애버리자. 그게 진짜 실력이다.

관련해서 읽어보면 좋은 글이 하나 있어 링크를 남긴다. 실수할 여지를 주지않기

태그:

업데이트:

댓글남기기

참고

Spring Boot 3 마이그레이션 팁 모음

September 16 2024

Spring Boot 2 -> Spring Boot 3 마이그레이션은 메이저 버전 변경임에도 불구하고 비교적 쉽게 진행할 수 있다. 하지만 말 그대로 Spring Boot 마이그레이션이 쉬울 뿐, 부수적으로 생기는 문제들까지 모두 해결하는 건 쉽지 않다.

제품을 만드는 사람과 변화를 만드는 사람

April 14 2024

뛰어난 기술과 수 없이 많은 서비스가 우리 곁에 놓여진 세상이다. 이제는 누구나 쉽게 제품을 만들 수 있고, 누구나 쉽게 서비스를 이용할 수 있다. 기업은 자신들의 제품을 자랑하고 싶어 하고, 엔지니어들은 자신들의 기술력을 뽐내고 싶어 한다. 그러나 뛰어난 제품, 기술력과 부단한...