스프링 부트 치트 시트

스프링 부트 치트 시트

주석

Annotation	Description	Example
@SpringBootApplication	Marks a class as a Spring Boot application. Enables auto-configuration and component scanning.	@SpringBootApplication
@RestController	Indicates that a class provides RESTful endpoints. It combines @Controller and @ResponseBody annotations.	@RestController
@RequestMapping	Maps HTTP requests to handler methods of RESTful controllers.	@RequestMapping("/api")
@Autowired	Injects dependencies into a Spring bean. It can be used for constructor, setter, or field injection.	@Autowired private MyService myService;
@Component	Indicates that a class is a Spring-managed component. It is automatically detected during component scanning.	@Component
@Repository	Marks a class as a Spring Data repository. It handles data access and persistence logic.	@Repository
@Service	Marks a class as a service component in the business layer. It is used to separate business logic from presentation logic.	@Service
@Configuration	Indicates that a class provides bean definitions. It is used along with @bean to define beans in Java-based configuration.	@Configuration
@Value	Injects values from properties files or environment variables into Spring beans.	@Value("${my.property}") private String property;

제어 흐름

1. 초기화: Spring Boot는 애플리케이션 속성을 로드하고 Bean을 자동 구성하여 시작됩니다.
2. 구성요소 스캔: 컨트롤러, 서비스, 저장소와 같은 구성요소에 대한 Spring 스캔
3. 빈 생성: Spring은 종속성 주입을 사용하여 빈을 생성하고 종속성을 해결합니다.
4. 요청 처리: 들어오는 HTTP 요청은 요청 매핑을 기반으로 컨트롤러 메서드에 매핑됩니다.
5. 실행: 컨트롤러 메서드가 요청을 처리하고 서비스와 상호 작용하며 응답을 반환합니다.
6. 응답 렌더링: Spring은 메서드 반환 값을 적절한 HTTP 응답(예: JSON)으로 변환합니다.

권장 폴더 구조

src
├── 메인
│ ├── 자바
│ │ └── com
│ │ └── 예시
│ │ ├── 컨트롤러
│ │ │ └── MyController.java
│ │ ├── 서비스
│ │ │ └── MyService.java
│ │ └── Application.java
│ └── 리소스
│ ├── 애플리케이션.속성
│ └── 템플릿
│ └── index.html
└── 테스트
└── 자바
└── com
└── 예시
└── 컨트롤러
└── MyControllerTest.java

Spring Boot 치트 시트의 오류 처리

오류 처리는 강력한 애플리케이션을 구축하는 데 있어 중요한 측면입니다. Spring Boot는 오류와 예외를 적절하게 처리하기 위한 여러 메커니즘을 제공하여 원활한 사용자 경험을 보장합니다.

오류 유형

• 클라이언트 오류: 400 잘못된 요청 또는 404 찾을 수 없음 등 잘못된 클라이언트 요청으로 인해 발생한 오류입니다.
• 서버 오류: 500 내부 서버 오류 등 서버 측에서 발생하는 오류입니다.
• 검증 오류: 잘못된 입력 또는 데이터 검증 실패로 인한 오류

오류 처리 메커니즘

1. 컨트롤러 조언

• @ControllerAdvice: Spring MVC에서 전역 예외 처리기를 정의하는 데 사용되는 주석입니다.
• @ExceptionHandler: 컨트롤러 조언 내에서 특정 예외를 처리하는 데 사용되는 주석입니다.
• 예:

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MyException.class)
    public ResponseEntity<ErrorResponse> handleMyException(MyException ex) {
        ErrorResponse response = new ErrorResponse("My error message");
        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse response = new ErrorResponse("Internal server error");
        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

ResponseEntityExceptionHandler

• ResponseEntityExceptionHandler: 일반적인 Spring MVC 예외를 처리하기 위한 기본 클래스입니다.
• 재정의: handlerMethodArgumentNotValid, handlerHttpMessageNotReadable 등과 같은 메서드를 재정의합니다.
• 예:

@ControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {

@Override
protected ResponseEntity<Object> handleMethodArgumentNotValid(
        MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
    ErrorResponse response = new ErrorResponse("Validation failed");
    return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
}

// Other overrides for handling specific exceptions

3. 오류 속성

• ErrorAttributes: 오류 응답의 내용과 형식을 사용자 정의하는 데 사용되는 인터페이스입니다.
• DefaultErrorAttributes: Spring Boot에서 제공하는 기본 구현입니다.

@Component
public class CustomErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
    Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
    errorAttributes.put("customAttribute", "Custom value");
    return errorAttributes;
}

}

속성 파일 사용

• application.properties: 서버 포트, 데이터베이스 URL 등과 같은 애플리케이션 전체 속성을 저장합니다.
• 사용자 정의 속성 파일: 다양한 환경에 대한 사용자 정의 속성 파일을 정의합니다(예: application-dev.properties).
• 속성 액세스: @Value 주석 또는 Spring의 Environment API를 사용하여 속성에 액세스합니다.

건축 프로젝트

• Maven: mvn clean install을 실행하여 프로젝트를 빌드하고 실행 가능한 JAR을 생성합니다.
• Gradle: ./gradlew build를 실행하여 프로젝트를 빌드하고 실행 가능한 JAR을 생성합니다.

추가 주제

• Spring Boot Starters: 스타터를 사용하여 프로젝트에 종속성과 자동 구성을 추가합니다.
• 로깅: Logback, Log4j 또는 Java Util Logging을 사용하여 로깅을 구성합니다.
• 오류 처리: @ControllerAdvice를 사용하여 전역 예외 처리를 구현합니다.
• 테스트: JUnit, Mockito 및 SpringBootTest를 사용하여 단위 테스트 및 통합 테스트를 작성합니다.

위 내용은 스프링 부트 치트 시트의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!