SpringBoot设置传⼊参数⾮必要的操作
我就废话不多说了，⼤家还是直接看代码吧~
设置参数是否为必要参数
@RequestParam(required = false)
补充：SpringBoot 开发案例之参数传递的正确姿势
前⾔
开发这么多年，肯定还有不少⼩伙伴搞不清各种类型的参数是如何传递的，很多同学都是拿来即⽤，复制粘贴⼀把撸，遇到问题还是⼀脸懵逼。
姿势
学习参数传递的正确姿势，先说怎么做，再说为什么，本质上还是复制粘贴⼀把撸，问题是你想问不想问为什么！
传递
⽤户登录
前端代码：
var param = {
"username": "admin",
"password": "admin"
}
$.ajax({
url: "/sys/login",
data: param,
type: "post",
dataType: "json",
success: function(data) {
}
});
后端代码：
@RestController
@RequestMapping("/sys")
public class LoginController {
private static final Logger logger = Logger(LoginController.class);
/**
* 登录
*/
@PostMapping("/login")
public Result login(String username, String password){
logger.info("⽤户登录"+username);
//业务逻辑
return Result.ok("登录成功");
}
}
当然，你也可以这么实现，@RequestParam(value="username", required=true) ，required 默认为 true，如果前台不传递此参数，后台会报错。如果设置为 false，如果不传，默认为 null。
/**
* 登录
* blog.52itstyle.vip
*/
@PostMapping("/login")
public Result login(@RequestParam(value="username", required=true) String username,
@RequestParam(value="password", required=true) String password){
logger.info("⽤户登录"+username);
//业务逻辑
return Result.ok("登录成功");
⽤户注册
前端代码，提交⽅式与登录基本保持⼀致。
后端代码：
⽤⼀个对象来接收前台参数，⼀般后端有对应的实体类。/**
* 注册
* blog.52itstyle.vip
*/
@PostMapping("/register")
public Result register(SysUser user){
logger.info("{}，⽤户注册",Username());
//业务逻辑
return Result.ok("注册成功");
}
多参数⽆实体⼀
前端代码：
var param = {
"title": "⽖哇笔记",
"content": "⼀个有趣的",
"author": "⼩柒2012"
}
param = JSON.stringify(param);
$.ajax({
url: "/sys/multiParameter",
data: param,
type: "post",
contentType: "application/json",
dataType: "json",
success: function(data) {
}
});
后端实现：
/**
* 多参数
* blog.52itstyle.vip
*/
@PostMapping("/multiParameter")
public Result register(@RequestBody Map<String,Object> map){
logger.info("多参数传递:{},{}",("title"),("content"));
//业务逻辑
return Result.ok("接收多参数成功");
}
多参数⽆实体⼆
前端代码：
var param = {
"title": "⽖哇笔记",
"content": "⼀个有趣的",
"author": "⼩柒2012"
}
$.ajax({
url: "/sys/multiParameter",
data: param,
type: "post",
dataType: "json",
success: function(data) {
}
});
后端实现：
/**
* blog.52itstyle.vip
*/
@PostMapping("/multiParameter")
public Result register(@RequestParam Map<String,Object> map){
logger.info("多参数传递:{},{}",("title"),("content"));
//业务逻辑
return Result.ok("接收多参数成功");
}
传递数组
前端代码：
var param = {
"ids": [1, 2, 3]
fastjson字符串转数组
}
$.ajax({
url: "/sys/array",
data: param,
type: "post",
dataType: "json",
success: function(data) {
}
});
后端实现：
/**
* 数组
* blog.52itstyle.vip
*/
@PostMapping("array")
public Result array(@RequestParam(value = "ids[]") Integer[] ids) {
logger.info("数据{}", Arrays.asList(ids));
//业务逻辑
return Result.ok();
}
传递集合
前端代码与传递数组保持⼀致。
后端实现：
/**
* 集合
* blog.52itstyle.vip
*/
@PostMapping("array")
public Result array(@RequestParam(value = "ids[]") List<Integer> ids) { logger.info("数据{}", String());
//业务逻辑
return Result.ok();
}
传递集合实体对象
⽐如，后端想接收⼀个实体对象集合 List<SysUser>
前端代码：
var list = [];
list.push({
"username": "⼩柒2012",
"mobile": "177********"
});
list.push({
"username": "⼩柒2013",
"mobile": "177********"
});
$.ajax({
url: "/sys/listUser",
data: JSON.stringify(list),
contentType: "application/json",
dataType: "json",
success: function(data) {
}
});
后端代码：
/**
* ⽖哇笔记
* blog.52itstyle.vip
*/
@PostMapping("listUser")
public Result listUser(@RequestBody List<SysUser> list) {
logger.info("数据{}", list.size());
list.forEach(user->{
//输出实体对象
System.out.Username());
});
//业务逻辑
return Result.ok();
}
传递集合实体对象⼀对多
⽐如，⼀个⽤户有多个⾓⾊ List<SysRole> roleList 前端代码：
var roleList = [];
roleList.push({
"roleSign": "admin",
"roleName": "管理员"
});
roleList.push({
"roleSign": "user",
"roleName": "普通⽤户"
});
var list = [];
var user = {
"username": "⼩柒2012",
"mobile": "177********"
};
list.push(user);
$.ajax({
url: "/sys/listUserRole",
data: JSON.stringify(list),
type: "post",
contentType: "application/json",
dataType: "json",
success: function(data) {
}
});
后端实现：
/**
* ⽖哇笔记
* blog.52itstyle.vip
*/
@PostMapping("listUserRole")
public Result listUserRole(@RequestBody List<SysUser> list) { logger.info("数据{}", list.size());
list.forEach(user->{
List<SysRole> roleList = RoleList();
roleList.forEach(role->{
System.out.RoleName());
});
});
return Result.ok();
}
炒鸡复杂
传输对象有实体，有集合，有各种类型的数据，这时候最简单的⽅式就是传递 Key-Value 结构的 JSON 字符串，后台 Map 类型接收，然后通过FastJson的 JSON.parseObject() 和 JSON.parseArray() ⽅法转化为对应的实体或者集合。
String user = ("user").toString();
SysUser sysUser = JSON.parseObject(user,SysUser.class);
String contractClause = ("rules").toString();
List<Rule> ruleList = JSON.parseArray(contractClause,Rule.class);
RESTful 风格
⽐如，访问某篇⽂章：
/**
* ⽖哇笔记
* blog.52itstyle.vip
*/
@GetMapping("article/{id}")
public void article(@PathVariable("id") String id) {
logger.info("⽂章{}",id);
//业务逻辑
}
原则
记住⼀下⼏点：
@RequestBody注解，必须与 contentType 类型application/json配合使⽤。
@RequestParam注解，必须与 contentType 类型application/x-www-form-urlencoded配合使⽤，其为默认类型。
JSON.stringify() 把对象类型转换为字符串类型，⼀般配合 @RequestBody注解和contentType 类型application/json使⽤。扩展
在以上只涉及了两种 contentType 类型，其实还有两种常见的类型：
multipart/form-data
⼀般⽤于表单⽂件上传，必须让 form 的 enctype 等于这个值。
<form action="/upload" method="post" enctype="multipart/form-data">
<input type="text" name="description" value="⽖哇笔记，⼀个神奇的">
<input type="file" name="myFile">
<button type="submit">Submit</button>
</form>
text/xml
做过⽀付的⼩伙伴⼀定会知道，就喜欢⽤这种⽅式，去年还发⽣过 XXE 漏洞，在解析XML⽂档时，解析器通过ENTITY 扩展的功能，读取本地受保护的⽂件，并且使⽤扩展功能将受保护的⽂件发送到远程地址。
⼩结
不敢说是最完整的传参⽅案，但绝对敢保证是最正确的，因为所有的传参⽅式都经过 360° 官⽅检验。
以上为个⼈经验，希望能给⼤家⼀个参考，也希望⼤家多多⽀持。如有错误或未考虑完全的地⽅，望不吝赐教。
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论