SpringMVC中請求參數(shù)的獲取方式

更新時(shí)間：2022年05月30日 08:42:05 作者：把蘋果咬哭的測試筆記

這篇文章主要為大家介紹了SpringMVC中請求參數(shù)的獲取方式，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

SpringMVC請求參數(shù)獲取方式

一、通過 ServletAPI 獲取

可以使用原生 Servlet 獲取請求參數(shù)，將 HttpServletRequest 作為控制器方法的形參，此時(shí) HttpServletRequest 類型的參數(shù)表示封裝了當(dāng)前請求的請求報(bào)文的對象。

有兩種常用的方法。

使用 getParameter()方法獲取指定字段的值，如果有重名的字段，只獲取第一個(gè)。

@RequestMapping("/testParam")
public String testParam(HttpServletRequest request){
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    System.out.println("username:"+username+",password:"+password);
    return "success";
}

如果要獲取同字段的多個(gè)值，使用request.getParameterValues()方法，比如：

<form name="checkform" method="post" action="getvalue.jsp">    
    你希望學(xué)習(xí)哪些程式語言：<br>    
    <input type="checkbox" name="langtype" value="JSP">JSP　    
    <input type="checkbox" name="langtype" value="PHP">PHP　    
    <input type="checkbox" name="langtype" value="PERL">PERL    
    <input type="submit" name="b1" value="送出">    
    </form>

這個(gè) form 表單中，幾個(gè) input type 的 name 都叫做 langtype，用getParameterValues("langtype")，得到字符串類型的數(shù)組。

二、通過控制器方法的形參獲取

在控制器方法的形參位置，設(shè)置和請求參數(shù)同名的形參。

當(dāng)瀏覽器發(fā)送請求，匹配到請求映射時(shí)，在 DispatcherServlet 中就會將請求參數(shù)賦值給相應(yīng)的形參。

@RequestMapping("/testParam")
    public String testParam(String username, String password){
        System.out.println("username:" + username + ",password:" + password);
        return "success";
    }

在頁面中發(fā)起請求：

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>測試請求參數(shù)</title>
</head>
<body>
    <h1>測試請求參數(shù)</h1>
    <a th:href="@{/testParam(username='admin',password=123456)}">測試獲取請求參數(shù)-->/testParam</a><br>
</body>
</html>

查看 idea 的控制器輸出日志，可以看到成功獲取到了形參對應(yīng)位置的請參數(shù)。

處理多個(gè)同名的請求參數(shù)

使用 springmvc 也會遇到多個(gè)參數(shù)同名的請求，還是用一個(gè)表單來說明，里面有一個(gè)復(fù)選框：

<form th:action="@{/testParam}" method="post">
        用戶名：<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="提交">
    </form>

對應(yīng)的在后端代碼里，增加這個(gè)新參數(shù) hobby ：

@RequestMapping("/testParam")
    public String testParam(String username, String password, String hobby){
        System.out.println("username:" + username + ",password:" + password + "hobby:" + hobby);
        return "success";
    }

現(xiàn)在勾選上3個(gè)復(fù)選框，提交請求，看下 hobby的值是什么。

可以看到，a,b,c是用逗號拼接在一起的。其實(shí)這種也可以用，只不過不太方便。

這里還可以使用另一種方法，在控制器方法的形參中設(shè)置字符串?dāng)?shù)組，這里就是String[] hobby：

@RequestMapping("/testParam")
    public String testParam(String username, String password, String[] hobby){
        System.out.println("username:" + username + ",password:" + password + ",hobby:" + Arrays.toString(hobby));
        return "success";
    }

重新提交下請求，取到的參數(shù)就是數(shù)組了，這樣取里面的單個(gè)值就方便了。

三、通過 @RequestParam 注解

在上面的控制器方法的形參獲取中，形參和請求的參數(shù)名需要一致才行，那如果不一致的情況怎么處理，那就是使用 @RequestParam 注解。

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

修改下上面的 form 表單，把參數(shù)名從 username 改成 username：

<form th:action="@{/testParam}" method="post">
        用戶名：<input type="text" name="user_name"><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="提交">
    </form>

