Spring MVC 深度解析与应用实践

文章目录

1. 引言

1.1 Spring MVC 概述

Spring MVC（Model-View-Controller）是 Spring 框架的一部分，专门用于设计创建分层的 Java Web 应用。它是一个全功能的 MVC 模块，能够提供强大的配置选项，并利用默认的约定，使基本项目的配置降至最低。Spring MVC 提供了一种分离的方式，使得能够通过控制器（Controller）进行业务处理，模型（Model）进行数据处理，视图（View）进行展示处理，这样使得 Web 层的开发变得更加简洁明了。

1.2 Spring MVC 在 MVC 架构中的位置

MVC（Model-View-Controller）是一种设计模式，用于将应用程序的数据（Model），用户界面（View），和处理用户输入（Controller）的逻辑分离开。Spring MVC 作为 MVC 中的 “C” - 控制器，它的主要任务是将用户的请求路由到相应的服务接口，然后再将处理结果返回给用户。

在 MVC 架构中，Spring MVC 通过控制器接收用户请求，根据请求的 URL，将请求路由到相应的服务处理逻辑。服务处理完请求后，会返回一个模型（Model）和对应的视图名称给控制器，控制器再通过视图解析器找到相应的视图，将模型数据填充到视图中，生成响应返回给用户。

通过这样的设计，我们可以将请求处理逻辑、数据处理逻辑和展示逻辑清晰地分开，极大地提高了代码的可读性和可维护性，这也是使用 Spring MVC 的一大优势。

2. Spring MVC 的工作流程

Spring MVC 的工作流程是一种典型的前端控制器设计模式，当一个请求到达 Spring MVC 框架时，其主要流程如下：

2.1 DispatcherServlet (前端控制器)

DispatcherServlet 是整个 Spring MVC 框架的入口，它负责接收所有的 HTTP 请求并分发给对应的处理器。在具体的工作过程中，DispatcherServlet 扮演着前端控制器的角色，其主要职责包括：

请求的拦截：所有经过 DispatcherServlet 的请求都会被拦截，它将作为请求的第一站。
请求的分发：根据处理器映射器（HandlerMapping）找到的处理器（Handler，通常是一个 Controller），DispatcherServlet 将请求转发给对应的处理器进行处理。

2.2 HandlerMapping (处理器映射器)

处理器映射器 HandlerMapping 的主要任务是根据请求的 URL 找到对应的处理器（Handler）。在 Spring MVC 中，Handler 通常就是我们的 Controller 控制器，HandlerMapping 负责将请求 URL 和对应的 Controller 进行关联。

一般情况下，我们会在 Controller 的类或方法上使用 @RequestMapping 注解来映射 URL 和处理器。这种映射关系会在服务器启动时被解析并保存，当一个请求到来时，HandlerMapping 会根据这些映射关系找到最匹配的 Controller。

2.3 Handler (处理器)

找到对应的 Handler（Controller）后，DispatcherServlet 会将请求传递给该 Handler 进行处理。Handler 会处理请求，并返回一个 ModelAndView 对象。ModelAndView 包含了视图名和模型数据，视图名用于之后的视图解析，模型数据则用于填充到视图中。

这个部分我们会在接下来的章节中进行详细的讨论，包括如何编写 Controller，如何处理请求参数，如何返回视图等等。

以上就是 Spring MVC 工作流程中的前两个重要组件，接下来我们将讨论 HandlerAdapter，ViewResolver 和 View。## 2.3 Controller (控制器)

在 Spring MVC 中，Controller 负责处理由 DispatcherServlet 分发的请求。它将业务处理逻辑和数据封装在 ModelAndView 中，并将其返回给 DispatcherServlet。Controller 是一个接口，而我们通常会使用它的实现类，如

@Controller

或

@RestController

来创建控制器类。

在 Controller 中，我们可以定义方法来处理不同的 HTTP 请求，如 GET、POST、PUT、DELETE 等。这些方法可以直接将结果返回（例如，返回一个 JSON 对象或字符串），也可以返回一个

ModelAndView

对象，包含了视图名称和数据模型。

2.4 ModelAndView

