Spring MVC常用十大注解

Spring MVC常用十大注解

一，什么要使用注解

使用注解可以简化配置，提高代码的可读性和可维护性。通过注解可以实现依赖注入，减少手动管理对象的代码量。注解还支持面向切面编程，实现切面、切入点和通知等。此外，注解提供了声明式事务管理的支持，简化了事务配置和管理。注解还可以用于组件扫描和自动装配，提高开发效率。最后，注解在测试时也有很好的支持。总之，注解使得代码更简洁、灵活，并能更好地利用框架的功能和特性。

1.@Controller

1.作用

在使用 Spring MVC 框架开发 Web 应用程序时，@Controller 注解是用来标识一个类为控制器（Controller）的注解。控制器层负责接收用户请求，并根据请求处理逻辑选择合适的业务逻辑进行处理，最终返回响应给用户。

2.示例代码

控制器的主要作用包括：

  1. 接收用户请求：控制器负责接收用户发起的请求，可以通过注解中的 @RequestMapping 来定义请求的 URL 地址和请求方法（如 GET、POST 等），从而将请求映射到相应的处理方法。

  2. 处理请求：控制器包含多个处理方法，每个方法用于处理不同的请求或请求路径。这些方法通常返回数据模型、视图名称或者响应体，完成请求的处理逻辑。

  3. 调用业务逻辑：控制器通过调用合适的服务层或业务逻辑组件来处理业务逻辑，以满足用户请求的需求。

  4. 返回响应：控制器根据处理结果，可以选择返回数据模型给视图进行渲染，或者直接返回响应体给客户端。可以通过注解如 @ResponseBody 或 @RestController 来标识方法返回的是响应体。

下面是一个示例代码，展示了一个简单的 Spring MVC 控制器类：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;@Controller
@RequestMapping("/example")
public class ExampleController {@RequestMapping("/hello")@ResponseBodypublic String hello() {return "Hello, World!";}
}

上述代码中，通过 @Controller 注解将类标识为控制器，并使用 @RequestMapping 注解定义了请求路径的前缀为 “/example”。方法 hello() 使用 @RequestMapping 注解来定义了处理 “/hello” 路径的 GET 请求，@ResponseBody 则表示将返回的字符串直接作为响应体返回给客户端。

通过以上示例代码，可以看到控制器的作用是接收并处理用户请求，并根据请求的逻辑选择合适的处理方法进行处理，并最终返回响应给客户端。

2.@RequestMapping

1.作用

@RequestMapping 注解是 Spring MVC 框架中的一个核心注解，用于将请求映射到相应的处理方法。它可以用在类级别和方法级别上，具体作用如下：

  1. 类级别的 @RequestMapping： 用于指定该类中所有处理方法的公共请求路径前缀。当用户请求的 URL 匹配该前缀时，会进入该类中的处理方法进行处理。

  2. 方法级别的 @RequestMapping： 用于指定处理请求的方法和请求路径。当用户请求的 URL 匹配该路径时，会调用该方法进行处理。

2.示例代码

下面是一个示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {@RequestMapping(value = "/hello", method = RequestMethod.GET)@ResponseBodypublic String hello() {return "Hello, World!";}
}

以上示例代码展示了类级别和方法级别的 @RequestMapping 的使用。类级别的 @RequestMapping 指定了公共请求路径前缀为 “/example”，而方法级别的 @RequestMapping 指定了处理 “/hello” 路径的 GET 请求。

这意味着，当用户访问 “/example/hello” 路径时，会由 hello() 方法来处理该请求，并将返回的字符串 “Hello, World!” 作为响应体返回给客户端。

使用 @RequestMapping 注解可以灵活地定义请求的路径和处理方法，同时支持多种请求方法（如 GET、POST、PUT、DELETE 等），以满足不同的业务需求。

3.@RequestParam

1.作用

@RequestParam 注解用于将 HTTP 请求中的参数绑定到控制器方法的参数上，即获取请求中的参数值并映射到方法参数。它支持几乎所有的数据类型，包括基本数据类型和复杂数据类型。

2.示例代码

下面是一个使用 @RequestParam 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {@RequestMapping(value = "/hello", method = RequestMethod.GET)@ResponseBodypublic String hello(@RequestParam("name") String name) {return "Hello, " + name + "!";}
}

以上示例代码中，@RequestParam("name") 表示方法参数 name 与请求参数 name 相对应，Spring MVC 框架会自动将请求参数 name 的值注入到方法参数 name 中。

