您现在的位置是：首页 >技术教程 >Spring MVC 框架网站首页技术教程

Spring MVC 框架

红尘不染 2024-06-17 10:43:05
简介Spring MVC 框架

Spring MVC 框架

Spring MVC 简介

Spring MVC 是属于 Spring 框架的一部分。主要用来进行Web开发，是对Servlet进行了封装。
对于Spring MVC的主要学习内容如下：

  • Spring MVC 简介
  • 请求与响应
  • REST风格
  • SSM整合
  • 拦截器

Spring MVC是处于Web层的框架，主要的作用就是接受前端发过来的请求和数据，进行处理，然后将处理结果响应给前端。
REST 是一种请求的风格，可以降低开发的复杂度，提高系统的可伸缩性，REST风格应用十分广泛。

对于Spring MVC的学习，要达成的目标：

  • 掌握基于SpringMVC获取请求参数和响应json数据操作
  • 熟练应用基于REST风格的请求路径设置和参数传递
  • 能够根据实际业务建立前后端开发通信协议并进行实现
  • 基于SSM整合技术开发

Spring MVC 概述

Web程序大多基于三层架构来实现的。

请添加图片描述
后端服务器拆分为三层，分别是web，service，dao。

  • web层主要由servlet来处理，负责页面请求和数据的收集及其响应结果给前端。
  • service 层主要负责业务逻辑的处理。
  • dao层主要负责数据的增删改查操作。
    servlet 处理请求和数据的时候，存在的问题是一个servlet 只能处理一个请求。
    针对 web层进行了优化，采用 MVC模式，将其设计为controller，view和model。
  • controller 负责请求和数据的接收，接收后将其转发给service进行业务处理。
  • service 根据需要会调用dao对数据进行增删改查。
  • dao 把数据处理完将结果交给service，service 再交给controller。
  • controller 根据需求组装成 Model 和 View，Model 和 View 组合生成页面转发前端。

上述过程是同步调用的情况。
前端如果通过异步调用的方式进行交互，后台就需要将返回的数据转换成json格式进行返回。

SpringMVC主要负责的就是

  • controller如何接收请求和数据
  • 如何将请求和数据转发给业务层
  • 如何将响应数据转换成json发回到前端

SpringMVC是一种基于Java实现MVC模型的轻量级Web框架，使用简单、开发便捷、灵活性强。

Spring MVC入门案例

案例步骤

导包

<dependencies>
	<dependency>
		<groupId>javax.servlet</groupId>
		<artifactId>javax.servlet-api</artifactId>
		<version>3.1.0</version>
		<scope>provided</scope>
	</dependency>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-webmvc</artifactId>
		<version>5.2.10.RELEASE</version>
	</dependency>
</dependencies>

scope是maven中jar包依赖作用范围的描述，如果不设置默认是compile在在编译、运行、测试时均有效，如果运行有效的话就会和tomcat中的servlet-api包发生冲突，导致启动报错。provided代表的是该包只在编译和测试的时候用，运行的时候无效直接使用tomcat中的，就避免冲突。

创建配置类

@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}

创建Controller类

@Controller
public class UserController {
	@RequestMapping("/save")
	public String save(){
		System.out.println("user save ...");
		return "{'info':'springmvc'}";
	}
}

创建web容器配置类，初始化web容器。

public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
	// 加载springmvc配置类
	protected WebApplicationContext createServletApplicationContext() {
	// 初始化WebApplicationContext对象
		AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
		// 加载指定配置类
		ctx.register(SpringMvcConfig.class);
		return ctx;
	} 
	// 设置由springmvc控制器处理的请求映射路径
	protected String[] getServletMappings() {
		return new String[]{"/"};
	} 
	// 加载spring配置类
	protected WebApplicationContext createRootApplicationContext() {
		return null;
	}
}

配置tomcat环境，启动项目。访问 http://localhost/save，就可以进入到 UserController 中的 save 方法。save方法会返回json数据。
注意事项

  • SpringMVC是基于Spring的，在pom.xml只导入了spring-webmvc的 jar 包的原因是它会自动依赖 spring相关坐标。
  • AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类。
  • AbstractDispatcherServletInitializer 提供了三个接口方法供用户实现。
    createServletApplicationContext 方法，创建Servlet容器时，加载SpringMVC对应的bean并放入WebApplicationContext对象范围中，而WebApplicationContext的作用范围为ServletContext范围，即整个web容器范围。
    getServletMappings方法，设定SpringMVC对应的请求映射路径，即SpringMVC拦截哪些请求。
    createRootApplicationContext方法，如果创建Servlet容器时需要加载非SpringMVC对应的bean,使用当前方法进行，使用方式和createServletApplicationContext相同。createServletApplicationContext用来加载SpringMVC环境。
    createRootApplicationContext用来加载Spring环境。

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

案例总结

步骤
创建项目，导入坐标，创建SpringMVC 配置类，创建 Web 容器启动类。定义处理请求的控制类，定义处理请求的控制器方法，配置映射路径与返回json数据。

