Spring Boot 備忘單

註解

控制流程

1. 初始化：Spring Boot 首先載入應(yīng)用程式屬性和自動(dòng)配置 bean。
2. 元件掃描：Spring 掃描控制器、服務(wù)和儲(chǔ)存庫(kù)等元件。
3. Bean 建立：Spring 建立 Bean 並使用依賴(lài)注入解析依賴(lài)關(guān)係。
4. 請(qǐng)求處理：傳入的 HTTP 請(qǐng)求根據(jù)請(qǐng)求對(duì)應(yīng)對(duì)應(yīng)到控制器方法。
5. 執(zhí)行：控制器方法處理請(qǐng)求、與服務(wù)互動(dòng)並回傳回應(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ò)誤處理是建立健全應(yīng)用程式的關(guān)鍵方面。 Spring Boot 提供了多種優(yōu)雅處理錯(cuò)誤和異常的機(jī)制，確保流暢的使用者體驗(yàn)。

錯(cuò)誤類(lèi)型

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

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

1. 控制者建議

• @ControllerAdvice：用於在 Spring MVC 中定義全域異常處理程序的註解。
• @ExceptionHandler：用於處理控制器建議中的特定例外的註解。
• 範(fàn)例：

@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 異常的基底類(lèi)別。
• 重寫(xiě)：重寫(xiě)handleMethodArgumentNotValid、handleHttpMessageNotReadable等方法
• 範(fàn)例：

@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 提供的預(yù)設(shè)實(shí)作。

@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)用程式範(fàn)圍的屬性，例如伺服器連接埠、資料庫(kù) URL 等
• 自訂屬性檔：為不同環(huán)境定義自訂屬性檔（例如application-dev.properties）。
• 存取屬性：使用@Value註解或Spring的Environment API存取屬性。

建築工程

• Maven：執(zhí)行 mvn clean install 來(lái)建置專(zhuān)案並產(chǎn)生可執(zhí)行 JAR。
• Gradle：執(zhí)行 ./gradlew build 來(lái)建置專(zhuān)案並產(chǎn)生可執(zhí)行 JAR。

附加主題

• Spring Boot Starters：使用 starters 為專(zhuān)案新增依賴(lài)項(xiàng)和自動(dòng)配置。
• 日誌記錄：使用 Logback、Log4j 或 Java Util Logging 設(shè)定日誌記錄。
• 錯(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)文章！