当用户访问 “/example/hello?name=world” 时，框架会将请求参数 name 的值 “world” 绑定到方法参数 name 上，并执行 hello() 方法，返回 “Hello, world!”。

此外，@RequestParam 还支持一些可选属性，例如 required 属性可以指定该参数是否是必须的，默认为 true；defaultValue 属性可以指定当参数未传递时的默认值。

总之，@RequestParam 注解是用来获取请求参数并在控制器方法中使用的重要注解，可以让我们方便地获取 HTTP 请求参数，并进行相应的处理。

4.@PathVariable

1.作用

@PathVariable 注解用于获取 URL 中的动态参数，即将 URL 中的变量映射到控制器方法的参数上。这样就可以通过 URL 传递参数，而不是通过查询字符串的方式来传递参数。

2.示例代码

下面是一个使用 @PathVariable 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {@RequestMapping(value = "/hello/{name}", method = RequestMethod.GET)@ResponseBodypublic String hello(@PathVariable("name") String name) {return "Hello, " + name + "!";}
}

以上示例代码中，@PathVariable("name") 表示将 URL 中的变量 name 映射到方法参数 name 上。

当用户访问 “/example/hello/world” 时，框架会将 URL 中的动态变量 world 绑定到方法参数 name 上，并执行 hello() 方法，返回 “Hello, world!”。

另外，@PathVariable 还支持一些可选属性，例如 required 属性可以指定该参数是否是必须的，默认为 true。如果没有提供该路径变量，则将设置为 null 值。

总之，@PathVariable 注解是用于获取 URL 中动态参数值并在控制器方法中使用的重要注解，可以方便地将 URL 中的动态变量转换为对应的方法参数值。

5.@RequestBody

1.作用

@RequestBody 注解用于将 HTTP 请求体中的数据绑定到控制器方法的参数上，即获取 POST 请求中的数据并映射到方法参数。它通常用于处理 JSON 或 XML 格式的请求体数据。

2.示例代码

