【SpringMVC】4. 獲取Http的請求資訊或請求頭
注意!!!
此文章需要配置了SpringDispatcherServlet
和InternalResourceViewResolver
才能夠使用,如果不會配置,請翻看我【SpringMVC】系列的第一篇文章《【SpringMVC】1. SpringMVC的第一個程式——HelloWorld》
##一、什麼是請求地址資訊
我們在訪問網頁的過程中,總會看到類似於下面這樣的連結:
http://localhost:8080/springmvc-1/springmvc/testRequestParam?username=ben&age=11
請注意地址紅色標記的部分,格式類似於?屬性=屬性值
,這樣子的鍵值對能夠在網頁和網頁,或者網頁互伺服器之間傳遞引數資訊,一般儲存在request作用域。
Spring MVC 通過分析處理方法的簽名,將 HTTP 請求信 息繫結到處理方法的相應入參中。
- Spring MVC 對控制器處理方法簽名的限制是很寬鬆的, 幾乎可以按喜歡的任何方式對方法進行簽名。
- 必要時可以對方法及方法入參標註相應的註解(
@PathVariable
、@RequestParam
、@RequestHeader
等)、Spring MVC 框架會將 HTTP 請求的資訊繫結到相應的方法入參 中,並根據方法的返回值型別做出相應的後續處理。
##二、SpringMVC能夠獲取請求資訊的註解
注意!!!
此處為知識點解釋,請下翻本文章配合程式碼和程式碼註釋進行閱讀,基本一個Handler方法對應一個註解的使用。
###(1)@PathVariable
@RequestParam
@RequestParam
相關的屬性及屬性值
屬性 | 屬性值 |
---|---|
value | 引數名 |
required | 是否必須。預設為 true , 表示請求引數中必須包含對應的引數,若不存在,將丟擲異常 |
@RequestHeader
相關的屬性及屬性值和@RequestParam
屬性 | 屬性值 |
---|---|
value | 引數名 |
required | 是否必須。預設為 true , 表示請求引數中必須包含對應的引數,若不存在,將丟擲異常 |
請求頭的相關請求欄位(資料源於:維基百科——《HTTP頭欄位》)
###(4)@CookieValue
獲得請求Cookie的資訊 用法和@RequestParam
相同
屬性 | 屬性值 |
---|---|
value | 引數名 |
required | 是否必須。預設為 true , 表示請求引數中必須包含對應的引數,若不存在,將丟擲異常 |
POJO(Plain Ordinary Java Object)簡單的Java物件,實際就是普通JavaBeans,是為了避免和EJB混淆所創造的簡稱。 使用POJO名稱是為了避免和EJB混淆起來, 而且簡稱比較直接. 其中有一些屬性及其getter setter方法的類,沒有業務邏輯,有時可以作為VO(value -object)或dto(Data Transform Object)來使用.當然,如果你有一個簡單的運算屬性也是可以的,但不允許有業務方法,也不能攜帶有connection之類的方法。 ——百度百科《POJO》
簡單來說,它是一個普通的Java類,也就是和JavaBean差不多,POJO只能有私有的全域性變數,Getter、Setter方法,但是不能再出現其他方法,而JavaBean還能夠在POJO的基礎上加入其他東西,在嚴格程度上,POJO比JavaBean嚴格。。
####2.如何使用 POJO 物件繫結請求引數值
SpringMvc會按引數名和Pojo屬性名進行匹配,自動為該物件填充屬性值,支援級聯屬性。
也就是說,只需要在Controller層的某個Handler方法的形參中放入POJO
類即可,SpringMVC就會自動為對應POJO類裡面的同名屬性進行賦值。
###(6)使用 Servlet API
作為入參
Servlet 原生API作為形參,springMVC的Handler方法可以接受下列型別的引數:
- HttpServletRequest
- HttpServletResponse
- HttpSession
- java.security.Principal
- Locale
- InputStream
- OutputStream
- Reader
- Writer
##三、相關程式碼
###1.在com.springmvc.entities
建立兩個POJO類User
和Address
User.java
package com.springmvc.entities;
public class User {
private Integer id;
private String username;
private String password;
private String email;
private int age;
private Address address;
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 String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public Address getAddress() {
return address;
}
public void setAddress(Address address) {
this.address = address;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", password=" + password + ", email=" + email + ", age="
+ age + "]";
}
public User(Integer id, String username, String password, String email, int age) {
super();
this.id = id;
this.username = username;
this.password = password;
this.email = email;
this.age = age;
}
public User(String username, String password, String email, int age) {
super();
this.username = username;
this.password = password;
this.email = email;
this.age = age;
}
public User() {
}
}
Address.java
package com.springmvc.entities;
public class Address {
private String province;
private String city;
public String getProvince() {
return province;
}
public void setProvince(String province) {
this.province = province;
}
public String getCity() {
return city;
}
public void setCity(String city) {
this.city = city;
}
@Override
public String toString() {
return "Address [province=" + province + ", city=" + city + "]";
}
}
###2. 在`com.springmvc.handlers`建立一個名為`SpringMVCTest`的Handler類
package com.springmvc.handlers;
import java.io.IOException;
import java.io.Writer;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.SessionAttributes;
import org.springframework.web.servlet.ModelAndView;
import com.springmvc.entities.User;
@RequestMapping("/springmvc")
@Controller
public class SpringMVCTest {
private static final String SUCCESS = "success";
/*
* @RequestParam 來對映請求引數 value 值即請求引數的引數名 required 該引數是否必須,預設為true
* defaultValue 請求引數的預設值
*/
@RequestMapping(value = "/testRequestParam")
public String testRequestParam(@RequestParam(value = "username", required = false) String username,
@RequestParam(value = "age", required = false, defaultValue = "0") Integer age) {
System.out.println("testRequestParam,user:" + username + ";age:" + age);
return SUCCESS;
}
/*
* 對映請求頭資訊 用法和@requestParam相同
*/
@RequestMapping("/testRequestHeader")
public String testRequestHeader(@RequestHeader("Accept-Language") String al) {
System.out.println("testRequestHeader,Accept-Language:" + al);
return SUCCESS;
}
/*
* 請求Cookie的資訊 用法和@RequestParam相同
* 每個cookie在建立的時候都會有一個獨一無二的JSESSIONID
*/
@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue("JSESSIONID") String id) {
System.out.println("testCookieValue,JSESSionId:" + id);
return SUCCESS;
}
/*
* SpringMvc會按引數名和Pojo屬性名進行匹配,自動為該物件填充屬性值,支援級聯屬性,如dept.deptid、dept.
* deptaddress.tel等
*/
@RequestMapping("/testPojo")
public String testPojo(User user) {
System.out.println("Test Pojo:" + user);
return SUCCESS;
}
/*
* 可以使用原生的ServletAPI作為目標方法的引數,具體支援以下型別 HttpServletRequest
* HttpServletResponse HttpSession java.security.Principal Locale
* InputStream OutputStream Reader Writer
*/
@RequestMapping("/testServletAPI")
public void testServletAPI(HttpServletRequest request, HttpServletResponse response, Writer out)
throws IOException {
System.out.println("testServletAPI,request:" + request + ",response:" + response);
out.write("Hello SpringMVC");
}
}
###3.在WebRoot的根目錄下建立`index.jsp`
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>My JSP 'index.jsp' starting page</title>
</head>
<body>
<a href="springmvc/testRequestParam?username=ben&age=11">Test RequestParam</a>
<br>
<br>
<a href="springmvc/testRequestHeader">Test RequestHeader</a>
<br>
<br>
<a href="springmvc/testCookieValue">Test CookieValue</a>
-------------------------------------------------------------------<br><br>
<form action="springmvc/testPojo">
username:<input type="text" name="username">
<br>
passowrd:<input type="password" name="password">
<br>
Email:<input type="email" name="email">
<br>
age:<input type="number" name="age">
<br>
city:<input type="text" name="Address.city">
<br>
province:<input type="text" name="Address.province">
<br>
<input type="submit">
</form>
<br>-------------------------------------------------------------------<br>
<a href="springmvc/testServletAPI">testServletAPI</a>
</body>
</html>
###4.在`WEB-INF`資料夾下建立views,並在views下建立`success.jsp`檔案
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>success</title>
</head>
<body>
<h1>Success page</h1>
time:${requestScope.time }
<br>-----------------------------------------
<br> names:${requestScope.names }
<br>-----------------------------------------
<br> request user:${requestScope.user }
<br>-----------------------------------------
<br> session user:${sessionScope.user }
<br>-----------------------------------------
<br><fmt:message key="i18n.username"></fmt:message>
<br>-----------------------------------------<br>
<fmt:message key="i18n.password"></fmt:message>
</body>
</html>