x-www-form-urlencoded纸面翻译即所谓url格式的编码,是post的默认Content-Type,其实就是一种编码格式,类似json也是一种编码传输格式。form表单中使用
form的enctype属性为编码方式,常用有两种:application/x-www-form-urlencoded和multipart/form-data,默认为application/x-www-form-urlencoded。
用登录案例来作说明,登录的时候需要输入账户跟密码。但是前端使用的是x-www-form-urlencoded类型传输,所以我们也需要使用x-www-form-urlencoded类型接收
@ApiOperation(value = "用户登陆获取token", position = 5, notes = "用户登陆获取token")
@ApiImplicitParams({
@ApiImplicitParam(name = "account", value = "用户名", dataType = "String"),
@ApiImplicitParam(name = "password", value = "密码", dataType = "String"),
})
@RequestMapping(value="/login",method= RequestMethod.POST)
public Result loginPC(String account ,String password ) throws Exception {
Map map = UserService.LoginUer(account, password);
return Result.success(map);
}
需要使用到@ApiImplicitParam,若有多个参数的话使用@ApiImplicition进行包裹。
接收x-www-form-urlencoded类型的关键点就在于@ApiImplicitParam。免去了使用@RequestBody在写一个接收类的繁琐步骤,加上@ApiImplicitParam之后直接接收即可。
若使用application/x-www-form-urlencoded类型传输数据过来,后端使用@ReposeBody接收,或出现报错
Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported
若出现上边的错误,只需要按照上边代码修改一些接收参数即可
所以使用application/x-www-form-urlencoded类型传输数据过来,需要使用@ApiImplicitParam说明参数并且接收
@ApiImplicitParam是一个标注方法参数的注解
注解内的属性有
name:参数名
value:参数的中文含义
required:是否必须
dataType:参数类型
paramType:参数所放位置
defaultValue:参数的默认值
其中,paramType可选值有header、query、path
header标注为从@RequestHeader中获取
query标注为从@RequestParam中获取
path从标注为@PathVariable中获取
方法中有多个参数时,使用@ApiImplicitParams包围
@ApiImplicitParams({
@ApiImplicitParam(name = "account", value = "用户名", dataType = "String"),
@ApiImplicitParam(name = "password", value = "密码", dataType = "String"),
})
x-www-form-urlencoded:表单的形式,表单格式。可以直接接收DTO数据,方法上不使用@ApiImplicitParams 。直接整个dto接收数据,不需要加上@ReposeBody.按照下方代码接收就可以达到目的
@ApiOperation(value="系统查询", position = 2, notes="系统查询",response =SysUserDTO.class)
@RequestMapping(value = "/query",method = RequestMethod.GET )
public Result query(@Validated ConditionDTO dto, @Validated PageDTO page) throws Exception{
PageResultDTO result = UserService.query(dto, page);
return Result.success(result);
}