Spring常用注解的讲解
转载,原文链接
作者:字母哥博客
本文出自:springboot深入浅出系列
文章目录
- 一、常用注解回顾
- 1.1 @RequestBody与@ResponseBody
- 1.2. @RequestMapping注解
- 1.3. @RestController与@Controller
- 1.4. @PathVariable 与@RequestParam
- 二、接收复杂嵌套对象参数
- 三、Http数据转换的原理
- 四、自定义HttpMessageConverter
一、常用注解回顾
1.1 @RequestBody与@ResponseBody
注意并不要求@RequestBody与@ResponseBody成对使用。
public @ResponseBody AjaxResponse saveArticle(@RequestBody ArticleVO article)
如上代码所示:
- @RequestBody修饰请求参数,注解用于接收HTTP的body,默认是使用JSON的格式
- @ResponseBody修饰返回值,注解用于在HTTP的body中携带响应数据,默认是使用JSON的格式。如果不加该注解,spring响应字符串类型,是跳转到模板页面或jsp页面的开发模式。说白了:
加上这个注解你开发的是一个数据接口,不加这个注解你开发的是一个页面跳转控制器。
那么我们有一个问题:如果我们想接收或XML数据该怎么办?我们想响应excel的数据格式该怎么办?我们后文来回答这个问题。
1.2. @RequestMapping注解
@RequestMapping注解是所有常用注解中,最有看点的一个注解,用于标注HTTP服务端点。它的很多属性对于丰富我们的应用开发方式方法,都有很重要的作用。如:
- value: 应用请求端点,最核心的属性,用于标志请求处理方法的唯一性;
- method: HTTP协议的method类型, 如:GET、POST、PUT、DELETE等;
- consumes: HTTP协议请求内容的数据类型(Content-Type),例如application/json, text/html;
- produces: HTTP协议响应内容的数据类型。下文会详细讲解。
- params: HTTP请求中必须包含某些参数值的时候,才允许被注解标注的方法处理请求。
- headers: HTTP请求中必须包含某些指定的header值,才允许被注解标注的方法处理请求。
@RequestMapping(value = "/article", method = POST)
@PostMapping(value = "/article")
上面代码中两种写法起到的是一样的效果,也就是PostMapping等同于@RequestMapping的method等于POST。同理:@GetMapping、@PutMapping、@DeleteMapping也都是简写的方式。
1.3. @RestController与@Controller
@Controller注解是开发中最常使用的注解,它的作用有两层含义:
一是告诉Spring,被该注解标注的类是一个Spring的Bean,需要被注入到Spring的上下文环境中。
二是该类里面所有被RequestMapping标注的注解都是HTTP服务端点。
@RestController相当于 @Controller和@ResponseBody结合。它有两层含义:
- 一是作为Controller的作用,将控制器类注入到Spring上下文环境,该类RequestMapping标注方法为HTTP服务端点。
- 二是作为ResponseBody的作用,请求响应默认使用的序列化方式是JSON,而不是跳转到jsp或模板页面。
1.4. @PathVariable 与@RequestParam
PathVariable用于URI上的{参数},如下方法用于删除一篇文章,其中id为文章id。如:我们的请求URL为“/article/1”,那么将匹配DeleteMapping并且PathVariable接收参数id=1。而RequestParam用于接收普通表单方式或者ajax模拟表单提交的参数数据。
@DeleteMapping("/article/{id}")
public @ResponseBody AjaxResponse deleteArticle(@PathVariable Long id) {@PostMapping("/article")
public @ResponseBody AjaxResponse deleteArticle(@RequestParam Long id) {
二、接收复杂嵌套对象参数
有一些朋友可能还无法理解RequestBody注解存在的真正意义,表单数据提交用RequestParam就好了,为什么还要搞出来一个RequestBody注解呢?RequestBody注解的真正意义在于能够使用对象或者嵌套对象接收前端数据。
仔细看上面的代码,是一个paramData对象里面包含了一个bestFriend对象。这种数据结构使用RequestParam就无法接收了,RequestParam只能接收平面的、一对一的参数。像上文中这种数据结构的参数,就需要我们在java服务端定义两个类,一个类是ParamData,一个类是BestFriend.
public class ParamData {private String name;private int id;private String phone;private BestFriend bestFriend;public static class BestFriend {private String address;private String sex;}
}
- 注意上面代码中省略了GET、SET方法等必要的java plain model元素。
- 注意成员变量名称一定要和JSON属性名称对应上。
- 注意接收不同类型的参数,使用不同的成员变量类型
完成以上动作,我们就可以使用@RequestBody ParamData paramData,一次性的接收以上所有的复杂嵌套对象参数了,参数对象的所有属性都将被赋值。
三、Http数据转换的原理
大家现在使用JSON都比较普遍了,其方便易用、表达能力强,是绝大部分数据接口式应用的首选。那么如何响应其他的类型的数据?其中的判别原理又是什么?下面就来给大家介绍一下:
- 当一个HTTP请求到达时是一个InputStream,通过HttpMessageConverter转换为java对象,从而进行参数接收。
- 当对一个HTTP请求进行响应时,我们首先输出的是一个java对象,然后由HttpMessageConverter转换为OutputStream输出。
当我们在Spring Boot应用中集成了jackson的类库之后,如下的一些HttpMessageConverter将会被加载。
根据HTTP协议的Accept和Content-Type属性,以及参数数据类型来判别使用哪一种HttpMessageConverter。当使用RequestBody或ResponseBody时,再结合前端发送的Accept数据类型,会自动判定优先使用MappingJacksonHttpMessageConverter作为数据转换器。但是,不仅JSON可以表达对象数据类型,XML也可以。如果我们希望使用XML格式该怎么告知Spring呢,那就要使用到produces属性了。
@GetMapping(value ="/demo",produces = MediaType.APPLICATION_XML_VALUE)
这里我们明确的告知了返回的数据类型是xml,就会使用Jaxb2RootElementHttpMessageConverter作为默认的数据转换器。当然实现XML数据响应比JSON还会更复杂一些,还需要结合@XmlRootElement、@XmlElement等注解实体类来使用。同理consumes属性你是不是也会用了呢。
四、自定义HttpMessageConverter
其实绝大多数的数据格式都不需要我们自定义HttpMessageConverter,都有第三方类库可以帮助我们实现(包括下文代码中的Excel格式)。但有的时候,有些数据的输出格式并没有类似于Jackson这种类库帮助我们处理,需要我们自定义数据格式。该怎么做?下面代码只是帮助我们理解的一个例子,不要用于生产:
@Service
public class TeamToXlsConverter extends AbstractHttpMessageConverter<Team> {private static final MediaType EXCEL_TYPE = MediaType.valueOf("application/vnd.ms-excel");TeamToXlsConverter() {super(EXCEL_TYPE);}@Overrideprotected Team readInternal(final Class<? extends Team> clazz, final HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {return null;}@Overrideprotected boolean supports(final Class<?> clazz) {return (Team.class == clazz);}@Overrideprotected void writeInternal(final Team team, final HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {try (final Workbook workbook = new HSSFWorkbook()) {final Sheet sheet = workbook.createSheet();int rowNo = 0;for (final TeamMember member : team.getMembers()) {final Row row = sheet.createRow(rowNo++);row.createCell(0).setCellValue(member.getName());}workbook.write(outputMessage.getBody());}}
}
- 实现AbstractHttpMessageConverter接口
- 指定该转换器是针对哪种数据格式的?如上文代码中的"application/vnd.ms-excel"
- 指定该转换器针对那些对象数据类型?如上文代码中的supports函数
- 使用writeInternal对数据进行输出处理,上例中是输出为Excel格式。
Spring常用注解的讲解相关推荐
- Spring常用注解(讲解的通俗易懂,很透彻)
使用注解来构造IoC容器 用注解来向Spring容器注册Bean.需要在applicationContext.xml中注册<context:component-scan base-package ...
- Spring系列之Spring常用注解总结
参看博客:https://www.cnblogs.com/xiaoxi/p/5935009.html 传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺 ...
- Spring常用注解总结
传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点: 1.如果所有的内容都配置在.xml文件中,那么.xml文件将会十分庞大:如果按需求分开.xml文 ...
- spring autowired idea都匹配上了_你清楚这几个Spring常用注解吗?
作者:平凡希http://cnblogs.com/xiaoxi/p/5935009.html 传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点: 如 ...
- Java 必须掌握的 12 种 Spring 常用注解
转载自 Java 必须掌握的 12 种 Spring 常用注解 1.声明bean的注解 @Component 组件,没有明确的角色 @Service 在业务逻辑层使用(service层) @Repo ...
- Spring常用注解 - 使用注解来构造IoC容器
Spring常用注解 使用注解来构造IoC容器 用注解来向Spring容器注册Bean.需要在applicationContext.xml中注册<context:component-scan b ...
- autowired注解_Spring系列之Spring常用注解总结
作者:平凡希来源:https://www.cnblogs.com/xiaoxi/p/5935009.html 传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做 ...
- sessionattribute 被spring 扫描不到_Spring 系列之 Spring 常用注解总结(肝硬化的干货)...
传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop.事物,这么做有两个缺点: 1. 如果所有的内容都配置在.xml文件中,那么.xml文件将会十分庞大:如果按需求分开.xml ...
- java 知识积累_java学习知识积累-spring常用注解
java学习知识积累-spring常用注解 类的分层注解,由于我们后台开发都是分为三层进行开发的,所以Spring框架提供了三种对于不同层的注解方式: 控制层:@Controller 服务层:@Ser ...
最新文章
- PaddleOCR加载chinese_ocr_db_crnn_modile模型进行中英文混合预测(Http服务)实践
- 如何查看哪些参数被新版本抛弃了?
- 使用ildasm和ilasm修改dll
- java ssh优势_java框架组合ssm和ssh各自的优势是什么?
- ActiveMQ学习总结(5)——Java消息服务JMS详解
- python 打开网页自动播放视频_html5的video标签自动播放
- 数据量大的sql怎么做优化_南浔区360优化怎么做,百度关键词优化_万推霸屏
- Cockos REAPER 6 for Mac - 强大的数字音频工作站
- python中win32api模块_解决在Python中使用Win32api报错的问题,No module named win32api
- 王国纪元服务器不稳定,王国纪元闪退怎么解决 游戏闪退解决方法
- vmware 删除后安装不了,vmware workstation.msi failed
- Unity外部资源无法拖入Unity
- java4android网易云_仿照网易云音乐界面 android特效
- Application loader:ERROR ITMS-90168: The binary you uploaded was invalid.
- 构建北京市政百姓信件分析实战案例
- 消息系统(ActiveMQ)
- 传奇手游服务器搭建_传奇手游怎么搭建服务器
- 95后字节八年测开晒出工资单:狠补了这个,真香···
- 产品经理常见面试题目——思维/场景问题
- Hiveos本地加密,hiveon加密线路设置
热门文章
- HelloJava,我的第一个Java程序
- LeetCode 907. 子数组的最小值之和(单调栈)
- LeetCode 1657. 确定两个字符串是否接近
- 天池 在线编程 音乐组合
- LeetCode 740. 删除与获得点数(排序+动态规划)
- LeetCode 1469. 寻找所有的独生节点
- LeetCode 1200. 最小绝对差
- LeetCode 405. 数字转换为十六进制数
- 程序员面试金典 - 面试题 17.12. BiNode(BST中序遍历)
- LeetCode 890. 查找和替换模式(哈希表)