详细分析Springmvc中的@ModelAttribute基本知识（附Demo）

2024-06-24 14:04
文章标签 java spring springmvc 详细分析 demo 基本知识 modelattribute

本文主要是介绍详细分析Springmvc中的@ModelAttribute基本知识（附Demo），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

目录

  • 前言
  • 1. 注解用法
    • 1.1 方法参数
    • 1.2 方法
    • 1.3 类
  • 2. 注解场景
    • 2.1 表单参数
    • 2.2 AJAX请求
    • 2.3 文件上传
  • 3. 实战
  • 4. 总结

前言

将请求参数绑定到模型对象上，或者在请求处理之前添加模型属性

可以在方法参数、方法或者类上使用

一般适用这几种场景：

  • 表单处理：通过 @ModelAttribute 将表单数据绑定到模型对象上
  • 预处理逻辑：在请求处理之前执行一些初始化操作，如设置常见模型属性
  • RESTful API：结合 @RequestBody 处理 JSON 数据

对于Java的相关知识推荐阅读：java框架 零基础从入门到精通的学习路线 附开源项目面经等（超全）

1. 注解用法

1.1 方法参数

将表单参数（name 和 email）绑定到 User 对象上，并将这个对象作为模型属性传递给视图

后端结合User，对应这个User属性要写全，才能获取到对应属性

@Controller
public class UserController {@RequestMapping(value = "/user", method = RequestMethod.POST)public String addUser(@ModelAttribute User user, Model model) {// 处理业务逻辑model.addAttribute("user", user);return "userDetails";}
}

前端对应捕捉相关的表单值

<form action="/user" method="post"><input type="text" name="name" /><input type="text" name="email" /><button type="submit">Submit</button>
</form>

1.2 方法

控制器方法上使用 @ModelAttribute 注解，可以在每个请求处理方法调用之前执行一些预处理操作，如初始化模型数据

对应的后端示例如下：

@Controller
public class UserController {@ModelAttributepublic void addAttributes(Model model) {model.addAttribute("message", "Welcome to the user page!");}@RequestMapping(value = "/user", method = RequestMethod.GET)public String getUserForm(Model model) {// 模型中已经包含了 "message" 属性return "userForm";}
}

前端视图如下：

<!-- userForm.jsp -->
<html>
<body><h1>${message}</h1><form action="/user" method="post"><input type="text" name="name" /><input type="text" name="email" /><button type="submit">Submit</button></form>
</body>
</html>

对应每次请求都会在控制器方法调用之前添加一个名为 "message" 的模型属性

1.3 类

在类上使用 @ModelAttribute 注解，可以为所有该类的请求处理方法添加共同的模型属性

对应后端写法如下：

@Controller
@SessionAttributes("user")
public class UserController {@ModelAttribute("user")public User createUser() {return new User();}@RequestMapping(value = "/user", method = RequestMethod.GET)public String getUserForm(@ModelAttribute("user") User user) {return "userForm";}@RequestMapping(value = "/user", method = RequestMethod.POST)public String submitUser(@ModelAttribute("user") User user) {// 处理业务逻辑return "userDetails";}
}

2. 注解场景

与上面的第一章有些重复，不过容易理解

2.1 表单参数

表单参数：处理来自前端 HTML 表单的数据，将表单字段绑定到 Java 对象上
（其Demo对应此章的1.1）
在这里插入图片描述

也可通过编辑用户信息，绑定到相关的模型对象

@Controller
public class UserController {@RequestMapping(value = "/user/edit", method = RequestMethod.GET)public String editUser(@ModelAttribute User user, @RequestParam("userId") Long userId, Model model) {// 通过 userId 获取用户信息并填充到 user 对象user = userService.findById(userId);model.addAttribute("user", user);return "editUserForm";}
}

2.2 AJAX请求

配合前端进行交互，此处写一个示例的Demo

使用 JavaScript（例如 jQuery 或者原生的 XMLHttpRequest）发送异步请求，后端通过 @RequestBody 结合 @ModelAttribute 解析 JSON 数据

$.ajax({url: '/user',type: 'POST',contentType: 'application/json',data: JSON.stringify({ name: 'John', email: 'john@example.com' }),success: function(response) {console.log(response);}
});

对应后端如下：

@Controller
public class UserController {@RequestMapping(value = "/user", method = RequestMethod.POST)@ResponseBodypublic User addUser(@RequestBody @ModelAttribute User user) {// 处理业务逻辑return user;}
}

2.3 文件上传

前端使用 <form> 标签并设置 enctype="multipart/form-data"，后端通过 @ModelAttribute 绑定文件数据

前端：

<form action="/upload" method="post" enctype="multipart/form-data"><input type="file" name="file" /><button type="submit">Upload</button>
</form>

后端：

@Controller
public class FileUploadController {@RequestMapping(value = "/upload", method = RequestMethod.POST)public String handleFileUpload(@RequestParam("file") MultipartFile file) {// 处理文件上传逻辑return "fileUploadSuccess";}
}

3. 实战

通过实战前端交互加深印象

此处使用Vue3 + Java

对应的函数调用如下：

options中添加了file的对应属性，但是后续需要将id传输给后端
在这里插入图片描述

对应的JS如下：

// 上传文件
export const updateFile = (data: any) => {const formData = new FormData();formData.append('file', data.file);formData.append('appointmentId', data.id.toString());return request.upload({url: '/dangerous/appointment-commission/appointment-file/upload',data: formData});
}

其后端的写法如下：

@PostMapping("/appointment-file/upload")
@Operation(summary = "上传文件", description = "模式一：后端上传文件")
public CommonResult<String> uploadFile(@ModelAttribute FileUploadReqVO uploadReqVO,@RequestParam("appointmentId") Long appointmentId) throws Exception {MultipartFile file = uploadReqVO.getFile();String path = uploadReqVO.getPath();return success(appointmentCommissionService.createFile(file.getOriginalFilename(), path, IoUtil.readBytes(file.getInputStream()),appointmentId));
}

4. 总结