流程解析
启动服务器初始化过程

  • 服务器启动，执行ServletContainersInitConfig类，初始化web容器
  • 执行createServletApplicationContext方法，创建了WebApplicationContext对象，加载SpringMVC的配置类SpringMvcConfig来初始化SpringMVC的容器。
  • 加载SpringMvcConfig配置类
  • 执行@ComponentScan加载对应的bean
  • 加载UserController，每个@RequestMapping的名称对应一个具体的方法
  • 执行getServletMappings方法，设定SpringMVC拦截请求的路径规则，只有被拦截到的请求，才交给SpringMVC处理。

单次请求过程

  • 发送请求http://localhost/save
  • web容器发现该请求满足SpringMVC拦截规则，将请求交给SpringMVC处理
  • 解析请求路径/save
  • 由/save匹配执行对应的方法save(）
  • 执行save()
  • 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方。

Bean 加载控制

Spring和SpringMVC 的配置类，都需要加载Bean，需要控制让它们各自加载各自需要的资源。

SpringMVC加载其相关bean(表现层bean),也就是controller包下的类。
Spring需要加载业务bean(Service)，功能bean(DataSource,SqlSessionFactoryBean等)。
使用 @ComponentSca注解，控制加载不同的bean

目录结构
请添加图片描述
SpringMVC配置类，设定扫描范围，只加载controller下的bean

@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}

Spring配置类 ，设定扫描范围为com.itheima，排除掉controller 包中的bean。

@Configuration
@ComponentScan(value="com.itheima", 
	excludeFilters = @ComponentScan.Filter(
		type = FilterType.ANNOTATION,
		classes = Controller.class
	)
) 
public class SpringConfig {
}

excludeFilters属性：设置扫描加载bean时，排除的过滤规则。
type属性：设置排除规则，当前使用按照bean定义时的注解类型进行排除。

  • ANNOTATION：按照注解排除
  • ASSIGNABLE_TYPE:按照指定的类型过滤
  • ASPECTJ:按照Aspectj表达式排除，基本上不会用
  • REGEX:按照正则表达式排除
  • CUSTOM:按照自定义规则排除

classes属性：设置排除的具体注解类，当前设置排除@Controller定义的bean

创建web容器配置类，加载web容器。继承 AbstractAnnotationConfigDispatcherServletInitializer。简化web容器配置类。

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
	protected Class<?>[] getRootConfigClasses() {
		return new Class[]{SpringConfig.class};
	} 
	protected Class<?>[] getServletConfigClasses() {
		return new Class[]{SpringMvcConfig.class};
	} 
	protected String[] getServletMappings() {
		return new String[]{"/"};
	}
}

在这里插入图片描述

请求与响应

@RequestMapping 设置请求路径

设置请求映射路径，路径不能重复，一个访问路径对应一个方法。
使用 @RequestMapping 注解在类上和方法上添加路径。

@Controller
@RequestMapping("/user")
public class UserController {
	@RequestMapping("/save")
	@ResponseBody
	public String save(){
		System.out.println("user save ...");
		return "{'module':'user save'}";
	} 
	@RequestMapping("/delete")
	@ResponseBody
	public String delete(){
		System.out.println("user delete ...");
		return "{'module':'user delete'}";
	}
} 
@Controller
@RequestMapping("/book")
public class BookController {
	@RequestMapping("/save")
	@ResponseBody
	public String save(){
		System.out.println("book save ...");
		return "{'module':'book save'}";
	}
}

@RequestMapping 在类上设置路径，则为类中所有方法的请求路径的前缀。
如 UserController类 的 delete方法对应的请求路径为 /user/delete，BookController 类中的 save方法对应的请求路径为 /book/save。
@RequestMapping注解value属性前面加不加 / 都可以，@RequestMapping(“/book”) 和 @RequestMapping(“book”) 效果一样。

请求参数

请求路径设置好后，只要确保页面发送请求地址和后台Controller类中配置的路径一致，就可以接收到前端的请求。
关于请求参数的传递与接收是和请求方式有关系的，目前比较常见的两种请求方式为：GET，POST。

GET发送单个参数 http://localhost/commonParam?name=itcast
接受参数：

@Controller
public class UserController {
	@RequestMapping("/commonParam")
	@ResponseBody
	public String commonParam(String name){
		System.out.println("普通参数传递 name ==> "+name);
		return "{'module':'commonParam'}";
	}
}

GET发送多个参数 http://localhost/commonParam?name=itcast&age=15
接收参数：

Controller
public class UserController {
	@RequestMapping("/commonParam")
	@ResponseBody
	public String commonParam(String name,int age){
		System.out.println("普通参数传递 name ==> "+name);
		System.out.println("普通参数传递 age ==> "+age);
		return "{'module':'commonParam'}";
	}
}

GET 发送的参数是在请求路径中，后台方法的形参名称只需要和路径中的名称对应即可接受到。

