Pengendalian Pengecualian dalam But Spring

Pengendalian pengecualian ialah bahagian penting dalam membina aplikasi yang teguh dan mesra pengguna. Dalam Spring Boot, kami boleh mengendalikan pengecualian dalam pelbagai cara untuk memastikan aplikasi kami kekal stabil dan memberikan maklum balas yang bermakna kepada pengguna. Panduan ini akan merangkumi strategi berbeza untuk pengendalian pengecualian, termasuk pengecualian tersuai, pengendalian pengecualian global, ralat pengesahan dan amalan terbaik untuk pengeluaran.

1. Asas Pengendalian Pengecualian

Pengecualian ialah peristiwa yang mengganggu aliran biasa program. Mereka boleh dibahagikan kepada:

• Pengecualian yang Disemak: Pengecualian yang disemak pada masa penyusunan.
• Pengecualian Tidak Bertanda (Pengecualian Masa Jalan): Pengecualian yang berlaku semasa masa jalan.
• Ralat: Isu serius yang tidak sepatutnya dikendalikan oleh aplikasi, seperti OutOfMemoryError.

2. Kelas Pengecualian Tersuai

Mencipta kelas pengecualian tersuai membantu dalam mengendalikan keadaan ralat tertentu dalam aplikasi anda.

package com.example.SpringBootRefresher.exception;

public class DepartmentNotFoundException extends RuntimeException {
    public DepartmentNotFoundException(String message) {
        super(message);
    }
}

3. Pengendalian Pengecualian dalam Pengawal

@ExceptionHandler Anotasi:
Anda boleh menentukan kaedah untuk mengendalikan pengecualian dalam kelas pengawal anda.

package com.example.SpringBootRefresher.controller;

import com.example.SpringBootRefresher.exception.DepartmentNotFoundException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DepartmentController {

    @GetMapping("/department")
    public String getDepartment() {
        // Simulate an exception
        throw new DepartmentNotFoundException("Department not found!");
    }

    @ExceptionHandler(DepartmentNotFoundException.class)
    public ResponseEntity<String> handleDepartmentNotFoundException(DepartmentNotFoundException ex) {
        return new ResponseEntity<>(ex.getMessage(), HttpStatus.NOT_FOUND);
    }
}

4. Pengendalian Pengecualian Global dengan @ControllerAdvice

Untuk mengendalikan pengecualian secara global, anda boleh menggunakan @ControllerAdvice dan pengendali pengecualian berpusat.

package com.example.SpringBootRefresher.error;

import com.example.SpringBootRefresher.entity.ErrorMessage;
import com.example.SpringBootRefresher.exception.DepartmentNotFoundException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

@ControllerAdvice
@ResponseStatus
public class CustomResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(DepartmentNotFoundException.class)
    public ResponseEntity<ErrorMessage> handleDepartmentNotFoundException(DepartmentNotFoundException exception, WebRequest request) {
        ErrorMessage message = new ErrorMessage(
                HttpStatus.NOT_FOUND.value(),
                exception.getMessage(),
                request.getDescription(false)
        );

        return ResponseEntity.status(HttpStatus.NOT_FOUND)
                .body(message);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorMessage> handleGlobalException(Exception exception, WebRequest request) {
        ErrorMessage message = new ErrorMessage(
                HttpStatus.INTERNAL_SERVER_ERROR.value(),
                exception.getMessage(),
                request.getDescription(false)
        );

        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body(message);
    }
}

5. Mencipta Respons Ralat Standard

Tentukan kelas respons ralat standard untuk menstrukturkan mesej ralat anda.

package com.example.SpringBootRefresher.entity;

public class ErrorMessage {
    private int statusCode;
    private String message;
    private String description;

    public ErrorMessage(int statusCode, String message, String description) {
        this.statusCode = statusCode;
        this.message = message;
        this.description = description;
    }

    // Getters and setters

    public int getStatusCode() {
        return statusCode;
    }

    public void setStatusCode(int statusCode) {
        this.statusCode = statusCode;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

6. Mengendalikan Ralat Pengesahan

Spring Boot disepadukan dengan baik dengan Bean Validation (JSR-380). Untuk mengendalikan ralat pengesahan secara global, gunakan @ControllerAdvice.

package com.example.SpringBootRefresher.error;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.context.request.WebRequest;
import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
@ResponseStatus
public class ValidationExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach((error) -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }
}

7. Menggunakan @ResponseStatus untuk Pengecualian Mudah

Untuk kes mudah, anda boleh menganotasi kelas pengecualian dengan @ResponseStatus untuk menentukan kod status HTTP.

package com.example.SpringBootRefresher.exception;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

@ResponseStatus(HttpStatus.NOT_FOUND)
public class DepartmentNotFoundException extends RuntimeException {
    public DepartmentNotFoundException(String message) {
        super(message);
    }
}

8. Amalan Terbaik untuk Pengeluaran

1. Respon Ralat Konsisten: Pastikan aplikasi anda mengembalikan respons ralat yang konsisten dan berstruktur. Gunakan kelas respons ralat standard.
2. Log: Pengecualian log untuk tujuan penyahpepijatan dan pemantauan. Pastikan maklumat sensitif tidak didedahkan dalam log.
3. Mesej Mesra Pengguna: Sediakan mesej ralat mesra pengguna. Elakkan daripada mendedahkan butiran dalaman atau kesan tindanan kepada pengguna.
4. Keselamatan: Berhati-hati dengan maklumat yang disertakan dalam respons ralat untuk mengelak daripada mendedahkan data sensitif.
5. Dokumentasi: Dokumentasikan strategi pengendalian pengecualian anda untuk pasukan anda dan penyelenggara masa hadapan.

Ringkasan

Pengendalian pengecualian dalam Spring Boot melibatkan penggunaan anotasi seperti @ExceptionHandler, @ControllerAdvice dan @ResponseStatus untuk mengurus ralat dengan berkesan. Dengan membuat pengecualian tersuai, mengendalikan ralat pengesahan dan mengikut amalan terbaik, anda boleh membina aplikasi teguh yang mengendalikan ralat dengan anggun dan memberikan maklum balas yang bermakna kepada pengguna. Menggunakan ciri Java 17 memastikan aplikasi anda memanfaatkan peningkatan terkini dalam ekosistem Java.

Atas ialah kandungan terperinci Pengendalian Pengecualian dalam But Spring. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!