這時(shí)候發(fā)送請求，控制器是中的形參 username 就拿不到值了。

修改后端代碼，加上 @RequestParam注解：

@RequestMapping("/testParam")
    public String testParam(@RequestParam("user_name") String username, String password, String[] hobby){
        System.out.println("username:" + username + ",password:" + password + ",hobby:" + Arrays.toString(hobby));
        return "success";
    }

重新部署執(zhí)行請求，username 可以拿到值。

在 @RequestParam 注解中有三個(gè)屬性：

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

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

若沒有傳輸該請求參數(shù)，且沒有設(shè)置 defaultValue 屬性，則頁面報(bào)錯(cuò)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;"時(shí)，則使用默認(rèn)值為形參賦值。

四、@RequestHeader 注解

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

有著與@RequestParam一樣的三個(gè)屬性：value、required、defaultValue，用法也一樣。

比如，現(xiàn)在要接受 Header 里的 Host 值，修改控制器代碼：

@RequestMapping("/testParam")
    public String testParam(@RequestParam("user_name") String username,
                                String password,
                                String[] hobby,
                            @RequestHeader("Host") String host){
        System.out.println("username:" + username +
                        ",password:" + password +
                        ",hobby:" + Arrays.toString(hobby) +
                        "host: " + host);
        return "success";

這里使用@RequestHeader("Host") String host，將 Host 與形參 host 綁定，成功獲取 Header 里 Host 的值。

五、@CookieValue 注解

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

有著與@RequestParam一樣的三個(gè)屬性：value、required、defaultValue，用法也一樣。

我在另一個(gè)請求控制器里使用 HttpSession，設(shè)置 session：

@GetMapping("/test3")
    public String testGetMapping(HttpServletRequest request) {
        HttpSession session =  request.getSession();
        return "success";
    }

當(dāng)?shù)谝淮卧L問/test3的時(shí)候，響應(yīng)報(bào)文里就會返回 JSESSIONID，key 就是 JSESSIONID，value 就是后面的隨機(jī)序列。

當(dāng)不關(guān)閉瀏覽器，繼續(xù)訪問這個(gè)頁面或者其他頁面時(shí)，JSESSIONID 就會出現(xiàn)在請求頭信息里了，比如現(xiàn)在訪問/param：

ok，繼續(xù)修改后端控制器的代碼，使用@CookieValue來獲取 cookie：

@RequestMapping("/testParam")
    public String testParam(@RequestParam("user_name") String username,
                                String password,
                                String[] hobby,
                            @RequestHeader("Host") String host,
                            @CookieValue("JSESSIONID") String jsessionid){
        System.out.println("username:" + username +
                        ",password:" + password +
                        ",hobby:" + Arrays.toString(hobby) +
                        ",host: " + host +
                        ",JSESSIONID: " + jsessionid);
        return "success";
    }

重新部署，發(fā)送請求。

查看控制臺獲取成功。

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

在具體開發(fā)的時(shí)候，可能需要實(shí)現(xiàn)某些功能，比如添加，涉及到的字段就非常的多，再像上面那樣添加就不現(xiàn)實(shí)了。

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

現(xiàn)在有個(gè)新的 form 表單：

<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">
</form>

接著新建個(gè)實(shí)體類 User：

public class User {
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private String sex;
    private String email;
... ...

后面加上構(gòu)造方法、get和set方法、toString方法。

不需要手寫，idea中右擊，再點(diǎn)擊 Generate，然后就可以選擇你要統(tǒng)一生成的代碼了。

繼續(xù)，再寫一個(gè)接收/testpojo請求的控制器：

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

注意，這里就直接使用了實(shí)體類對象 user 作為形參。

部署提交表單請求。

查看結(jié)果。

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

在上面獲取 sex 值的時(shí)候出現(xiàn)了亂碼，因?yàn)樽址幋a不一致。

可以使用 SpringMVC 提供的編碼過濾器CharacterEncodingFilter，但是必須在 web.xml中進(jìn)行注冊才可以使用。

<!--配置 springMVC 的編碼過濾器-->
<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <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>

重試看下效果。