POST 发送参数，POST请求发送的数据在请求体中，使用 PostMan 模拟POST请求。
在这里插入图片描述
接受参数和GET一致，将方法的形参名称和参数名称对应，就可以接收到。

@Controller
public class UserController {
	@RequestMapping("/commonParam")
	@ResponseBody
	public String commonParam(String name,int age){
		System.out.println("普通参数传递 name ==> "+name);
		System.out.println("普通参数传递 age ==> "+age);
		return "{'module':'commonParam'}";
	}
}

对于参数中如果有中文字符，可能会有中文乱码问题。配置过滤器，设置编码。

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer{
	protected Class<?>[] getRootConfigClasses() {
		return new Class[0];
	} 
	protected Class<?>[] getServletConfigClasses() {
		return new Class[]{SpringMvcConfig.class};
	} 
	protected String[] getServletMappings() {
		return new String[]{"/"};
	} 
	//乱码处理
	@Override
	protected Filter[] getServletFilters() {
		CharacterEncodingFilter filter = new CharacterEncodingFilter();
		filter.setEncoding("UTF-8");
		return new Filter[]{filter};
	}
}

五种类型参数传递

常见的参数种类有: 普通参数，POJO类型参数，嵌套POJO类型参数，数组类型参数，集合类型参数。

普通参数

普通参数：url 地址传参，地址参数名和形参变量名相同，定义形参即可接受参数。
如果形参与地址参数名不一致，数据就不能接收成功。可以使用 @RequestParam注解 指定接受路径中的参数名称。
发生请求：http://localhost/commonParamDifferentName?name=张三&age=18

@RequestMapping("/commonParamDifferentName")
@ResponseBody
public String commonParamDifferentName(@RequestParam("name") String userName , int age){
	System.out.println("普通参数传递 userName ==> "+userName);
	System.out.println("普通参数传递 age ==> "+age);
	return "{'module':'common param different name'}";
}

@RequestPaam(“name”) 指定路径中的参数名称，将数据传入形参中。

POJO 数据类型

如果参数比较多，那么后台接收参数的时候就比较复杂，这个时候可以考虑使用POJO数据类型。
POJO参数：请求参数名与形参对象属性名相同，定义POJO类型形参即可接收参数。

public class User {
	private String name;
	private int age;
	//setter...getter...略
}

请添加图片描述
后台接收参数：

@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
	System.out.println("pojo参数传递 user ==> "+user);
	return "{'module':'pojo param'}";
}

POJO参数接收，前端GET和POST发送请求数据的方式不变。请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

嵌套POJO类型参数

POJO对象中嵌套了其他的POJO类，如下

public class Address {
	private String province;
	private String city;
	//setter...getter...略
} 
public class User {
	private String name;
	private int age;
	private Address address;
	// setter...getter...略
}

嵌套POJO参数：请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套POJO属性参数。
请添加图片描述

// POJO参数：请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
	System.out.println("pojo参数传递 user ==> "+user);
	return "{'module':'pojo param'}";
}

请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

数组类型参数

数组参数：请求参数名与形参对象属性名相同且请求参数为多个，定义数组类型即可接收参数。
请添加图片描述

//数组参数：同名请求参数可以直接映射到对应名称的形参数组对象中
@RequestMapping("/arrayParam")
@ResponseBody
public String arrayParam(String[] likes){
	System.out.println("数组参数传递 likes ==> "+ Arrays.toString(likes));
	return "{'module':'array param'}";
}

集合类型参数

请添加图片描述

//集合参数：同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
@RequestMapping("/listParam")
@ResponseBody
public String listParam(@RequestParam List<String> likes){
	System.out.println("集合参数传递 likes ==> "+ likes);
	return "{'module':'list param'}";
}

集合保存普通参数：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam绑定
参数关系。
在这里插入图片描述

JSON 数据传输参数

前后台以异步方式进行交换，传输的数据使用的是JSON。
对于JSON数据类型，我们常见的有三种:

  • json普通数组（[“value1”,“value2”,“value3”,…]）
  • json对象（{key1:value1,key2:value2,…}）
  • json对象数组（[{key1:value1,…},{key2:value2,…}]）

SpringMVC默认使用的是jackson来处理json的转换，所以需要在pom.xml添加jackson依赖。

<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-databind</artifactId>
	<version>2.9.0</version>
</dependency>

还需要在配置类中开启SpringMVC注解支持，这里面就包含了JSON转换对象的功能。

