[Spring] - application.properties(.yml)에 개발자 정의 프로퍼티 경고창없애기

Spring Boot로 개발하다보면 application.properties나 application.yml 파일에 개발자 정의 프로퍼티를 추가하는일이 많다.
하지만 개발자 정의 프로퍼티를 작성할 경우 왼쪽에 노란색 전구모양의 경고가 뜨게되는데 정상작동은 프로퍼티가 많아지면 왠지 소스가 깔끔하지 못하고 지저분(??)해 보일수 있다.
그래서 이번엔 저 경고창을 없애는 방법과 개발자가 정의한 프로퍼티 값들을 관리할 수 있는 방법을
예제코드와 함께 알아보자.

application.propeties(.yml) 파일에 개발자 정의 프로퍼티 추가

사용자에게 이미지파일을 응답하기 위한 요청url과 요청을 서버쪽 이미지가 있는 경로에 전달하기 위한 url 2개를 추가했다.

metadata.json 파일생성하기

커서를 경고밑줄에 두게되면 해당 프로퍼티에 대한 metadata 파일을 만들 수 있는 창이뜬다. 클릭하고 만들자

경고창이 없어지고 src/main/resource/META-INF/additional-spring-configuration-metadata.json
이라는 JSON 파일이 만들어졌다.

json파일에 name으로 명시된 key를 입력하게되면 그 key에 맞는 메타정보들을 확인할 수 있다.
description이라는 속성으로 이 프로퍼티에 대한 설명도 적을수 있고 defaultValue속성엔 default 값도 설정할 수 있다.

개발자가 정의한 프로퍼티 목록보기

개발자가 직접 추가한 프로퍼티 목록들을 볼 수 있다. 그럴일이 발생될진 모르겠지만 이렇게 개발자들이 추가한
프로퍼티가 많을시 이 프로퍼티목록들을 따로 로그를 남긴다거나 파일로 남기는 일이 생기게 되면 유용할 것 같다.

위 JSON 파일에 대해 더 궁금하신분들은 아래링크를 통해 확인해보자.
https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-configuration-metadata.html