제임스딘딘의
Tech & Life

개발자의 기록 노트/Web Technology

[스프링부트] 레퍼런스 문서는 필수품

제임스-딘딘 2023. 4. 5. 20:01

스프링부트 개발을 하다보면 스프링부트 버전별로 조금씩 달라지는 것들이 있다.
내가 겪었던 문제를 예를들면, 스타터 + 자동설정이 되도록 만든 라이브러리(maven프로젝트)를 AutoConfigure 에 등록하는 것.

2.X 버전까지는 META-INF/spring.factories 파일에,
org.springframework.boot.autoconfigure.EnableAutoConfigration = [추가할 클래스 전체경로]

이런식으로 해줬었다.
그런데 이게 스프링부트 3 버전 부터는 변경된 걸 모르고 그대로 했더니,

key is not supported as of Spring boot 3...

이런 에러가 발생한다.


레퍼런스 문서에서 'auto-configuration' 관련 키워드로 급하게 찾아보니, 3.X 버전부터는 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 파일에,
[추가할 클래스 전체경로] 를 한줄에 한개씩 적어주어야 한다.

역시.. 레퍼런스 문서는 꼭 필요하다.

 

아래는 스프링부트 3.1.X 버전 레퍼런스.

https://docs.spring.io/spring-boot/docs/3.1.x/reference/html/index.html

 

Spring Boot Reference Documentation

The reference documentation consists of the following sections: Legal Legal information. Getting Help Resources for getting help. Documentation Overview About the Documentation, First Steps, and more. Getting Started Introducing Spring Boot, System Require

docs.spring.io

 

다른 버전의 스프링부트 레퍼런스가 필요하다면?
아래 경로를 방문해보자.

https://docs.spring.io/spring-boot/docs/

이처럼 모든 버전의 레퍼런스 문서가 준비되어있다.
문서는 하이퍼링크로 연결된 여러개의 html과, 단일 html 파일, pdf파일 이렇게 3가지 타입으로 제공되고 있다.
놀랍게 문서화가 잘 된 프레임워크는 언제나 좋다.