SpringMVC實(shí)現(xiàn)獲取請求參數(shù)方法詳解

更新時間：2022年09月28日 08:53:54 作者：搗蛋孩學(xué)編程

Spring MVC 是 Spring 提供的一個基于 MVC 設(shè)計(jì)模式的輕量級 Web 開發(fā)框架，本質(zhì)上相當(dāng)于 Servlet，Spring MVC 角色劃分清晰，分工明細(xì)，這篇文章主要介紹了SpringMVC實(shí)現(xiàn)獲取請求參數(shù)方法

1、通過ServletAPI獲取

將HttpServletRequest作為控制器方法的形參，此時HttpServletRequest類型的參數(shù)表示封裝了當(dāng)前請求的請求報(bào)文的對象

<a th:href="@{/testServletAPI(username='admin',password=123456)}" rel="external nofollow" >測試使用testServletAPI獲取請求參數(shù)</a>

    @RequestMapping("/testServletAPI")
    //形參位置的request就表示當(dāng)前請求
    public String testServletAPI(HttpServletRequest request){
        String username = request.getParameter("username");
        String password = request.getParameter("password");
        System.out.println("username:"+username+",password:"+password);
        return "success";
    }

輸出：username:admin,password:123456

2、通過控制器方法的形參獲取請求參數(shù)

在控制器方法的形參位置，設(shè)置和請求參數(shù)同名的形參，當(dāng)瀏覽器發(fā)送請求，匹配到請求映射時，在DispatcherServlet中就會將請求參數(shù)賦值給相應(yīng)的形參

常見：

<a th:href="@{/testParam(username='admin',password=123456)}" rel="external nofollow" >測試通過控制器方法的形參獲取請求參數(shù)</a><br>

    @RequestMapping("/testParam")
    //必須保證形參名和請求傳遞的參數(shù)名一致
    public String testParam(String username, String password){
        System.out.println("username:"+username+",password:"+password);
        return "success";
    }

有多個同名參數(shù)（例如復(fù)選框）:

<form th:action="@{/testParam}" method="get">
    用戶名：<input type="text" name="username"><br>
    密碼：<input type="password" name="password"><br>
    愛好：<input type="checkbox" name="hobby" value="a">a
        <input type="checkbox" name="hobby" value="b">b
        <input type="checkbox" name="hobby" value="c">c<br>
    <input type="submit" value="測試通過控制器方法的形參獲取多個同名請求參數(shù)">
</form>

    @RequestMapping("/testParam")
    //必須保證形參名和請求傳遞的參數(shù)名一致
    public String testParam(String username, String password,String hobby){
        System.out.println("username:"+username+",password:"+password+",hobby:"+hobby);
        return "success";
    }

    @RequestMapping("/testParam")
    //必須保證形參名和請求傳遞的參數(shù)名一致
    public String testParam(String username, String password,String[] hobby){
        System.out.println("username:"+username+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        return "success";
    }

注：

若請求所傳輸?shù)恼埱髤?shù)中有多個同名的請求參數(shù)，此時可以在控制器方法的形參中設(shè)置字符串?dāng)?shù)組或者字符串類型的形參接收此請求參數(shù)

若使用字符串?dāng)?shù)組類型的形參，此參數(shù)的數(shù)組中包含了每一個數(shù)據(jù)：hobby:[a, b]

若使用字符串類型的形參，此參數(shù)的值為每個數(shù)據(jù)中間使用逗號拼接的結(jié)果：hobby:a,b

3、@RequestParam

@RequestParam是將請求參數(shù)和控制器方法的形參創(chuàng)建映射關(guān)系

    @RequestMapping("/testParam")
    //當(dāng)形參名和請求參數(shù)名不一致時，通過注解@RequestParam綁定形參和請求參數(shù)
    public String testParam(
            @RequestParam("username") String user_name,
            String password,
            String[] hobby){
        System.out.println("user_name:"+user_name+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        return "success";
    }

輸出：user_name:admin,password:123456,hobby:[a, b, c]

@RequestParam注解一共有三個屬性：

value：指定為形參賦值的請求參數(shù)的參數(shù)名

required：設(shè)置是否必須傳輸此請求參數(shù)，默認(rèn)值為true

若設(shè)置為true時，則當(dāng)前請求必須傳輸value所指定的請求參數(shù)，若沒有傳輸該請求參數(shù)，且沒有設(shè)置defaultValue屬性，則頁面報(bào)錯400：Required String parameter 'xxx' is not present；

若設(shè)置為false，則當(dāng)前請求不是必須傳輸value所指定的請求參數(shù)，若沒有傳輸，則注解所標(biāo)識的形參的值為null

defaultValue：不管required屬性值為true或false，當(dāng)value所指定的請求參數(shù)沒有傳輸或傳輸?shù)闹禐?quot;"時，則使用默認(rèn)值為形參賦值

4、@RequestHeader

