一、Spring MVC框架概述
1、概念
Spring MVC是基于Java的开源MVC(Model-View-Controller)框架,用于开发Web应用程序。它通过将应用程序分为模型、视图和控制器来实现松耦合、可维护和可扩展的设计。
2、特点
(1)高度灵活:Spring MVC支持多种配置方式和自定义组件,可以根据项目需求进行灵活配置。
(2)松耦合:Spring MVC框架使用了松耦合的设计原则,使得各个模块之间的关联度较低,易于测试和维护。
(3)可扩展:Spring MVC提供了丰富的扩展点,允许开发人员根据需要自定义组件和功能。
(4)易于集成:Spring MVC可以与其他Spring框架无缝集成,如Spring IoC、Spring AOP等。
二、Spring MVC框架的配置方式
1、XML配置方式
(1)在pom.xml中导入SpringMVC相关坐标(idea版本问题可以对依赖包降或升版本)
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.8</version>
</dependency>
</dependencies>
(2)创建一个web.xml
文件,配置DispatcherServlet
和监听器
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_4_0.xsd"
id="WebApp_ID" version="4.0">
<display-name>SpringMVCExample</display-name>
<!-- 配置DispatcherServlet -->
<servlet>
<servlet-name>dispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
(3)创建一个spring-mvc.xml
文件,配置Spring MVC相关的组件。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 配置控制器 -->
<bean class="com.example.controller.HelloController"/>
<!-- 配置视图解析器 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/"/>
<property name="suffix" value=".jsp"/>
</bean>
<!-- 开启Spring MVC注解驱动 -->
<mvc:annotation-driven/>
</beans>
(4)创建一个控制器类HelloController.java
,处理请求并返回视图。
package com.example.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class HelloController {
@RequestMapping("/hello")
public String hello(){
System.out.println("hello···");
return "hello.jsp";
}
}
(5)在/WEB-INF/views/
目录下创建一个hello.jsp
文件作为视图。
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
你好,SpringMVC!
</body>
</html>
(6)配置Tomcat启动
2、注解配置方式
(1)在pom.xml中添加一个servlet依赖包
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
</dependency>
(2)创建一个web.xml
文件,配置DispatcherServlet
和监听器
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_4_0.xsd"
id="WebApp_ID" version="4.0">
<display-name>SpringMVCExample</display-name>
<!-- 配置DispatcherServlet -->
<servlet>
<servlet-name>dispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextClass</param-name>
<param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
</init-param>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>com.example.config</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
(3)在config包下创建配置类SpringMvcConfig替换spring-mvc.xml
package com.example.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan("com.cqgcxy.controller")
public class SpringMvcConfig {
}
(4)在config包下创建配置类ServletContainersInitConfig替换web.xml
package com.example.config;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.support.AbstractDispatcherServletInitializer;
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
@Override
protected WebApplicationContext createServletApplicationContext() {
AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
ctx.register(SpringMvcConfig.class);
return ctx;
}
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
protected WebApplicationContext createRootApplicationContext() {
return null;
}
}
3、收获
(1)XML配置方式配置繁琐,需要编写大量的XML代码;
(2)注解配置方式配置简洁,无需编写大量的XML代码,易于理解和维护;注解方式配置可能难以管理复杂的场景,不够灵活。
三、控制器的使用方法和注意事项
1、使用方法
定义控制器:可以使用@Controller注解将一个类声明为控制器,使用@RequestMapping注解定义请求映射规则。
处理请求参数:可以使用@RequestParam注解获取请求参数,也可以通过在控制器方法中定义一个POJO对象作为参数来接收请求参数。
进行数据校验:可以使用Spring提供的数据校验框架。
2、注意事项
(1)控制器应尽量保持简洁,遵循单一职责原则,将不同的功能拆分到不同的控制器中。
(2) 合理处理异常,可以使用@ExceptionHandler注解来处理控制器内部抛出的异常。
(3)适当地使用@RequestMapping注解的属性,如method、params等,以实现更精确的请求映射。
四、实现SpringMVC多种类型数据响应
在控制器类,处理请求并返回
1、返回视图页面
@RequestMapping("/hello")
public ModelAndView hello() {
ModelAndView modelAndView = new ModelAndView();
modelAndView.setViewName("hello"); // 视图名称
modelAndView.addObject("message", "Hello, World!"); // 视图中使用的数据
return modelAndView;
}
2、返回JSON数据
@RequestMapping("/hello")
public Map<String, String> hello() {
Map<String, String> result = new HashMap<>();
result.put("message", "Hello, World!");
return result;
}
JSON依赖:
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.0</version></dependency>
3、返回文件下载
@GetMapping("/download")
public ResponseEntity<byte[]> download() throws IOException {
// 读取文件的二进制数据
byte[] fileBytes = Files.readAllBytes(Paths.get("/path/to/file.pdf"));
// 设置响应头信息
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_PDF);
headers.setContentDisposition(ContentDisposition.attachment().filename("file.pdf").build());
// 构造ResponseEntity对象
return new ResponseEntity<>(fileBytes, headers, HttpStatus.OK);
}
4、返回重定向
@RequestMapping("/redirect")
public String redirect() {
return "redirect:/hello"; // 使用redirect关键字
}
@RequestMapping("/redirectView")
public RedirectView redirectView() {
RedirectView redirectView = new RedirectView("/hello"); // 使用RedirectView类
redirectView.setStatusCode(HttpStatus.MOVED_PERMANENTLY);
return redirectView;
}
五、SpringMVC获取不同类型参数
1、路径参数
使用@PathVariable
注解将路径参数绑定到方法的参数上。
@GetMapping("/users/{id}")
public String getUserById(@PathVariable("id") Long userId) {
// 处理获取用户信息的逻辑
}
2、查询参数
使用@RequestParam
注解将查询参数绑定到方法的参数上。
@GetMapping("/search")
public String searchUsers(@RequestParam("keyword") String keyword) {
// 根据关键字搜索用户
}
3、表单参数
使用@RequestParam
注解或@ModelAttribute
注解将表单参数绑定到方法的参数上。
@PostMapping("/register")
public String registerUser(@RequestParam("username") String username, @RequestParam("password") String password) {
// 处理用户注册逻辑
}
4、收获
在Spring MVC中,获取不同类型的参数是非常重要的,因为它们包含了请求的具体数据,可以用于处理业务逻辑。通过使用@PathVariable
、@RequestParam
、@RequestBody
、@RequestHeader
等注解,你可以轻松地从URL路径、查询参数、请求体和请求头中获取参数值。
六、拦截器的使用方法和实际应用场景
1、使用方法
可以通过实现HandlerInterceptor接口来定义一个拦截器,重写preHandle、postHandle和afterCompletion方法来实现请求预处理和后处理操作。
2、实际应用场景
防止重复提交:可以通过拦截器在提交表单后禁止用户重复提交。
身份认证:可以在拦截器中进行身份验证,检查用户是否登录或具有访问权限
日志拦截器:
七、Spring MVC框架与MyBatis整合(关键步骤)
1、在项目的pom.xml文件中添加Spring MVC和MyBatis的依赖
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.10</version>
</dependency>
<!-- MyBatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.7</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.7</version>
</dependency>
2、配置数据源:applicationContext.xml
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
<property name="username" value="root"/>
<property name="password" value="password"/>
</bean>
3、配置MyBatis:mybatis-config.xml
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
<property name="username" value="root"/>
<property name="password" value="password"/>
</dataSource>
</environment>
</environments>
<mappers>
<!-- 配置Mapper映射文件的路径 -->
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
4、配置Mapper扫描器:
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.example.mapper"/>
</bean>
5、配置事务管理器:
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource"/>
</bean>
6、配置SqlSessionFactoryBean:
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="configLocation" value="classpath:mybatis-config.xml"/>
</bean>