private boolean success;
private String message;
private T data;
private List<String> errors;
private int errorCode;
private long timestamp; // Adding timestamp for tracking
private String path; // Adding path to identify the API endpoint

// Constructors, getters, and setters
}

了解每個(gè)字段：

成功：

類型： boolean
描述：指示 API 調(diào)用是否成功。
為什么使用它 ：快速確定請(qǐng)求的結(jié)果，簡(jiǎn)化客戶端邏輯。

2.消息 ：

類型： String
描述：提供有關(guān) API 調(diào)用結(jié)果的人性化消息。
為什么使用它 ：有助于向客戶提供上下文反饋，對(duì)于成功和錯(cuò)誤情況都有用。

3.數(shù)據(jù)：

類型： T
描述：包含響應(yīng)的有效負(fù)載，可以是任何數(shù)據(jù)類型。
為什么使用它 ：提供客戶端請(qǐng)求的實(shí)際數(shù)據(jù)。

4.錯(cuò)誤 ：

類型： List<String>
描述：API 調(diào)用不成功時(shí)顯示的錯(cuò)誤消息列表。
為什么使用它 ：提供有關(guān)出現(xiàn)問題的詳細(xì)信息，對(duì)于調(diào)試和用戶反饋很有用。

5. 錯(cuò)誤代碼 ：

類型： int
描述：代表錯(cuò)誤類型的特定代碼。
為什么使用它 ：幫助以編程方式對(duì)錯(cuò)誤進(jìn)行分類并做出適當(dāng)?shù)捻憫?yīng)。

6.時(shí)間戳 ：

類型： long
描述：生成響應(yīng)的時(shí)間戳。
為什么使用它 ：對(duì)于記錄和跟蹤響應(yīng)時(shí)間很有用，這有助于調(diào)試和監(jiān)控。

7.路徑 ：

類型： String
描述：調(diào)用的 API 端點(diǎn)。
為什么使用它 ：幫助識(shí)別哪個(gè) API 端點(diǎn)生成了響應(yīng)，這對(duì)于調(diào)試和日志記錄很有用。

2. 創(chuàng)建響應(yīng)的實(shí)用方法

讓我們創(chuàng)建實(shí)用的方法來生成響應(yīng)，以保持不重復(fù)。這樣做既可以確保一致性，又能減少樣板代碼。

public class ResponseUtil {



    public static <T> ApiResponse<T> success(T data, String message, String path) {

        ApiResponse<T> response = new ApiResponse<>();

        response.setSuccess(true);

        response.setMessage(message);

        response.setData(data);

        response.setErrors(null);

        response.setErrorCode(0); // No error

        response.setTimestamp(System.currentTimeMillis());

        response.setPath(path);

        return response;

    }



    public static <T> ApiResponse<T> error(List<String> errors, String message, int errorCode, String path) {

        ApiResponse<T> response = new ApiResponse<>();

        response.setSuccess(false);

        response.setMessage(message);

        response.setData(null);

        response.setErrors(errors);

        response.setErrorCode(errorCode);

        response.setTimestamp(System.currentTimeMillis());

        response.setPath(path);

        return response;

    }



    public static <T> ApiResponse<T> error(String error, String message, int errorCode, String path) {

        return error(Arrays.asList(error), message, errorCode, path);

    }

}

3. 實(shí)現(xiàn)全局異常處理

我們可以使用 @ControllerAdvice 和 @ExceptionHandler 注解來全局處理異常，確保捕獲任何未處理的錯(cuò)誤并以標(biāo)準(zhǔn)響應(yīng)格式返回。

@RestControllerAdvice

public class GlobalExceptionHandler {



    @ExceptionHandler(Exception.class)

    public ResponseEntity<ApiResponse<Void>> handleException(HttpServletRequest request, Exception ex) {

        List<String> errors = Arrays.asList(ex.getMessage());

        ApiResponse<Void> response = ResponseUtil.error(errors, "An error occurred", 1000, request.getRequestURI()); // General error

        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);

    }



    @ExceptionHandler(ResourceNotFoundException.class)

    public ResponseEntity<ApiResponse<Void>> handleResourceNotFoundException(HttpServletRequest request, ResourceNotFoundException ex) {

        ApiResponse<Void> response = ResponseUtil.error(ex.getMessage(), "Resource not found", 1001, request.getRequestURI()); // Resource not found error

        return new ResponseEntity<>(response, HttpStatus.NOT_FOUND);

    }



    @ExceptionHandler(ValidationException.class)

    public ResponseEntity<ApiResponse<Void>> handleValidationException(HttpServletRequest request, ValidationException ex) {

        ApiResponse<Void> response = ResponseUtil.error(ex.getErrors(), "Validation failed", 1002, request.getRequestURI()); // Validation error

        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);

    }



    // Handle other specific exceptions similarly

}

4. 在控制器中使用響應(yīng)格式

現(xiàn)在，讓我們?cè)谑纠刂破髦惺褂脴?biāo)準(zhǔn)化響應(yīng)結(jié)構(gòu)。

@RestController

@RequestMapping("/api/products")

public class ProductController {



    @GetMapping("/{id}")

    public ResponseEntity<ApiResponse<Product>> getProductById(@PathVariable Long id, HttpServletRequest request) {

        // Fetch product by id (dummy code)

        Product product = productService.findById(id);

        if (product == null) {

            throw new ResourceNotFoundException("Product not found with id " + id);

        }

        ApiResponse<Product> response = ResponseUtil.success(product, "Product fetched successfully", request.getRequestURI());

        return new ResponseEntity<>(response, HttpStatus.OK);

    }



    @PostMapping

    public ResponseEntity<ApiResponse<Product>> createProduct(@RequestBody Product product, HttpServletRequest request) {

        // Create new product (dummy code)

        Product createdProduct = productService.save(product);

        ApiResponse<Product> response = ResponseUtil.success(createdProduct, "Product created successfully", request.getRequestURI());

        return new ResponseEntity<>(response, HttpStatus.CREATED);

    }



    // More endpoints...

}