ModelAndView 是 Spring MVC 中一个非常重要的概念。它包含了视图名（View name）和模型（Model）。视图名是一个字符串，用来标识需要渲染的视图，而模型则是一个 Map 类型的对象，用来保存渲染视图时所需要的数据。

当我们在 Controller 中处理完一个请求后，可以创建一个 ModelAndView 对象，将处理结果放入模型中，然后设置视图名。当 DispatcherServlet 接收到 ModelAndView 后，会使用视图解析器（ViewResolver）来找到对应的视图，并将模型中的数据填充到视图中。

2.5 ViewResolver (视图解析器)

视图解析器的主要任务是根据视图名找到对应的视图。在 Spring MVC 中，视图并不仅仅是 JSP 或 Thymeleaf 这样的模板文件，还可以是 JSON、XML 或其他格式的数据。

在 Spring MVC 配置中，我们可以定义视图解析器，并指定其前缀和后缀。例如，如果我们设置了前缀为

/WEB-INF/views/

，后缀为

.jsp

，那么当视图名为

home

时，视图解析器会解析为

/WEB-INF/views/home.jsp

。这样，我们就可以将视图文件统一放在

/WEB-INF/views/

目录下，而在控制器中，我们只需要返回视图名，而不需要关心视图文件的具体位置和后缀。

至此，我们已经了解了 Spring MVC 工作流程中的五个主要部分，接下来我们将进一步深入了解如何在实际开发中使用 Spring MVC。

3. Spring MVC 基础应用

3.1 环境搭建

首先，我们需要搭建 Spring MVC 的开发环境。这通常包括以下步骤：

创建一个新的 Maven 或 Gradle 项目。
添加 Spring MVC 的依赖。在 Maven 的 pom.xml 文件中，我们可以添加如下依赖：

<dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>5.3.8</version></dependency>

创建 Java 源代码目录和资源文件目录。Java 源代码通常位于 src/main/java 目录，而 JSP、静态资源和配置文件则位于 src/main/webapp 目录。
创建 Spring 配置文件。我们可以创建一个 src/main/webapp/WEB-INF/appContext.xml 文件，用来配置 Spring MVC 的组件。

3.2 创建 Controller

在

src/main/java

目录下，我们可以创建一个 Controller 类来处理请求。以下是一个简单的例子：

importorg.springframework.stereotype.Controller;importorg.springframework.web.bind.annotation.RequestMapping;importorg.springframework.web.servlet.ModelAndView;@ControllerpublicclassHelloController{@RequestMapping("/hello")publicModelAndViewhello(){ModelAndView mav =newModelAndView();
        mav.addObject("message","Hello Spring MVC!");
        mav.setViewName("hello");return mav;}}

在上述代码中，

@Controller

注解表明这是一个 Controller 类，

@RequestMapping("/hello")

注解将

hello

方法映射到

/hello

路径。

3.3 配置 DispatcherServlet 和 Spring MVC

我们需要在

src/main/webapp/WEB-INF/web.xml

文件中配置 DispatcherServlet。以下是一个例子：

<web-app><servlet><servlet-name>dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><init-param><param-name>contextConfigLocation</param-name><param-value>/WEB-INF/appContext.xml</param-value></init-param><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>dispatcher</servlet-name><url-pattern>/</url-pattern></servlet-mapping></web-app>

在上述配置中，我们设置了

DispatcherServlet

的初始化参数

contextConfigLocation

，指向了我们的 Spring 配置文件

appContext.xml

。同时，我们将

路径映射到了

DispatcherServlet

，这意味着所有的请求都会被

DispatcherServlet

处理。

在

appContext.xml

文件中，我们需要配置 Spring MVC 的组件，如 Controller、ViewResolver 等。

3.4 运行和测试

在完成了以上配置后，我们就可以运行和测试我们的 Spring MVC 应用了。可以使用内置的 Tomcat、Jetty 等服务器，或者将应用部署到独立的服务器上进行测试。

通过在浏览器中访问 `http

😕/localhost:8080/hello`，我们就可以看到 Controller 返回的 “Hello Spring MVC!” 消息了。

4. Spring MVC 高级应用

4.1 数据绑定

Spring MVC 提供了强大的数据绑定功能，可以将请求参数自动绑定到 Controller 方法的参数上。例如，我们可以在 Controller 方法的参数中使用

@RequestParam