@RequestHeader是將請求頭信息和控制器方法的形參創(chuàng)建映射關(guān)系

    @RequestMapping("/testParam")
    //當(dāng)形參名和請求參數(shù)名不一致時，通過注解@RequestParam綁定形參和請求參數(shù)
    public String testParam(
            @RequestParam("username") String user_name,
            String password,
            String[] hobby,
            //通過注解@RequestHeader將請求頭信息和控制器方法的形參創(chuàng)建映射關(guān)系
            @RequestHeader("Host") String host){
        System.out.println("user_name:"+user_name+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        System.out.println("host:"+host);
        return "success";
    }

輸出：

user_name:admin,password:123456,hobby:[a, b, c]

host:localhost:8080

@RequestHeader注解一共有三個屬性：value、required、defaultValue，用法同@RequestParam

5、@CookieValue

@CookieValue是將cookie數(shù)據(jù)和控制器方法的形參創(chuàng)建映射關(guān)系

    @RequestMapping("/testParam")
    //當(dāng)形參名和請求參數(shù)名不一致時，通過注解@RequestParam綁定形參和請求參數(shù)
    public String testParam(
            @RequestParam("username") String user_name,
            String password,
            String[] hobby,
            //通過注解@RequestHeader將請求頭信息和控制器方法的形參創(chuàng)建映射關(guān)系
            @RequestHeader("Host") String host,
            //通過注解@CookieValue將cookie數(shù)據(jù)和控制器方法的形參創(chuàng)建映射關(guān)系
            @CookieValue("JSESSIONID") String JSESSIONID){
        System.out.println("user_name:"+user_name+",password:"+password+",hobby:"+ Arrays.toString(hobby));
        System.out.println("host:"+host);
        System.out.println("JSESSIONID:"+JSESSIONID);
        return "success";
    }

輸出：

user_name:admin,password:123456,hobby:[a, b, c]

host:localhost:8080 JSESSIONID:005A829F9D7222CEA96E9EF6F86B8F58

@CookieValue注解一共有三個屬性：value、required、defaultValue，用法同@RequestParam

6、通過POJO獲取請求參數(shù)

可以在控制器方法的形參位置設(shè)置一個實(shí)體類類型的形參，此時若瀏覽器傳輸?shù)恼埱髤?shù)的參數(shù)名和實(shí)體類中的屬性名一致，那么請求參數(shù)就會為此屬性賦值

public class User {
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private String sex;
    private String email;
    public User() {
    }
    public User(Integer id, String username, String password, Integer age, String sex, String email) {
        this.id = id;
        this.username = username;
        this.password = password;
        this.age = age;
        this.sex = sex;
        this.email = email;
    }
    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 getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", age=" + age +
                ", sex='" + sex + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

<form th:action="@{/testPojo}" method="get">
    用戶名：<input type="text" name="username"><br>
    密碼：<input type="password" name="password"><br>
    性別：<input type="radio" name="sex" value="男">男<input type="radio" name="sex" value="女">女<br>
    年齡：<input type="text" name="age"><br>
    郵箱：<input type="text" name="email"><br>
    <input type="submit" value="測試通過POJO獲取請求參數(shù)">
</form>

    @RequestMapping("/testPojo")
    public String testPOJO(User user){
        System.out.println(user);
        return "success";
    }

輸出：User{id=null, username='admin', password='123', age=22, sex='男', email='125jugyg@163.com'}

7、解決獲取請求參數(shù)的亂碼問題

上述通過POJO獲取請求參數(shù)時，如果使用get方式不會亂碼（Tomcat8以上已經(jīng)解決了get亂碼問題），但是使用post方式獲取時還是會亂碼

<form th:action="@{/testPojo}" method="post">
    用戶名：<input type="text" name="username"><br>
    密碼：<input type="password" name="password"><br>
    性別：<input type="radio" name="sex" value="男">男<input type="radio" name="sex" value="女">女<br>
    年齡：<input type="text" name="age"><br>
    郵箱：<input type="text" name="email"><br>
    <input type="submit" value="測試通過POJO獲取請求參數(shù)">
</form>

輸出：

User{id=null, username='admin', password='123', age=22, sex='ç·', email='125jugyg@163.com'}

解決獲取請求參數(shù)的亂碼問題，可以使用SpringMVC提供的編碼過濾器CharacterEncodingFilter，但是必須在web.xml中進(jìn)行注冊

    <!--配置springMVC的編碼過濾器-->
    <filter>
<!--        過濾器名稱自定義-->
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
<!--            初始化所需編碼，請求編碼直接設(shè)置-->
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
<!--            只需要設(shè)置響應(yīng)編碼，請求編碼已經(jīng)在初始化參數(shù)時設(shè)置-->
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
<!--        所有請求地址均可用-->
        <url-pattern>/*</url-pattern>
    </filter-mapping>

再次發(fā)送post請求無亂碼