@Configuration
@ComponentScan("com.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}

参数前添加@RequestBody，表示从请求体中获取JSON数据
JSON普通数组
请添加图片描述

//使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据
@RequestMapping("/listParamForJson")
@ResponseBody
public String listParamForJson(@RequestBody List<String> likes){
	System.out.println("list common(json)参数传递 list ==> "+likes);
	return "{'module':'list common for json param'}";
}

JSON对象数据
请添加图片描述

@RequestMapping("/pojoParamForJson")
@ResponseBody
public String pojoParamForJson(@RequestBody User user){
	System.out.println("pojo(json)参数传递 user ==> "+user);
	return "{'module':'pojo for json param'}";
}

JSON对象中的属性名要和POJO对象的属性名相同才能接受数据。

JSON对象数组
请添加图片描述

@RequestMapping("/listPojoParamForJson")
@ResponseBody
public String listPojoParamForJson(@RequestBody List<User> list){
	System.out.println("list pojo(json)参数传递 list ==> "+list);
	return "{'module':'list pojo for json param'}";
}

SpringMVC接收JSON数据的实现步骤为:
(1) 导入jackson包
(2) 使用PostMan发送JSON数据
(3) 开启SpringMVC注解驱动，在配置类上添加@EnableWebMvc注解
(4) Controller方法的参数前添加@RequestBody注解

在这里插入图片描述
在这里插入图片描述
@RequestBody与@RequestParam区别
@RequestParam用于接收url地址传参
@RequestBody用于接收json数据

日期类型参数传递

使用@DateTimeFormat 注解，进行日期格式转换。
请添加图片描述

@RequestMapping("/dataParam")
@ResponseBody
public String dataParam(Date date,
		@DateTimeFormat(pattern="yyyy-MM-dd") Date date1,
		@DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss") Date date2){
	System.out.println("参数传递 date ==> "+date);
	System.out.println("参数传递 date1(yyyy-MM-dd) ==> "+date1);
	System.out.println("参数传递 date2(yyyy/MM/dd HH:mm:ss) ==> "+date2);
	return "{'module':'data param'}";
}

默认接受的日期格式为 yyyy/mm/dd。其它的日期格式可以用 @DateTimeFormat 注解进行转换。
在这里插入图片描述

响应

SpringMVC接收到请求和数据后，进行处理，处理完以后，都需要将结果返回前端。
对于响应，主要包括两部分，页面和数据。主要了解响应返回 JSON 数据。

响应页面
响应页面其实就是将返回的 String 作为页面的地址，跳转到这个页面。

@Controller
public class UserController {
	@RequestMapping("/toJumpPage")
	//1.此处不能添加@ResponseBody,如果加了该注入，会直接将page.jsp当字符串返回前端
	//2.方法需要返回String
	public String toJumpPage(){
		System.out.println("跳转页面");
		return "page.jsp";
	}
}

响应文本数据

@Controller
public class UserController {
	@RequestMapping("/toText")
	@ResponseBody
	public String toText(){
		System.out.println("返回纯文本数据");
		return "response text";
	}
}

响应JSON数据
返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖 @ResponseBody注解和 @EnableWebMvc注解

@Controller
public class UserController {
	@RequestMapping("/toJsonPOJO")
	@ResponseBody
	public User toJsonPOJO(){
		System.out.println("返回json对象数据");
		User user = new User();
		user.setName("itcast");
		user.setAge(15);
		return user;
	}
}

响应POJO集合对象

@Controller
public class UserController {
	@RequestMapping("/toJsonList")
	@ResponseBody
	public List<User> toJsonList(){
		System.out.println("返回json集合数据");
		User user1 = new User();
		user1.setName("传智播客");
		user1.setAge(15);
		User user2 = new User();
		user2.setName("黑马程序员");
		user2.setAge(12);
		List<User> userList = new ArrayList<User>();
		userList.add(user1);
		userList.add(user2);
		return userList;
	}
}

在这里插入图片描述
当方法上有@ReponseBody注解后，方法的返回值为字符串，会将其作为文本内容直接响应给前端。方法的返回值为对象，会将对象转换成JSON响应给前端。

REST 风格

REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格。
REST风格描述形式

http://localhost/users 查询全部用户信息 GET（查询）
http://localhost/users/1 查询指定用户信息 GET（查询）
http://localhost/users 添加用户信息 POST（新增/保存）
http://localhost/users 修改用户信息 PUT（修改/更新）
http://localhost/users/1 删除用户信息 DELETE（删除）

REST的优点有：隐藏资源的访问行为，无法通过地址得知对资源是何种操作，书写简化。
REST 按照请求的方式，区分对资源进行的操作。
请求的方式，比较常用的就4种，分别是GET，POST，PUT，DELETE。
按照不同的请求方式代表不同的操作类型。

  • 发送GET请求是用来做查询
  • 发送POST请求是用来做新增
  • PUT请求是用来做修改
  • 发送DELETE请求是用来做删除

上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范。
描述模块的名称通常使用复数，也就是加s的格式描述，表示此类资源，而非单个资源，例如：users、books…

根据REST风格对资源进行访问称为RESTful。

案例

SpringMVC 配置类

@Configuration
@ComponentScan("com.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}

Web容器配置类

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
	protected Class<?>[] getRootConfigClasses() {
		return new Class[0];
	} 
	protected Class<?>[] getServletConfigClasses() {
		return new Class[]{SpringMvcConfig.class};
	} 
	protected String[] getServletMappings() {
		return new String[]{"/"};
	} 
	//乱码处理
	@Override
	protected Filter[] getServletFilters() {
		CharacterEncodingFilter filter = new CharacterEncodingFilter();
		filter.setEncoding("UTF-8");
		return new Filter[]{filter};
	}
}

实体类

public class User {
	private String name;
	private int age;
	//getter...setter...toString省略
} 
public class Book {
	private String name;
	private double price;
	//getter...setter...toString省略
}

UserController 和 BookController

@RestController
@RequestMapping("/users")
public class UserController {
	@PostMapping
	public String save(@RequestBody User user) {
		System.out.println("user save..."+user);
		return "{'module':'user save'}";
	} 
	@DeleteMapping("/{id}")
	public String delete(@PathVariable Integer id) {	
		System.out.println("user delete..." + id);
		return "{'module':'user delete'}";
	} 
	@PutMapping
	public String update(@RequestBody User user) {
		System.out.println("user update..." + user);
		return "{'module':'user update'}";
	} 
	@GetMapping("/{id}")
	public String getById(@PathVariable Integer id) {
		System.out.println("user getById..." + id);
		return "{'module':'user getById'}";
	} 
	@GetMapping
	public String getAll() {
		System.out.println("user getAll...");
		return "{'module':'user getAll'}";
	}
} 
@RestController
@RequestMapping("/books")
public class BookController {
	@PostMapping
	public String save(@RequestBody Book book){
		System.out.println("book save..." + book);
		return "{'module':'book save'}";
	} 
	@DeleteMapping("/{id}")
	public String delete(@PathVariable Integer id){
		System.out.println("book delete..." + id);
		return "{'module':'book delete'}";
	} 
	@PutMapping
	public String update(@RequestBody Book book){
		System.out.println("book update..." + book);
		return "{'module':'book update'}";
	} 
	@GetMapping("/{id}")
	public String getById(@PathVariable Integer id){
		System.out.println("book getById..." + id);
		return "{'module':'book getById'}";
	} 
	@GetMapping
	public String getAll(){
		System.out.println("book getAll...");
		return "{'module':'book getAll'}";
	}
}

在这里插入图片描述
接受参数的三个注解 @RequestBody、@RequestParam、@PathVariable

  • @RequestParam 用于接收url地址传参或表单传参，接受非json格式的数据
  • @RequestBody 用于接收json数据
  • @PathVariable 用于接收路径参数，使用{参数名称}描述路径参数
    在这里插入图片描述在这里插入图片描述

静态资源放行

如果请求是访问的静态资源，Spring MVC 需要进行放行。需要进行如下配置。

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
	//设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
	@Override
	protected void addResourceHandlers(ResourceHandlerRegistry registry) {
		//当访问/pages/????时候，从/pages目录下查找内容
		registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
		registry.addResourceHandler("/js/**").addResourceLocations("/js/");
		registry.addResourceHandler("/css/**").addResourceLocations("/css/");
		registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
	}
}