下面是一个使用 @RequestBody 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {@RequestMapping(value = "/addUser", method = RequestMethod.POST)@ResponseBodypublic String addUser(@RequestBody User user) {// 处理用户数据return "User added successfully!";}
}

在上述示例代码中，@RequestBody 用于将 HTTP 请求体中的数据转换成 User 对象，并将其作为参数传递给 addUser() 方法进行处理。

当用户提交 POST 请求时，将会包含一个 JSON 或 XML 格式的请求体数据，然后框架会使用 Jackson 或 JAXB 等工具将其转换成 User 对象。

注意，使用 @RequestBody 注解时需要确保请求体数据的格式与方法参数类型匹配。例如，如果控制器方法的参数是 String 类型，那么请求体中的数据应该是纯文本格式的。

总之，@RequestBody 注解是用于获取 POST 请求体中的数据并在控制器方法中使用的重要注解，可以方便地将请求体中的数据转换成 Java 对象并进行相应的处理。

6.@ResponesBody

1.作用

@ResponseBody 注解用于将方法的返回值直接作为 HTTP 响应的内容，而不是通过视图解析器返回一个视图。它通常与 @RequestMapping 注解一起使用。

2.示例代码

下面是一个使用 @ResponseBody 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {@RequestMapping(value = "/hello", method = RequestMethod.GET)@ResponseBodypublic String hello() {return "Hello, World!";}
}

在上述示例代码中，@ResponseBody 注解表示将方法的返回值直接作为 HTTP 响应的内容返回。

当用户访问 “/example/hello” 时，框架会执行 hello() 方法，并将方法返回的字符串 “Hello, World!” 作为 HTTP 响应的内容返回给客户端。

@ResponseBody 注解不仅可以返回纯文本响应，还可以返回其他类型的数据，例如 JSON 或 XML。

总之，@ResponseBody 注解用于将方法的返回值直接作为 HTTP 响应的内容返回给客户端，提供了方便的方式来返回不需要通过视图解析器进行处理的响应内容。

7.@RestController

1.作用

@RestController 是一个组合注解，它是 @Controller 和 @ResponseBody 两个注解的整合。它表示控制器类中的所有方法都会返回 JSON、XML 或其他格式的数据，而不是视图。

2.示例代码

下面是一个使用 @RestController 注解的示例代码：

@RestController
@RequestMapping("/example")
public class ExampleController {@RequestMapping(value = "/hello", method = RequestMethod.GET)public String hello() {return "Hello, World!";}
}

在上述示例代码中，@RestController 表示该控制器类中的所有方法都将返回数据（可以是 JSON、XML 等格式），而不是视图。

当用户访问 “/example/hello” 时，框架会执行 hello() 方法，并将其返回的字符串 “Hello, World!” 作为 HTTP 响应的内容返回给客户端。

与 @Controller 注解不同的是，如果使用 @RestController 注解，则不必为每个方法都添加 @ResponseBody 注解，因为该注解已经包含在 @RestController 中了。

总之，@RestController 注解是用于表示控制器类中所有方法都将返回数据的注解，方便快捷地返回 JSON、XML 或其他格式的响应内容，减少了在控制器方法中添加 @ResponseBody 注解的重复性工作。

8.@ModelAttribute

1.作用

@ModelAttribute 注解用于绑定请求参数到方法的参数或方法级别的模型属性上。

2.示例代码

  1. 绑定请求参数到方法的参数上：

    @RequestMapping(value = "/example", method = RequestMethod.GET)
public String example(@ModelAttribute("name") String name) {// 处理请求参数return "Hello, " + name + "!";
}

    在上述示例代码中，@ModelAttribute("name") 表示将名为 “name” 的请求参数绑定到方法的 name 参数上。当用户发送一个 GET 请求时，例如 /example?name=John，框架会自动将请求参数中的 “name” 值赋值给 name 参数。

  2. 绑定请求参数到方法级别的模型属性：

    @ModelAttribute("user")
public User getDefaultUser() {User user = new User();user.setName("John");user.setAge(20);return user;
}

    在上述示例代码中，@ModelAttribute("user") 表示将方法返回的 User 对象绑定为模型属性，并使用 “user” 作为模型属性的名称。

    当在视图中需要访问该模型属性时，可以直接使用 ${user} 进行访问。例如，在 JSP 视图中，可以使用 ${user.name} 获取用户的名称。

总之，@ModelAttribute 注解用于绑定请求参数到方法的参数或方法级别的模型属性上，提供了方便的方式来获取请求参数或预设模型属性的值，并在控制器方法中进行处理或在视图中使用。

9.@SessionAttributes

1.作用

@SessionAttributes 注解是用于将模型属性暂时存储在会话（Session）中的注解。它可以用在控制器类级别或控制器方法级别。

2.示例代码

  1. 在控制器类级别使用 @SessionAttributes：

    @Controller
@SessionAttributes("user")
public class UserController {// ...
}

    在上述示例代码中，@SessionAttributes("user") 表示将名为 “user” 的模型属性存储在会话中。当请求处理方法返回时，存储在会话中的模型属性将保留下来，直到会话结束或被清除。

  2. 在控制器方法级别使用 @SessionAttributes：

    @Controller
@SessionAttributes("user")
public class UserController {@RequestMapping(value = "/user", method = RequestMethod.GET)public String getUser(@RequestParam("id") int id, Model model) {User user = userService.getUserById(id);model.addAttribute("user", user);return "user";}
}

    在上述示例代码中，@SessionAttributes("user") 表示将控制器方法中添加的名为 “user” 的模型属性存储在会话中。在这个例子中，getUser() 方法从数据库中获取用户信息，并将其添加到模型中。模型属性 “user” 将存储在会话中，并在后续请求中仍然可用。

需要注意的是，@SessionAttributes 注解只能用于存储模型属性，不能用于存储任意类型的对象。

总结来说，@SessionAttributes 注解用于将模型属性存储在会话中。通过在控制器类或方法上添加该注解，可以方便地管理会话中的模型属性，并在多个请求之间共享数据。

10.@ExceptionHandler

1.作用

@ExceptionHandler 注解用于定义一个处理异常的方法。它可以用在控制器类级别或控制器方法级别。

2.示例代码

  1. 在控制器类级别使用 @ExceptionHandler：

    @ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(Exception.class)public ModelAndView handleException(Exception e) {ModelAndView mv = new ModelAndView();mv.addObject("errMsg", "系统异常：" + e.getMessage());mv.setViewName("error");return mv;}
}

    在上述示例代码中，@ControllerAdvice 注解用于定义一个全局的异常处理器，可以处理所有控制器中抛出的异常。@ExceptionHandler(Exception.class) 注解表示该方法用于处理所有类型的异常。当控制器中抛出异常时，就会调用该方法来处理异常，并返回错误页面。

  2. 在控制器方法级别使用 @ExceptionHandler：

    @Controller
