欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

SpringBoot 设置传入参数非必要的操作

程序员文章站 2022-09-25 23:40:29
我就废话不多说了,大家还是直接看代码吧~设置参数是否为必要参数@requestparam(required = false) 补充: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 = loggerfactory.getlogger(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。

/**
 * 登录
 * https://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("登录成功");
}

用户注册

前端代码,提交方式与登录基本保持一致。

后端代码:

用一个对象来接收前台参数,一般后端有对应的实体类。

/**
 * 注册
 * https://blog.52itstyle.vip
 */
@postmapping("/register")
public result register(sysuser user){
 logger.info("{},用户注册",user.getusername());
 //业务逻辑
 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) {
 }
});

后端实现:

/**
 * 多参数
 * https://blog.52itstyle.vip
 */
@postmapping("/multiparameter")
public result register(@requestbody map<string,object> map){
 logger.info("多参数传递:{},{}",map.get("title"),map.get("content"));
 //业务逻辑
 return result.ok("接收多参数成功");
}

多参数无实体二

前端代码:

var param = {
 "title": "爪哇笔记",
 "content": "一个有趣的公众号",
 "author": "小柒2012"
}
$.ajax({
 url: "/sys/multiparameter",
 data: param,
 type: "post",
 datatype: "json",
 success: function(data) {
 }
});

后端实现:

/**
 * 多参数
 * https://blog.52itstyle.vip
 */
@postmapping("/multiparameter")
public result register(@requestparam map<string,object> map){
 logger.info("多参数传递:{},{}",map.get("title"),map.get("content"));
 //业务逻辑
 return result.ok("接收多参数成功");
}

传递数组

前端代码:

var param = {
 "ids": [1, 2, 3]
}
$.ajax({
 url: "/sys/array",
 data: param,
 type: "post",
 datatype: "json",
 success: function(data) {
 }
});

后端实现:

/**
 * 数组
 * https://blog.52itstyle.vip
 */
@postmapping("array")
public result array(@requestparam(value = "ids[]") integer[] ids) {
 logger.info("数据{}", arrays.aslist(ids));
 //业务逻辑
 return result.ok();
}

传递集合

前端代码与传递数组保持一致。

后端实现:

/**
 * 集合
 * https://blog.52itstyle.vip
 */
@postmapping("array")
public result array(@requestparam(value = "ids[]") list<integer> ids) {
 logger.info("数据{}", ids.tostring());
 //业务逻辑
 return result.ok();
}

传递集合实体对象

比如,后端想接收一个实体对象集合 list<sysuser>

前端代码:

var list = [];
list.push({
 "username": "小柒2012",
 "mobile": "17762288888"
});
list.push({
 "username": "小柒2013",
 "mobile": "17762289999"
});
$.ajax({
 url: "/sys/listuser",
 data: json.stringify(list),
 type: "post",
 contenttype: "application/json",
 datatype: "json",
 success: function(data) {
 }
});

后端代码:

/**
 * 爪哇笔记
 * https://blog.52itstyle.vip
 */
@postmapping("listuser")
public result listuser(@requestbody list<sysuser> list) {
 logger.info("数据{}", list.size());
 list.foreach(user->{
  //输出实体对象
  system.out.println(user.getusername());
 });
 //业务逻辑
 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": "17762288888"
};
user.rolelist = rolelist;
list.push(user);
$.ajax({
 url: "/sys/listuserrole",
 data: json.stringify(list),
 type: "post",
 contenttype: "application/json",
 datatype: "json",
 success: function(data) {
 }
});

后端实现:

/**
 * 爪哇笔记
 * https://blog.52itstyle.vip
 */
@postmapping("listuserrole")
public result listuserrole(@requestbody list<sysuser> list) {
 logger.info("数据{}", list.size());
 list.foreach(user->{
  list<sysrole> rolelist = user.getrolelist();
  rolelist.foreach(role->{
   system.out.println(role.getrolename());
  });
 });
 return result.ok();
}

炒鸡复杂

传输对象有实体,有集合,有各种类型的数据,这时候最简单的方式就是传递 key-value 结构的 json 字符串,后台 map 类型接收,然后通过fastjson的 json.parseobject() 和 json.parsearray() 方法转化为对应的实体或者集合。

 string user = parsemap.get("user").tostring();
 sysuser sysuser = json.parseobject(user,sysuser.class);
 string contractclause = parsemap.get("rules").tostring();
 list<rule> rulelist = json.parsearray(contractclause,rule.class);

restful 风格

比如,访问某篇文章:

/**
 * 爪哇笔记
 * https://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° 官方检验。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。如有错误或未考虑完全的地方,望不吝赐教。