该配置类需要被Spring MVC容器加载，需要扫描到，才能生效。

SSM 整合

整合分析：

  1. 需要Web容器配置类，实现 AbstractAnnotationConfigDispatcherServletInitializer，getRootConfigClasses() ：返回Spring的配置类->需要SpringConfig配置类
    getServletConfigClasses() ：返回SpringMVC的配置类->需要SpringMvcConfig配置类
    getServletMappings() : 设置SpringMVC请求拦截路径规则
    getServletFilters() ：设置过滤器，解决POST请求中文乱码问题
  2. Spring 配置类，需要引入 Mybaits 配置类，Jdbc配置类，还需要扫描包，加载bean。
  3. Jdbc配置类，配置数据源，配置Spring事务。 Mybatis 配置类，配置 SqlSessionFactoryBean和MapperScannerConfigurer。
  4. Spring MVC配置类，扫描 Controller，开启 @EnableWebMvc注解。

创建SpringConfig配置类

@Configuration
@ComponentScan({"com.itheima.service"})
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class,MyBatisConfig.class})
@EnableTransactionManagement
public class SpringConfig {
}

创建JDBC配置类，配置数据源和事务管理器

public class JdbcConfig {
	@Value("${jdbc.driver}")
	private String driver;
	@Value("${jdbc.url}")
	private String url;
	@Value("${jdbc.username}")
	private String username;
	@Value("${jdbc.password}")
	private String password;
	@Bean
	public DataSource dataSource(){
		DruidDataSource dataSource = new DruidDataSource();
		dataSource.setDriverClassName(driver);
		dataSource.setUrl(url);
		dataSource.setUsername(username);
		dataSource.setPassword(password);
		return dataSource;
	} 
	@Bean
	public PlatformTransactionManager transactionManager(DataSource dataSource){
		DataSourceTransactionManager ds = new DataSourceTransactionManager();
		ds.setDataSource(dataSource);
		return ds;
	}
}

Mybatis配置类

