Spring MVC框架（spring MVC框架的优点）

Spring MVC是基于Spring框架基础之上的，主要解决了后端服务器接收客户端提交的请求，并给予响应的相关问题

MVC = Model + View + Controller，它们分别是：

1. – Model：数据模型，通常由业务逻辑层（Service Layer）和数据访问层（Data Access Object Layer）共同构成
2. – View：视图
3. – Controller：控制器 – MVC为项目中代码的职责划分提供了参考

【注意】Spring MVC框架只关心V - C之间的交互，与M其实没有任何关系

Spring MVC的核心执行流程图

创建Spring MVC工程

pom.xml中添加spring-webmvc依赖项：

<!-- https://mvnrepository.com/artifact/org.springframework/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>
//<scope>provided</scope>表示此依赖不会参与测试或部署，
//因为当Web项目部署到Tomcat中后，Tomcat环境会包含此依赖项

准备2个配置类

//一个是Spring框架的配置类：
package cn.tedu.springmvc.config; 
import org.springframework.context.annotation.Configuration; 
@Configuration // 此注解不是必须的 
public class SpringConfig { }
//SpringMvc配置类
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个抽象方法，返回正确的值（各方法的意义请参见以下代码 中的注释）：

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" }; } 
}

创建控制器类，用于接收客户端的某个请求，并简单的响应结果：

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，不可以是此前在Spring框架中学习到的其它组件注解 
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即可实现访问，并看到结果

在启动过程中，你还可以在IntelliJ IDEA的控制台中看到控制器类的构造 方法中输出的内容

关于以上案例：

1. – 当启动Tomcat时，会自动将项目打包并部署到Tomcat，通过自动打开的浏览器中的URL即 可访问主页，在URL中有很长一段是例如 springmvc01_war_explored 这一段是不可以删 除的，其它的各路径必须补充在其之后，例如 /login.do 就必须在此之后
2. – 当启动Tomcat时，项目一旦部署成功，就会自动创建并加载 AbstractAnnotationConfigDispatcherServletInitializer的子类，即当前项目中自定义的 SpringMvcInitialier，无论这个类放在哪个包中，都会自动创建并加载
3. – 由于会自动调用这个类中所有方法，所以会将Spring MVC框架处理的请求路径设置为 *.do， 并执行对 cn.tedu.springmvc 的组件扫描，进而会创建 UserController 的对象
4. – 由于在 UserController 中配置的方法使用了 @RequestMapping("/login.do")，则此时还 将此方法与/login.do进行了绑定，以至于后续随时访问/login.do时都会执行此方法

【上述案例注意事项】

• ①组件扫描必须配置在Spring MVC的配置类中
• ②控制器类上的注解必须是@Controller，不可以是@Component、@Service、 @Repository 各注解的作用并不是注解自身决定的，而是运行环境或框架决定的，在Spring框架中， 这4个注解是完全等效的，但是，在部分版本的Spring MVC框架中并不相同
• ③方法返回的值应该是ASCII码字符，不推荐使用中文、中文标点符号等非 ASCII码字符，否则可能显示为乱码 – 某些版本的Spring MVC默认的字符编码是ISO-8859-1，只支持ASCII字符

@RequestMapping注解

@RequestMapping注解的主要作用是配置请求路径与处理请求的方法的映射关系，例如将此注解添加在控制器中某个方法之前：

// http://localhost:8080/springmvc01_war_exploded/login.do 
@RequestMapping("/login.do") 
@ResponseBody 
public String login() { return "UserController.login()"; }
//配置的请求路径值必须是初始化类getServletMapping()方法返回 值可以匹配的，
例如方法返回值是 *.do，则配置的请求路径必须以 .do 作为后缀

除了方法之前，此注解还可以添加在控制器类之前，例如：

@Controller 
@RequestMapping("/user") 
public class UserController { }
//在开发实践中，推荐为每一个控制器类都配置此注解，以指定某个 URL前缀

在类上添加了此注解并配置路径后，每个方法实际映射到的请求路径都是 “类上的配置的路径 + 方法上的配置的路径”，例如 /user/login.do【注】无论在类上，还是在方法上， 配置的请求路径均以 / 作为第1个字符

在@RequestMapping还可以配置

1. – method：请求方式
2. – headers：请求头
3. – params：请求参数
4. – consumes：请求文档类型
5. – produces：响应文档类型

