Spring MVC 請求參數綁定例子（轉）

本文轉載自查看原文 2019-12-25 17:44 774 后台框架

出處： SpringMVC參數綁定，這篇就夠了！

　　　 [Spring MVC] - SpringMVC的各種參數綁定方式

SpringMVC參數綁定，簡單來說就是將客戶端請求的key/value數據綁定到controller方法的形參上，然后就可以在controller中使用該參數了

下面通過5個常用的注解演示下如何進行參數綁定：

1. @PathVariable注解

　　@PathVariable 是用來獲得請求url中的動態參數的，可以將URL中的變量映射到功能處理方法的參數上，其中URL 中的 {xxx} 占位符可以通過@PathVariable(“xxx“) 綁定到操作方法的入參中。

示例代碼：

　　 @ResponseBody
    @RequestMapping("/testUrlPathParam/{param1}/{param2}")
    public void testUrlPathParam(HttpServletRequest request, @PathVariable String param1,
                                 @PathVariable String param2) {
        System.out.println("通過PathVariable獲取的參數param1=" + param1);
        System.out.println("通過PathVariable獲取的參數param2=" + param2);
    }

Postman發送請求截圖：

發送請求截圖

輸出結果：

通過PathVariable獲取的參數param1=1
通過PathVariable獲取的參數param2=2

2.@RequestHeader注解

　　@RequestHeader 注解，可以把Request請求header部分的值綁定到方法的參數上。

示例代碼：

    @ResponseBody
    @RequestMapping("/testHeaderParam")
    public void testHeaderParam(HttpServletRequest request, @RequestHeader String param1) {
        System.out.println("通過RequestHeader獲取的參數param1=" + param1);
    }

Postman發送請求截圖：

發送請求截圖

輸出結果：

通過RequestHeader獲取的參數param1=abc

3.@CookieValue注解

　　@CookieValue 可以把Request header中關於cookie的值綁定到方法的參數上。

示例代碼：

    @ResponseBody
    @RequestMapping("/testCookieParam")
    public void testCookieParam(HttpServletRequest request, HttpServletResponse response,
                                  @CookieValue String sessionid) {
        System.out.println("通過CookieValue獲取的參數sessionid=" + sessionid);
    }

Postman發送請求截圖：

發送請求截圖

輸出結果：

通過CookieValue獲取的參數sessionid=ebef978eef6c46f8a95cc0990d2d360a

4.@RequestParam注解

　　@RequestParam注解用來處理Content-Type: 為 application/x-www-form-urlencoded編碼的內容。提交方式為get或post。（Http協議中，form的enctype屬性為編碼方式，常用有兩種：application/x-www-form-urlencoded和multipart/form-data，默認為application/x-www-form-urlencoded）；

　　@RequestParam注解實質是將Request.getParameter() 中的Key-Value參數Map利用Spring的轉化機制ConversionService配置，轉化成參數接收對象或字段，
get方式中queryString的值，和post方式中body data的值都會被Servlet接受到並轉化到Request.getParameter()參數集中，所以@RequestParam可以獲取的到；

　　該注解有三個屬性： value、required、defaultValue； value用來指定要傳入值的id名稱，required用來指示參數是否必錄，defaultValue表示參數不傳時候的默認值。

示例代碼：

    @ResponseBody
    @RequestMapping("/testRequestParam")
    public void testRequestParam(HttpServletRequest request,
                                   @RequestParam(value = "num", required = true, defaultValue = "0") int num) {
        System.out.println("通過RequestParam獲取的參數num=" + num);
    }

Postman發送請求截圖：

輸出結果：

通過RequestParam獲取的參數num=10

5.@RequestBody注解

　　@RequestBody注解用來處理HttpEntity（請求體）傳遞過來的數據，一般用來處理非Content-Type: application/x-www-form-urlencoded編碼格式的數據；

　　GET請求中，因為沒有HttpEntity，所以@RequestBody並不適用；

　　POST請求中，通過HttpEntity傳遞的參數，必須要在請求頭中聲明數據的類型Content-Type，SpringMVC通過使用HandlerAdapter配置的HttpMessageConverters來解析HttpEntity中的數據，然后綁定到相應的bean上。

示例代碼：

    @ResponseBody
    @RequestMapping("/testRequestBody")
    public void testRequestBody(HttpServletRequest request, @RequestBody String bodyStr){
        System.out.println("通過RequestBody獲取的參數bodyStr=" + bodyStr);
    }

Postman發送請求截圖：

發送請求截圖

代碼運行結果：

通過RequestBody獲取的參數bodyStr=這是body的內容

SpringMVC的各種參數綁定方式

1. 基本數據類型(以int為例，其他類似)：
Controller代碼：

@RequestMapping("saysth.do")
    public void test(int count) {
}

表單代碼：

<form action="saysth.do" method="post">
    <input name="count" value="10" type="text"/>
    ......
</form>