public class MyBatisConfig {
	@Bean
	public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource){
		SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
		factoryBean.setDataSource(dataSource);
		factoryBean.setTypeAliasesPackage("com.itheima.domain");
		return factoryBean;
	} 
	@Bean
	public MapperScannerConfigurer mapperScannerConfigurer(){
		MapperScannerConfigurer msc = new MapperScannerConfigurer();
		msc.setBasePackage("com.itheima.dao");
		return msc;
	}
}

SpringMVC配置类

@Configuration
@ComponentScan("com.itheima.controller")
@EnableWebMvc
public class SpringMvcConfig {
}

Web容器配置类

public class ServletConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
	//加载Spring配置类
	protected Class<?>[] getRootConfigClasses() {
		return new Class[]{SpringConfig.class};
	} 
	//加载SpringMVC配置类
	protected Class<?>[] getServletConfigClasses() {
		return new Class[]{SpringMvcConfig.class};
	} 
	//设置SpringMVC请求地址拦截规则
	protected String[] getServletMappings() {
		return new String[]{"/"};
	} 
	//设置post请求中文乱码过滤器
	@Override
	protected Filter[] getServletFilters() {
		CharacterEncodingFilter filter = new CharacterEncodingFilter();
		filter.setEncoding("utf-8");
		return new Filter[]{filter};
	}
}

以上就完成了SSM的整合。在上面的基础上，可以进行功能模块的开发。

功能模块的开发步骤

  1. 创建数据库及表结构
  2. 创建与表结构对应的实体类
  3. 编写DAO接口
  4. 编写Service接口和实现类
  5. 编写Controller类

开发完成对应的功能模块，还有针对Service层的方法和Controller 层的方法，进行单元测试。 使用PostMan工具对Controller 层进行测试。

统一结果封装

在前后台交互中，使用统一封装方式。针对前端不同的请求，返回相同结构的数据结果，有助于前后台数据交互，前端在解析数据的时候，可以使用一种方式进行解析。

统一结果封装实现思路：
创建结果模型类

public class Result{
	private Object data;
	private Integer code;
	private String msg;
}

封装数据到data属性中，封装操作结果到code属性中，封装特殊消息到message(msg)属性中。

示例：
创建Result类

public class Result {
	//描述统一格式中的数据
	private Object data;
	//描述统一格式中的编码，用于区分操作，可以简化配置0或1表示成功失败
	private Integer code;
	//描述统一格式中的消息，可选属性
	private String msg;
	public Result() {
	} 
	//构造方法是方便对象的创建
	public Result(Integer code,Object data) {
		this.data = data;
		this.code = code;
	} 
	//构造方法是方便对象的创建
	public Result(Integer code, Object data, String msg) {
		this.data = data;
		this.code = code;
		this.msg = msg;
	} 
	//setter...getter...省略
}

定义返回码 Code类

//状态码
public class Code {
	public static final Integer SAVE_OK = 20011;
	public static final Integer DELETE_OK = 20021;
	public static final Integer UPDATE_OK = 20031;
	public static final Integer GET_OK = 20041;
	public static final Integer SAVE_ERR = 20010;
	public static final Integer DELETE_ERR = 20020;
	public static final Integer UPDATE_ERR = 20030;
	public static final Integer GET_ERR = 20040;
}

Controller类，返回统一结果

//统一每一个控制器方法返回值
@RestController
@RequestMapping("/books")
public class BookController {
	@Autowired
	private BookService bookService;
	@PostMapping
	public Result save(@RequestBody Book book) {
		boolean flag = bookService.save(book);
		return new Result(flag ? Code.SAVE_OK:Code.SAVE_ERR,flag);
	} 
	@PutMapping
	public Result update(@RequestBody Book book) {
		boolean flag = bookService.update(book);
		return new Result(flag ? Code.UPDATE_OK:Code.UPDATE_ERR,flag);
	} 
	@DeleteMapping("/{id}")
	public Result delete(@PathVariable Integer id) {
		boolean flag = bookService.delete(id);
		return new Result(flag ? Code.DELETE_OK:Code.DELETE_ERR,flag);
	} 
	@GetMapping("/{id}")
	public Result getById(@PathVariable Integer id) {
		Book book = bookService.getById(id);
		Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
		String msg = book != null ? "" : "数据查询失败，请重试！";
		return new Result(code,book,msg);
	} 
	@GetMapping
	public Result getAll() {
		List<Book> bookList = bookService.getAll();
		Integer code = bookList != null ? Code.GET_OK : Code.GET_ERR;
		String msg = bookList != null ? "" : "数据查询失败，请重试！";
		return new Result(code,bookList,msg);
	}
}

在Controller 中统一了返回结果，前端根据返回的结果，先从中获取code，根据code判断，如果成功则取data属性的值，如果失败，则取msg中的值做提示。

统一异常处理

在后端程序中，由于各种各样的原因，可能会出现各种异常，在出现异常的时候，就没有办法做统一的结果返回。
需要对异常进行统一处理，然后统一结果返回。

