第
2
章
SpringMVC
注解式开发
2.1 @RequestMapping
定义请求规则
通过
@RequestMapping
注解可以定义处理器对于请求的映射规则。该注解可以注解在方
法上,也可以注解在类上,但意义是不同的。
value
属性值常以“
/
”开始。
@RequestMapping
的
value
属性用于定义所匹配请求的
URI
。但对于注解在方法上与类
上,其
value
属性所指定的
URI
,意义是不同的。
一个
@Controller
所注解的类中,可以定义多个处理器方法。当然,不同的处理器方法
所匹配的
URI
是不同的。这些不同的
URI
被指定在注解于方法之上的
@RequestMapping
的
value
属性中。但若这些请求具有相同的
URI
部分,则这些相同的
URI
,可以被抽取到注解在
类之上的
@RequestMapping
的
value
属性中。此时的这个
URI
表示模块的名称。
URI
的请求
是相对于
Web
的根目录。
换个角度说,要访问处理器的指定方法,必须要在方法指定
URI
之前加上处理器类前定
义的模块名称
项目:
requestMapping-modelName
。在
primary-annotation
基础上进行修改。
Step1
:修改处理器类
MyController
。
2.1.1 指定模块名称
通过
@RequestMapping
注解可以定义处理器对于请求的映射规则。该注解可以注解在方
法上,也可以注解在类上,但意义是不同的。
value
属性值常以“
/
”开始。
@RequestMapping
的
value
属性用于定义所匹配请求的
URI
。但对于注解在方法上与类
上,其
value
属性所指定的
URI
,意义是不同的。
一个
@Controller
所注解的类中,可以定义多个处理器方法。当然,不同的处理器方法
所匹配的
URI
是不同的。这些不同的
URI
被指定在注解于方法之上的
@RequestMapping
的
value
属性中。但若这些请求具有相同的
URI
部分,则这些相同的
URI
,可以被抽取到注解在
类之上的
@RequestMapping
的
value
属性中。此时的这个
URI
表示模块的名称。
URI
的请求
是相对于
Web
的根目录。
换个角度说,要访问处理器的指定方法,必须要在方法指定
URI
之前加上处理器类前定
义的模块名称
项目:
requestMapping-modelName
。在
primary-annotation
基础上进行修改。
Step1
:修改处理器类
MyController
。
package com.bjpowernode.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.RedirectView;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.xml.ws.RequestWrapper;
/**
* @Controller:创建处理器对象,对象放在springmvc容器中。
* value:所有请求地址的公共部分,叫做模块名称
* 位置:在类的上面
* 和Spring中讲的@Service ,@Component
*
* 能处理请求的都是控制器(处理器): MyController能处理请求,
* 叫做后端控制器(back controller)
*
* 没有注解之前,需要实现各种不同的接口才能做控制器使用
*/
@Controller
@RequestMapping("/user")
public class MyController {
/**
* @RequestMapping:请求映射
* 属性:method,表示请求的方式。他的值RequestMethod枚举值。
* 例如表示get请求方式,RequestMethod.GET
* post请求方式:RequestMethod.POST
* @return
*/
//指定some.do使用get请求方式
@RequestMapping(value = "/some.do",method = RequestMethod.GET)
public ModelAndView doSome(){ // doGet()--service请求处理
//处理some.do请求了。 相当于service调用处理完成了。
ModelAndView mv = new ModelAndView();
mv.addObject("msg","欢迎使用springmvc做web开发");
mv.addObject("fun","执行的是doSome方法");
mv.setViewName("show");
return mv;
}
//指定other.do是POST请求方式
@RequestMapping(value = "/other.do",method = RequestMethod.POST)
public ModelAndView doOther(){
ModelAndView mv = new ModelAndView();
mv.addObject("msg","====欢迎使用springmvc做web开发====");
mv.addObject("fun","执行的是doOther方法");
mv.setViewName("other");
return mv;
}
//不指定请求方式,没有限制
@RequestMapping(value = "/first.do")
public ModelAndView doFirst(HttpServletRequest request,
HttpServletResponse response,
HttpSession session){
ModelAndView mv = new ModelAndView();
mv.addObject("msg","====欢迎使用springmvc做web开发===="+request.getParameter("name "));
mv.addObject("fun","执行的是doFirst方法");
mv.setViewName("other");
return mv;
}
}
2.1.2
对请求提交方式的定义
对于
@RequestMapping
,其有一个属性
method
,用于对被注解方法所处理请求的提交
方式进行限制,即只有满足该
method
属性指定的提交方式的请求,才会执行该被注解方法。
Method
属性的取值为
RequestMethod
枚举常量。常用的为
RequestMethod.GET
与
RequestMethod.POST
,分别表示提交方式的匹配规则为
GET
与
POST
提交。
以上处理器方法只能处理
POST
方式提交的请求。客户端浏览器常用的请求方式,及其
提交方式有以下几种:
也就是说,只要指定了处理器方法匹配的请求提交方式为
POST
,则相当于指定了请求
发送的方式:要么使用表单请求,要么使用
AJAX
请求。其它请求方式被禁用。
当然,若不指定
method
属性,则无论是
GET
还是
POST
提交方式,均可匹配。即对于
请求的提交方式无要求。
项目:
requestMapping-method
。在
requestMapping-modelName
基础上进行修改。
Step1
:修改处理器类
MyController
Step2
:修改
index
页面
2.2
处理器方法的参数
处理器方法可以包含以下四类参数,这些参数会在系统调用时由系统自动赋值,即程序
员可在方法内直接使用。
➢
HttpServletRequest
➢
HttpServletResponse
➢
HttpSession
➢
请求中所携带的请求参数
2.2.1
逐个参数接收
只要保证请求参数名与该请求处理方法的参数名相同即可。
项目:
receiveParameters-property
。在
requestMapping-method
基础上修改。
Step1
:修改
index
页面
Step2
:修改处理器类
MyController
Step3
:添加
show
页面
在
/WEB-INF/jsp
下添加
show.jsp
页面。
2.2.2
请求参数中文乱码问题
对于前面所接收的请求参数,若含有中文,则会出现中文乱码问题。
Spring
对于请求参
数中的中文乱码问题,给出了专门的字符集过滤器:
spring-web-5.2.5.RELEASE.jar
的
org.springframework.web.filter
包下的
CharacterEncodingFilter
类。
(
1
) 解决方案
在
web.xml
中注册字符集过滤器,即可解决
Spring
的请求参数的中文乱码问题。不过,
最好将该过滤器注册在其它过滤器之前。因为过滤器的执行是按照其注册顺序进行的。
直接在项目
receiveParameters-property
上进行修改。
2.2.3
校正请求参数名
@RequestParam
所谓校正请求参数名,是指若请求
URL
所携带的参数名称与处理方法中指定的参数名
不相同时,则需在处理方法参数前,添加一个注解
@RequestParam(“
请求参数名
”)
,指定请
求
URL
所携带参数的名称。该注解是对处理器方法参数进行修饰的。
value
属性指定请求参
数的名称。
项目:
receiveParameters-params
。在
receiveParameters-property
基础上修改。
Step1
:修改
index
页面
将表单中的参数名称修改的与原来不一样。
Step2
:修改处理器类
MyController
required
属性:
2.2.4
对象参数接收
将处理器方法的参数定义为一个对象,只要保证请求参数名与这个对象的属性同名即可。
项目:
receiveParameters-object
。在
receiveParameters-property
基础上修改。
Step1
:定义类
Student
Step2
:修改处理器类
MyController
Step3
:修改
show
页面
2.3
处理器方法的返回值
使用
@Controller
注解的处理器的处理器方法,其返回值常用的有四种类型:
➢
第一种:
ModelAndView
➢
第二种:
String
➢
第三种:无返回值
void
➢
第四种:返回自定义类型对象
根据不同的情况,使用不同的返回值。
2.3.1
返回
ModelAndView
若处理器方法处理完后,需要跳转到其它资源,且又要在跳转的资源间传递数据,此时
处理器方法返回
ModelAndView
比较好。当然,若要返回
ModelAndView
,则处理器方法中
需要定义
ModelAndView
对象。
在使用时,若该处理器方法只是进行跳转而不传递数据,或只是传递数据而并不向任何
资源跳转(如对页面的
Ajax
异步响应),此时若返回
ModelAndView
,则将总是有一部分多
余:要么
Model
多余,要么
View
多余。即此时返回
ModelAndView
将不合适。
2.3.2
返回
String
处理器方法返回的字符串可以指定逻辑视图名,通过视图解析器解析可以将其转换为物
理视图地址
返回内部资源逻辑视图名
若要跳转的资源为内部资源,则视图解析器可以使用
InternalResourceViewResolver
内部
资源视图解析器。此时处理器方法返回的字符串就是要跳转页面的文件名去掉文件扩展名后
的部分。这个字符串与视图解析器中的
prefix
、
suffix
相结合,即可形成要访问的
URI
。
项目:
returnString-viewName
。在
receiveParameters-object
基础上修改。
直接修改处理器类
MyController
当然,也可以直接返回资源的物理视图名。不过,此时就不需要再在视图解析器中再配
置前辍与后辍了。
2.3.3
返回
void
(了解)
对于处理器方法返回
void
的应用场景,
AJAX
响应
.
若处理器对请求处理后,无需跳转到其它任何资源,此时可以让处理器方法返回
void
。
例如,对于
AJAX
的异步请求的响应。
项目:
returnVoid-ajax
。在
primary-annotation
基础上进行修改。
Step1
:
maven
加入
jackson
依赖
由于本项目中服务端向浏览器传回的是
JSON
数据,需要使用一个工具类将字符串包装
为
JSON
格式,所以需要导入
JSON
的依赖。
<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>
Step2
:引入
jQuery
库
由于本项目要使用
jQuery
的
ajax()
方法提交
AJAX
请求,所以项目中需要引入
jQuery
的
库。在
WebRoot
下新建一个
Folder
(文件夹),命名为
js
,并将
jquery-1.11.1.js
文件放入其
中。
当然,该
jQuery
库文件,需要在使用
ajax()
方法的
index
页面中引入。
Step3
:定义
index
页面
index
页面由两部分内容构成:一个是
<button/>
,用于提交
AJAX
请求;一个是
<script/>
,
用于处理
AJAX
请求。
点击按钮发起请求
Step4:
定义对象
Student
Step5
:修改处理器类
MyController
处理器对于
AJAX
请求中所提交的参数,可以使用逐个接收的方式,也可以以对象的方
式整体接收。只要保证
AJAX
请求参数与接收的对象类型属性同名。
以逐个方式接收参数:
Step6
:删除视图页面
由于是服务端直接向浏览器发回数据,所以也就无需视图页面了,所以需要删除
WEB-INF
中的
jsp
目录及其中的
show
页面。
2.3.4
返回对象
Object
处理器方法也可以返回
Object
对象。这个
Object
可以是
Integer
,
String
,自定义对象,
Map
,
List
等。但返回的对象不是作为逻辑视图出现的,而是作为直接在页面显示的数据出
现的。
返回对象,需要使用
@ResponseBody
注解,将转换后的
JSON
数据放入到响应体中。
(
1
) 环境搭建
A
、
maven pom.xml
由于返回
Object
数据,一般都是将数据转化为了
JSON
对象后传递给浏览器页面的。而
这个由
Object
转换为
JSON
,是由
Jackson
工具完成的。所以需要导入
Jackson
的相关
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>
B
、 声明注解驱动
将
Object
数据转化为
JSON
数据,需要由消息转换器
HttpMessageConverter
完成。而转
换器的开启,需要由
<mvc:annotation-driven/>
来完成。
SpringMVC
使用消息转换器实现请求数据和对象,处理器方法返回对象和响应输出之间
的自动转换
当
Spring
容器进行初始化过程中,在
<mvc:annotation-driven/>
处创建注解驱动时,默认
创建了七个
HttpMessageConverter
对象。也就是说,我们注册
<mvc:annotation-driven/>
,就
是为了让容器为我们创建
HttpMessageConverter
对象。
HttpMessageConverter
接口
:
HttpMessageConverter<T>
是
Spring3.0
新添加的一个接口,
负责将请求信息转换为一个对象(类型为
T
),将对象(类型为
T
)输出为响应信息
HttpMessageConverter<T>
接口定义的方法:
boolean canRead(Class<?> clazz,MediaType mediaType):
指定转换器可以读取的对象类型,即
转 换 器 是 否 可 将 请 求 信 息 转 换 为
clazz
类 型 的 对 象 , 同 时 指 定 支 持
MIME
类 型
(text/html,applaiction/json
等
)
boolean canWrite(Class<?> clazz,MediaType mediaType):
指定转换器是否可将
clazz
类型的对
象写到响应流中,响应流支持的媒体类型在
MediaType
中定义。
LIst<MediaType> getSupportMediaTypes()
:该转换器支持的媒体类
型。
T read(Class<? extends T> clazz,HttpInputMessage inputMessage)
:将请求信息流转换为
T
类型
的对象。
void write(T t,MediaType contnetType,HttpOutputMessgae outputMessage):
将
T
类型的对象写
到响应流中,同时指定相应的媒体类型为
contentType
加入注解驱动
<mvc:annotation-driven/>
后适配器类的
messageConverters
属性值
(
2
) 返回自定义类型对象
返回自定义类型对象时,不能以对象的形式直接返回给客户端浏览器,而是将对象转换
为
JSON
格式的数据发送给浏览器的。
由于转换器底层使用了
Jackson
转换方式将对象转换为
JSON
数据,所以需要导入
Jackson
的相关
Jar
包。
项目:
returnObject-custom
。在
returnVoid-ajax
基础上进行修改。
Step1
:定义数据类
Step2
:修改处理器
MyController
Step3
:修改
index
页面
(
3
) 返回
List
集合
项目:
returnObject-list
。在
returnObject-custom
基础上进行修改。
Step1
:修改处理器
MyController
Step2
:修改
index
页面
(
4
) 返回字符串对象
若要返回非中文字符串,将前面返回数值型数据的返回值直接修改为字符串即可。但若
返 回 的 字 符 串 中 带 有 中 文 字 符 , 则 接 收 方 页 面 将 会 出 现 乱 码 。 此 时 需 要 使 用
@RequestMapping
的
produces
属性指定字符集。
produces
,产品,结果,即该属性用于设置输出结果类型。
项目:
returnObject-String
。
直接修改处理器。
修改页面:
2.4
解读
<url-pattern/>
2.4.1
配置详解
(
1
)
*.do
在没有特殊要求的情况下,
SpringMVC
的中央调度器
DispatcherServlet
的
<url-pattern/>
常使用后辍匹配方式,如写为
*.do
或者
*.action, *.mvc
等。
(
2
)
/
可以写为
/
,因为
DispatcherServlet
会将向静态资源的获取请求,例如
.css
、
.js
、
.jpg
、
.png
等资源的获取请求,当作是一个普通的
Controller
请求。中央调度器会调用处理器映射器为
其查找相应的处理器。当然也是找不到的,所以在这种情况下,所有的静态资源获取请求也
均会报
404
错误。
项目:
url-pattern
。在项目
primary-annotation
基础上进行修改。
需求:在
index.jsp
页面中存在一个访问图片的链接。该项目用于演示将
<url-pattern/>
写为
*.do
可以访问到该图片,而写为
/
,则无法访问。
A
、 在项目中添加图片
在项目的
WebRoot
下添加一个目录
images
,并在其中添加一张图片资源。
B
、
修改
index
页面
C
、
修改
<url-pattern/>
的值
保持
<url-pattern/>
的值为
*.do
,扩展名方式,图片会正常显示。
将
<url-pattern/>
的值修改为
/
,则图片将无法显示。
2.4.2
静态资源访问
<url-pattern/>
的值并不是说写为
/
后,静态资源就无法访问了。经过一些配置后,该问
题也是可以解决的。
(
1
) 使用
<mvc:default-servlet-handler/>
声 明 了
<mvc:default-servlet-handler />
后 ,
springmvc
框 架 会 在 容 器 中 创 建
DefaultServletHttpRequestHandler
处理器对象。它会像一个检查员,对进入
DispatcherServlet
的
URL
进行筛查,如果发现是静态资源的请求,就将该请求转由
Web
应用服务器默认的
Servlet
处理。一般的服务器都有默认的
Servlet
。
在
Tomcat
中,有一个专门用于处理静态资源访问的
Servlet
名叫
DefaultServlet。其<servlet-name/>为 default。可以处理各种静态资源访问请求。该 Servlet 注册在 Tomcat 服务器的 web.xml 中。在 Tomcat 安装目录/conf/web.xml。
项目:
url-pattern-2
。在项目
url-pattern
基础上修改。
只需要在
springmvc.xml
中添加
<mvc:default-servlet-handler/>
标签即可。
<mvc:default-servlet-handler/>
表示使用
DefaultServletHttpRequestHandler
处理器对象。
而该处理器调用了
Tomcat
的
DefaultServlet
来处理静态资源的访问请求。
当然了,要想使用
<mvc: …/>
标签,需要引入
mvc
约束
该约束可从
Spring
帮助文档中搜索关键字
spring-mvc.xsd
即可获取:
docs/spring-framework-reference/htmlsingle/index.html
(
2
) 使用
<mvc:resources/>
(掌握)
项目:
url-pattern-3
。在项目
url-pattern
基础上修改。
在
Spring3.0
版本后,
Spring
定义了专门用于处理静态资源访问请求的处理器
ResourceHttpRequestHandler
。并且添加了
<mvc:resources/>
标签,专门用于解决静态资源无
location
表示静态资源所在目录。当然,
目录不要使用
/WEB-INF/
及其子目录
。
mapping
表 示 对 该 资 源 的 请 求 (
以
/images/
开 始 的 请 求 , 如
/image/beauty.jpg ,
/images/car.png
等
)。注意,后面是两个星号
**
。
(
3
) 声明注解驱动
解决动态资源和静态资源冲突的问题,在
springmvc
配置文件加入: