哎哎哎,来荔枝后,web方面较少了好多!之前做开发时,大多数注解都是熟悉的,可是就是说不出来,这里做一个整理,方便后续查看。
Swagger中paramType:
paramType:表示参数放在哪个地方
header-->请求参数的获取:@RequestHeader(代码中接收注解)
query-->请求参数的获取:@RequestParam(代码中接收注解)
path(用于restful接口)-->请求参数的获取:@PathVariable(代码中接收注解)
body-->请求参数的获取:@RequestBody(代码中接收注解)
form(不常用)
get请求的headers中没有content-type这个字段,post 的 content-type 有两种 :
1)application/x-www-form-urlencoded
这种就是一般的文本表单用post传地数据,只要将得到的data用querystring解析下就可以了
2)multipart/form-data
文件表单的传输
所以,当springboot中,在Controller上全局限定@RequestMapping(value = "api/v/", consumes = APPLICATION_JSON_UTF8_VALUE, produces = APPLICATION_JSON_UTF8_VALUE),那么就不能用get方式了,因为get没有content-type。会报错:
org.springframework.web.HttpMediaTypeNotSupportedException: Content type '' not supported
1、handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类:(主要讲解常用类型)
A、处理requet uri 部分(这里指uri template中variable,不含queryString部分)的注解: @PathVariable;
B、处理request header部分的注解: @RequestHeader, @CookieValue;
C、处理request body部分的注解:@RequestParam, @RequestBody;
D、处理attribute类型是注解: @SessionAttributes, @ModelAttribute;
2、 @RequestHeader、@CookieValue
@RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。
@RequestMapping("/xxxxx")
public void headerInfo(@RequestHeader("Accept-Encoding") String encoding,
@RequestHeader("Keep-Alive") long keepAlive)
3、@PathVariable
当使用@RequestMapping URI template 样式映射时, 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
4、@RequestParam
A、用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容,提交方式GET、POST;
B、常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况( String--> 简单类型的转换操作由ConversionService配置的转换器来完成);因为使用request.getParameter()方式获取参数,所以可以处理get 方式中queryString的值,也可以处理post方式中 body data的值;
C、该注解有两个属性: value、required; value用来指定要传入值的id名称,required用来指示参数是否必须绑定;
5、@RequestBody
A、该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容,例如application/json, application/xml等;当然也可以处理 application/x-www-form-urlencoded(@RequestParam, @ModelAttribute),不能处理multipart/form-data。
B、它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body,然后绑定到相应的bean上的。
因为配置有FormHttpMessageConverter,所以也可以用来处理 application/x-www-form-urlencoded的内容,处理完的结果放在一个MultiValueMap<String, String>里,这种情况在某些特殊需求下使用,详情查看FormHttpMessageConverter api;
C、该注解有一个属性:required;required用来指示参数是否必须绑定;
使用时机:request的body部分的数据编码格式由header部分的Content-Type指定;
A) GET、POST方式提时, 根据request header Content-Type的值来判断:
application/x-www-form-urlencoded, 可选(即非必须,因为这种情况的数据@RequestParam, @ModelAttribute也可以处理,当然@RequestBody也能处理);
multipart/form-data, 不能处理(即使用@RequestBody不能处理这种格式的数据);
其他格式, 必须(其他格式包括application/json, application/xml等。这些格式的数据,必须使用@RequestBody来处理);
B) PUT方式提交时, 根据request header Content-Type的值来判断:
application/x-www-form-urlencoded, 必须;
multipart/form-data, 不能处理;
其他格式, 必须;
6、@SessionAttributes:
该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。
该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute对象;
7、@ModelAttribute
该注解有两个用法,一个是用于方法上,一个是用于参数上;
用于方法上时: 通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;
用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:
A、@SessionAttributes 启用的attribute 对象上;
B、@ModelAttribute 用于方法上时指定的model对象;
C、上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。
8、@ResponseBody
作用:该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。
使用时机:返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用;
相关推荐
java spring 框架及注解 总结,本人在项目开发中总结的,希望对大家有所帮助
sping注解开发总结,基于注解开发,Spring的IOC的注解开发, Spring的AOP的基于AspectJ的XML的开发。
传统的Spring做法是使用.xml文件来对bean进行注入或者是...为了解决这两个问题,Spring引入了注解,通过"@XXX"的方式,让注解与Java Bean紧密结合,既大大减少了配置文件的体积,又增加了Java Bean的可读性与内聚性。
Spring AOP之基于AspectJ注解总结与案例 ,具体效果和过程看博文 http://blog.csdn.net/evankaka/article/details/45394409
spring注解开发总结md版
Spring个人总结,基于Annotation注解的方式开发,配置
2、在开发中在.java文件和.xml文件之间不断切换,是一件麻烦的事,同时这种思维上的不连贯也会降低开发的效率 1、@Autowired@Autowired顾
spring_mvc各种注解详解与总结,针对初学spring_mvc的童鞋
Spring3.0注解注入详解[总结].pdf
Struts2.3.28+spring4.1.6+hibernate4.3.8整合总结(注解),测试环境使用myeclipse2014,jdk1.6
花了10个小时总结的spring注解开发,与普通的xml对比总结,更加形象,包括IOC DI AOP 事务 持久层整合.... 为以后的springboot学习有很大帮助!!
mybatis和spring整合方式-带注解,个人经验总结,适合新手学习,欢迎下载
不适合小白,用于个人梳理
mybatis与spring的整合总结以及spring常用注解
spring注解开发笔记总结,方便网友使用
Spring 注解学习手札,个人学习Spring mvc的知识总结
Spring注解驱动开发第33讲——AOP原理总结
SpringCloud中关于Feign的常见问题总结,包括常用的请求注解、@PathVariable、FeignClient多参数的构造等
对BeanFactory的相关所有接口的功能的关键点进行了总结描述,中文版本
基于注解的spring3.0mvc 框架搭建总结