异常的种类及出现异常的原因：

  • 框架内部抛出的异常：因使用不合规导致
  • 数据层抛出的异常：因外部服务器故障导致（例如：服务器访问超时）
  • 业务层抛出的异常：因业务逻辑书写错误导致（例如：遍历业务书写操作，导致索引异常等）
  • 表现层抛出的异常：因数据收集、校验等规则导致（例如：不匹配的数据类型间导致异常）
  • 工具类抛出的异常：因工具类书写不严谨不够健壮导致（例如：必要释放的连接长期未释放等）

出现异常的地方和异常的种类多种多样，需要对异常进行统一的处理。为了方便对异常的统一处理。**将所有的异常都抛出到表现层进行统一处理。**需要针对异常的类别，分类处理。使用AOP，统一对表现层的异常进行处理。

SpringMVC提供了异常处理器，可以集中的，统一的处理项目中出现的异常。

异常处理器的使用案例
创建异常处理器类。

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
@RestControllerAdvice
public class ProjectExceptionAdvice {
	//除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
	@ExceptionHandler(Exception.class)
	public Result doException(Exception ex){
		System.out.println("嘿嘿,异常你哪里跑！")
		return new Result(666,null,"嘿嘿,异常你哪里跑！");
	}
}

确保SpringMvcConfig能够扫描到异常处理器类。
在Controller中出现异常的时候，就会被异常处理器所捕获。@ExceptionHandler注解指明了方法所处理的异常类。
在异常处理类的方法中，就可以对异常进行处理，并向前端返回统一结果。

在这里插入图片描述
此注解自带@ResponseBody注解与@Component注解，具备对应的功能
在这里插入图片描述
此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常。

由于异常的种类有很多，所有不可能为每一个异常都对应一个@ExceptionHandler，所以在处理异常之前，需要对异常进行一个分类。
异常分类

  • 业务异常（处理业务中，出现的异常，如数据不规范）
  • 系统异常（项目运行过程中可预见但无法避免的异常，如服务器宕机）
  • 其他异常（未预期到的异常）

将异常分类以后，针对不同类型的异常，要提供具体的解决方案。

具体实现：
自定义异常类，用于封装异常信息，对异常进行分类。

public class SystemException extends RuntimeException{
	private Integer code;
	public Integer getCode() {
		return code;
	} 
	public void setCode(Integer code) {
		this.code = code;
	} 
	public SystemException(Integer code, String message) {
		super(message);
		this.code = code;
	} 
	public SystemException(Integer code, String message, Throwable cause) {
		super(message, cause);
		this.code = code;
	}
}
public class BusinessException extends RuntimeException{
	private Integer code;
	public Integer getCode() {
		return code;
	} 
	public void setCode(Integer code) {
		this.code = code;
	} 
	public BusinessException(Integer code, String message) {
		super(message);
		this.code = code;
	} 
	public BusinessException(Integer code, String message, Throwable cause) {
		super(message, cause);
		this.code = code;
	}
}

Code 类，定义异常状态码

public class Code {
	public static final Integer SAVE_OK = 20011;
	public static final Integer DELETE_OK = 20021;
	public static final Integer UPDATE_OK = 20031;
	public static final Integer GET_OK = 20041;
	public static final Integer SAVE_ERR = 20010;
	public static final Integer DELETE_ERR = 20020;
	public static final Integer UPDATE_ERR = 20030;
	public static final Integer GET_ERR = 20040;
	public static final Integer SYSTEM_ERR = 50001;
	public static final Integer SYSTEM_TIMEOUT_ERR = 50002;
	public static final Integer SYSTEM_UNKNOW_ERR = 59999;
	public static final Integer BUSINESS_ERR = 60002;
}

Controller类的方法中，将出现的异常，包装自定义异常。

public Book getById(Integer id) {
	//模拟业务异常，包装成自定义异常
	if(id == 1){
		throw new BusinessException(Code.BUSINESS_ERR,"请不要使用你的技术挑战我的耐性!");
	} 
	//模拟系统异常，将可能出现的异常进行包装，转换成自定义异常
	try{
		int i = 1/0;
	}catch (Exception e){
		throw new SystemException(Code.SYSTEM_TIMEOUT_ERR,"服务器访问超时，请重试!",e);
	} 
	return bookDao.getById(id);
}

包装方式可以使用 try{} catch(){} 在catch中重新 throw 自定义异常即可，还可以直接throw自定义异常即可。

异常处理器类中处理自定义异常

@RestControllerAdvice
public class ProjectExceptionAdvice {
	@ExceptionHandler(SystemException.class)
	public Result doSystemException(SystemException ex){
		//记录日志
		//发送消息给运维
		//发送邮件给开发人员,ex对象发送给开发人员
		return new Result(ex.getCode(),null,ex.getMessage());
	} 
	@ExceptionHandler(BusinessException.class)
	public Result doBusinessException(BusinessException ex){
		return new Result(ex.getCode(),null,ex.getMessage());
	} 
	// 除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
	@ExceptionHandler(Exception.class)
	public Result doOtherException(Exception ex){
		//记录日志
		//发送消息给运维
		//发送邮件给开发人员,ex对象发送给开发人员
		return new Result(Code.SYSTEM_UNKNOW_ERR,null,"系统繁忙，请稍后再试！");
	}
}

