SpringMVC简介
看到SpringMVC这个名字,我们会发现其中包含Spring,那么SpringMVC和Spring之间有怎样的关系呢?
- SpringMVC隶属于Spring,是Spring技术中的一部分。
那么SpringMVC是用来做什么的呢?
- 回想web阶段,我们学习过Servlet,而SpeingMVC与Servlet技术功能相同,均属于web层或者说表现层开发技术。
那么既然已经有了Servlet,为什么还需要花时间在学习一个SpringMVC?想要回答这个问题,我们就需要先搞清楚SpringMVC和Servlet相比,存在什么优势?
- 框架我们都知道是用来简化开发的,所以SpringMVC和Servlet相比,开发起来更加简单快捷,用更少的代码完成表现层代码的开发。
SpringMVC概述
请求响应模式演进过程
三层架构
web层负责收集数据和产生页面,但是一个Servlet只能处理一个请求
MVC模式
- 通过service组织最终要展示的数据模型,然后和抽取出来的页面一起工作,最终得到页面
- 这样子一个Servlet通过控制器就可以完成请求的分发了
- View通常使用JSP技术
异步调用
- SpringMVC负责完成Controller层的开发,然后把操作完的数据转成JSON格式交给前端
当前WEB程序的工作流程
三层架构
web程序通过浏览器访问前端页面,发送异步请求到后端服务器
后台服务器采用三层架构进行功能开发
- 表现层负责接收请求和数据然后将数据转交给业务层
- 业务层负责调用数据层完成数据库表的增删改查,并将结果返给表现层
- 表现层将数据转换成json格式返回给前端
前端页面将数据进行解析最终展示给用户
表现层与数据层的技术选型
- 数据层采用Mybatis框架
- 表现层采用SpringMVC框架,SpringMVC主要负责的内容有:
- controller如何接收请求和数据
- 如何将请求和数据转发给业务层
- 如何将响应数据转换成json发回到前端
SpringMVC小结
- SpringMVC是一种基于Java实现MVC模型的轻量级web框架
- 优点
- 使用简单,开发便捷(相比于Servlet)
- 灵活性强
SpringMVC入门案例
由于SpringMVC是一个Web框架,将来是要替换之前我们所使用的Servlet,所以我们先回顾以前Servlet是如何进行开发的?
- 浏览器发送请求到Tomcat服务器
- Tomcat服务器接收到请求后,会根据请求路径来匹配对应的Servlet,并将请求交给对应的Servlet来处理
所以对于Servlet来说,我们主要完成的是Servlet类的开发以及对应路径的配置
那么对于SpringMVC程序的流程会是什么样的呢?
- 浏览器发送请求到Tomcat服务器
- Tomcat服务器接收到请求后,会见请求交给SpringMVC中的DispatcherServlet(前端控制器)来处理请求
- DispatcherServlet不真正处理请求,只是按照对应的规则将请求分发给对应的Bean对象
- Bean对象是由我们自己编写,来处理不同的请求,每个Bean中可以处理一个或多个不同的请求url
- DispatcherServlet和Bean对象都需要交给Spring容器来进行管理
综上所述,需要我们编写的内容包含:
- Bean对象的编写
- 请求url和Bean对象对应关系的配置
- 构建Spring容器,将DispatcherServlet和Bean对象交给容器管理
- 配置Tomcat服务器,使其能够识别Spring容器,并将请求交给容器中的DispatcherServlet来分发请求
具体的实现步骤如下:
- 创建web工程(Maven结构)并在工程的pom.xml添加SpringMVC和Servlet坐标
- 创建SpringMVC控制器类(等同于Servlet功能)
- 初始化SpringMVC环境(同Spring环境),设定SpringMVC加载对应的bean
- 初始化Servlet容器,加载SpringMVC环境,并设置SpringMVC技术处理的请求
使用Servlet开发和使用SpringMVC开发的区别
需求分析
案例制作
步骤一:创建Maven项目,并导入对应的jar包
打开IDEA,创建一个新的web项目
因为使用骨架创建的项目结构不完整,需要手动补全
将pom.xml中多余的内容删除掉,再添加SpringMVC需要的依赖
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.ling</groupId>
<artifactId>springmvc_01_quickstart</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
<version>6.1.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>6.1.14</version>
</dependency>
</dependencies>
</project>
说明:servlet的坐标为什么需要添加<scope>provided</scope>
- scope是maven中jar包依赖作用范围的描述
- 如果不设置的话,默认是compile,在编译、运行、测试时均有效
- 如果运行有效的话,就会和tomcat中的servlet-api包发生冲突,会导致启动报错
- provided代表的是该包只在编译和测试的时候用,运行的时候使用的是tomcat中的包,能够避免冲突
步骤二:创建控制器类
//2.制作控制器类,等同于Servlet
//2.1必须是一个spring管理的bean
//2.2定义具体处理请求的方法
//2.3设置当前方法的访问路径
//2.4设置响应结果为json数据
@Controller
public class UserController {
@RequestMapping("/save")
@ResponseBody
public String save(){
System.out.println("user save ...");
return "{'info':'springmvc'}";
}
}
步骤三:创建配置类
//3.定义配置类加载Controller对应的bean
@Configuration
@ComponentScan("com.ling.controller")
public class SpringMvcConfig {
}
步骤四:创建Tomcat的Servlet容器配置类
//4.定义servlet容器的配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
//加载springMVC配置
protected WebApplicationContext createServletApplicationContext() {
//初始化WebApplicationContext对象
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
//加载指定配置类
ctx.register(SpringMvcConfig.class);
return ctx;
}
//设置Tomcat接收的请求哪些归SpringMVC处理
protected String[] getServletMappings() {
return new String[]{"/"};
}
//设置spring相关配置
protected WebApplicationContext createRootApplicationContext() {
return null;
}
}
步骤五:配置Tomcat环境
步骤六:启动运行项目
步骤七:浏览器访问
浏览器输入http://localhost:8080/save进行访问,可以看到如下内容:
注解知识点
知识点一:@Controller
名称 | @Controller |
---|---|
类型 | 类注解 |
位置 | SpringMVC控制器类定义上方 |
作用 | 设定SpringMVC的核心控制器bean |
知识点二:@RequestMapping
名称 | @RequestMapping |
---|---|
类型 | 类注解或方法注解 |
位置 | SpringMVC控制器类或方法定义上方 |
作用 | 设置当前控制器方法请求访问路径 |
相关属性 | value(默认),请求访问路径 |
知识点三:@ResponseBody
名称 | @ResponseBody |
---|---|
类型 | 类注解或方法注解 |
位置 | SpringMVC控制器类或方法定义上方 |
作用 | 设置当前控制器方法响应内容为当前返回值,无需解析 |
入门案例总结
SpringMVC入门程序开发总结(1+N)
- 一次性工作
- 创建工程,设置服务器,加载工程
- 导入坐标
- 创建web容器启动类,加载SpringMVC配置,并设置SpringMVC请求拦截路径
- SpringMVC核心配置类(设置配置类,扫描controller包,加载Controller控制器bean)
- 多次工作
- 定义处理请求的控制器类
- 定义处理请求的控制器方法,并配置映射路径(@RequestMapping)与返回json数据(@ResponseBody)
- 多次工作我们可以通过实现一个用户的删除功能来体验一把
- controller类中编写删除方法
//2.制作控制器类,等同于Servlet //2.1必须是一个spring管理的bean //2.2定义具体处理请求的方法 //2.3设置当前方法的访问路径 //2.4设置响应结果为json数据 @Controller public class UserController { @RequestMapping("/save") @ResponseBody public String save(){ System.out.println("user save ..."); return "{'info':'springmvc'}"; } @RequestMapping("/delete") @ResponseBody public String delete(){ System.out.println("user delete ..."); return "{'info':'springmvc-delete'}"; } }
- 重启服务器,访问http://localhost8080/delete,可以看到如下效果:
Tomcat的Servlet容器配置总结
- AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类
- AbstractDispatcherServletInitializer类提供了三个接口方法供用户实现
- createRootApplcationContext()方法,如果出啊关键Servlet容器时需要加载非SpringMVC对应的bean,使用当前方法进行,使用方式同createServletApplicationContext()
- createServletApplicationContext()方法,创建Servlet容器时,加载SpringMVC对应的bean并放入WebApplicationContext对象范围中,而WebApplicationContext的作用范围为ServletContext范围,即整个web容器范围
- getServletMappings()方法,设定SpringMVC对应的请求映射路径,设置为 / 表示拦截所有请求,任意请求都将转入到SpringMVC进行处理
- createServletApplicationContext用来加载SpringMVC环境
- createRootApplicationContext用来加载Spring环境
入门案例工作流程分析
为了更好地使用SpringMVC,我们将SpringMVC的使用过程总共分为两个阶段来分析,分别是启动服务器初始化过程 和 单次请求过程
启动服务器初始化过程
- 服务器启动,执行ServletCotainersInitConfig类,初始化web容器
- 执行createServletApplicationContext()方法,创建了WebApplicationContext对象
该方法加载SpringMVC的配置类SpringMvcConfig来初始化SpringMVC的容器@Override protected WebApplicationContext createServletApplicationContext() { // 创建AnnotationConfigWebApplicationContext对象 AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext(); // 注册SpringMvcConfig类 ctx.register(SpringMvcConfig.class); return ctx; }
- 加载SpringMvcConfig配置类
@Configuration @ComponentScan("com.ling.controller") public class SpringMvcConfig { }
- 执行@ComponentScan加载对应的bean
- 扫描指定报下所有类上的注解,如Cntroller类上的@Controller注解
- 加载UserController,每个@RequestMapping的名称对应一个具体的方法
@Controller public class UserController { @RequestMapping("/save") @ResponseBody public String save(){ System.out.println("user save..."); return "{'info', 'springmvc'}"; } }
- 此时就建立了 /save 和 save 方法的对应关系
- 执行getServletMappings方法,定义所有的请求都通过SpringMVC
@Override protected String[] getServletMappings() { return new String[]{"/"}; }
- / 代表所拦截请求的路径规则,只有被拦截后才能交给SpringMVC来处理请求
单次请求过程
- 发送请求 localhost/save
- web容器发现所有请求都经过SpringMVC,将请求交给SpringMVC处理
- 因为符合上面第六步设置的请求路径,所以该请求会交给iSpringMVC来处理
- 解析请求路径 /save
- 由 /save 匹配执行对应的方法save()
- 上面的第五步已经将请求路径和方法进行对应关系,通过 /save 就能找到对应的save方法
- 执行save()
- 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方
bean加载控制
问题分析
入门案例的内容已经做完了,在入门案例中我门窗见过一个SpringMvcConfig的配置类,再回到前面咱们学习Spring的时候也创建古一个配置类SpringConfig。这两个配置类都需要加载资源,那么它们分别都需要加载哪些内容呢?
我们先来看下目前我们的项目目录结构:
- config目录存入的是配置类,写过的配置类有:
- ServletContainersInitConfig
- SpringConfig
- SpringMvcConfig
- JdbcConfig
- MyBatisConfig
- controller目录存放的是SpringMVC的controller类
- service目录存放的是service接口和实现类
- dao目录存放的是dao/Mapper接口
controller、service和dao这些类都需要被容器管理成bean对象,那么到底是该让SpringMVC加载还是让Spring加载呢?
- SpringMVC加载其相关bean(表现层bean),也就是controller包下的类
- Spring控制的bean
- 业务bean(Service)
- 功能bean(DataSource,SqlSessionFactoryBean,MapperScannerConfiguer等)
分析清楚谁该管哪些bean以后,接下来要解决的问题是如何让Spring和SpringMVC分开加载各自的内容。
在SpringMVC的配置类SpringMvcConfig中使用注解@ComponentScan,我们只需要将其扫描范围设置到controller即可,如
@Configuration
@ComponentScan("com.ling.controller")
public class SpringMvcConfig {
}
在Spring的配置类SpringConfig中使用注解@ComponentScan,当前扫描的范围中其实是已经包含了controller,如
@Configuration
@ComponentScan("com.ling")
public class SpringConfig {
}
从包结构来看的话,Spring以及把SpringMVC的controller的类也给扫描到了,所以针对这个问题该如何解决,就是我们接下来要学习的内容
概况的描述下咱们现在的问题就是因为功能不同,如何避免Spring错误加载到SpringMVC的bean?
思路分析
针对上面的问题,解决方案也比较简单,就是:
- 加载Spring控制的bean的时候排除掉SpringMVC控制的bean
具体该如何排除,有两种方式来解决
- 方式一:Spring加载的bean设定扫描范围为com.ling,排除掉controller包中的bean
- 方式二:Spring加载的bean设定扫描范围为精准范围,例如service包、dao包等
- 方式三:不区分Spring与SpringMVC的环境,加载到同一个环境中[了解即可]
环境准备
创建一个Web的Maven项目
pom.xml添加Spring依赖
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.ling</groupId>
<artifactId>springmvc_02_bean_load</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<dependencies>
<dependency>
<groupId>jakarta.servlet</groupId>
<artifactId>jakarta.servlet-api</artifactId>
<version>6.1.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>6.1.14</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.15</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.16</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.30</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>6.1.14</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>3.0.1</version>
</dependency>
</dependencies>
</project>
创建对应的配置类
ServletContainersInitConfig
// 继承AbstractDispatcherServletInitializer类,用于初始化Spring MVC的DispatcherServlet
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
// 创建Servlet的上下文
@Override
protected WebApplicationContext createServletApplicationContext() {
// 创建AnnotationConfigWebApplicationContext对象
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
// 注册SpringMvcConfig类
ctx.register(SpringMvcConfig.class);
return ctx;
}
// 配置DispatcherServlet的映射路径
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
// 创建根上下文
@Override
protected WebApplicationContext createRootApplicationContext() {
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
ctx.register(SpringConfig.class);
return ctx;
}
}
SpringMvcConfig
@Configuration
@ComponentScan("com.ling.controller")
public class SpringMvcConfig {
}
SpringConfig
@Configuration
@ComponentScan("com.ling.service")
public class SpringConfig {
}
编写Controller、Service、Dao、Domain类
@Controller
public class UserController {
@RequestMapping("/save")
@ResponseBody
public String save(){
System.out.println("user save ...");
return "{'info':'springmvc'}";
}
}
public interface UserService {
public void save(User user);
}
@Service
public class UserServiceImpl implements UserService {
public void save(User user) {
System.out.println("user service ...");
}
}
public interface UserDao {
@Insert("insert into tbl_user(name,age)values(#{name},#{age})")
public void save(User user);
}
public class User {
private Integer id;
private String name;
private Integer age;
//setter..getter..toString略
}
最终创建好的项目结构如下:
设置bean加载控制
方式一:修改Spring配置类,设定扫描范围为精准范围
@Configuration
@ComponentScan({"com.ling.service","com.ling.dao"})
public class SpringConfig {
}
说明:
上述只是通过例子说明可以精确指定让Spring扫描对应的包结构,真正做开发的时候,因为Dao最终是交给MapperScannerConfigurer对象进行扫描处理的,我们只需要将其扫描到service包即可
方式二:修改Spring配置类,设定扫描范围为com.ling,排除掉controller包中的bean
@Configuration
@ComponentScan(value = "com.ling", excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {Controller.class}))
public class SpringConfig {
}
- excludeFilters属性:设置扫描加载bean时,排除的过滤规则
- type属性:设置排除规则,当前使用按照bean定义时的注解类型进行排除
- ANNOTATION:按照注解排除
- ASSIGNABLE_TYPE:按照指定的类型过滤
- ASPECTJ:按照Aspectj表达式排除,基本上不会用
- REGEX:按照正则表达式排除
- CUSTOM:按照自定义规则排除
大家只需要知道第一种ANNOTATION即可
- classes属性:设置排除的具体注解类,当前设置排除@Controller定义的bean
如何测试controller类已经被排除掉了?
public class App {
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(SpringConfig.class);
// 刷新上下文
ctx.refresh();
System.out.println(ctx.getBean(UserController.class));
}
}
如果被排除了,该方法执行就会报bean未被定义的错误
注意:测试的时候,需要把SpringMvcConfig配置类上的@ComponentScan注解注释掉,否则不会报错
出现问题的原因是,
- Spring配置类扫描的包是
com.itheima
- SpringMVC的配置类,
SpringMvcConfig
上有一个@Configuration注解,也会被Spring扫描到 - SpringMvcConfig上又有一个@ComponentScan,把controller类又给扫描进来了
- 所以如果不把@ComponentScan注释掉,Spring配置类将Controller排除,但是因为扫描到SpringMVC的配置类,又将其加载回来,演示的效果就出不来
- 解决方案,也简单,把SpringMVC的配置类移出Spring配置类的扫描范围即可。
最后一个问题,有了Spring的配置类,要想在tomcat服务器启动将其加载,我们需要修改ServletContainersInitConfig
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
// 创建Servlet的上下文
@Override
protected WebApplicationContext createServletApplicationContext() {
// 创建AnnotationConfigWebApplicationContext对象
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
// 注册SpringMvcConfig类
ctx.register(SpringMvcConfig.class);
return ctx;
}
// 配置DispatcherServlet的映射路径
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
// 创建根上下文
@Override
protected WebApplicationContext createRootApplicationContext() {
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
ctx.register(SpringConfig.class);
return ctx;
}
}
对于上述的配置方式,Spring还提供了一种更简单的配置方式,可以不用再去创建AnnotationConfigWebApplicationContext
对象,不用手动register
对应的配置类,如何实现?
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class[]{SpringConfig.class};
}
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[]{SpringMvcConfig.class};
}
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
注解知识点
@ComponentScan
名称 | @ComponentScan |
---|---|
类型 | 类注解 |
位置 | 类定义上方 |
作用 | 设置spring配置类扫描路径,用于加载使用注解格式定义的bean |
相关属性 | excludeFilters:排除扫描路径中加载的bean,需要指定类别(type)和具体项(classes) includeFilters:加载指定的bean,需要指定类别(type)和具体项(classes) |