天天看点

【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

这个注解我曾经在之前的文章《【SpringMVC】3.REST表现层状态转换》中有讲过,如有需要请点击超链接跳转过去查看。

(2)

@RequestParam

@RequestParam

相关的属性及属性值

属性 属性值
value 参数名
required 是否必须。默认为

true

, 表示请求参数中必须包含对应的参数,若不存在,将抛出异常

(3)

@RequestHeader

请求头包含了若干个属性,服务器可据此获知客户端的信 息,通过

@RequestHeader

即可将请求头中的属性值绑定到处理方法的入参中。

@RequestHeader

相关的属性及属性值和

@RequestParam

一样

属性 属性值
value 参数名
required 是否必须。默认为

true

, 表示请求参数中必须包含对应的参数,若不存在,将抛出异常

请求头的相关请求字段(资料源于:维基百科——《HTTP头字段》)

【SpringMVC】4. 获取Http的请求信息或请求头

(4)

@CookieValue

获得请求Cookie的信息 用法和

@RequestParam

相同

属性 属性值
value 参数名
required 是否必须。默认为

true

, 表示请求参数中必须包含对应的参数,若不存在,将抛出异常

(5)使用 POJO 对象绑定请求参数值

1.什么是POJO对象?

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>

           

四、实现效果

(1)在浏览器打开index.jsp

http://localhost:8080/springmvc-1/index.jsp

【SpringMVC】4. 获取Http的请求信息或请求头

(2)测试

@RequestParam

点击超链接

Test RequestParam

,超链接的地址为:

http://localhost:8080/springmvc-1/springmvc/testRequestParam?username=ben&age=11

成功跳转到

Success.jsp

【SpringMVC】4. 获取Http的请求信息或请求头

控制台成功获得地址的请求参数

username

age

(3)测试

@RequestHeader

点击超链接

Test RequestHeader

,超链接的地址为:

http://localhost:8080/springmvc-1/springmvc/testRequestHeader

【SpringMVC】4. 获取Http的请求信息或请求头

控制台成功获得请求头

Accept-Language

参数

(4)测试

@CookieValue

点击超链接

Test CookieValue

,超链接的地址为:

http://localhost:8080/springmvc-1/springmvc/testCookieValue

【SpringMVC】4. 获取Http的请求信息或请求头

控制台成功获得Cookie的

JSESSIONID

参数

(5)测试使用 POJO 对象绑定请求参数值

在表单输入内容

【SpringMVC】4. 获取Http的请求信息或请求头

提交后成功跳转到

Succes.jsp

页面

【SpringMVC】4. 获取Http的请求信息或请求头

控制台也能获取到数据

【SpringMVC】4. 获取Http的请求信息或请求头

(6)测试使用Servlet 原生API

点击超链接

testServletAPI

,超链接的地址为:

http://localhost:8080/springmvc-1/springmvc/testServletAPI

【SpringMVC】4. 获取Http的请求信息或请求头

成功跳转到相应的页面

继续阅读