  • @RequestBody：数据来自请求体，通常是 JSON 格式
@Controller
public class UserController {@RequestMapping(value = "/api/user", method = RequestMethod.POST)@ResponseBodypublic User addUser(@RequestBody User user) {// 处理 JSON 请求体return user;}
}
  • @ModelAttribute：数据来自 URL 查询参数、表单参数，或其他请求参数
@Controller
public class UserController {@RequestMapping(value = "/form/user", method = RequestMethod.POST)public String addUser(@ModelAttribute User user) {// 处理表单参数return "userDetails";}
}

其他注解详情如下：

注解说明
@ModelAttribute适用于将多个请求参数绑定到复杂对象，或在处理请求之前初始化模型数据
@RequestParam适用于获取单个或少量请求参数
@RequestBody适用于处理 JSON 格式的请求体数据
@PathVariable适用于从 RESTful 风格的 URL 中提取路径变量
@RequestHeader适用于访问 HTTP 请求头信息
@CookieValue适用于从请求中获取特定的 Cookie 值

这篇关于详细分析Springmvc中的@ModelAttribute基本知识（附Demo）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1090350。

相关文章

Spring IOC的三种实现方式详解

Spring IOC的三种实现方式详解

《SpringIOC的三种实现方式详解》：本文主要介绍SpringIOC的三种实现方式,在Spring框架中,IOC通过依赖注入来实现,而依赖注入主要有三种实现方式,构造器注入、Setter注入... 目录1. 构造器注入（Cons编程tructor Injection）2. Setter注入（Setter
阅读更多...
Java function函数式接口的使用方法与实例

Java function函数式接口的使用方法与实例

《Javafunction函数式接口的使用方法与实例》：本文主要介绍Javafunction函数式接口的使用方法与实例,函数式接口如一支未完成的诗篇,用Lambda表达式作韵脚,将代码的机械美感... 目录引言-当代码遇见诗性一、函数式接口的生物学解构1.1 函数式接口的基因密码1.2 六大核心接口的形态学
阅读更多...
Spring IOC控制反转的实现解析

Spring IOC控制反转的实现解析

《SpringIOC控制反转的实现解析》：本文主要介绍SpringIOC控制反转的实现,IOC是Spring的核心思想之一,它通过将对象的创建、依赖注入和生命周期管理交给容器来实现解耦,使开发者... 目录1. IOC的基本概念1.1 什么是IOC1.2 IOC与DI的关系2. IOC的设计目标3. IOC
阅读更多...
Spring Boot统一异常拦截实践指南(最新推荐)

Spring Boot统一异常拦截实践指南(最新推荐)

《SpringBoot统一异常拦截实践指南(最新推荐)》本文介绍了SpringBoot中统一异常处理的重要性及实现方案,包括使用`@ControllerAdvice`和`@ExceptionHand... 目录Spring Boot统一异常拦截实践指南一、为什么需要统一异常处理二、核心实现方案1. 基础组件
阅读更多...
java中的HashSet与 == 和 equals的区别示例解析

java中的HashSet与 == 和 equals的区别示例解析

《java中的HashSet与==和equals的区别示例解析》HashSet是Java中基于哈希表实现的集合类,特点包括：元素唯一、无序和可包含null,本文给大家介绍java中的HashSe... 目录什么是HashSetHashSet 的主要特点是HashSet 的常用方法hasSet存储为啥是无序的
阅读更多...
IDEA运行spring项目时,控制台未出现的解决方案

IDEA运行spring项目时,控制台未出现的解决方案

《IDEA运行spring项目时,控制台未出现的解决方案》文章总结了在使用IDEA运行代码时,控制台未出现的问题和解决方案,问题可能是由于点击图标或重启IDEA后控制台仍未显示,解决方案提供了解决方法... 目录问题分析解决方案总结问题js使用IDEA，点击运行按钮，运行结束，但控制台未出现http://
阅读更多...
解决Spring运行时报错:Consider defining a bean of type ‘xxx.xxx.xxx.Xxx‘ in your configuration

解决Spring运行时报错:Consider defining a bean of type ‘xxx.xxx.xxx.Xxx‘ in your configuration

《解决Spring运行时报错:Considerdefiningabeanoftype‘xxx.xxx.xxx.Xxx‘inyourconfiguration》该文章主要讲述了在使用S... 目录问题分析解决方案总结问题Description:Parameter 0 of constructor in x
阅读更多...
解决IDEA使用springBoot创建项目,lombok标注实体类后编译无报错,但是运行时报错问题

解决IDEA使用springBoot创建项目,lombok标注实体类后编译无报错,但是运行时报错问题

《解决IDEA使用springBoot创建项目,lombok标注实体类后编译无报错,但是运行时报错问题》文章详细描述了在使用lombok的@Data注解标注实体类时遇到编译无误但运行时报错的问题,分析... 目录问题分析问题解决方案步骤一步骤二步骤三总结问题使用lombok注解@Data标注实体类，编译时
阅读更多...
JSON字符串转成java的Map对象详细步骤

JSON字符串转成java的Map对象详细步骤

《JSON字符串转成java的Map对象详细步骤》：本文主要介绍如何将JSON字符串转换为Java对象的步骤,包括定义Element类、使用Jackson库解析JSON和添加依赖,文中通过代码介绍... 目录步骤 1: 定义 Element 类步骤 2: 使用 Jackson 库解析 jsON步骤 3: 添
阅读更多...
Java中注解与元数据示例详解

Java中注解与元数据示例详解

《Java中注解与元数据示例详解》Java注解和元数据是编程中重要的概念,用于描述程序元素的属性和用途,：本文主要介绍Java中注解与元数据的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参... 目录一、引言二、元数据的概念2.1 定义2.2 作用三、Java 注解的基础3.1 注解的定义3.2 内
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2