public class UserController {@ExceptionHandler(UserNotFoundException.class)public ModelAndView handleUserNotFoundException(UserNotFoundException e) {ModelAndView mv = new ModelAndView();mv.addObject("errMsg", "用户不存在：" + e.getMessage());mv.setViewName("error");return mv;}@RequestMapping(value = "/user/{id}", method = RequestMethod.GET)public String getUser(@PathVariable("id") int id) {User user = userService.getUserById(id);if (user == null) {throw new UserNotFoundException("id=" + id);}return "user";}
}

    在上述示例代码中，@ExceptionHandler(UserNotFoundException.class) 注解表示该方法用于处理 UserNotFoundException 类型的异常。当控制器方法中抛出该异常时，就会调用该方法来处理异常，并返回错误页面。

总之，@ExceptionHandler 注解用于定义一个处理异常的方法，可以用在控制器类级别或控制器方法级别。通过添加该注解，可以方便地处理控制器中抛出的异常，并返回错误信息或错误页面。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/116882.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

数据可视化素材分享 | 数十图表、无数模板

数据可视化素材分享 | 数十图表、无数模板

很多人在后台求分享报表、源代码，其实何必这么麻烦，在奥威BI数据可视化平台上点击即可获得大量的可视化素材，如数十种可视化图表，适用于不同分析场景；又如大量不同主题的BI数据可视化报表模板，套用后替换数…
阅读更多...
GoLong的学习之路（四）语法之循环语句

GoLong的学习之路（四）语法之循环语句

