AjaxResult詳解

AjaxResult是一個常用的返回值類型，用於在前後端分離的Web應用中進行數據交互。它主要用於返回瀏覽器需要的JSON格式數據，以便於瀏覽器端進行非同步處理。本文將從不同的角度來闡述AjaxResult的作用與使用方法。

一、AjaxResult概述

AjaxResult是一個常用的返回值類型，它主要用於返回JSON格式數據，以便於瀏覽器端進行非同步數據處理。它通常包含以下屬性：

public class AjaxResult {
    /**
     * 狀態碼，0表示請求成功，其他表示請求失敗
     */
    private int code;
    /**
     * 消息提示
     */
    private String message;
    /**
     * 返回數據
     */
    private Object data;
}

其中，code表示請求的返回狀態碼，message表示請求返回的消息提示，data則表示請求返回的數據。

二、AjaxResult的使用方法

AjaxResult的使用方法非常簡單，只需要在Controller中將需要返回的數據，封裝到AjaxResult對象中即可。下面是一段例子代碼：

@RequestMapping("/demo")
@ResponseBody
public AjaxResult demo() {
    User user = new User();
    user.setName("Test");
    user.setAge(18);
    return AjaxResult.success(user);
}

在上面的代碼中，我們創建了一個User對象，並將其封裝到了AjaxResult對象中。我們可以通過AjaxResult.success()方法來創建一個請求成功的AjaxResult對象，並將數據作為參數傳入。如果請求失敗，我們可以使用AjaxResult.error()方法，同樣可以將數據作為參數傳入。

三、AjaxResult與全局異常處理

當我們在開發中遇到錯誤時，我們通常需要對錯誤進行處理，並返回給用戶錯誤信息。全局異常處理可以幫助我們有效的處理這些錯誤，同時也可以將錯誤信息封裝成AjaxResult對象，返回給前端頁面。下面是一個全局異常處理的示例代碼：

@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {

    /**
     * 攔截所有運行時異常
     */
    @ExceptionHandler(RuntimeException.class)
    public AjaxResult handleRuntimeException(RuntimeException ex) {
        return AjaxResult.error(ex.getMessage());
    }
}

在上面的代碼中，我們使用@ControllerAdvice註解對全局異常進行攔截。當程序拋出運行時異常時，我們通過@ExceptionHandler註解對異常進行捕獲，然後將異常信息封裝為AjaxResult對象，並返回給前端頁面。

四、AjaxResult與分頁查詢

在分頁查詢的場景中，我們通常需要將查詢結果封裝為一個分頁對象，並將其返回給前端頁面。我們可以使用AjaxResult對象來封裝分頁查詢的結果。下面是一個分頁查詢的示例代碼：

@RequestMapping("/list")
@ResponseBody
public AjaxResult list(int pageNum, int pageSize) {
    PageHelper.startPage(pageNum, pageSize);
    List userList = userService.getUserList();
    PageInfo pageInfo = new PageInfo(userList);
    return AjaxResult.success(pageInfo);
}

在上面的代碼中，我們使用PageHelper來進行分頁查詢，並將查詢結果封裝為PageInfo對象，然後將PageInfo對象作為參數傳入AjaxResult.success()方法中。這樣，就可以將分頁查詢結果封裝為AjaxResult對象，返回給前端頁面。

五、AjaxResult與文件上傳

在文件上傳的場景中，我們通常需要將上傳的文件保存到伺服器上，並將文件保存的路徑封裝為一個對象，並將該對象返回給前端頁面。我們可以使用AjaxResult對象來封裝該對象。下面是一個文件上傳的示例代碼：

@RequestMapping("/upload")
@ResponseBody
public AjaxResult upload(MultipartFile file) {
    String path = fileService.upload(file);
    if (StringUtils.isBlank(path)) {
        return AjaxResult.error("文件上傳失敗");
    }
    return AjaxResult.success(path);
}

在上面的代碼中，我們使用MultipartFile來接收上傳的文件。在文件上傳成功後，我們將文件保存的路徑作為參數傳入AjaxResult.success()方法中，使用AjaxResult對象來封裝文件上傳結果。如果文件上傳失敗，我們則返回一個錯誤的AjaxResult對象。

六、總結

本文對AjaxResult進行了詳細的闡述，分別從AjaxResult概述、AjaxResult的使用方法、AjaxResult與全局異常處理、AjaxResult與分頁查詢、AjaxResult與文件上傳五個方面進行了詳細講解。使用AjaxResult可以方便地將請求返回的結果封裝為JSON格式數據，並返回給前端頁面進行非同步處理。