SpringBoot

📙 Spring Boot

Java 기반의 웹 애플리케이션 개발을 간소화하고 가속화하는 프레임워크

💡 Spring Boot의 특징

• legacy Spring
  • Application을 개발하려면 사전에 많은 작업을 해야 했다.
  • library 추가(pom.xml), dependency 설정(DI), SpringFramework가 처리해야 하는 여러 가지 구성 및 설정 파일 등
• SpringBoot의 장점
  • project에 따라 자주 사용되는 library들이 미리 조합되어 있음 (starter 의존성 제공)
  • 복잡한 설정을 자동으로 처리
    • component scan 등
  • 웹 서버에 독립적인 Spring Application 구축 가능
  • Tomcat, Jetty와 같은 WAS를 추가로 설치하지 않아도 개발 가능하다. (내장 서버)
  • WAS에 배포하지 않고도 실행할 수 있는 JAR 파일로 Web Application을 개발할 수 있다.

💡 spring boot starter

• 의존성이 모여 있는 그룹
• 필요한 기능을 간편하게 설정
• naming convention : “spring-boot-starter-{작업유형}”
• 대표적인 spring boot starter
  • spring-boot-starter-web : Spring MVC를 사용하여 web service를 개발할 때 필요한 의존성 모음
  • spring-boot-starter-test : Spring Boot Application을 테스트하기 위해 필요한 의존성 모음
  • spring-boot-starter-validation : validation check를 위해 필요한 의존성 모음
  • spring-boot-starter-actuator : monitoring을 위해 application에서 제공하는 다양한 정보를 제공하기 쉽게 하는 의존성 모음
  • spring-boot-starter-data-jpa : ORM Interface의 모음인 JPA를 사용하기 위한 의존성 모음

💡 Spring Boot Project 주요 파일

• src/main/java
  • java source directory
• SpringBootApplication.java
  • application을 시작할 수 있는 main method가 존재하는 스프링 구성 메인 클래스
• static
  • css, js, img 등의 정적 resource directory
• templates
  • SpringBoot에서 사용 가능한 여러가지 View Template(Thymeleaf, Velocity, FreeMarker 등) 위치
• application.properties
  • application 및 스프링의 설정 등에서 사용할 여러 가지 property를 정의한 file
• src/main/webapp
  • jsp 등의 리소스 directory

💡@SpringBootApplication Annotation

• @ SpringBootConfiguration
  • SpringBoot 관련 설정
• @ EnableAutoconfiguration
  • SpringBoot에서 자동 구성을 활성화하는 Annotation
  • 서버가 실행될 때 SpringBoot의 메타 파일을 읽고 정의된 설정들을 자동으로 구성
• @ ComponentScan
  • 사용자가 등록한 빈을 읽고 등록
  • @ Configuration, @ Controller, @ RestController, @ Service, @ Repository가 선언된 class

📙 Swagger

• FrontEnd 개발자의 경우 화면과 로직에 집중을 하고 BackEnd 개발자가 만든 문서 API를 보며 데이터 처리를 하게 됨
  → 개발 상황의 변화에 따른 API의 추가 또는 변경할 때마다 문서에 적용하는 불편함 발생
  ⇒ Swagger 사용
  

💡 Swagger

간단한 설정으로 프로젝트의 API 목록을 웹에서 확인 및 테스트 할 수 있게 해주는 Library

• Swagger를 사용하면 Controller에 정의되어 있는 모든 URL을 바로 확인 가능하다.
• API 목록 뿐 아니라 API의 명세 및 설명도 볼 수 있으며, API를 직접 테스트 가능하다.

💡관련 어노테이션

• @Tag
  • API 엔드포인트를 그룹화하고 카테고리를 형성하는 데 사용
  • 주로 @RestController 클래스에 적용
  • name과 description 속성을 통해 API 그룹의 이름과 설명을 정의
• @Operation
  • 개별 API 엔드포인트에 대한 상세 정보를 제공
  • Controller 메서드에 사용
  • summary와 description 속성을 통해 API의 간략한 설명과 상세 설명을 제공
• @Schema
  • API 요청/응답 모델의 상세 정보를 정의
  • DTO 클래스나 필드에 사용
  • description, example, allowableValues 등의 속성을 통해 모델 구조와 속성의 의미를 설명