简介:
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;
1、 @PathVariable
当使用@RequestMapping URI template 样式映射时, 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。
示例代码:
上面代码把URI template 中变量 ownerId的值和petId的值,绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致,需要在@PathVariable("name")指定uri template中的名称。2、 @RequestHeader、@CookieValue
@RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。
示例代码:
这是一个Request 的header部分:
上面的代码,把request header部分的 Accept-Encoding的值,绑定到参数encoding上了, Keep-Alive header的值绑定到参数keepAlive上。
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。
例如有如下Cookie值:
3、@RequestParam, @RequestBody
@RequestParam
A) 常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况( String--> 简单类型的转换操作由ConversionService配置的转换器来完成);因为使用request.getParameter()方式获取参数,所以可以处理get 方式中queryString的值,也可以处理post方式中 body data的值;
B)用来处理Content-Type: 为 application/x-www-form-urlencoded
编码的内容,提交方式GET、POST;
C) 该注解有两个属性: value、required; value用来指定要传入值的id名称,required用来指示参数是否必须绑定;
示例代码:
@RequestBody
该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded
编码的内容,例如application/json, application/xml等;
它是通过使用HandlerAdapter 配置的HttpMessageConverters
来解析post data body,然后绑定到相应的bean上的。
因为配置有FormHttpMessageConverter,所以也可以用来处理 application/x-www-form-urlencoded
的内容,处理完的结果放在一个MultiValueMap<String, String>里,这种情况在某些特殊需求下使用,详情查看FormHttpMessageConverter api;
示例代码:
4、@SessionAttributes, @ModelAttribute
@SessionAttributes:
该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。
该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute 对象;
示例代码:
@ModelAttribute
该注解有两个用法,一个是用于方法上,一个是用于参数上;
用于方法上时: 通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;
用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:
A) @SessionAttributes 启用的attribute 对象上;
B) @ModelAttribute 用于方法上时指定的model对象;
C) 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。
用到方法上@ModelAttribute的示例代码:
这种方式实际的效果就是在调用@RequestMapping的方法之前,为request对象的model里put(“account”, Account);
用在参数上的@ModelAttribute示例代码:
首先查询 @SessionAttributes有无绑定的Pet对象,若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象,若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。补充讲解:
问题: 在不给定注解的情况下,参数是怎样绑定的?
通过分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代码发现,方法的参数在不给定参数的情况下:
若要绑定的对象时简单类型: 调用@RequestParam来处理的。
若要绑定的对象时复杂类型: 调用@ModelAttribute来处理的。
这里的简单类型指java的原始类型(boolean, int 等)、原始类型对象(Boolean, Int等)、String、Date等ConversionService里可以直接String转换成目标对象的类型;
示例:
这种情况下,就调用@ModelAttribute来处理。
Spring RestController 请求参数详解
在阅读之前,先了解http请求的get,post,以及各种head头类型,请求参数类型。
- 无参数,设置RestController请求路径
- 查询字符串参数,可选和必选参数
- json参数,RestController用实体类型接受
- 路径参数
- body参数
- 文件流参数
1 无参数,设置RestController请求路径
下面是一个例子,例子无请求参数,通过@RequestMapping设置了请求的路由路径和请求方法。路由路由由类的mapping和方法的mapping组成,在后面的例子中,我就不再写出RestApiRequestDemoController类的mapping了。记住,url里面有个demo在前面。
@RestController
@RequestMapping("/demo")
public class RestApiRequestDemoController {
///方法说明: 普通查询
///示例请求:http://localhost:8091/demo/searchList
@RequestMapping(value="/searchList",method = RequestMethod.POST)
@ResponseBody
public List<UserModel> searchList() {
List list = new list();
return list;
}
}
2 查询字符串参数,可选和必选参数2. 查询字符串参数,可选和必选参数
下面是使用查询字符串的例子,required可以设置请求的字符串是否必填
///方法说明:url参数的使用-查询字符串 ,且name必填
///示例请求:http://localhost:8091/demo/searchListByName?name=liuyanwei
@RequestMapping(value="/listByName",method = RequestMethod.POST)
@ResponseBody
public List<TbUserModel> searchList(@RequestParam(value="name",required = true) String name) {
Session context = DatabaseHelper.context();
String sql = "select * from tb_user where name ='"+ name+"'" ;
List list = context.createSQLQuery(sql)
.setResultTransformer(Transformers.aliasToBean(TbUserModel.class))
.list();
return list;
}
3 json参数,RestController用实体类型接受
注意,需要设置application/json 否则数据库会返回。hibernate操作数据库代码暂时可以不用去管他。
/*
* 方法说明:添加数据
* 1:使用json数据提交,直接使用实体对象接收
* 2:hibernate 添加数据
* 请求参数: {"id":1,"userId":1,"pwd":"123","name":"123","pwd":"123","headPortait":"123","isEnable":"123","createDate":"2015-05-12","lastLogin":"2015-05-12"}
* 请求头:Content-Type : application/json
* 请求ur:http://localhost:8091/demo/addUser
* */
@RequestMapping(value="/addUser",method = RequestMethod.POST)
@ResponseBody
public TbUserModel addUser(@RequestBody TbUserModel user) {
Session context = DatabaseHelper.context();
Transaction tran = context.beginTransaction();
context.save(user);
tran.commit();
user.setId(user.getId());
context.close();
return user;
}
4 路径参数
路径参数不能设置是否必填,全部都是必须填,不能省略的
///方法说明:url参数的使用
///示例请求:http://localhost:8091/demo/searchListById/2
@RequestMapping(value="/searchListById/{id}",method = RequestMethod.POST)
@ResponseBody
public List<TbUserModel> searchList(@PathVariable("id") int id) {
Session context = DatabaseHelper.context();
// String sql = "select * from tb_user where id ="+ id ;
String sql = "select * from tb_user where tb_user.id = :id";
System.out.println(sql);
List list = context.createSQLQuery(sql).setInteger("id", id)
.setResultTransformer(Transformers.aliasToBean(TbUserModel.class))
.list();
return list;
}
高级用法:路径参数可以自由设置自己的规则,比如,你有个请求需要两个参数,月和日,你可以写成{month}-{day}
///方法说明:url参数的使用
///示例请求:http://localhost:8091/demo/searchListByDate/2-10
@RequestMapping(value="/searchListByDate/{month}-{day}",method = RequestMethod.POST)
@ResponseBody
public List<TbUserModel> searchList(@PathVariable("month") int month,
@PathVariable("day") int day) {
}
5. 表单参数参数
注意,
- 这种方式传参数不能设置参数选填
- 注意,参数写在boby中,相当于表单参数,必须设置请求头为:application/x-www-form-urlencoded
- 若参数不正确,是无法进入控制器的。
/*
* 方法说明:使用表单方式提交数据
* 请求参数:isEnable=1&name=cool
* 配置
* 请求头:Content-Type : application/x-www-form-urlencoded
* 请求url:http://localhost:8091/demo/findUsersByName
* */
@RequestMapping(value="/findUsersByName",method = RequestMethod.POST)
@ResponseBody
public void findUsersByName(boolean isEnable , String name)
{
System.out.println(isEnable);
System.out.println(name);
}
6. 文件流参数
-
单个文件通过这种方式 @RequestParam(“file”) MultipartFile file获得,这里是简单的写法,相当于 MultipartFile file = ((MultipartHttpServletRequest) request).getFile(“file”); 多个文件使用@RequestParam(“files”) MultipartFile[] files)
- 表单中文件的name属性必须设置file(注意,不是文件名),例如,html中
- 这个是简单获取文件的方式,若不知道表单中文件的name属性,可以通过request获取文件
例子:
@RequestMapping("upload")
public Resp upload(HttpServletRequest request,
HttpServletResponse response, @RequestParam("file") MultipartFile file){
try {
//MultipartHttpServletRequest multipartRequest = (MultipartHttpServletRequest) request;
String filePath = FilesService.uploadFile(file, request);
return Resp.succeedResp(filePath);
}
catch (Exception e){
e.printStackTrace();
}
return Resp.failureResp("图片上传失败");
}
@RequestMapping("batchUpload")
public Resp batchUpload(HttpServletRequest request,
HttpServletResponse response,
@RequestParam("files") MultipartFile[] files) throws IOException {
List<String> list = new ArrayList<String>();
try {
for (MultipartFile file :files) {
String filePath = FilesService.uploadFile(file, request);
list.add(filePath);
System.out.println("filePath:" + filePath);
}
return Resp.succeedResp(list);
}
catch (Exception e){
e.printStackTrace();
}
return Resp.failureResp("文件上传失败");
}
总结
想要把Rest风格的api用好,合理利用参数是必须的。不同功能的api使用不同类型的参数接收方式。每个人有不同的习惯,我的习惯是:
- 一般获取内容,不涉及加密的用get方法,设计加密的用post
- 提交内容,例如添加,删除,修改,使用post、delete、put方法
- 通过主键获取内容的,我习惯用url参数,例如:/news/details/1,参数不是很多,组合起来有意义的也会用url路径组合,例如前面的日期:/demo/searchListByDate/2-10
- 有时候接收参数组合起来用比较好,有的内容通过url参数,有的部分用表单内容。
- 所有的设计接收参数的原则就是,然你的api的url能读通,看起来合理。