10、SpringMVC之處理Ajax請求_ZenDei技術網路在線

創建名為spring_mvc_ajax的新module，過程參考9.1節和9.5節 10.1、SpringMVC處理Ajax請求 10.1.1、頁面請求示例 <input type="button" value="測試SpringMVC處理Ajax請求" onclick="testAjax()"> ...

創建名為spring_mvc_ajax的新module，過程參考9.1節和9.5節

10.1、SpringMVC處理Ajax請求

10.1.1、頁面請求示例

<input type="button" value="測試SpringMVC處理Ajax請求" onclick="testAjax()">

<script type="text/javascript">
    function testAjax() {
        // 實例化 XMLHttpRequest 對象
        var xhr = new XMLHttpRequest()

        // 設置請求方式和請求路徑
        // 因為thymeleaf語法只能應用於html的屬性，所以在js中的請求要包含上下文信息
        xhr.open("post","/spring_mvc_ajax/test/ajax?id=1001")

        // 設置請求頭
        // 一般 get 不需要設置，而 post 必須設置請求頭
        // 必須寫在在open（）和send（）之間
        xhr.setRequestHeader("Content-Type", "application/json")

        // 發送請求
        // JSON.stringify() 是用來將合法的JSON數據字元串化的
        xhr.send( JSON.stringify( {"username":"admin","password":123} ) )

        // 設置 XMLHttpRequest 對象狀態變化事件的處理函數
        xhr.onreadystatechange = function () {
            // readyState的值為4時，表示已獲取到伺服器的響應
            if (xhr.readyState == 4){
                // 在瀏覽器控制台輸出伺服器響應的內容
                console.log(xhr.responseText)
            }
        }
    }
</script>

10.1.2、控制器方法示例

    @RequestMapping("/test/ajax")
    public void testAajx(Integer id , HttpServletResponse response) throws IOException {
        // 通過形參獲取 url 中的請求參數
        System.out.println("id："+id);
        // 通過 HttpServletResponse 對象為 Ajax 請求響應（字元串）數據
        response.getWriter().write("hello,ajax");
    }

10.1.3、測試效果

10.2、@RequestBody註解的基礎示例

10.2.1、作用

@RequestBody 註解用於將請求體中的內容和控制器方法中的形參進行綁定

10.2.2、控制器方法示例

頁面請求示例，見10.1.1節

    @RequestMapping("/test/ajax")
    public void testAajx(Integer id ,@RequestBody String requestBody ,HttpServletResponse response) throws IOException {
        // 通過形參獲取 url 中的請求參數
        System.out.println("id："+id);

        // 通過 @RequestBody 註解後的形參，獲取請求體中的內容
        System.out.println("requestBody："+requestBody);

        // 通過 HttpServletResponse 對象為 Ajax 請求響應（字元串）數據
        response.getWriter().write("hello,ajax");
    }

10.2.3、測試效果

10.3、@RequestBody註解的進階示例

10.3.1、前提條件一(引入jackson依賴)

        <!--jackson-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.12.1</version>
        </dependency>

10.3.2、前提條件二(開啟mvc的註解驅動)

mvc的註解驅動，在配置視圖控制器和預設的servlet處理器的時候，已經開啟；其重要性不言而喻

    <!--開啟mvc的註解驅動-->
    <mvc:annotation-driven></mvc:annotation-driven>

10.3.3、前提條件三(一個匹配json格式的Java類型)

匹配json格式的Java類型，一般是自定義實體類或map類型

package online.liaojy.pojo;

import java.io.Serializable;

/**
 * @author liaojy
 * @date 2023/10/30 - 0:02
 */
public class User implements Serializable {

    private Integer id;

    private String username;

    private String password;

    private Integer age;

    private String gender;

    public User() {
    }