统一异常处理总结：
将项目中的异常统一抛到到 Contrller 层。使用自定义异常包装异常对象，使用异常处理器进行处理，返回统一结果给前端。
在这里插入图片描述

拦截器

请添加图片描述
首先分析请求的过程。

  1. 浏览器发送一个请求会先到Tomcat的web服务器
  2. 如果是静态资源，会直接到Tomcat的项目部署目录下去直接访问
  3. 如果是动态资源，就需要交给项目的后台代码进行处理
  4. 在找到具体的方法之前，可以配置过滤器(可以配置多个)，按照顺序进行执行
  5. 然后SpringMVC会根据配置的规则进行拦截，如果满足规则，则进行处理，找到其对应的controller类中的方法进行执行，完成后返回结果。
  6. 如果不满足规则，则不进行处理。

拦截器就是在每个Controller方法执行的前后进行执行。
拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行。
拦截器作用:

  • 在指定的方法调用前后执行预先设定的代码
  • 阻止原始方法的执行
  • 总结：拦截器就是用来做增强

拦截器和过滤器之间的区别

  • 归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术
  • 拦截内容不同：Filter对所有访问进行增强，Interceptor仅针对SpringMVC的访问进行增强。
    请添加图片描述

拦截器案例
拦截器类，拦截器类要被SpringMVC容器扫描到。

@Component
//定义拦截器类，实现HandlerInterceptor接口
//注意当前类必须受Spring容器控制
public class ProjectInterceptor implements HandlerInterceptor {
	@Override
	//原始方法调用前执行的内容
	public boolean preHandle(HttpServletRequest request, HttpServletResponse
		response, Object handler) throws Exception {
		System.out.println("preHandle...");
		return true;
	} 
	@Override
	//原始方法调用后执行的内容
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,ModelAndView modelAndView) throws Exception {
		System.out.println("postHandle...");
	} 
	@Override
	//原始方法调用完成后执行的内容
	public void afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, Exception ex) throws Exception{
		System.out.println("afterCompletion...");
	}
}

配置拦截器类，设置拦截器需要拦截的请求。

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
	@Autowired
	private ProjectInterceptor projectInterceptor;
	@Override
	protected void addResourceHandlers(ResourceHandlerRegistry registry) {
		// 配置静态资源方行
		registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
	} 
	@Override
	protected void addInterceptors(InterceptorRegistry registry) {
		// 配置拦截器
		registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
	}
}

SpringMVC添加SpringMvcSupport包扫描

@Configuration
@ComponentScan({"com.itheima.controller","com.itheima.config"})
@EnableWebMvc
public class SpringMvcConfig{
}

在拦截器配置中，/books和 /books/* 的请求将会被拦截器拦截。在拦截器的preHandle方法，只有当该方法返回值为true，请求才会继续向后执行。

拦截器的执行流程：
请添加图片描述
拦截器参数：
前置处理方法 preHandle，原始方法之前运行preHandle
request：请求对象
response：响应对象
handler：被调用的处理器对象，本质上是一个方法对象，对反射中的Method对象进行了再包装
使用handler参数，可以获取方法的相关信息

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
	System.out.println("preHandle");
	return true;
}

后置处理方法postHandle，如果原始方法被拦截，则不执行
前三个参数和上面的是一致的。
modelAndView：如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整

public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
	System.out.println("postHandle");
}

完成处理方法，拦截器最后执行的方法，无论原始方法是否执行
前三个参数与上面的是一致的。
ex：如果处理器执行过程中出现异常对象，可以针对异常情况进行单独处理

public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,Exception ex) throws Exception {
	System.out.println("afterCompletion");
}

拦截器链配置，为一个请求可以配置多个拦截器。
拦截器类

@Component
public class ProjectInterceptor2 implements HandlerInterceptor {
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse
		response, Object handler) throws Exception {
		System.out.println("preHandle...222");
		return false;
	} 
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
		System.out.println("postHandle...222");
	} 
	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
		System.out.println("afterCompletion...222");
	}
}

配置拦截器类

@Configuration
@ComponentScan({"com.itheima.controller"})
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {
	@Autowired
	private ProjectInterceptor projectInterceptor;
	@Autowired
	private ProjectInterceptor2 projectInterceptor2;
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		//配置多拦截器
		registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
		registry.addInterceptor(projectInterceptor2).addPathPatterns("/books","/books/*");
	}
}

拦截器执行的顺序是和配置顺序有关。

  • 当配置多个拦截器时，形成拦截器链
  • 拦截器链的运行顺序参照拦截器添加顺序为准
  • 当拦截器中出现对原始处理器的拦截，后面的拦截器均终止运行
  • 当拦截器运行中断，仅运行配置在前面的拦截器的afterCompletion操作

请添加图片描述

风语者！平时喜欢研究各种技术，目前在从事后端开发工作，热爱生活、热爱工作。

站长推荐