导航
写在前面：
一般前端提供API接口，包括各种联调等，使用的框架有spring全家桶、Jfinal等，配合Swagger2写Restful接口及文档非常方便简洁，以下是一些相关笔记。
@PathVariable
当使用@RequestMapping URI template 样式映射时，@PathVariable能使传过来的参数绑定到路由上，这样比较容易写出restful api，看代码
@RequestMapping(value="/{id}", method=RequestMethod.GET)
public List<Map<String, Object>> getUser(@PathVariable Integer id) {
return userService.getUserById(id);
}
上面这个接口可通过get请求 http://xxxxx/1111来得到想要的数据，1111既是getUser的方法参数又是@RequestMapping的路由。如果方法参数不想写成和路由一样的应该怎么办？看代码：
@RequestMapping(value="/{uid}", method=RequestMethod.GET)
public List<Map<String, Object>> getUser(@PathVariable("uid") Integer id) {
return userService.getUserById(id);
}
在@PathVariable后面接入“uid”就可以了。
@PathVariable 映射 URL 绑定的占位符
带占位符的 URL 是 Spring3.0 新增的功能，该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义;
通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中;
事例:
@PostMapping("/userInfo/{user_id}/delete")
@FalconMonitor(metric = "delete_userInfo_byUserId", type = MetricType.AVG_BY_TIME)
public MyHttpResponse deleteUserInfoByUserId(@PathVariable("user_id") long UserId) {
//打印日志,请求deleteUserInfoByUserId方法,参数是UserId;
logger.info("Enter method deleteUserInfoByUserId, user_id:{}", UserId);
//校验UserId参数是否大于0,不成立抛异常"必需的长参数“user_id”必须是肯定的";
checkArgument(UserId > 0, "Required long param 'user_id' must be positive.");
//service方法
userInfoService.deleteUserInfoByUserId(UserId);
//封装返回信息
MyHttpResponse response = MyHttpResponse.createSuccessResponse(null);
//日志打印,方法deleteUserInfoByUserId请求结束,打印返回信息;
logger.info("End method deleteUserInfoByUserId: {}", JSONUtils.writeValue(response));
//返回结果
return response;
}
请求路径:
//请求路径携带userId=123的用户请求方法,进行删除该用户;
localhost:8080/userInfo/123/delete
## @RequestParam @RequestParam和@PathVariable的区别就在于请求时当前参数是在url路由上还是在请求的body上，例如有下面一段代码： ```java @RequestMapping(value="", method=RequestMethod.POST) public String postUser(@RequestParam(value="phoneNum", required=true) String phoneNum ) String userName) { userService.create(phoneNum, userName); return "success"; } ``` 这个接口的请求url这样写：http://xxxxx?phoneNum=xxxxxx，也就是说被@RequestParam修饰的参数最后通过key=value的形式放在http请求的Body传过来，对比下上面的@PathVariable就很容易看出两者的区别了。
## @RequestBody @RequestBody能把简单json结构参数转换成实体类，如下代码：
@RequestMapping(value = "/testUser", method = RequestMethod.POST)
public String testUser(@RequestBody User user){
System.out.print(user.getAge());
return "success";
}
参数为：
{"id":1,"user":"pkxutao","name":"name","age":18}