//method请求方式
@RequestMapping(value = "/login.do", method = RequestMethod.POST) 
@ResponseBody 
public String login() { return "UserController.login()"; }
//按照以上代码，则/login.do路径只能通过POST方式发起请求才可以 被正确的处理，
如果使用其它请求方式（例如GET），则会导致HTTP的 405错误。

//响应结果不会自动添加响应头的文档 类型，可通过配置@RequestMapping的produces属性
//显式的添加，以 解决中文乱码问题
@RequestMapping(value = "/login.do", produces="text/html; charset=utf-8") 
@ResponseBody 
public String login() { return "UserController.login()"; }

如果没有配置method属性，则表示可以使用任何请求方式，包括：GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE

另外，Spring MVC框架还提供了@RequestMapping的相关注解，例如：

1. – @GetMapping
2. – @PostMapping
3. – @PutMapping
4. – @DeleteMapping
5. – 等等

@GetMapping等注解是已经限制了请求方式的注解 以@GetMapping为例，限制了请求方式必须是GET，除此以外，使用方式与 @RequestMapping完全相同

在开发实践中，在类的上方肯定使用@RequestMapping（其它的 @XxxMapping不可以加在类上），方法上一般都使用@GetMapping、 @PostMapping等注解，除非在极特殊的情况下，某些请求同时允许多种 请求方式，才会在方法上使用@RequestMapping

小结（需要掌握知识点）

1. 使用@RequestMapping的主要作用是配置请求路径
2. @RequestMapping可以添加在类上，也可以添加在方法上， 同时配置时，最终的URL是由类上的与方法上的配置值组合的
3. 当需要限制请求方式为某1种时，应该在处理请求的方法上 使用@GetMapping、@PostMapping等注解
4. 在类上使用@RequestMapping，配置请求路径，并配置produces以指定响应的文 档类型
5. 在方法上使用@GetMapping、@PostMapping等限制了请求类型的注解，配置请求 路径

@ResponseBody注解表示：响应正文

配置为“响应正文”，则处理请求的方法的返回值就会直接响应到客户端去

如果没有配置为“响应正文”，则处理请求的方法的返回值表示“视图组 件的名称”，当方法返回后，服务器端并不会直接响应，而是根据“视图 组件的名称”在服务器端找到对应的视图组件，并处理，最后，将处理后 的视图响应到客户端去，这不是前后端分离的做法

@ResponseBody注解可以添加在方法上，则仅作用于当前方法，也可以添加在类上，则作用于当前类的所有方法

在Spring MVC框架中，还提供了@RestController注解，它同时具有 @Controller和@ResponseBody注解的效果，所以，在响应正文的控制 器上，只需要使用@RestController即可，不必再添加@Controller和 @ResponseBody注解。

Spring MVC内置了一系列的转换器（Converter），用于将方法的返回值 转换为响应到客户端的数据（并补充其它必要数据），并且，Spring MVC会根据方法的返回值不同，自动选取某个转换器

当方法的返 回值是String时，会自动使用StringHttpMessageConverter，这个转换 器的特点就是直接将方法返回的字符串作为响应的正文，并且，在许多版 本的Spring MVC框架中，其默认的响应文档的字符集是ISO-8859-1，所 以在在许多版本的Spring MVC中响应String正文时默认不支持非ASCII字 符（例如中文）

响应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的配置类上添加 @EnableWebMvc注解，否则响应时将导致出现HTTP的406错误。

// http://localhost:8080/springmvc01_war_exploded/user/info.do 
@GetMapping("/info.do") 
public UserVO info() { 
  UserVO userVO = new UserVO(); 
  userVO.setUsername("wj"); 
  userVO.setPassword("12345678"); 
  userVO.setEmail("jun@qq.com"); 
  return userVO; 
}

//Spring MVC配置类
@Configuration 
@EnableWebMvc //该注释必须加
@ComponentScan("cn.tedu.springmvc")//Spring的配置类 
public class SpringMvcConfig implements WebMvcConfigurer { }

响应正文的小结(需要掌握的知识点)