书接上回，上回说到运算符，这次我们说一个编程语言中最重要的一点：流程控制，及循环语句 文章目录 循环语句if else(分支结构)if条件判断特殊写法 for(循环结构)for range(键值循环) switch casegoto(跳转到指定标签)break(跳出循环…
阅读更多...
按键中断控制LED灯亮灭

按键中断控制LED灯亮灭

EXTI—外部中断/事件控制器 EXTI（External interrupt/event controller）—外部中断/事件控制器，管理了控制器的 20 个中断/事 件线。每个中断/事件线都对应有一个边沿检测器，可以实现输入信号的上升沿检测和下降沿的 检测。EXTI可…
阅读更多...
【广州华锐互动】关于物理力学的3D实验实操平台

【广州华锐互动】关于物理力学的3D实验实操平台

在科学的广阔领域中，物理力学是一个至关重要的分支，它探索了物体在力作用下的运动规律。然而，传统的物理实验往往需要复杂的设备和大量的操作，这对于学生来说是一项巨大的挑战。为了解决这个问题，广州华锐互动开发了物…
阅读更多...
Hadoop3教程（三十五）：（生产调优篇）HDFS小文件优化与MR集群简单压测

Hadoop3教程（三十五）：（生产调优篇）HDFS小文件优化与MR集群简单压测

文章目录 （168）HDFS小文件优化方法（169）MapReduce集群压测参考文献 （168）HDFS小文件优化方法 小文件的弊端，之前也讲过，一是大量占用NameNode的空间，二是会使得寻址速度…
阅读更多...
浅谈RabbitMQ的延迟队列

浅谈RabbitMQ的延迟队列

Part 01、 延迟队列是什么 延迟队列代表了一种强大的消息传递机制，允许我们在将消息发送至RabbitMQ时，规定它们只能在未来某个预定的时间点被消费。这种特殊类型的消息被简称为"延迟消息"。 以RabbitMQ为例，它允许我们通过延迟…
阅读更多...
聊聊分布式架构10——Zookeeper入门详解

聊聊分布式架构10——Zookeeper入门详解

目录 01ZooKeeper的ZAB协议 ZAB协议概念 ZAB协议基本模式 消息广播 崩溃恢复 选举出新的Leader服务器 数据同步 02Zookeeper的核心 ZooKeeper 的核心特点 ZooKeeper 的核心组件 选举算法概述 服务器启动时的Leader选举 服务器运行期间的Leader选举 03ZooKeeper的…
阅读更多...
人工智能算法PPT学习

人工智能算法PPT学习

YOLO You only look once 是一种图像识别算法，速度较快。高效、灵活、泛化性能好，在工业中较为受欢迎。 图像金字塔 一幅图像的多个不同分辨率的子图构成的图像集合。是通过一个图像不断的降低采样率产生的，最小的图像可能仅仅有一个像素点…
阅读更多...
C# out参数out多个参数

C# out参数out多个参数

文章目录 C# out参数out多个参数背景说明作用方法定义调用方法测试结果注意 C# out参数out多个参数 背景说明 一个方法返回多个相同数据类型的变量，可以采用数据的方式； 我需要返回多个不同数据类型的方法，在这里采用out多个参数的方式。 …
阅读更多...
vue3项目使用TypeIt打字机

vue3项目使用TypeIt打字机

官网: TypeIt | The most versatile JavaScript typewriter effect library on the planet. 下载: npm i typeit 使用方法: 正常打字 多行打字机 input输入框实现打字机效果 打字机颜色变化 删除,光标移动,最全面的打字机效果 官网最下面还可以输入你想有的打字效果,然后生…
阅读更多...
【文件操作】Java -操作File对象

【文件操作】Java -操作File对象

个人简介：Java领域新星创作者；阿里云技术博主、星级博主、专家博主；正在Java学习的路上摸爬滚打，记录学习的过程~ 个人主页：.29.的博客 学习社区：进去逛一逛~ 文件操作 Java - File对象 Java - File对象 Fi…
阅读更多...
计算机视觉-数学基础*变换域表示

计算机视觉-数学基础*变换域表示

被研究最多的图像（或任何序列数据）变换域表示是通过傅 里叶分析 。所谓的傅里叶表示就是使用 正弦函数的线性组合来表示信号。对于一个给定的图像I(n1,n2) ，可以用如下方式分解它（即逆傅里叶变换）： 其中&a…
阅读更多...
【lesson14】进程控制之进程等待

【lesson14】进程控制之进程等待

文章目录 为什么要有进程等待？如何等待和什么是等待？ 为什么要有进程等待？ 1.子进程退出，父进程不管子进程，子进程就要处于僵尸状态------会导致内存泄漏 2.父进程创建子进程是要让子进程办事的，那么子进…
阅读更多...
【Tensorflow 2.12 简单智能商城商品推荐系统搭建】

【Tensorflow 2.12 简单智能商城商品推荐系统搭建】

Tensorflow 2.12 简单智能商城商品推荐系统搭建 前言架构数据召回排序部署调用结尾 前言 基于 Tensorflow 2.12 搭建一个简单的智能商城商品推荐系统demo~ 主要包含6个部分，首先是简单介绍系统架构，接着是训练数据收集、处理，然后是召回模型、…
阅读更多...
“深入探讨Java JUC中的ReentrantLock锁：实现多线程同步与并发控制“

“深入探讨Java JUC中的ReentrantLock锁：实现多线程同步与并发控制“

简介 1、从Java5开始，Java提供了一种功能更强大的线程同步机制——通过显式定义同步锁对象来实现同步，在这种机制下，同步锁由Lock对象充当。 2、Lock 提供了比synchronized方法和synchronized代码块更广泛的锁定操作，Lock允许实…
阅读更多...
arcgis js api FeatureLayer加载时返回数据带*问题

arcgis js api FeatureLayer加载时返回数据带*问题

接着这一问题衍生出来的问题 arcgis的MapServer服务查询出来的结果geometry坐标点带*的问题-CSDN博客 个人感觉像是server版本的问题，具体不清楚，pg数据库里面的shape点集合坐标点的精度是8，但是server服务查出来的默认都十几位。所以存在一…
阅读更多...
使用CPR库和Python编写程序

使用CPR库和Python编写程序

以下是一个使用CPR库和Python编写的爬虫程序，用于爬取。此程序使用了proxy的代码。 import requests from cpr import CPR ​ def get_proxy():url "https://www.duoip.cn/get_proxy"headers {"User-Agent": "Mozilla/5.0 (Windows NT …
阅读更多...
如何用.bat文件直接安装jar包

如何用.bat文件直接安装jar包

大家应该都知道一个maven引入jar包，如果直接把jar包放到目录，这样是没用的，引入还是会失败 这里我们可以创建一个.bat的windows系统文件，写入pom.xml对应的groupid，artifactId，version pom.xml中进入jar包…
阅读更多...
RDB.js：适用于 Node.js 和 Typescript 的终极对象关系映射器

RDB.js：适用于 Node.js 和 Typescript 的终极对象关系映射器

RDB.js 是适用于 Node.js 和 Typescript 的终极对象关系映射器，可与 Postgres、MS SQL、MySQL、Sybase SAP 和 SQLite 等流行数据库无缝集成。无论您是使用 TypeScript 还是 JavaScript（包括 CommonJS 和 ECMAScript）构建应用程序&#xff0c…
阅读更多...
Ceres 使用笔记

Ceres 使用笔记

文章目录 Part.I IntroductionChap.I 预备知识Chap.II 概念理解 Part.II 简单使用Chap.I Ceres 中主要函数简介Chap.II 一个简单的实例 Reference Part.I Introduction Ceres 1 是由 Google 开发的开源 C 通用非线性优化库，与 g2o 并列为目前视觉 SLAM 中应用最广泛…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023