　　表單中input的name值和Controller的參數變量名保持一致，就能完成數據綁定，如果不一致可以使用@RequestParam注解。需要注意的是，如果Controller方法參數中定義的是基本數據類型，但是從頁面提交過來的數據為null或者”"的話，會出現數據轉換的異常。也就是必須保證表單傳遞過來的數據不能為null或”"，所以，在開發過程中，對可能為空的數據，最好將參數數據類型定義成包裝類型，具體參見下面的例子。

2. 包裝類型(以Integer為例，其他類似)：
Controller代碼：

@RequestMapping("saysth.do")
public void test(Integer count) {
}

表單代碼：

<form action="saysth.do" method="post">
    <input name="count" value="10" type="text"/>
    ......
</form>

　　和基本數據類型基本一樣，不同之處在於，表單傳遞過來的數據可以為null或”"，以上面代碼為例，如果表單中num為”"或者表單中無num這個input，那么，Controller方法參數中的num值則為null。

3. 自定義對象類型：
Model代碼：

public class User {
    private String firstName;
    private String lastName;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

Controller代碼：

@RequestMapping("saysth.do")
public void test(User user) {
}

表單代碼：

<form action="saysth.do" method="post">
    <input name="firstName" value="張" type="text"/>
    <input name="lastName" value="三" type="text"/>
    ......
</form>

非常簡單，只需將對象的屬性名和input的name值一一匹配即可。

4. 自定義復合對象類型：
Model代碼：

public class ContactInfo {
    private String tel;
    private String address;

    public String getTel() {
        return tel;
    }

    public void setTel(String tel) {
        this.tel = tel;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

}

public class User {
    private String firstName;
    private String lastName;
    private ContactInfo contactInfo;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public ContactInfo getContactInfo() {
        return contactInfo;
    }

    public void setContactInfo(ContactInfo contactInfo) {
        this.contactInfo = contactInfo;
    }

}

Controller代碼：

@RequestMapping("saysth.do")
public void test(User user) {
    System.out.println(user.getFirstName());
    System.out.println(user.getLastName());
    System.out.println(user.getContactInfo().getTel());
    System.out.println(user.getContactInfo().getAddress());
}

表單代碼：

<form action="saysth.do" method="post">
    <input name="firstName" value="張" /><br>
    <input name="lastName" value="三" /><br>
    <input name="contactInfo.tel" value="13809908909" /><br>
    <input name="contactInfo.address" value="北京海淀" /><br>
    <input type="submit" value="Save" />
</form>

User對象中有ContactInfo屬性，Controller中的代碼和第3點說的一致，但是，在表單代碼中，需要使用“屬性名(對象類型的屬性).屬性名”來命名input的name。

5. List綁定：
List需要綁定在對象上，而不能直接寫在Controller方法的參數中。
Model代碼：

public class User {
    private String firstName;
    private String lastName;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

}

public class UserListForm {
    private List<User> users;

    public List<User> getUsers() {
        return users;
    }

    public void setUsers(List<User> users) {
        this.users = users;
    }

}

Controller代碼：

@RequestMapping("saysth.do")
public void test(UserListForm userForm) {
    for (User user : userForm.getUsers()) {
        System.out.println(user.getFirstName() + " - " + user.getLastName());
    }
}

表單代碼：

<form action="saysth.do" method="post">
    <table>
        <thead>
            <tr>
                <th>First Name</th>
                <th>Last Name</th>
            </tr>
        </thead>
        <tfoot>
            <tr>
                <td colspan="2"><input type="submit" value="Save" /></td>
            </tr>
        </tfoot>
        <tbody>
            <tr>
                <td><input name="users[0].firstName" value="aaa" /></td>
                <td><input name="users[0].lastName" value="bbb" /></td>
            </tr>
            <tr>
                <td><input name="users[1].firstName" value="ccc" /></td>
                <td><input name="users[1].lastName" value="ddd" /></td>
            </tr>
            <tr>
                <td><input name="users[2].firstName" value="eee" /></td>
                <td><input name="users[2].lastName" value="fff" /></td>
            </tr>
        </tbody>
    </table>
</form>

　　其實，這和第4點User對象中的contantInfo數據的綁定有點類似，但是這里的UserListForm對象里面的屬性被定義成List，而不是普通自定義對象。所以，在表單中需要指定List的下標。值得一提的是，Spring會創建一個以最大下標值為size的List對象，所以，如果表單中有動態添加行、刪除行的情況，就需要特別注意，譬如一個表格，用戶在使用過程中經過多次刪除行、增加行的操作之后，下標值就會與實際大小不一致，這時候，List中的對象，只有在表單中對應有下標的那些才會有值，否則會為null，看個例子：

表單代碼：

<form action="saysth.do" method="post">
    <table>
        <thead>
            <tr>
            <th>First Name</th>
            <th>Last Name</th>
            </tr>
        </thead>
        <tfoot>
            <tr>
                <td colspan="2"><input type="submit" value="Save" /></td>
            </tr>
        </tfoot>
        <tbody>
            <tr>
                <td><input name="users[0].firstName" value="aaa" /></td>
                <td><input name="users[0].lastName" value="bbb" /></td>
            </tr>
            <tr>
                <td><input name="users[1].firstName" value="ccc" /></td>
                <td><input name="users[1].lastName" value="ddd" /></td>
            </tr>
            <tr>
                <td><input name="users[20].firstName" value="eee" /></td>
                <td><input name="users[20].lastName" value="fff" /></td>
            </tr>
        </tbody>
    </table>
</form>

這個時候，Controller中的userForm.getUsers()獲取到List的size為21，而且這21個User對象都不會為null，但是，第2到第19的User對象中的firstName和lastName都為null。打印結果：

aaa - bbb
ccc - ddd
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
null - null
eee - fff

6. Set綁定：
Set和List類似，也需要綁定在對象上，而不能直接寫在Controller方法的參數中。但是，綁定Set數據時，必須先在Set對象中add相應的數量的模型對象。
Model代碼：

public class User {
    private String firstName;
    private String lastName;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

}

public class UserSetForm {
    private Set<User> users = new HashSet<User>();

