关于Spring MVC
Spring MVC是基于Spring框架基础之上的,主要解决了后端服务器接收客户端提交的请求,并给与响应的相关问题。
MVC = Model(数据模型) + View(视图) + Controller(控制器)
- Model:数据模型,通常由业务逻辑层(Service Layer)和数据访问层(Data Access Object Layer)共同构成
- View:视图
- Controller:控制器
MVC为项目中代码的职责划分提供了参考。
需要注意:Spring MVC框架只关心V-C之间的交互,与M没有任何关系
创建Spring MVC工程
略。。。
使用Spring MVC工程接收客户端的请求
【操作步骤】
- 在pom.xml中添加spring-webmvc依赖项:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.14</version>
</dependency>
- 提示:如果后续运行时提示不可识别Servlet相关类,则补充添加以下依赖项:
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
- 接下来,准备2个配置类,一个是Spring框架的配置类,一个是Spring MVC框架的配置类:
cn.tedu.springmvc.config.SpringConfig.java
package cn.tedu.springmvc.config;
import org.springframework.context.annotation.Configuration;
@Configuration // 此注解不是必须的
public class SpringConfig {
}
cn.tedu.springmvc.config.SpringMvcConfig.java
package cn.tedu.springmvc.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration // 此注解不是必须的
@ComponentScan("cn.tedu.springmvc") // 必须配置在当前配置类,不可配置在Spring的配置类
public class SpringMvcConfig implements WebMvcConfigurer {
}
- 接下来,需要创建项目的初始化类,此类必须继承自AbstractAnnotationConfigDispatcherServletInitializer,并在此类中重写父类的3个抽象方法,返回正确的值(各方法的意义请参见以下代码中的注释):
cn.tedu.springmvc.SpringMvcInitializer
package cn.tedu.springmvc;
import cn.tedu.springmvc.config.SpringConfig;
import cn.tedu.springmvc.config.SpringMvcConfig;
import org.springframework.web.servlet.support.
AbstractAnnotationConfigDispatcherServletInitializer;
/**
* Spring MVC项目的初始化类
*/
public class SpringMvcInitializer extends
AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
// 返回自行配置的Spring相关内容的类
return new Class[] { SpringConfig.class };
}
@Override
protected Class<?>[] getServletConfigClasses() {
// 返回自行配置的Spring MVC相关内容的类
return new Class[] { SpringMvcConfig.class };
}
@Override
protected String[] getServletMappings() {
// 返回哪些路径是由Spring MVC框架处理的
return new String[] { "*.do" };
}
}
- 最后,创建控制器类,用于接收客户端的某个请求,并简单的响应结果:
cn.tedu.springmvc.controller.UserController
package cn.tedu.springmvc.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller // 必须是@Controller,不可以是其它组件注解
public class UserController {
public UserController() {
System.out.println("UserController.UserController()");
}
// http://localhost:8080/springmvc01_war_exploded/login.do
@RequestMapping("/login.do")
@ResponseBody
public String login() {
return "UserController.login()";
}
}
- 全部完成后,启动项目,会自动打开浏览器并显示主页,在主页的地址栏URL上补充/login.do即可实现访问,并看到结果。
关于以上案例:
- 当启动Tomcat时,会自动将项目打包并部署到Tomcat,通过自动打开的浏览器中的URL即可访问主页,在URL中有很长一段是例如 springmvc01_war_explored 这一段是不可以删除的,其它的各路径必须补充在其之后,例如 /login.do 就必须在此之后
- 当启动Tomcat时,项目一旦部署成功,就会自动创建并加载AbstractAnnotationConfigDispatcherServletInitializer的子类,即当前项目中自定义的SpringMvcInitialier,无论这个类放在哪个包中,都会自动创建并加载,由于会自动调用这个类中所有方法,所以会将Spring MVC框架处理的请求路径设置为 *.do,并执行对 cn.tedu.springmvc 的组件扫描,进而会创建 UserController 的对象,由于在 UserController 中配置的方法使用了 @RequestMapping(“/login.do”),则此时还将此方法与/login.do进行了绑定,以至于后续随时访问/login.do时都会执行此方法
- 注意:组件扫描必须配置在Spring MVC的配置类中
- 注意:控制器类上的注解必须是@Controller,不可以是@Component、@Service、@Repository
@RequestMapping注解
@RequestMapping注解的主要作用是配置请求路径与处理请求的方法的映射关系,例如将此注解添加在控制器中某个方法之前:
// http://localhost:8080/springmvc01_war_exploded/login.do
@RequestMapping("/login.do")
@ResponseBody
public String login() {
return "UserController.login()";
}
就会将注解中配置的路径与注解所在的方法对应上!
除了方法以外,次注解还可以添加在控制器的类上,例如:
@Controller
@RequestMapping("/user")
public class UserController {
}
@RequestMapping(“/user”)此处第一个"/“例如 “/user” 可以舍弃 “/” 写成 “user” 加不加”/“都可以,看个人习惯,不加Spring会自动帮我们补上,但仅限于第一个”/"
此时请求的网址是:http://localhost:8080/maven_webapp_tomcat_war_exploded/login.do
一旦在类上添加了此注解并配置路径,则每个方法实际映射到的请求路径都是“类上的@RequestMapping配置的路径 + 方法上的@RequestMapping配置的路径”。
例如:
@RestController //必须是Controller,不可以是其他组件的注解
@RequestMapping(value = "/user")
public class UserController {
public UserController(){
System.out.println("UserController.UserController()");
}
@RequestMapping(value = "/login.do")
public String login(){
return "<h1 style=\"color: #f00;\">Spring MVC</h1>";
}
}
此时请求的网址变成:http://localhost:8080/maven_webapp_tomcat_war_exploded/user/login.do
如果还请求的以前的网站,则会404
常见浏览器错误
400 :请求参数错误
401 :需要先登录
403 :访问被禁止
404 :请求资源不存在
405 :请求方式错误
406 :请求头不可接收
另外,在@RequestMapping还可以配置:
- 请求方式
- 请求头
- 响应头
- 等等
所以,在@RequestMapping注解中,增加配置method属性,可以限制客户端的请求方式,例如可以配置为:
@RequestMapping(value = "/login.do", method = RequestMethod.POST)
@ResponseBody
public String login() {
return "UserController.login()";
}
如果按照以上代码,则/login.do路径 只能通过POST 方式发起请求才可以被正确的处理,如果使用其它请求方式(例如GET),则会导致HTTP的405错误。
如果没有配置method属性,则表示可以使用任何请求方式,包括:
GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE //这些请求都能够访问
另外,Spring MVC框架还提供了@RequestMapping的相关注解,例如:
- @GetMapping
- @PostMapping
- @PutMapping
- @DeleteMapping
- 等等
这些注解就是已经限制了请求方式的注解!以@GetMapping为例,就限制了请求方式必须是GET,除此以外,使用方式与@RequestMapping完全相同!
所以,在实际应用中,在类的上方肯定使用@RequestMapping(其它的@XxxMapping不可以加在类上),方法上一般都使用@GetMapping、@PostMapping等注解,除非在极特殊的情况下,某些请求同时允许多种请求方式,才会在方法上使用@RequestMapping。
@ResponseBody注解
@ResponseBody注解表示:响应正文。
一旦配置为“响应正文”,则处理请求的方法的返回值就会直接响应到客户端去!
如果没有配置为“响应正文”,则处理请求的方法的返回值表示“视图组件的名称”,当方法返回后,服务器端并不会直接响应,而是根据“视图组件的名称”在服务器端找到对应的视图组件,并处理,最后,将处理后的视图响应到客户端去,这不是前后端分离的做法!
可以在需要正文的方法上添加@ResponseBody注解,由于开发模式一般相对统一,所以,一般会将@ResponseBody添加在控制器类上,表示此控制器类中所有处理请求的方法都将响应正文!
在Spring MVC框架中,还提供了@RestController注解,它同时具有@Controller和@ResponseBody注解的效果,所以,在响应正文的控制器上,只需要使用@RestController即可,不必再添加@Controller和@ResponseBody注解。
关于响应正文,Spring MVC内置了一系列的转换器(Converter),用于将方法的返回值转换为响应到客户端的数据(并根据HTTP协议补充了必要的数据),并且,Spring MVC会根据方法的返回值不同,自动选取某个转换器,例如,当方法的返回值是String时,会自动使用StringHttpMessageConverter这个转换器,这个转换器的特点就是直接将方法返回的字符串作为响应的正文,并且,其默认的响应文档的字符集是ISO-8859-1,所以在默认情况并不支持非ASCII字符(例如中文)。
在实际应用中,不会使用String作为处理请求的方法的返回值类型,主要是因为普通的字符串不足以清楚的表现多项数据,如果自行组织成JSON或其它某种格式的字符串成本太高!
通常,建议向客户端响应JSON格式的字符串,应该在项目中添加jackson-databind的依赖项:
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.12.3</version>
</dependency>
以上jackson-databind依赖项中也有一个转换器,当Spring MVC调用的处理请求的方法的返回值是Spring MVC没有匹配的默认转换器时,会自动使用jackson-databind的转换器,而jackson-databind转换器就会解析方法的返回值,并将其处理为JSON格式的字符串,在响应头中将Content-Type设置为application/json。
注意:在Spring MVC项目中,还需要在Spring MVC的配置类(SpringMvcConfig)上添加@EnableWebMvc注解,否则响应时将导致出现HTTP的406错误。
【示例代码】
cn.tedu.springmvc.vo.UserVO
package cn.tedu.springmvc.vo;
public class UserVO {
private String username;
private String password;
private String email;
// 请自行补充以上3个属性的Setter & Getter
}
UserController的代码片段:
// http://localhost:8080/springmvc01_war_exploded/user/info.do
@GetMapping("/info.do")
public UserVO info() {
UserVO userVO = new UserVO();
userVO.setUsername("chengheng");
userVO.setPassword("1234567890");
userVO.setEmail("chengheng@qq.com");
return userVO;
}
SpringMvcConfig(补充@EnableWebMvc注解)
@Configuration // 此注解不是必须的
@EnableWebMvc
@ComponentScan("cn.tedu.springmvc") // 必须配置在当前配置类,不可配置在Spring的配置类
public class SpringMvcConfig implements WebMvcConfigurer {
}
接受请求参数
在Spring MVC中,当需要接收客户端的请求参数时,只需要将各参数直接声明为处理请求的方法的参数即可,例如:
/* http://localhost:8080/springmvc01_war_exploded/user/reg.do?
username=root&password=123456&age=25*/
@RequestMapping("/reg.do")
public String reg(String username, String password, Integer age) {
System.out.println("username = " + username
+ ", password = " + password
+ ", age = " + age);
return "OK";
}
需要注意:
- 如果客户端提交的请求中根本没有匹配名称的参数,则以上获取到的值将是null
- 例如:http://localhost/user/login.do
- 如果客户端仅提交了参数名称,却没有值,则以上获取到的值将是""(长度为0的字符串)
- 例如:http://localhost/user/login.do?username=&password=&age=
- 如果客户端提交了匹配名称的参数,并且值是有效的,则可以获取到值
- 例如:http://localhost/user/login.do?username=admin&password=1234&age=27
- 以上名称应该是由服务器端决定的,客户端需要根据以上名称来提交请求参数
- 声明参数时,可以按需将参数声明成期望的类型,例如以上将age声明为Integer类型
- 注意:声明成String以外的类型时,应该考虑是否可以成功转换类型
当有必要的情况下,可以在以上各参数的声明之前添加@RequestParam注解,其作用主要有:
- 配置name属性:客户端将按照此配置的值提交请求参数,而不再是根据方法的参数名称来提交请求参数
- 配置required属性:是否要求客户端必须提交此请求参数,默认为true,如果不提交,则出现400错误,当设置为false时,如果不提交,则服务器端将此参数值视为null
- 配置defaultValue属性:配置此请求参数的默认值,当客户端没有提交此请求参数时,视为此值
另外,如果需要客户端提交的请求参数较多,可以将这些参数封装为自定义的数据类型,并将自定义的数据类型作为处理方法的参数即可,例如:
cn.tedu.springmvc.dto.UserRegDTO
public class UserRegDTO {
private String username;
private String password;
private Integer age;
// 生成Setters & Getters
// 生成toString()
}
UserController(代码片段)
/* http://localhost:8080/springmvc01_war_exploded/user/reg.do?
username=root&password=123456&age=25*/
@RequestMapping("/reg.do")
public String reg(UserRegDTO userRegDTO) {
System.out.println(userRegDTO);
return "OK";
}
需要注意,不要将@RequestParam添加在封装的类型之前。
另外,你也可以将多个请求参数区分开来,一部分直接声明为处理请求的方法的参数,另一部分封装起来。
关于RESTful
百科资料:RESTFUL是一种网络应用程序的设计风格和开发方式,基于HTTP,可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景,实现第三方OTT调用移动网络资源的功能,动作类型为新增、变更、删除所调用资源。
RESTful的设计风格的典型表现就是:将某些唯一的请求参数的值放在URL中,使之成为URL的一部分,例如https://www.zhihu.com/question/28557115这个URL的最后一部分28557115应该就是这篇贴子的id值,而不是使用例如?id=28557115
这样的方式放在URL参数中。
注意:RESTful只是一种设计风格,并不是一种规定,也没有明确的或统一的执行方式!
如果没有明确的要求,以处理用户数据为例,可以将URL设计为:
- /users:查看用户列表
- /users/9527:查询id=9527的用户的数据
- /users/9527/delete:删除id=9527的用户的数据
在RESTful风格的URL中,大多是包含了某些请求参数的值,在使用Spring MVC框架时,当需要设计这类URL时,可以使用{名称}进行占位,并在处理请求的方法的参数列表中,使用@PathVariable注解请求参数,即可将占位符的实际值注入到请求参数中!
例如:
// http://localhost:8080/springmvc01_war_exploded/user/3/info.do
@GetMapping("/{id}/info.do")
public UserVO info(@PathVariable Long id) {
System.out.println("即将查询 id = " + id + " 的用户的信息……");
UserVO userVO = new UserVO();
userVO.setUsername("chengheng");
userVO.setPassword("1234567890");
userVO.setEmail("chengheng@qq.com");
return userVO;
}
提示:在以上代码中,URL中使用的占位符是{id},则方法的参数名称也应该是id,就可以直接匹配上!如果无法保证这2处的名称一致,则需要在@PathVariable注解中配置占位符中的名称,例如:
@GetMapping("/{userId}/info.do")
public UserVO info(@PathVariable("userId") Long id) {
// ...
}
在使用{}格式的占位符时,还可以结合正则表达式进行匹配,其基本语法是:
{占位符名称:正则表达式}
例如:
@GetMapping("/{id:[0-9]+}/info.do")
当设计成以上URL时,仅当占位符位置的是纯数字的URL才会被匹配上,如果不是纯数字的刚出现404错误页面。
并且,以上模式的多种不冲突的正则表达式是可以同时存在的,例如:
@GetMapping("/{id:[0-9]+}/info.do")
public UserVO info(@PathVariable Long id) {
System.out.println("即将查询 id = " + id + " 的用户的信息……");
// ...
}
@GetMapping("/{username:[a-zA-Z]+}/info.do")
public UserVO info(@PathVariable String username) {
System.out.println("即将查询 用户名 = " + username + " 的用户的信息……");
// ...
}
甚至,还可以存在不使用正则表达式,但是URL格式几乎一样的配置:
@GetMapping("/{id:[0-9]+}/info.do")
public UserVO info(@PathVariable Long id) {
System.out.println("即将查询 id = " + id + " 的用户的信息……");
// ...
}
@GetMapping("/{username:[a-zA-Z]+}/info.do")
public UserVO info(@PathVariable String username) {
System.out.println("即将查询 用户名 = " + username + " 的用户的信息……");
// ...
}
// 【以下是新增的】
// http://localhost:8080/springmvc01_war_exploded/user/list/info.do
@GetMapping("/list/info.do")
public UserVO list() {
System.out.println("即将查询 用户的列表 的信息……");
// ...
}
最终执行时,如果使用/user/list/info.do,则会匹配到以上代码中的最后一个方法,并不会因为这个URL还能匹配第2个方法配置的{username:[a-zA-Z]+}而产生冲突。所以,使用了占位符的做法并不影响精准匹配的路径。
关于响应正文时的结果类型
当响应正文时,只要方法的返回值是自定义的数据类型,则Spring MVC框架就一定会调用jackson-databind中的转换器,就可以将结果转换为JSON格式的字符串!
通常,在项目开发中,会定义一个“通用”的数据类型,无论是哪个控制器的哪个处理请求的方法,最终都将返回此类型!
显示的通用返回类型如下:
public class JsonResult<T> {
private Integer state; // 业务返回码
private String message; // 消息
private T data; // 数据
private JsonResult() { }
public static JsonResult<Void> ok() {
return ok(null);
}
public static <T> JsonResult<T> ok(T data) {
JsonResult<T> jsonResult = new JsonResult<>();
jsonResult.state = State.OK.getValue();
jsonResult.data = data;
return jsonResult;
}
public static JsonResult<Void> fail(State state, String message) {
JsonResult<Void> jsonResult = new JsonResult<>();
jsonResult.state = state.getValue();
jsonResult.message = message;
return jsonResult;
}
public enum State {
OK(20000),
ERR_USERNAME(40400),
ERR_PASSWORD(40600);
Integer value;
State(Integer value) {
this.value = value;
}
public Integer getValue() {
return value;
}
}
// Setters & Getters
}
统一处理异常
Spring MVC框架提供了统一处理异常的机制,使得特定种类的异常对应一段特定的代码,后续,当编写代码时,无论在任何位置,都可以将异常直接抛出,由统一处理异常的代码进行处理即可!
关于统一处理异常,需要自定义方法对异常进行处理,关于此方法:
- 注解:需要添加@ExceptionHandler注解
- 访问权限:应该是公有的
- 返回值类型:可参考处理请求的方法的返回值类型
- 方法名称:自定义
- 参数列表:必须包含1个异常类型的参数,并且可按需添加HttpServletRequest,HttpServletResponse等少量特定的类型的参数,不可以随意添加参数
例如:
@ExceptionHandler
public String handleException(NullPointerException e) {
return "Error, NullPointerException!";
}
需要注意:以上处理异常的代码,只能作用于当前控制器类中各个处理请求的方法,对其它控制器类的中代码并不产生任何影响,也就无法处理其它控制类中处理请求时出现的异常!
为保证更合理的处理异常,应该:
- 将处理异常的代码放在专门的类中
- 在此类上添加@ControllerAdvice注解
- 由于目前主流的响应方式都是“响应正文”的,则可以将@ControllerAdvice替换为@RestControllerAdvice
所以,可以创建GlobalExceptionHandler类,代码如下:
- 由于目前主流的响应方式都是“响应正文”的,则可以将@ControllerAdvice替换为@RestControllerAdvice
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler
public String handleException(NullPointerException e) {
return "Error, NullPointerException!";
}
}
另外,可以将处理异常的代码放在所有控制器类公共的父类中,则各控制器类都相当于有此代码,则处理异常的代码可以作用于所有控制器中处理请求的方法!但不推荐此做法。
在以上处理异常的过程中,Spring MVC的处理模式大致如下:
try {
userController.npe();
} catch (NullPointerException e) {
globalExceptionHandler.handleException(e);
}
关于以上处理的方法的参数中的异常类型,将对应Spring MVC框架能够统一处理的异常类型,例如将其声明为Throwable时,所有异常都可被此方法进行处理!但是,在处理过程中,应该判断当前异常对象所归属的类型,以针对不同类型的异常进行不同的处理!
需要注意:允许存在多个统一处理异常的方法,例如:
@ExceptionHandler
public String handleNullPointerException(NullPointerException e) {
return "Error, NullPointerException!";
}
@ExceptionHandler
public String handleNumberFormatException(NumberFormatException e) {
return "Error, NumberFormatException!";
}
@ExceptionHandler
public String handleThrowable(Throwable e) {
e.printStackTrace();
return "Error, Throwable!";
}
并且,如果某个异常能够被多个方法处理(异常类型符合多个处理异常的方法的参数类型),则优先执行最能精准匹配的处理异常的方法,例如,当出现NullPointerException时,将执行handleNullPointerException()而不会执行handleThrowable()!
在开发实践中,通常都会有handleThrowable()方法,以避免某个异常没有被处理而导致500错误!
关于@ExceptionHandler注解,可用于表示被注解的方法是用于统一处理异常的,而且,可用于配置被注解的方法能够处理的异常的类型,其效力的优先级高于在方法的参数上指定异常类型。
在开发实践中,建议为每一个@ExceptionHandler配置注解参数,在注解参数中指定需要处理异常的类型,而处理异常的方法的参数直接使用Throwable即可。
例如:
@ExceptionHandler({
NullPointerException.class,
ClassCastException.class
})
public String handleNullPointerException(Throwable e) {
return "Error, NullPointerException or ClassCastException!";
}
@ExceptionHandler(NumberFormatException.class)
public String handleNumberFormatException(Throwable e) {
return "Error, NumberFormatException!";
}
@ExceptionHandler(Throwable.class)
public String handleThrowable(Throwable e) {
return "Error, Throwable!";
}
拦截器(Interceptor)
在Spring MVC框架中,拦截器是可以运行在所有控制器处理请求之前和之后的一种组件,并且,如果拦截器运行在控制器处理请求之前,还可以选择对当前请求进行阻止或放行。
注意:拦截器的目的并不是“拦截下来后阻止运行”,更多的是“拦截下来后执行某些代码”,其优势在于可作用于若干种不同请求的处理过程,即写一个拦截器,就可以在很多种请求的处理过程中被执行。
只要是若干种不同的请求过程中都需要执行同样的或高度相似的代码,都可以使用拦截器解决,典型的例如验证用户是否已经登录等等。
当需要使用拦截器时,首先,需要自定义类,实现HandlerInterceptor接口,例如:
package cn.tedu.springmvc.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("LoginInterceptor.preHandle()");
return false;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("LoginInterceptor.postHandle()");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("LoginInterceptor.afterCompletion()");
}
}
每个拦截器都必须注册才会被启用,注册过程通过重写WebMvcConfigure接口中的addInterceptors()方法即可,例如:
@Configuration // 此注解不是必须的
@EnableWebMvc
@ComponentScan("cn.tedu.springmvc") // 必须配置在当前配置类,不可配置在Spring的配置类
public class SpringMvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInterceptor())
.addPathPatterns("/user/login.do");
}
}
当进行访问时,在浏览器窗口中将看到一片空白,在Tomcat控制台可以看到preHandle()方法已经执行。当把拦截器中preHandle()方法的返回值改为true时,在Tomcat控制台可以看到依次执行了preHandle() > 控制器中处理请求的方法 > postHandle() > afterCompletion()。
其实,preHandle()方法的返回值为true时,表示“放行”,为false时,表示“阻止”。
关于注册拦截器时的配置,使用链式语法可以先调用addInterceptor()方法添加拦截器,然后调用addPathPatter()方法添加哪些路径需要被拦截,此方法的参数可以是String…,也可以是List,在编写路径值时,可以使用作为通配符,例如配置为/user/,则可以匹配/user/login.do、/user/reg.do等所有直接在/user下的路径,但不能匹配/user/1/info.do,如果需要匹配若干层级,必须使用2个连续的星号,例如配置为/user/**。一旦使用通配符,就有可能导致匹配的范围过大,例如配置为/user/**时,还可以匹配到/user/reg.do(注册)和/user/login.do(登录),如果此拦截器是用于“验证用户是否登录”的,则不应该对这2个路径进行处理,那么,配置拦截器时,还可以在链式语法中调用excludePathPattern()方法,以添加“排除路径”(例外)。
配置示例:
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoginInterceptor())
.addPathPatterns("/user/**")
.excludePathPatterns("/user/reg.do", "/user/login.do");
}
关于Spring MVC的小结
关于Spring MVC框架,你应该:
- 理解Spring MVC框架的作用
- 接收请求,响应结果,处理异常……
- 掌握创建基于Maven的运行在Tomcat的Webapp
- 认识基础的依赖项
- spring-webmvc、javax.servlet-api、jackson-databind
- 掌握配置Spring MVC的运行环境(使得控制器能接收到请求)
- 掌握以下注解的使用:
- @Controller / @RestController
- @ResponseBody
- @RequestMapping / @GetMapping / @PostMapping …
- @RequestParam / @PathVariable
- @ExceptionHandler / @ControllerAdvice / @RestControllerAdvice
- @EnableWebMvc
- 掌握接收请求参数的方式
- 将请求参数直接声明在处理请求的方法的参数列表中
- 将若干个请求参数进行封装,并将封装的类型声明在处理请求的方法的参数列表中
- 如果是URL中的路径,则需要使用@PathVariable
- 掌握响应JSON格式的正文的做法
- 处理请求的方法必须添加@ResponseBody,或当前控制器类添加@ResponseBody,或当前控制器类添加@RestController
- 在Spring MVC配置类上添加@EnableWebMvc
- 在项目的pom.xml中添加了jackson-databind
- 处理请求的方法返回自定义的数据类型
- 掌握响应JSON格式的正文时,统一的响应类型的类的设计
- 了解RESTful风格
- 掌握统一处理异常
- 掌握拦截器的创建与配置
附:关于POJO
所有用于封装属性的类型都可以统称为POJO。
常见的POJO后缀有:BO、DO、VO、DTO等,不同的后缀表示不同的意义,例如:VO = Value Object / View Object,DTO = Data Transfer Object ……
在一个项目中,哪些情景下使用哪种后缀并没有统一的规定,通常是各项目内部决定。
注意:在为封装属性的类进行命名时,以上BO、DO、VO、DTO等这些后缀的每一个字母都应该是大写的!