1. 响应正文的原理：Spring MVC内置了一系列的转换器 （Converter），根据处理请求的方法的返回值不同，自动选取某个转换 器，将方法的返回值转换为响应到客户端的数据，当方法的返回值没有匹 配的默认转换器时，会自动使用jackson-databind的转换器
2. 当需要响应JSON格式的正文时，你需要： ①– 添加jackson-databind依赖 ②– 在Spring MVC配置类上添加@EnableWebMvc注解 ③– 自定义类，作为处理请求的方法的返回值类型 ④– 类的属性必须添加Setter & Getter ⑤– 使得处理请求的方法是响应正文的

接收请求参数

在Spring MVC中，当需要接收客户端的请求参数时，只需要将各参数直 接声明为处理请求的方法的参数即可，例如：

// /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";
}

在声明参数时，你可以将参数声明为你期望的数据类型，Spring会自动的执行类型转换 – 经过网络传输得到的数据，最原始的类型都是String – Spring会自动尝试转换类型，通常，类型必须是基础数据类型及其包装类、常用类型（例如String等）、Spring定义的类型等 – 如果自动转换类型失败，会抛出相应的异常

1. 如果客户端提交的请求中根本没有匹配名称的参数，则以上获取到的值将是null – 例如：http://localhost/user/login.do
2. 如果客户端仅提交了参数名称，却没有值，则以上获取到的值将是""（长度为0 的字符串） – 例如：http://localhost/user/login.do?username=&password=&age=
3. 如果客户端提交了匹配名称的参数，并且值是有效的，则可以获取到值 – 例如：http://localhost/user/login.do?username=admin&password=1234&age=27
4. 以上名称应该是由服务器端决定的，客户端需要根据以上名称来提交请求参数

当有必要的情况下，可以在以上各参数的声明之前添加@RequestParam 注解，其作用主要有：

1. – 配置name属性：客户端将按照此配置的值提交请求参数，而不再是根据方法的参数 名称来提交请求参数
2. – 配置required属性：是否要求客户端必须提交此请求参数，默认为true，如果不提 交，则出现400错误，当设置为false时，如果不提交，则服务器端将此参数值视为 null
3. – 配置defaultValue属性：配置此请求参数的默认值，当客户端没有提交此请求参数 时，视为此值

// /user/reg.do?username=root&password=123456&age=25 
@RequestMapping("/reg.do") 
public String reg(UserRegDTO userRegDTO) { 
  System.out.println(userRegDTO); 
  return "OK"; 
}

• 理论上来说，由于一个个的声明请求参数更加简单并且直观，所以，当请求参数数量非常少时，应该使用这种做法，当参数较多，或参数数量可能调整（例如需求变化引起的调整），则应该使用封装的数据类型
• 在开发实践中，考虑到需要使用到的其它框架的特性，使用封装的做法更为常见

接收请求参数的小结（需要掌握的知识点）

1. 你可以将请求参数一个个的声明为处理请求方法的参数，也可以将多个参数封装到一个自定义类中，使用自定义类作为处理请求的方法的参数，Spring MVC框架会自动接收客户端提交的请求参数，并用于调用你编写的处理请求的方法
2. 在大部分情况下，推荐使用将参数封装到自定义类的做法
3. 你需要保证非String类型的参数是Spring框架可以成功自动转换类型的，或者，对转换失败有进一步的处理，或可以接受转换失败带来的后果

关于POJO

POJO：Plain Ordinary Java Object，即：普通Java对象

所有用于封装属性的类型都可以统称为POJO

常见的POJO的类名后缀有：BO、DO、VO、DTO等，不同的后缀表示不 同的意义，例如：

1. – VO = Value Object / View Object
2. – DTO = Data Transfer Object

所有POJO类都应该遵循以下规范：

– 实现Serializable接口

– 所有属性都是私有的

– 所有属性都有规范的Setter & Getter – 由开发工具生成的，即是规范的

– 规范的重写了hashCode()和equals()

1. – 2个类型相同、所有属性值都相同的对象，equals()应该返回true，否则，返回false
2. – 2个类型相同、所有属性值都相同的对象，hashCode()返回值应该相同，否则，不同 – 由开发工具生成的，即是规范的，不同开发工具生成的方法源码可能不同，这不重要

– 通常，应该重写toString()输出每个属性的值

所有POJO类的类名后缀：

– 在一个项目中，哪些情景下使用哪种后缀并没有统一的规定，通常是各项目内部决定

– 注意：在为封装属性的类进行命名时，以上BO、DO、VO、DTO等这些后缀的每一 个字母都应该是大写的！

POJO类都不要设置属性默认值

学习记录，如有侵权请联系删除。