目录
一、SpringMVC的数据响应
1.1SpringMVC的数据响应方式
SpringMVC的数据响应方式有两种,分别为页面跳转和回写数据,
- 页面跳转
- 直接返回字符串
- 通过ModelAndView对象返回
- 回写数据
- 直接返回字符串
- 返回对象或集合
下面我们依次进行介绍。
1.2页面跳转
1、返回字符串形式
直接返回字符串:此种方式会将返回的字符串与视图解析器的前后缀拼接后跳转。
这种方法我们之前已经做过了,通过直接返回字符串形式指定跳转的地址。
2、返回ModelAndView对象
关于这个 ModelAndView 对象有两种方式获得,一个是自己创建,一个是从参数中获取。
首先我们试试在Controller中方法创建 ModelAndView 对象,并且设置视图名称
@RequestMapping("/quick2")//配置映射地址
public ModelAndView save2(){
/**
* Model:模型,作用为封装数据
* View:视图,作用为展示数据
*/
ModelAndView modelAndView=new ModelAndView();//创建ModelAndView对象
modelAndView.addObject("username","Tom");//设置模型数据,这里的属性值可以是任意类型(我们以字符串为例)
modelAndView.setViewName("success");//设置视图
return modelAndView;//返回模型视图
}
然后我们在success.jsp中获取设置到ModelAndView对象中的模型数据,
<h1>Success! ${username}</h1>
启动服务器:
我们再试试将 ModelAndView 对象作为参数传进来,Spring在解析的时候会自动注入传入的参数对象,从而实现功能,
@RequestMapping("/quick3")//配置映射地址
public ModelAndView save3(ModelAndView modelAndView){
modelAndView.addObject("username","Tom2");//设置模型数据,这里的属性值可以是任意类型(我们以字符串为例)
modelAndView.setViewName("success");//设置视图
return modelAndView;//返回模型视图
}
其他的不修改,启动服务器访问对应的映射地址:
我们还可以将这个ModelAndView对象拆分为Model和View分别设置,
@RequestMapping("/quick4")//配置映射地址
public String save4(Model model){
model.addAttribute("username","Tom3");//设置模型数据,这里的属性值可以是任意类型(我们以字符串为例)
return "success";//返回视图
}
启动服务器,
这里我们甚至可以不使用Model对象来存储数据,可以直接调用request在域中存储信息,
@RequestMapping("/quick5")//配置映射地址
public String save5(HttpServletRequest request){
request.setAttribute("username","Tom4");//通过SpringMVC提供的Request对象来设置属性
return "success";//返回视图
}
启动服务器(这种方法不太常用)
1.3回写数据
回写同样有两种实现方法,分别为直接返回字符串和返回对象或集合。下面我们依次介绍。
1、直接返回字符串
在以前学习Web基础中,客户端访问服务端,如果想要直接回写字符串作为响应体返回时,只需要使用 response.getWriter().print(“XXXX”)即可,所以关键在于,我们如何在Controller层的对象中获取到 response对象。
通过上面的学习,我们可以通过 SpringMVC 框架注入的response对象,然后调用它的getWriter().print()方法回写数据,此时不需要视图跳转,业务方法返回值为void。
@RequestMapping("/quick6")//配置映射地址
public void save5(HttpServletResponse response) throws IOException {
response.getWriter().print("<h1>Hello World!</h1>");
}
使用这个方法比较简单,但是会和HttpServletResponse对象耦合度较高,我们希望不适用Servlet中的对象,那么我们能不能将要输出的字符串直接返回。
但是之前直接返回的字符串服务器会解析为跳转的地址,如果要让服务器知道此时方法返回的字符串不是跳转,而是作为直接在http响应体中返回的字符串,则需要通过 @ResponseBody 注解实现。
@RequestMapping("/quick7")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转,直接进行数据响应,相应方式为http响应体回写
public String save7(){
return "<h1>Hello World!</h1>";
}
在实际开发中,我们一般不直接返回普通字符串,这个字符串会有一些格式,比如json格式字符串,下面我们看看如何直接回写json格式的字符串。
@RequestMapping("/quick8")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转,直接进行数据响应,相应方式为http响应体回写
public String save8(){
return "{\"username\":\"Jack\",\"age\":18}";
}
但是这么人工写比较麻烦,我们在Controller中使用的都是实体类对象,如果属性过多一个个拼接字符串比较麻烦,我们可以使用工具来写json字符串,首先在pom.xml中导入需要用的jar包坐标,
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.9.0</version>
</dependency>
假设现在有一个User类,里面刚好有String类型的username和int类型的age变量,
@RequestMapping("/quick9")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转,直接进行数据响应,相应方式为http响应体回写
public String save9() throws JsonProcessingException {
User user=new User("Jack",18);//模拟Controller层中操作的实体类对象,有对应的两个属性
ObjectMapper objectMapper=new ObjectMapper();
String json = objectMapper.writeValueAsString(user);//将实体对象转换为json格式的字符串
return json;//返回json格式字符串
}
2、直接返回对象或集合
其实SpringMVC中已经封装了对象转json字符串的功能,我们现在只需要返回一个对象或者集合,SpringMVC框架会在内部帮我们转换为json字符串。
但是这个功能的实现需要我们在spring-mvc.xml中进行配置,指定使用jackson进行对象或者集合的转换。
<!--配置处理器适配器-->
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
<!--指定jackson作为信息转换器,用于对象转换json字符串-->
<property name="messageConverters">
<list>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"></bean>
</list>
</property>
</bean>
然后我们就可以直接返回对象,
@RequestMapping("/quick10")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转,直接进行数据响应,响应方式为直接返回对象
public User save10(){
User user=new User("Jack",18);//模拟Controller层中操作的实体类对象,有对应的两个属性
return user;//返回对象
}
启动服务器,可以看到我们返回的对象直接被转换成了json字符串,
Spring还提供了一种简单的方式,代替上面的配置处理器适配器,还要指定信息转换器。我们直接配置MVC的注解驱动即可。(需要先导入mvc的命名空间)
<mvc:annotation-driven/>
在 SpringMVC 的各个组件中,处理器映射器、处理器适配器、视图解析器称为 SpringMVC 的三大组件。
使用 <mvc:annotation-driven/> 自动加载 RequestMappingHandlerMapping(处理映射器)和RequestMappingHandlerAdapter(处理适配器),可用在 Spring-xml.xml 配置文件中使用 <mvc:annotation-driven/> 替代注解处理器和适配器的配置。
同时使用 <mvc:annotation-driven/> 默认底层就会集成jackson进行对象或集合的json格式字符串的转换。
二、SpringMVC的请求
客户端请求参数的格式是(GET请求):name=value&name=value……
服务器端要获得请求的参数,有时还需要进行数据的封装,SpringMVC可以接收如下类型的参数:
- 基本类型参数
- POJO类型参数
- 数组类型参数
- 集合类型参数
2.1获得请求参数类型
2.1.1基本类型参数
服务端在获取到请求的基本类型参数时,就直接进行使用,不进行数据的封装。
我们要保证 Controller中的业务方法的参数名称要与请求参数的name一致,参数值会自动映射匹配。并且能自动做类型转换(自动的类型转换是指从String向其他类型的转换)。
假设现在有一个请求 :
http://localhost:8080/quick11?username=tz&age=22
我们要获取里面的参数username和age,那么我们需要在Controller中创建一个业务方法,方法的参数名要和这里的username和age统一,这样参数值才会自动映射匹配。
@RequestMapping("/quick11")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save11(String username, int age){
System.out.println(username+":"+age);//打印获得的请求参数
}
启动服务器,访问目标url,并且携带两个参数username=tz&age=22,
2.1.2POJO类型参数
POJO类型实际上就是普通的JavaBean对象。
如果我们想让请求的参数通过SpringMVC自动封装到POJO也就是实体类对象中,那么我们需要让请求的参数名和实体类的属性名称一致,这样参数值会自动映射匹配,将参数封装到实体对象中。
假设我们还是用上面的请求,参数包括username和age,
http://localhost:8080/quick12?username=tz&age=22
那么我们要保证封装的User实体类中要有这两个属性(并生成对应的set方法),然后我们在方法参数中设置好User对象参数,
@RequestMapping("/quick12")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save12(User user){
System.out.println(user);//打印封装好的实体类对象
}
启动服务器,输入对应的url,并且带上请求参数,
2.1.3数组类型参数
如果客户端请求的参数名称都一样,只不过有很多值,对于这种情况,我们可以将这种数据封装到数组数据中。
假设有这么一个请求,参数名都为strs,
http://localhost:8080/quick13?strs=aaa&strs=bbb&strs=ccc
我们只需要让 Controller 中的业务方法数组名称与请求参数的name一致,参数值会自动映射匹配。
@RequestMapping("/quick13")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save13(String[] strs){
System.out.println(Arrays.asList(strs));//打印封装好的字符串数组,我们转换为集合打印更方便
}
启动服务器,输入对应的url和参数,
2.1.4集合类型参数
获得集合参数时,要将集合参数包装到一个JavaBean对象中才可以,这个对象我们一般命名为VO。我们在对象中创建对应的集合属性,生成get和set方法,为了方便打印也生成toString方法。
class VO {
private List<User> userList;
//...生成对应的set、get方法和toString方法
}
接下来我们在客户端界面中模拟提交一个集合,里面存储的user对象,这个集合名要和VO对象的集合属性名相同,即userList。(因为提交的数据比较复杂,所以我们用post方法)首先我们创建一个jsp,用于提交集合数据。
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<form action="${pageContext.request.contextPath}/quick14" method="post">
username1:<input type="text" name="userList[0].username"><br/><%--给第一个User对象的username进行赋值--%>
age1:<input type="text" name="userList[0].age"><br/><%--给第一个User对象的age进行赋值--%>
username2:<input type="text" name="userList[1].username"><br/><%--给第二个User对象的username进行赋值--%>
age2:<input type="text" name="userList[1].age"><br/><%--给第二个User对象的age进行赋值--%>
username3:<input type="text" name="userList[2].username"><br/><%--给第三个User对象的username进行赋值--%>
age3:<input type="text" name="userList[2].age"><br/><%--给第三个User对象的age进行赋值--%>
<input type="submit" value="提交"><%--提交按钮--%>
</form>
</body>
</html>
然后我们启动服务器,访问表单界面form.jsp,点击提交跳转\quick14对应的方法中,打印集合。
如果使用ajax提交时,可以指定contentType为json形式,那么在方法参数位置使用@RequestBody 可以直接接收集合数据而无需使用POJO进行包装。
因为要使用ajax提交数据,所以我们先导入jquery.js(提取码:lb4v)的库,放置到webapp的js目录下,接着我们新建一个ajax.jsp用于提交数据,并且设置contentType的格式,
<head>
<title>Title</title>
<script src="${pageContext.request.contextPath}/js/jquery-3.3.1.js"></script>
<script>
var userList=new Array();
userList.push({username:"tz",age:22});
userList.push({username:"dl",age:23});
$.ajax({
type:"POST",
url:"${pageContext.request.contextPath}/quick15",
data:JSON.stringify(userList),//将userList转换为json格式的字符串作为请求的数据
contentType:"application/json;charset=utf-8"//设定编码格式
})
</script>
</head>
然后我们在 Controller 层创建一个方法,里面的参数加上@RequestBody 注解,
@RequestMapping("/quick15")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save15(@RequestBody List<User> list){//在集合参数前面加入注解@RequestBody
System.out.println(list);//打印集合
}
启动服务器,我们发现 /js/jquery-3.3.1.js 文件资源没找到,
因为我们在访问 ajax.jsp 的界面中,使用到了jquery-3.3.1.js的库,所以服务器会重新提交一个请求http://localhost:8080/js/jquery-3.3.1.js,去找这个资源。
但是我们去访问这个资源时,因为我们在 web.xml 中配置核心控制器的拦截地址为任意地址,所以它会被SpringMVC核心控制器DispatcherServlet拦截到,然后它会去Controller层看看有没有方法对应这个映射地址,但是没有方法配置了这个映射地址,所以他就找不到 jquery-3.3.1.js的库,所以就会报错说"$"未定义。
解决这个问题有两种方法,一个是在spring-mvc.xml中指定哪些资源为静态资源,不需要SpringMVC核心控制器DispatcherServlet进行拦截,直接放行即可。(如果静态资源文件比较多分布也比较散,那么推荐使用第二种方法)
<!--开放资源的访问(一般是一些静态资源),mapping为访问的地址路径,location为资源在工程中的路径-->
<mvc:resources mapping="/js/**" location="/js/"></mvc:resources>
还有一种是当核心控制器DispatcherServlet找不到资源时,我们指定它让默认的控制器(也就是我们的tomcat服务器)来查找资源,tomcat是可以查找这些静态资源的,所以就能找到库。
<!--如果SpringMVC找不到资源,则交给默认的处理器(即我们的Tomcat服务器)帮我们找资源-->
<mvc:default-servlet-handler></mvc:default-servlet-handler>
这两种方法任选一个进行配置,启动服务器再看集合已经被正确获取到了,
2.2请求数据乱码问题
当我们使用POST请求时,如果参数涉及到了中文,就会出现乱码问题,
在之前我们是在request获取请求数据之前设置字符编码的格式来解决这个问题,
request.setCharacterEncoding("utf-8");//设置编码格式为utf-8
这里我们不使用request对象,与web层进行解耦合,通过配置过滤器的方法来进行编码的过滤。
<!--配置全局过滤的filter-->
<filter>
<filter-name>CharacterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name><!--配置编码的格式为utf-8-->
<param-value>utf-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CharacterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern><!--对所有的资源都进行过滤,即访问所有的资源时,获取请求数据的编码格式都为utf-8-->
</filter-mapping>
启动服务器,访问表单页面,填入中文数据,查看控制台输出发现已经不乱码了,
2.3参数绑定注解@RequestParam
当请求的参数名称与Controller的业务方法参数名称不一致时,就需要通过@RequestParam注解显示的绑定。
假设现在我们方法中的参数名称为username,此时如果想让SpringMVC帮我们把请求参数自动映射到方法中的username中,我们需要在get请求时写的参数名也为username,即
http://localhost:8080/quick16?username=test
可是如果我们这里把username改为name,即
http://localhost:8080/quick16?name=test
此时如果还想让SpringMVC把这个参数映射到方法中的username变量中,则需要在方法的参数中加入@RequestParam注解,即
@RequestMapping("/quick16")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save16(@RequestParam(value = "name") String username){//显示绑定请求的参数名称
System.out.println(username);//打印获得的请求参数
}
@RequestParam注解还有如下参数可以使用:
- value:请求参数名称
- required:是否必须要带请求参数,默认是true。用户提交请求时如果没有此参数则报错
- defaultValue:当没有指定请求参数时,则使用指定的默认值赋值
@RequestMapping("/quick17")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save17(@RequestParam(value = "name",required = false,defaultValue = "defaultName") String username){
//这里用户请求时可以不用带参数name,如果没有携带参数则使用默认值"defaultName"对username进行赋值
System.out.println(username);//打印获得的请求参数
}
2.4获取Restful风格的参数
Restful是一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。
主要用于客户端和服务器交互类的软件,基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存机制等。
Restful风格的请求是使用"url+请求方式"表示一次请求目的的,HTTP 协议里面四个表示操作方式的动词如下:
- GET:用于获取资源
- POST:用于新建资源
- PUT:用于更新资源
- DELETE:用于删除资源
例如:
/user/1 GET : 得到 id = 1 的 user
/user/1 DELETE: 删除 id = 1 的 user
/user/1 PUT: 更新 id = 1 的 user
/user POST: 新增 user
上述url地址/user/1中的1就是要获得的请求参数,在SpringMVC中可以使用占位符进行参数绑定。
地址/user/1可以写成/user/{id},占位符{id}对应的就是1的值。
在业务方法中我们可以使用 @PathVariable 注解进行占位符的匹配获取工作。
@RequestMapping("/quick18/{name}")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save18(@PathVariable(value = "name",required = true) String username){
//这里用户请求时必须携带参数name,并且以/name的形式写在url之后,由PathVariable注解对参数username进行赋值
System.out.println(username);//打印获得的请求参数
}
2.5自定义类型转换器
SpringMVC 默认已经提供了一些常用的类型转换器,例如客户端提交的字符串转换成int型进行参数设置。
但是不是所有的数据类型都提供了转换器,没有提供的就需要自定义转换器,例如:日期类型的数据就需要自定义转换器。
自定义类型转换器的开发步骤:
- 定义转换器类实现Converter接口
- 在配置文件中声明转换器
- 在<annotation-driven>中引用转换器
第一步我们实现自定义转换器类,实现Converter接口,
class DateConverter implements Converter<String,Date> {
public Date convert(String source) {//将String类型转换为Date类型
SimpleDateFormat format=new SimpleDateFormat("yyyy.MM.dd-hh:mm:ss");
Date date=null;
try {
date = format.parse(source);
} catch (ParseException e) {
e.printStackTrace();
}
return date;
}
}
第二步我们在配置文件中声明转换器,
<!--声明自定义转换器,并利用转换器工厂帮我们创建转换器-->
<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
<property name="converters">
<list>
<bean class="Converter.DateConverter"></bean>
</list>
</property>
</bean>
第三步我们在<annotation-driven>中引用转换器,
<!--配置SpeingMVC注解驱动-->
<mvc:annotation-driven conversion-service="conversionService"/>
然后我们启动服务器,输入时间参数,
2.6获得Servlet相关API
SpringMVC支持使用原始ServletAPI对象作为控制器方法的参数进行注入,常用的对象如下:
- HttpServletRequest
- HttpServletResponse
- HttpSession
我们在方法的参数中直接写ServletAPI对象,SpringMVC会自动帮我们注入。
@RequestMapping("/quick20")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save20(HttpServletRequest request, HttpServletResponse response, HttpSession session){
System.out.println(request);
System.out.println(response);
System.out.println(session);
}
2.7获得请求头数据
使用 @RequestHeader 可以获得请求头信息,相当于web阶段学习的request.getHeader(name)
@RequestHeader 注解的属性如下:
- value:请求头的名称
- required:是否必须携带此请求头
@RequestMapping("/quick21")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save21(@RequestHeader(value = "User-Agent",required = false) String headValue){
System.out.println(headValue);//打印请求头信息
}
我们还可以使用 @CookieValue 注解来获取请求头中的Cookie值,
@CookieValue 注解的属性如下:
- value:指定cookie的名称
- required:是否必须携带此cookie
@RequestMapping("/quick22")//配置映射地址
@ResponseBody//告诉SpringMVC该方法不进行视图跳转, 回写数据的类型为void空
public void save22(@CookieValue(value = "JSESSIONID") String jsessionId){
System.out.println(jsessionId);//打印jsessionId信息
}