Spring MVC 深度解析与应用实践(2)

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

4.2 校验

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

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

4.3 异常处理

Spring MVC 提供了灵活的异常处理机制。我们可以使用 @ExceptionHandler 注解来处理 Controller 中的特定异常,也可以使用 @ControllerAdvice 注解来定义全局的异常处理器。

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

@Controller
public class MyController {
    // ...
    @ExceptionHandler(Exception.class)
    public ModelAndView handleError(Exception ex) {
        ModelAndView mav = new ModelAndView("error");
        mav.addObject("message", ex.getMessage());
        return mav;
    }
}

在 @ControllerAdvice 注解的类中,我们可以定义多个 @ExceptionHandler 注解的方法,来处理不同的异常。这些方法会被应用到所有的 Controller 中:

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ModelAndView handleError(Exception ex) {
        ModelAndView mav = new ModelAndView("error");
        mav.addObject("message", ex.getMessage());
        return mav;
    }
    // 可以定义更多的 @ExceptionHandler 方法...
}

4.4 文件上传和下载

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

@RequestMapping("/upload")
public String upload(@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")
public ResponseEntity<Resource> download(String filename) throws IOException {
    Path path = Paths.get("upload/" + filename);
    Resource resource = new UrlResource(path.toUri());
    return ResponseEntity.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")
@ResponseBody
public User data() {
    User user = new User();
    // 设置 user 的属性
    return user;
}

我们也可以在 Controller 方法的参数中使用 @RequestBody 注解,Spring MVC 会将请求体中的 JSON 或 XML 数据自动绑定到此参数上:

@RequestMapping("/data")
@ResponseBody
public User data(@RequestBody User user) {
    // 处理 user
    return user;
}

4.6 Spring MVC 与 RESTful API

Spring MVC 提供了一整套注解,如 @GetMapping、@PostMapping、@PutMapping、@DeleteMapping 等,使得我们可以轻松地创建符合 RESTful 风格的 API:

@RestController
@RequestMapping("/users")
public class UserController {
    @GetMapping("/{id}")
    public User getUser(@PathVariable String id) {
        // ...
    }
    @PostMapping
    public User createUser(@RequestBody User user) {
        // ...
    }
    @PutMapping("/{id}")
    public User updateUser(@PathVariable String id, @RequestBody User user) {
        // ...
    }
    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable String 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 等。我们可以根据自己的需要选择合适的模板引擎。


尽量减少视图中的逻辑: 视图的主要职责是展示数据,我们应该尽量减少视图中的逻辑。对于需要在多个视图中复用的逻辑,我们可以考虑使用视图帮助类或自定义标签来实现。

  1. 使用视图模型: 视图模型是一种设计模式,它可以帮助我们更好地组织和传递数据。在 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 开发的重要工具,值得我们深入学习和掌握。

相关文章
|
JSON 前端开发 Java
微服务——SpringBoot使用归纳——Spring Boot中的MVC支持——@RequestBody
`@RequestBody` 是 Spring 框架中的注解,用于将 HTTP 请求体中的 JSON 数据自动映射为 Java 对象。例如,前端通过 POST 请求发送包含 `username` 和 `password` 的 JSON 数据,后端可通过带有 `@RequestBody` 注解的方法参数接收并处理。此注解适用于传递复杂对象的场景,简化了数据解析过程。与表单提交不同,它主要用于接收 JSON 格式的实体数据。
1760 0
|
前端开发 Java 微服务
《深入理解Spring》:Spring、Spring MVC与Spring Boot的深度解析
Spring Framework是Java生态的基石,提供IoC、AOP等核心功能;Spring MVC基于其构建,实现Web层MVC架构;Spring Boot则通过自动配置和内嵌服务器,极大简化了开发与部署。三者层层演进,Spring Boot并非替代,而是对前者的高效封装与增强,适用于微服务与快速开发,而深入理解Spring Framework有助于更好驾驭整体技术栈。
|
前端开发 Java API
Spring Cloud Gateway Server Web MVC报错“Unsupported transfer encoding: chunked”解决
本文解析了Spring Cloud Gateway中出现“Unsupported transfer encoding: chunked”错误的原因,指出该问题源于Feign依赖的HTTP客户端与服务端的`chunked`传输编码不兼容,并提供了具体的解决方案。通过规范Feign客户端接口的返回类型,可有效避免该异常,提升系统兼容性与稳定性。
1012 0
|
SQL Java 数据库连接
Spring、SpringMVC 与 MyBatis 核心知识点解析
我梳理的这些内容,涵盖了 Spring、SpringMVC 和 MyBatis 的核心知识点。 在 Spring 中,我了解到 IOC 是控制反转,把对象控制权交容器;DI 是依赖注入,有三种实现方式。Bean 有五种作用域,单例 bean 的线程安全问题及自动装配方式也清晰了。事务基于数据库和 AOP,有失效场景和七种传播行为。AOP 是面向切面编程,动态代理有 JDK 和 CGLIB 两种。 SpringMVC 的 11 步执行流程我烂熟于心,还有那些常用注解的用法。 MyBatis 里,#{} 和 ${} 的区别很关键,获取主键、处理字段与属性名不匹配的方法也掌握了。多表查询、动态
479 0
|
JSON 前端开发 Java
第05课:Spring Boot中的MVC支持
第05课:Spring Boot中的MVC支持
538 0
|
前端开发 IDE Java
Spring MVC 中因导入错误的 Model 类报错问题解析
在 Spring MVC 或 Spring Boot 开发中,若导入错误的 `Model` 类(如 `ch.qos.logback.core.model.Model`),会导致无法解析 `addAttribute` 方法的错误。正确类应为 `org.springframework.ui.Model`。此问题通常因 IDE 自动导入错误类引起。解决方法包括:删除错误导入、添加正确包路径、验证依赖及清理缓存。确保代码中正确使用 Spring 提供的 `Model` 接口以实现前后端数据传递。
668 0
|
Java 测试技术 Spring
SPRING实践总结--参数注解的使用
今天用spring 搭建测试模型过程中发现web接收参数的注解使用方式各有不同,在不同场景下的使用方式总结了一下 @RequestBody 获取POST请求中的参数,请求参数会放到MAP里 @RequestMapping(value = "/doQueryTempReq", method = RequestMethod.
1209 0
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
1602 0
|
人工智能 Java 测试技术
Spring Boot 集成 JUnit 单元测试
本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧,包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块(如JSON、MVC、WebFlux、JDBC等),以及@MockBean和@SpyBean的应用。内容实用,适合Java开发者参考学习。
1551 0

推荐镜像

更多
  • DNS