注解来绑定请求参数：

@RequestMapping("/greet")publicStringgreet(@RequestParamString name){return"Hello, "+ name;}

Spring MVC 还支持复杂类型的数据绑定。例如，我们可以定义一个 User 类，然后在 Controller 方法的参数中使用 User 类型的参数，Spring MVC 会自动将请求参数绑定到 User 对象的属性上：

@RequestMapping("/register")publicStringregister(User user){// ...}

4.2 校验

Spring MVC 提供了基于 JSR 303 和 JSR 349 的校验功能。我们可以在 Model 对象的属性上使用 JSR 303 和 JSR 349 提供的注解，如 @NotNull、@Size、@Pattern 等，来定义校验规则。然后，在 Controller 方法中使用 @Valid 注解来触发校验：

@RequestMapping("/register")publicStringregister(@ValidUser user,BindingResult result){if(result.hasErrors()){// 校验失败，处理错误}else{// 校验成功，继续处理}}

4.3 异常处理

Spring MVC 提供了灵活的异常处理机制。我们可以使用

@ExceptionHandler

注解来处理 Controller 中的特定异常，也可以使用

@ControllerAdvice

注解来定义全局的异常处理器。

在

@ExceptionHandler

注解的方法中，我们可以对异常进行处理，并返回一个视图名，或者直接返回一个 ModelAndVIew 对象：

@ControllerpublicclassMyController{// ...@ExceptionHandler(Exception.class)publicModelAndViewhandleError(Exception ex){ModelAndView mav =newModelAndView("error");
        mav.addObject("message", ex.getMessage());return mav;}}

在

@ControllerAdvice

注解的类中，我们可以定义多个

@ExceptionHandler

注解的方法，来处理不同的异常。这些方法会被应用到所有的 Controller 中：

@ControllerAdvicepublicclassGlobalExceptionHandler{@ExceptionHandler(Exception.class)publicModelAndViewhandleError(Exception ex){ModelAndView mav =newModelAndView("error");
        mav.addObject("message", ex.getMessage());return mav;}// 可以定义更多的 @ExceptionHandler 方法...}

4.4 文件上传和下载

Spring MVC 提供了对文件上传和下载的支持。对于文件上传，我们可以在 Controller 方法的参数中使用 MultipartFile 类型的参数，Spring MVC 会自动将上传的文件绑定到此参数上：

@RequestMapping("/upload")publicStringupload(@RequestParam("file")MultipartFile file){if(!file.isEmpty()){// 保存文件byte[] bytes = file.getBytes();Path path =Paths.get("upload/"+ file.getOriginalFilename());Files.write(path, bytes);}return"redirect:/";}

对于文件下载，我们可以在 Controller 方法中返回一个 ResponseEntity 对象，Spring MVC 会将此对象转换为一个文件下载响应：

@RequestMapping("/download")publicResponseEntity<Resource>download(String filename)throwsIOException{Path path =Paths.get("upload/"+ filename);Resource resource =newUrlResource(path.toUri());returnResponseEntity.ok().header(HttpHeaders.CONTENT_DISPOSITION,"attachment; filename=\""+ resource.getFilename()+"\"").body(resource);}

4.5 Spring MVC 与 AJAX

Spring MVC 提供了对 AJAX 的良好支持。我们可以在 Controller 方法上使用

@ResponseBody

注解，Spring MVC 会将方法的返回值转换为 JSON 或 XML 格式，然后直接写入到响应体中：

@RequestMapping("/data")@ResponseBodypublicUserdata(){User user =newUser();// 设置 user 的属性return user;}

我们也可以在 Controller 方法的参数中使用

@RequestBody

注解，Spring MVC 会将请求体中的 JSON 或 XML 数据自动绑定到此参数上：

@RequestMapping("/data")@ResponseBodypublicUserdata(@RequestBodyUser user){// 处理 userreturn user;}

4.6 Spring MVC 与 RESTful API

Spring MVC 提供了一整套注解，如

@GetMapping

、

@PostMapping

、

@PutMapping

、

@DeleteMapping

等，使得我们可以轻松地创建符合 RESTful 风格的 API：

@RestController@RequestMapping("/users")publicclassUserController{@GetMapping("/{id}")publicUsergetUser(@PathVariableString id){// ...}@PostMappingpublicUsercreateUser(@RequestBodyUser user){// ...}@PutMapping("/{id}")publicUserupdateUser(@PathVariableString id,@RequestBodyUser user){// ...}@DeleteMapping("/{id}")publicvoiddeleteUser(@PathVariableString id){// ...}}

注意到这里我们使用了

@RestController

注解，它是

@Controller

和

@ResponseBody

注解的组合，表示这个 Controller 的所有方法都会返回 JSON 或 XML 数据，而不是视图名。

5. Spring MVC 的最佳实践

5.1 规划包结构

一个良好的包结构可以让我们的项目更易于理解和维护。在 Spring MVC 项目中，我们可以按照以下的方式规划我们的包结构：

com.mycompany.myapp.controller：存放所有的 Controller 类。
com.mycompany.myapp.service：存放所有的 Service 类，这些类主要负责业务逻辑的处理。
com.mycompany.myapp.repository：存放所有的 Repository 或 DAO 类，这些类主要负责数据库的访问。
com.mycompany.myapp.model：存放所有的 Model 类，这些类主要代表了我们的业务实体。
com.mycompany.myapp.dto：存放所有的 DTO (Data Transfer Object) 类，这些类用于在各层之间传输数据。
com.mycompany.myapp.exception：存放所有的自定义异常类。
com.mycompany.myapp.config：存放所有的配置类。

5.2 参数绑定的最佳实践

在 Spring MVC 中，我们经常需要将请求参数绑定到 Controller 方法的参数上。以下是一些参数绑定的最佳实践：

使用 DTO：如果一个 Controller 方法需要多个请求参数，那么我们可以创建一个 DTO 类，将这些请求参数作为 DTO 类的属性，然后在 Controller 方法的参数中使用这个 DTO 类。这样可以使得 Controller 方法的签名更简洁，也更方便我们进行数据验证和单元测试。
使用 @Valid：在 Controller 方法的参数中使用 @Valid 注解，可以让 Spring MVC 在参数绑定时自动进行数据验证。如果数据验证失败，Spring MVC 会抛出一个 MethodArgumentNotValidException 异常，我们可以在全局异常处理器中捕获此异常，然后返回一个包含错误信息的响应。
使用 @RequestParam 和 @PathVariable：在 Controller 方法的参数中，我们可以使用 @RequestParam 注解来绑定请求参数，使用 @PathVariable 注解来绑定路径变量。这两个注解可以使我们的 Controller 方法更加的自描述。
使用 @RequestBody：在 Controller 方法的参数中，我们可以使用 @RequestBody 注解来绑定请求体。这个注解非常适合用于处理 JSON 或 XML 数据。我们只需要在 DTO 类上添加相应的注解，就可以让 Spring MVC 自动将请求体的数据绑定到 DTO 类上。
避免使用 Servlet API：尽管 Spring MVC 允许我们在 Controller 方法的参数中使用 Servlet API 的类型，如 HttpServletRequest、HttpServletResponse、HttpSession 等，但是我们应该尽量避免使用这些类型。因为这些类型与 Servlet API 紧密耦合，使得我们的 Controller 方法难以进行单元测试。而且，使用这些类型也违反了面向对象的设计原则。

5.3 异常处理的最佳实践

在 Spring MVC 中，对于异常的处理，我们应该遵循以下的最佳实践：

使用 @ExceptionHandler: 我们可以在 Controller 中定义方法，并使用 @ExceptionHandler 注解来处理特定类型的异常。这样，当 Controller 中的方法抛出此类型的异常时，Spring MVC 会调用 @ExceptionHandler 标注的方法来处理异常。
使用 @ControllerAdvice: @ControllerAdvice 是一个全局的 @ExceptionHandler，当 Controller 中的 @ExceptionHandler 没有处理到的异常，会被 @ControllerAdvice 处理。我们可以定义一个 @ControllerAdvice 类，然后在该类中定义多个 @ExceptionHandler 方法，分别处理不同类型的异常。
自定义异常: 对于业务逻辑的异常，我们应该定义自己的异常类型，然后在业务逻辑出现错误时抛出这些异常。这样可以使我们的 Controller 和 Service 更加清晰，也可以让我们更好地控制异常处理的流程。
提供详细的错误信息: 当我们抛出异常时，应该提供尽可能详细的错误信息，包括错误发生的位置、错误的原因以及如何解决错误。这些信息可以帮助我们更快地定位和解决问题。
处理 RESTful API 的异常: 对于 RESTful API，我们应该返回一个包含错误信息的 HTTP 响应，而不是显示一个错误页面。我们可以使用 @ExceptionHandler 和 @ControllerAdvice 来实现这一点。

5.4 视图处理的最佳实践

在 Spring MVC 中，对于视图的处理，我们应该遵循以下的最佳实践：

使用视图解析器: Spring MVC 提供了多种视图解析器，如 InternalResourceViewResolver、BeanNameViewResolver、XmlViewResolver 等。我们可以根据自己的需要选择合适的视图解析器。视图解析器可以帮助我们更方便地管理视图，也可以让我们的 Controller 更加简洁。
支持多种视图格式: 一个优秀的 Web 应用应该支持多种视图格式，如 HTML、JSON、XML 等。我们可以使用 ContentNegotiatingViewResolver 来实现这一点。ContentNegotiatingViewResolver 可以根据请求的 Accept 头来选择合适的视图。
使用模板引擎: 模板引擎可以帮助我们更方便地生成 HTML 代码。Spring MVC 支持多种模板引擎，如 Thymeleaf、FreeMarker、Velocity 等。我们可以根据自己的需要选择合适的模板引擎。
尽量减少视图中的逻辑: 视图的主要职责是展示数据，我们应该尽量减少视图中的逻辑。对于需要在多个视图中复用的逻辑

，我们可以考虑使用视图帮助类或自定义标签来实现。

使用视图模型: 视图模型是一种设计模式，它可以帮助我们更好地组织和传递数据。在 Spring MVC 中，我们可以使用 ModelAndView 来实现视图模型。

6. 结语

6.1 Spring MVC 的优点和局限

优点：

清晰的角色划分：在 Spring MVC 中，DispatcherServlet、Controller、ViewResolver 等各个组件的职责都非常清晰，这有利于我们理解和使用 MVC 模式。
灵活的配置：Spring MVC 提供了非常灵活的配置方式，我们可以通过 XML 或 Java 代码来配置 Spring MVC，也可以使用默认的配置。
良好的与 Spring 框架的集成：Spring MVC 是 Spring 框架的一部分，它可以无缝集成 Spring 框架的各种功能，如依赖注入、事务管理、安全控制等。
强大的数据绑定和校验功能：Spring MVC 提供了强大的数据绑定和校验功能，我们可以很方便地处理和校验 HTTP 请求中的数据。
支持多种视图技术：Spring MVC 支持多种视图技术，如 JSP、Freemarker、Thymeleaf 等，我们可以根据自己的需要选择合适的视图技术。

局限：

学习曲线较陡峭：Spring MVC 的功能非常强大，但也意味着我们需要花费更多的时间和精力去学习和理解它。
配置较复杂：虽然 Spring MVC 提供了灵活的配置方式，但是对于新手来说，配置可能会显得有些复杂。
与前端技术的集成需要提升：随着前后端分离的趋势，Spring MVC 需要更好地支持前端技术，如 AJAX、Websocket 等。

6.2 展望

尽管 Spring MVC 在一些方面存在着局限性，但无可否认，它仍然是一个非常强大、成熟的 MVC 框架。随着云计算、微服务、容器化等技术的发展，Spring MVC 也在不断地进行更新和优化，以更好地适应新的技术趋势。

例如，Spring 5.x 版本引入了新的响应式编程模型，使得 Spring MVC 可以更好地支持事件驱动、非阻塞的应用，这无疑会大大提升其在高并发、高性能场景下的表现。

同时，Spring Boot 的出现，简化了 Spring MVC 的配置，让开发者能够更快速地创建和部署 Spring MVC 应用，这也将推动 Spring MVC 的发展。

总的来说，Spring MVC 仍然是 Java Web 开发的重要工具，值得我们深入学习和掌握。

标签： spring mvc java

本文转载自: https://blog.csdn.net/weixin_46703995/article/details/130937376
版权归原作者 沐雨风栉 所有，如有侵权，请联系我们删除。