Spring Boot 備忘單

注釋

控制流程

1. 初始化：Spring Boot 首先加載應(yīng)用程序?qū)傩院妥詣?dòng)配置 bean。
2. 組件掃描：Spring 掃描控制器、服務(wù)和存儲(chǔ)庫(kù)等組件。
3. Bean 創(chuàng)建：Spring 創(chuàng)建 Bean 并使用依賴注入解析依賴關(guān)系。
4. 請(qǐng)求處理：傳入的 HTTP 請(qǐng)求根據(jù)請(qǐng)求映射映射到控制器方法。
5. 執(zhí)行：控制器方法處理請(qǐng)求、與服務(wù)交互并返回響應(yīng)。
6. 響應(yīng)渲染：Spring 將方法返回值轉(zhuǎn)換為適當(dāng)?shù)?HTTP 響應(yīng)（例如 JSON）。

推薦的文件夾結(jié)構(gòu)

src
├── 主要
│ ├── java
│ │ └── com
│ │ └── 例子
│ │ ├── 控制器
│ │ │ └──MyController.java
│ │ ├── 服務(wù)
│ │ │ └──MyService.java
│ │ └── Application.java
│ └── 資源
│ ├── application.properties
│ └── 模板
│ └──index.html
└── 測(cè)試
└── java
└── com
└── 例子
└── 控制器
└── MyControllerTest.java

Spring Boot 備忘單中的錯(cuò)誤處理

錯(cuò)誤處理是構(gòu)建健壯應(yīng)用程序的一個(gè)關(guān)鍵方面。 Spring Boot 提供了多種優(yōu)雅處理錯(cuò)誤和異常的機(jī)制，確保流暢的用戶體驗(yàn)。

錯(cuò)誤類型

• 客戶端錯(cuò)誤：無(wú)效客戶端請(qǐng)求導(dǎo)致的錯(cuò)誤，例如 400 Bad Request 或 404 Not Found。
• 服務(wù)器錯(cuò)誤：服務(wù)器端發(fā)生的錯(cuò)誤，例如500內(nèi)部服務(wù)器錯(cuò)誤。
• 驗(yàn)證錯(cuò)誤：由于輸入無(wú)效或數(shù)據(jù)驗(yàn)證失敗而導(dǎo)致的錯(cuò)誤。

錯(cuò)誤處理機(jī)制

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);
    }
}

響應(yīng)實(shí)體異常處理程序

• ResponseEntityExceptionHandler：處理常見(jiàn) Spring MVC 異常的基類。
• 重寫(xiě)：重寫(xiě)handleMethodArgumentNotValid、handleHttpMessageNotReadable等方法
• 示例：

@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. 錯(cuò)誤屬性

• ErrorAttributes：用于自定義錯(cuò)誤響應(yīng)內(nèi)容和格式的接口。
• DefaultErrorAttributes：Spring Boot 提供的默認(rèn)實(shí)現(xiàn)。

@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：存儲(chǔ)應(yīng)用程序范圍的屬性，例如服務(wù)器端口、數(shù)據(jù)庫(kù) URL 等
• 自定義屬性文件：為不同環(huán)境定義自定義屬性文件（例如application-dev.properties）。
• 訪問(wèn)屬性：使用@Value注釋或Spring的Environment API訪問(wèn)屬性。

建筑工程

• Maven：運(yùn)行 mvn clean install 來(lái)構(gòu)建項(xiàng)目并生成可執(zhí)行 JAR。
• Gradle：運(yùn)行 ./gradlew build 來(lái)構(gòu)建項(xiàng)目并生成可執(zhí)行 JAR。

附加主題

• Spring Boot Starters：使用 starters 向項(xiàng)目添加依賴項(xiàng)和自動(dòng)配置。
• 日志記錄：使用 Logback、Log4j 或 Java Util Logging 配置日志記錄。
• 錯(cuò)誤處理：使用@ControllerAdvice實(shí)現(xiàn)全局異常處理。
• 測(cè)試：使用 JUnit、Mockito 和 SpringBootTest 編寫(xiě)單元測(cè)試和集成測(cè)試。

以上是Spring Boot 備忘單的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！