    public UserSetForm() {
        users.add(new User());
        users.add(new User());
        users.add(new User());
    }

    public Set<User> getUsers() {
        return users;
    }

    public void setUsers(Set<User> users) {
        this.users = users;
    }

}

Controller代碼：

@RequestMapping("saysth.do")
public void test(UserSetForm userForm) {
    for (User user : userForm.getUsers()) {
        System.out.println(user.getFirstName() + " - " + user.getLastName());
    }
}

表單代碼：

<form action="saysth.do" method="post">
    <table>
        <thead>
            <tr>
                <th>First Name</th>
                <th>Last Name</th>
            </tr>
        </thead>
        <tfoot>
            <tr>
                <td colspan="2"><input type="submit" value="Save" /></td>
            </tr>
        </tfoot>
        <tbody>
            <tr>
                <td><input name="users[0].firstName" value="aaa" /></td>
                <td><input name="users[0].lastName" value="bbb" /></td>
            </tr>
            <tr>
                <td><input name="users[1].firstName" value="ccc" /></td>
                <td><input name="users[1].lastName" value="ddd" /></td>
            </tr>
            <tr>
                <td><input name="users[2].firstName" value="eee" /></td>
                <td><input name="users[2].lastName" value="fff" /></td>
            </tr>
        </tbody>
    </table>
</form>

基本和List綁定類似。
需要特別提醒的是，如果最大下標值大於Set的size，則會拋出org.springframework.beans.InvalidPropertyException異常。所以，在使用時有些不便。

7. Map綁定：
Map最為靈活，它也需要綁定在對象上，而不能直接寫在Controller方法的參數中。
Model代碼：

public class User {
    private String firstName;
    private String lastName;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

}

public class UserMapForm {
    private Map<String, User> users;

    public Map<String, User> getUsers() {
        return users;
    }

    public void setUsers(Map<String, User> users) {
        this.users = users;
    }

}

Controller代碼：

@RequestMapping("saysth.do")
public void test(UserMapForm userForm) {
    for (Map.Entry<String, User> entry : userForm.getUsers().entrySet()) {
        System.out.println(entry.getKey() + ": " + entry.getValue().getFirstName() + " - " +
        entry.getValue().getLastName());
    }
}

表單代碼：

<form action="saysth.do" method="post">
    <table>
        <thead>
            <tr>
                <th>First Name</th>
                <th>Last Name</th>
            </tr>
        </thead>
        <tfoot>
            <tr>
                <td colspan="2"><input type="submit" value="Save" /></td>
            </tr>
        </tfoot>
        <tbody>
            <tr>
                <td><input name="users['x'].firstName" value="aaa" /></td>
                <td><input name="users['x'].lastName" value="bbb" /></td>
            </tr>
            <tr>
                <td><input name="users['y'].firstName" value="ccc" /></td>
                <td><input name="users['y'].lastName" value="ddd" /></td>
            </tr>
            <tr>
                <td><input name="users['z'].firstName" value="eee" /></td>
                <td><input name="users['z'].lastName" value="fff" /></td>
            </tr>
        </tbody>
    </table>
</form>

打印結果：

x: aaa - bbb
y: ccc - ddd
z: eee - fff

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 Spring MVC的各種參數綁定方式（請求參數用基礎類型和包裝類型的區別）（轉） Spring MVC 參數的綁定方法 [Spring MVC] - SpringMVC的各種參數綁定方式 Spring MVC 接收HTTP請求參數的注解 spring mvc 獲取請求中參數方式 Spring MVC如何獲取請求中的參數 .NET：自動將請求參數綁定到ASPX、ASHX和MVC（菜鳥必看） spring(spring mvc)整合WebSocket案例（獲取請求參數） Spring MVC的Post請求參數中文亂碼的原因&處理 Spring MVC 之請求處理方法可接收參數(三)