    public User(Integer id, String username, String password, Integer age, String gender) {
        this.id = id;
        this.username = username;
        this.password = password;
        this.age = age;
        this.gender = gender;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", age=" + age +
                ", gender='" + gender + '\'' +
                '}';
    }
}

10.3.4、頁面請求示例

<input type="button" value="測試使用@RequestBody註解處理json格式的請求參數" onclick="testRequestBody()">

<script type="text/javascript">
    function testRequestBody() {
        // 實例化 XMLHttpRequest 對象
        var xhr = new XMLHttpRequest()

        // 設置請求方式和請求路徑
        // 因為thymeleaf語法只能應用於html的屬性，所以在js中的請求要包含上下文信息
        xhr.open("post","/spring_mvc_ajax/test/RequestBody/json")

        // 設置請求頭
        // 一般 get 不需要設置，而 post 必須設置請求頭
        // 必須寫在在open（）和send（）之間
        xhr.setRequestHeader("Content-Type", "application/json")

        // 發送請求
        // JSON.stringify() 是用來將合法的JSON數據字元串化的
        xhr.send( JSON.stringify( {"username":"admin","password":"123","age":18,"gender":"男"} ) )

        // 設置 XMLHttpRequest 對象狀態變化事件的處理函數
        xhr.onreadystatechange = function () {
            // readyState的值為4時，表示已獲取到伺服器的響應
            if (xhr.readyState == 4){
                // 在瀏覽器控制台輸出伺服器響應的內容
                console.log(xhr.responseText)
            }
        }
    }
</script>

10.3.5、控制器方法示例(自定義實體類)

    // 通過 @RequestBody 註解形參，將json格式的請求參數轉換為Java對象(自定義實體類)
    @RequestMapping("/test/RequestBody/json")
    public void testRequestBody(@RequestBody User user,HttpServletResponse response) throws IOException {
        System.out.println("user："+user);
        response.getWriter().write("hello,RequestBody");
    }

10.3.6、測試效果(自定義實體類)

因為json格式的請求參數中，沒有包含id的鍵值對，所以轉換後的Java實體類對象的id值為null

10.3.7、控制器方法示例(map集合)

    // 通過 @RequestBody 註解形參，將json格式的請求參數轉換為Java對象(map集合)
    @RequestMapping("/test/RequestBody/json")
    public void testRequestBody(@RequestBody Map<String,Object> map, HttpServletResponse response) throws IOException {
        System.out.println("map："+map);
        response.getWriter().write("hello,RequestBody");
    }

10.3.8、測試效果(map集合)

10.4、@ResponseBody註解的基礎示例

10.4.1、作用

@ResponseBody 註解用於將控制器方法的返回值，作為響應報文的響應體，響應到瀏覽器

10.4.2、頁面請求示例

<a th:href="@{/test/ResponseBody}">測試通過@ResponseBody註解響應瀏覽器數據</a>

10.4.3、控制器方法示例(沒使用@ResponseBody註解)

    @RequestMapping("/test/ResponseBody")
    public String testResponseBody(){
        return "success";
    }

10.4.4、測試效果(沒使用@ResponseBody註解)

沒使用@ResponseBody註解時，return "success"響應的是success邏輯視圖所對應的頁面

10.4.5、控制器方法示例(有使用@ResponseBody註解)

    @RequestMapping("/test/ResponseBody")
    @ResponseBody
    public String testResponseBody(){
        return "success";
    }

10.4.6、測試效果(有使用@ResponseBody註解)

有使用@ResponseBody註解時，return "success"響應的是success字元串

10.5、@ResponseBody註解的進階示例

10.5.1、前提條件

引入jackson依賴，參考10.3.1節
開啟mvc的註解驅動，參考10.3.2節
一個匹配json格式的Java類型，參考10.3.3節

10.5.2、頁面請求示例

<input type="button" value="測試使用@ResponseBody註解響應瀏覽器json格式的數據" onclick="testResponseBody()">

<script type="text/javascript">
    function testResponseBody() {
        // 實例化 XMLHttpRequest 對象
        var xhr = new XMLHttpRequest()

        // 設置請求方式和請求路徑
        // 因為thymeleaf語法只能應用於html的屬性，所以在js中的請求要包含上下文信息
        xhr.open("get","/spring_mvc_ajax/test/ResponseBody/json")

        // 設置請求頭
        // 一般 get 不需要設置，而 post 必須設置請求頭

        // 發送請求
        xhr.send()

        // 設置 XMLHttpRequest 對象狀態變化事件的處理函數
        xhr.onreadystatechange = function () {
            // readyState的值為4時，表示已獲取到伺服器的響應
            if (xhr.readyState == 4){
                // 在瀏覽器控制台輸出伺服器響應的內容
                // JSON.parse()用來將JSON字元串，解析成字元串描述的JavaScript值或對象
                console.log(JSON.parse(xhr.responseText))
            }
        }
    }
</script>

10.5.3、Java對象與Json數據的轉換關係

Java對象	Json數據
實體類	Json對象
map集合	Json對象
list集合	Json數組

10.5.4、控制器方法示例(實體類)

使用@ResponseBody註解，可以取代將Java對象通過第三方類庫轉換為Json字元串的繁瑣過程

    @RequestMapping("/test/ResponseBody/json")
    @ResponseBody
    public User testResponseBodyjson(){
        User user = new User(1001, "admin", "123456", 28, "男");
        return user;
    }

10.5.5、測試效果(實體類)

10.5.6、控制器方法示例(map集合)

    @RequestMapping("/test/ResponseBody/json")
    @ResponseBody
    public Map<String,Object> testResponseBodyjson(){
        User user1 = new User(1001, "admin1", "123456", 28, "男");
        User user2 = new User(1002, "admin2", "123456", 28, "男");
        User user3 = new User(1003, "admin3", "123456", 28, "男");
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("1001",user1);
        map.put("1002",user2);
        map.put("1003",user3);
        return map;
    }

10.5.7、測試效果(map集合)

10.5.8、控制器方法示例(list集合)

    @RequestMapping("/test/ResponseBody/json")
    @ResponseBody
    public List<User> testResponseBodyjson(){
        User user1 = new User(1001, "admin1", "123456", 28, "男");
        User user2 = new User(1002, "admin2", "123456", 28, "男");
        User user3 = new User(1003, "admin3", "123456", 28, "男");
        LinkedList<User> users = new LinkedList<User>();
        users.add(user1);
        users.add(user2);
        users.add(user3);
        return users;
    }

10.5.9、測試效果(list集合)

與map集合轉換後的json相比，list集合轉換後的json外面用的是中括弧（數組的符號），而且還有長度

![image](https://img2023.cnblogs.com/blog/2052479/202311/2052479-20231101173920863-1481359634.png

10.6、@RestController註解

@RestController 註解是springMVC提供的一個複合註解；
其標識的位置是在類上面；
其效果相當於為類添加了 @Controller 註解，並且為其中的所有方法都添加了 @ResponseBody 註解

@Controller
public class TestAjaxController {

    @RequestMapping("/test/ResponseBody")
    @ResponseBody
    public String testResponseBody(){
        return "success";
    }

    @RequestMapping("/test/ResponseBody/json")
    @ResponseBody
    public User testResponseBodyjson(){
        User user = new User(1001, "admin", "123456", 28, "男");
        return user;
    }

}

@RestController
public class TestAjaxController {

    @RequestMapping("/test/ResponseBody")
    public String testResponseBody(){
        return "success";
    }

    @RequestMapping("/test/ResponseBody/json")
    public User testResponseBodyjson(){
        User user = new User(1001, "admin", "123456", 28, "男");
        return user;
    }

}

本文來自博客園，作者：Javaer1995，轉載請註明原文鏈接：https://www.cnblogs.com/Javaer1995/p/17792497.html