SpringMVC(二) --------- SpringMVC 注解式开发
目录
- 一、@RequestMapping 定义请求规则
-
- 指定模块名称
- 对请求提交方式的定义
- 二、处理器方法的参数
-
- 逐个参数接收
- 请求参数中文乱码问题
- 矫正请求参数名 @RequestParam
- 对象参数接收
- 三、处理器方法的返回值
-
- 返回 ModelAndView
- 返回 String
- 返回 void
- 返回对象 Object
- 四、解读< url-pattern />
-
- 配置详解
- 静态资源访问
一、@RequestMapping 定义请求规则
指定模块名称
通过@RequestMapping 注解可以定义处理器对于请求的映射规则。该注解可以注解在方法上，也可以注解在类上，但意义是不同的。value 属性值常以" / "开始。
@RequestMapping 的 value 属性用于定义所匹配请求的 URI。但对于注解在方法上与类上，其 value 属性所指定的 URI，意义是不同的。
一个 @Controller 所注解的类中，可以定义多个处理器方法。当然，不同的处理器方法所匹配的 URI 是不同的。这些不同的 URI 被指定在注解于方法之上的 @RequestMapping 的 value 属性中。但若这些请求具有相同的 URI 部分，则这些相同的 URI，可以被抽取到注解在类之上的 @RequestMapping 的 value 属性中。此时的这个 URI 表示模块的名称。URI 的请求是相对于 Web 的根目录。
换个角度说，要访问处理器的指定方法，必须要在方法指定 URI 之前加上处理器类前定义的模块名称。
定义处理器类 MyController
java注解@RequestMapping可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。
添加视图页面
在/WEB-INF/view 目录下添加 some.jsp 与 other.jsp 页面
结构：
简单定义 other.jsp 界面
简单定义 some.jsp 界面
对请求提交方式的定义
对于@RequestMapping，其有一个属性 method，用于对被注解方法所处理请求的提交方式进行限制，即只有满足该 method 属性指定的提交方式的请求，才会执行该被注解方法。Method 属性的取值为 RequestMethod 枚举常量。常用的为 RequestMethod.GET 与 RequestMethod.POST，分别表示提交方式的匹配规则为 GET 与 POST 提交。
以上处理器方法只能处理 POST 方式提交的请求。客户端浏览器常用的请求方式，及其提交方式有以下几种：
| 请求方式 | 提交方式 |
|---|---|
| 表单请求 | 默认GET，可以指定POST |
| AJAX 请求 | 默认GET，可以指定 POST |
| 地址栏请求 | GET请求 |
| 超链接请求 | GET请求 |
| src资源路径请求 | GET请求 |
也就是说，只要指定了处理器方法匹配的请求提交方式为 POST，则相当于指定了请求发送的方式：要么使用表单请求，要么使用 AJAX 请求。其它请求方式被禁用。当然，若不指定 method 属性，则无论是 GET 还是 POST 提交方式，均可匹配，即对于请求的提交方式无要求。
修改处理器类 MyController
定义 index 界面
二、处理器方法的参数
处理器方法可以包含以下四类参数，这些参数会在系统调用时由系统自动赋值，即程序员可在方法内直接使用。
➢ HttpServletRequest
➢ HttpServletResponse
➢ HttpSession
➢ 请求中所携带的请求参数
逐个参数接收
只要保证请求参数名与该请求处理方法的参数名相同即可。
修改 index 页面
修改处理器类 MyController
添加 show 界面
请求参数中文乱码问题
对于前面所接收的请求参数，若含有中文，则会出现中文乱码问题。Spring 对于请求参数中的中文乱码问题，给出了专门的字符集过滤器：spring-web-5.2.5.RELEASE.jar 的 org.springframework.web.filter 包下的 CharacterEncodingFilter 类。
- 解决方案
在 web.xml 中注册字符集过滤器，即可解决 Spring 的请求参数的中文乱码问题。不过，最好将该过滤器注册在其它过滤器之前。因为过滤器的执行是按照其注册顺序进行的。直接在项目 receiveParameters-property 上进行修改。
<filter>
<filter-name>characterEncodingFilterfilter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
<init-param>
<param-name>encodingparam-name>
<param-value>utf-8param-value>
init-param>
<init-param>
<param-name>forceRequestEncodingparam-name>
<param-value>trueparam-value>
init-param>
<init-param>
<param-name>forceResponseEncodingparam-name>
<param-value>trueparam-value>
init-param>
filter>
<filter-mapping>
<filter-name>characterEncodingFilterfilter-name>
<url-pattern>/*url-pattern>
filter-mapping>
矫正请求参数名 @RequestParam
所谓校正请求参数名，是指若请求 URL 所携带的参数名称与处理方法中指定的参数名不相同时，则需在处理方法参数前，添加一个注解 @RequestParam(“请求参数名”)，指定请求 URL 所携带参数的名称。该注解是对处理器方法参数进行修饰的。value 属性指定请求参数的名称。
@RequestParam 属性
- value, 请求中参数名
- required, boolean, 默认是true
true: 表示请求中必须有参数
false: 可以没有此参数
修改 index 界面
将表单中的参数名称修改的与原来不一样
修改处理器类 MyController
required 属性
对象参数接收
将处理器方法的参数定义为一个对象，只要保证请求参数名与这个对象的属性同名即可。
定义学生类Student
public class Student {
private String name;
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
修改处理器类 MyController
修改 show 页面
测试结果
三、处理器方法的返回值
使用@Controller 注解的处理器的处理器方法，其返回值常用的有四种类型：
➢ 第一种：ModelAndView
➢ 第二种：String
➢ 第三种：无返回值 void
➢ 第四种：返回自定义类型对象
根据不同的情况，使用不同的返回值。
返回 ModelAndView
若处理器方法处理完后，需要跳转到其它资源，且又要在跳转的资源间传递数据，此时处理器方法返回 ModelAndView 比较好。当然，若要返回 ModelAndView，则处理器方法中需要定义 ModelAndView 对象。
在使用时，若该处理器方法只是进行跳转而不传递数据，或只是传递数据而并不向任何资源跳转（如对页面的 Ajax 异步响应），此时若返回 ModelAndView，则将总是有一部分多余：要么 Model 多余，要么 View 多余。即此时返回 ModelAndView 将不合适。
返回 String
处理器方法返回的字符串可以指定逻辑视图名，通过视图解析器解析可以将其转换为物理视图地址
- 返回内部资源逻辑视图名
若要跳转的资源为内部资源，则视图解析器可以使用 InternalResourceViewResolver 内部资源视图解析器。此时处理器方法返回的字符串就是要跳转页面的文件名去掉文件扩展名后的部分。这个字符串与视图解析器中的 prefix、suffix 相结合，即可形成要访问的 URI。
当然，也可以直接返回资源的物理视图名。不过，此时就不需要再在视图解析器中再配置前辍与后辍了。
返回 void
对于处理器方法返回 void 的应用场景：AJAX 响应。若处理器对请求处理后，无需跳转到其它任何资源，此时可以让处理器方法返回 void，例如，对于 AJAX 的异步请求的响应。
maven 加入 jackson 依赖
由于本项目中服务端向浏览器传回的是 JSON 数据，需要使用一个工具类将字符串包装为 JSON 格式，所以需要导入 JSON 的依赖。
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-coreartifactId>
<version>2.9.0version>
dependency>
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-databindartifactId>
<version>2.9.0version>
dependency>
引入 jQuery 库
由于本项目要使用 jQuery 的 ajax()方法提交 AJAX 请求，所以项目中需要引入 jQuery 的库。在 WebRoot 下新建一个 Folder（文件夹），命名为 js，并将 jquery-3.1.1.js 文件放入其中。
当然，该 jQuery 库文件，需要在使用 ajax() 方法的 index 页面中引入
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<script type="text/javascript" src="js/jquery-3.1.1.min.js">script>
定义 index 界面
index 页面由两部分内容构成：一个是，用于提交 AJAX 请求；一个是，用于处理 AJAX 请求。
<script>
$(function (){
$("button").click(function (){
$.ajax({
url:"/MyWeb/test/MyAjax.do",
data:{
name:"zs",
age:"24"
},
type:"post",
dataType:"json",
success:function (resp){
alert("resp: " + resp.name + " " + resp.age);
}
});
});
});
</script>
index.jsp<br>
<button>发起 Ajax 请求button>
定义 Student 学生类
修改处理器类 MyController
处理器对于 AJAX 请求中所提交的参数，可以使用逐个接收的方式，也可以以对象的方式整体接收。只要保证 AJAX 请求参数与接收的对象类型属性同名。
以逐个方式接收参数：
// 处理器方法返回值 void , 不能表示数据, 也没有视图
// 可以通过使用HttpServletResponse的输出对象, 把数据输出到浏览器
@RequestMapping
public void doAjax(Integer age, String name, HttpServletResponse response) throws IOException {
Student student = new Student();
student.setName(name);
student.setAge(age);
// 使用 jackson 工具库, 把 Student 转化为 json
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(student);
System.out.println("json : " + json);
// 使用 HttpServletResponse 输出数据到浏览器
PrintWriter pw = response.getWriter();
pw.print(json);
pw.flush();
pw.close();
}
测试结果
删除视图页面
由于是服务端直接向浏览器发回数据，所以也就无需视图页面了，所以需要删除 WEB-INF 中的 view 目录及其中的 show 页面。
返回对象 Object
处理器方法也可以返回 Object 对象。这个 Object 可以是 Integer、String、自定义对象、Map、List 等。但返回的对象不是作为逻辑视图出现的，而是作为直接在页面显示的数据出现的。返回对象，需要使用@ResponseBody 注解，将转换后的 JSON 数据放入到响应体中。@ResponseBody的作用其实是将java对象转为json格式的数据。
(1) 环境搭建
声明注解驱动
将 Object 数据转化为 JSON 数据，需要由消息转换器 HttpMessageConverter 完成。而转换器的开启，需要由
注意选以mvc结尾的包
HttpMessageConverter 接口 ：HttpMessageConverter 是 Spring3.0 新添加的一个接口，负责将请求信息转换为一个对象（类型为 T），将对象（类型为 T）输出为响应信息。
HttpMessageConverter接口定义的方法：
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 包。
定义学生类
用之前定义好的学生类即可
修改处理器MyController
@RequestMapping("/MyAjax.do")
@ResponseBody
public Student doStudentJson() {
Student student = new Student();
student.setName("张三");
student.setAge(18);
return student;
}
修改 index 页面
测试结果
(3) 返回 List 集合
修改处理器 MyController
@RequestMapping("/MyAjax.do")
@ResponseBody
public List<Student> doStudentJson() {
List<Student> students = new ArrayList<>();
students.add(new Student("张三", 22));
students.add(new Student("李四", 22));
return students;
}
修改 index 页面
<script>
$(function (){
$("button").click(function (){
$.ajax({
url:"/MyWeb/test/MyAjax.do",
success:function (resp){
$.each(data, function (i, n)) {
alert(n.name + "===" + n.age);
}
}
});
});
});
</script>
(4) 返回字符串对象
若要返回非中文字符串，将前面返回数值型数据的返回值直接修改为字符串即可。但若返回的字符串中带有中文字符，则接收方页面将会出现乱码 。 此时需要使用 @RequestMapping 的 produces 属性指定字符集。
produces，产品，结果，即该属性用于设置输出结果类型。
四、解读< url-pattern />
配置详解
*.do
在没有特殊要求的情况下，SpringMVC 的中央调度器 DispatcherServlet 的*.do或者*.action，*.mvc等。/
可以写为/，因为 DispatcherServlet 会将向静态资源的获取请求，例如.css、.js、.jpg、.png等资源的获取请求，当作是一个普通的 Controller 请求。中央调度器会调用处理器映射器为其查找相应的处理器。当然也是找不到的，所以在这种情况下，所有的静态资源获取请求也均会报 404 错误。
静态资源访问
/ 后，静态资源就无法访问了。经过一些配置后，该问题也是可以解决的。
(1) 使用
声明了
代码如下
<servlet>
<servlet-name>defaultservlet-name>
<servlet-class>org.apache.catalina.servlets.DefaultServletservlet-class>
<init-param>
<param-name>debugparam-name>
<param-value>0param-value>
init-param>
<init-param>
<param-name>listingsparam-name>
<param-value>falseparam-value>
init-param>
<load-on-startup>1load-on-startup>
servlet>
<servlet-mapping>
<servlet-name>defaultservlet-name>
<url-pattern>/url-pattern>
servlet-mapping>
只需要在 springmvc.xml 中添加
(2) 使用
在 Spring3.0 版本后，Spring 定义了专门用于处理静态资源访问请求的处理器 ResourceHttpRequestHandler。并且添加了
<mvc:resouces location="" mapping=""/>
location 表示静态资源所在目录。当然，目录不要使用/WEB-INF/及其子目录。
mapping 表示对该资源的请求 (以 /images/ 开始的请求，如 /image/bee.jpg， /images/car.png 等)。注意，后面是两个星号 **
(3)声明注解驱动
解决动态资源和静态资源冲突的问题，在 springmvc 配置文件加入
<mvc:annotation-driven/>