ArgumentTypeMismatch詳解

一、什麼是ArgumentTypeMismatch

ArgumentTypeMismatch是Spring框架中的一個異常類型，一般在調用方法時，傳入的參數類型與方法所需參數類型不一致時會拋出此異常。

public class UserController {
    @GetMapping("/user")
    public String getUser(@RequestParam("id") Long id) {
        User user = userService.getUserById(id);
        // do something...
        return "user";
    }
}

// 當請求參數為字元串類型時，將會拋出ArgumentTypeMismatch異常
// eg. http://localhost/user?id=abc

上述代碼中，當我們在請求參數中傳入一個字元串類型的id參數時，將會觸發ArgumentTypeMismatch異常，因為getUser方法需要一個Long類型的id參數。

二、為什麼會出現ArgumentTypeMismatch異常

出現ArgumentTypeMismatch異常的原因有很多種，本小節主要探討以下兩種常見情況：

1.前端傳參類型不正確

當前端傳遞參數時，如果參數類型與後端介面要求的類型不一致，將會出現ArgumentTypeMismatch異常。

// 前端代碼
$.ajax({
    url: "/user",
    type: "GET",
    dataType: "json",
    data: {id: "abc"},
    success: function (data) {
        // do something...
    }
});

// 後端代碼
public class UserController {
    @GetMapping("/user")
    public String getUser(@RequestParam("id") Long id) {
        User user = userService.getUserById(id);
        // do something...
        return "user";
    }
}

// 將會拋出ArgumentTypeMismatch異常

上述代碼中，前端通過ajax請求後端的/user介面，並且將id參數傳遞為字元串類型。而後端介面需要的是Long類型的id參數，將會出現異常。

2.表單提交參數類型不正確

當使用表單提交數據時，如果傳遞參數類型與後端介面要求的類型不一致，同樣會出現ArgumentTypeMismatch異常。

// 前端代碼
<form action="/user" method="POST">
    <input type="text" name="id" value="abc">
    <button type="submit">提交</button>
</form>

// 後端代碼
public class UserController {
    @PostMapping("/user")
    public String updateUser(@RequestParam("id") Long id) {
        userService.updateUserById(id);
        // do something...
        return "user";
    }
}

// 將會拋出ArgumentTypeMismatch異常

上述代碼中，表單中的id參數為字元串類型，而後端介面需要Long類型的id參數，將會出現異常。

三、如何避免ArgumentTypeMismatch異常

針對出現ArgumentTypeMismatch異常的情況，我們可以做以下幾點來避免異常的出現：

1.前後端保持一致

在前後端數據傳遞時，需要確保前後端保持一致的類型。

// 前端代碼，傳遞Long類型的id參數
$.ajax({
    url: "/user",
    type: "GET",
    dataType: "json",
    data: {id: 1},
    success: function (data) {
        // do something...
    }
});

// 後端代碼，需要Long類型的id參數
public class UserController {
    @GetMapping("/user")
    public String getUser(@RequestParam("id") Long id) {
        User user = userService.getUserById(id);
        // do something...
        return "user";
    }
}

2.參數類型轉換

當出現參數類型不匹配的情況時，我們可以通過參數類型轉換來解決異常。

// 後端代碼，將String類型的參數轉換成Long類型
public class UserController {
    @PostMapping("/user")
    public String updateUser(@RequestParam("id") String id) {
        Long userId = Long.valueOf(id);
        userService.updateUserById(userId);
        // do something...
        return "user";
    }
}

3.使用@RequestParam註解

針對考慮不周全，前後端類型不一致的情況，我們可以使用@RequestParam註解來明確指定參數類型，避免ArgumentTypeMismatch異常的出現。

// 前端代碼，傳遞字元串類型的id參數
$.ajax({
    url: "/user",
    type: "GET",
    dataType: "json",
    data: {id: "1"},
    success: function (data) {
        // do something...
    }
});

// 後端代碼，使用@RequestParam註解來指定參數類型
public class UserController {
    @GetMapping("/user")
    public String getUser(@RequestParam("id") Long id) {
        User user = userService.getUserById(id);
        // do something...
        return "user";
    }
}

四、ArgumentTypeMismatch異常的作用

ArgumentTypeMismatch異常只是一個提醒，提醒我們在參數傳遞過程中出現了類型不匹配的情況。

出現該異常時，我們需要檢查前後端數據類型是否一致，以及是否需要進行參數類型轉換。

五、總結

ArgumentTypeMismatch異常是Spring框架中的一個異常類型，當參數類型不匹配時，將會拋出該異常。為避免該異常的出現，我們需要在前後端交互時明確參數類型，以及必要時進行類型轉換。