SpringBoot 开发案例之参数传递的正确姿势
<p><img src="https://img2018.cnblogs.com/blog/109211/201910/109211-20191029144936371-199950210.png"></p><h2 id="前言">前言</h2>
<p>开发这么多年，肯定还有不少小伙伴搞不清各种类型的参数是如何传递的，很多同学都是拿来即用，复制粘贴一把撸，遇到问题还是一脸懵逼。</p>
<h2 id="姿势">姿势</h2>
<p>学习参数传递的正确姿势，先说怎么做，再说为什么，本质上还是复制粘贴一把撸，问题是你想问不想问为什么！</p>
<h2 id="传递">传递</h2>
<h4 id="用户登录">用户登录</h4>
<p>前端代码：</p>
<pre><code>var param = {
"username": "admin",
"password": "admin"
}
$.ajax({
url: "/sys/login",
data: param,
type: "post",
dataType: "json",
success: function(data) {
}
});
</code></pre>
<p>后端代码：</p>
<pre><code>@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("登录成功");
}
}
</code></pre>
<p>当然，你也可以这么实现，<code>@RequestParam(value="username", required=true)</code> ，<code>required</code> 默认为 <code>true</code>，如果前台不传递此参数，后台会报错。如果设置为 <code>false</code>，如果不传，默认为 <code>null</code>。</p>
<pre><code>/**
* 登录
* 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("登录成功");
}
</code></pre>
<h4 id="用户注册">用户注册</h4>
<p>前端代码，提交方式与登录基本保持一致。</p>
<p>后端代码：</p>
<p>用一个对象来接收前台参数，一般后端有对应的实体类。</p>
<pre><code>/**
* 注册
* https://blog.52itstyle.vip
*/
@PostMapping("/register")
public Result register(SysUser user){
logger.info("{}，用户注册",user.getUsername());
//业务逻辑
return Result.ok("注册成功");
}
</code></pre>
<h4 id="多参数无实体一">多参数无实体一</h4>
<p>前端代码：</p>
<pre><code>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) {
}
});
</code></pre>
<p>后端实现：</p>
<pre><code>/**
* 多参数
* 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("接收多参数成功");
}
</code></pre>
<h4 id="多参数无实体二">多参数无实体二</h4>
<p>前端代码：</p>
<pre><code>var param = {
"title": "爪哇笔记",
"content": "一个有趣的公众号",
"author": "小柒2012"
}
$.ajax({
url: "/sys/multiParameter",
data: param,
type: "post",
dataType: "json",
success: function(data) {
}
});
</code></pre>
<p>后端实现：</p>
<pre><code>/**
* 多参数
* 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("接收多参数成功");
}
</code></pre>
<h4 id="传递数组">传递数组</h4>
<p>前端代码：</p>
<pre><code>var param = {
"ids":
}
$.ajax({
url: "/sys/array",
data: param,
type: "post",
dataType: "json",
success: function(data) {
}
});
</code></pre>
<p>后端实现：</p>
<pre><code>/**
* 数组
* https://blog.52itstyle.vip
*/
@PostMapping("array")
public Result array(@RequestParam(value = "ids[]") Integer[] ids) {
logger.info("数据{}", Arrays.asList(ids));
//业务逻辑
return Result.ok();
}
</code></pre>
<h4 id="传递集合">传递集合</h4>
<p>前端代码与传递数组保持一致。</p>
<p>后端实现：</p>
<pre><code>/**
* 集合
* https://blog.52itstyle.vip
*/
@PostMapping("array")
public Result array(@RequestParam(value = "ids[]") List<Integer> ids) {
logger.info("数据{}", ids.toString());
//业务逻辑
return Result.ok();
}
</code></pre>
<h4 id="传递集合实体对象">传递集合实体对象</h4>
<p>比如，后端想接收一个实体对象集合 <code>List<SysUser></code></p>
<p>前端代码：</p>
<pre><code>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) {
}
});
</code></pre>
<p>后端代码：</p>
<pre><code>/**
* 爪哇笔记
* 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();
}
</code></pre>
<h4 id="传递集合实体对象一对多">传递集合实体对象一对多</h4>
<p>比如，一个用户有多个角色 <code>List<SysRole> roleList</code></p>
<p>前端代码：</p>
<pre><code>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) {
}
});
</code></pre>
<p>后端实现：</p>
<pre><code>/**
* 爪哇笔记
* 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();
}
</code></pre>
<h4 id="炒鸡复杂">炒鸡复杂</h4>
<p>传输对象有实体，有集合，有各种类型的数据，这时候最简单的方式就是传递 <code>Key-Value</code> 结构的 <code>JSON</code> 字符串，后台 <code>Map</code> 类型接收，然后通过<code>FastJson</code>的 <code>JSON.parseObject()</code> 和 <code>JSON.parseArray()</code> 方法转化为对应的实体或者集合。</p>
<pre><code> 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);
</code></pre>
<h4 id="restful-风格">RESTful 风格</h4>
<p>比如，访问某篇文章：</p>
<pre><code>/**
* 爪哇笔记
* https://blog.52itstyle.vip
*/
@GetMapping("article/{id}")
public void article(@PathVariable("id") String id) {
logger.info("文章{}",id);
//业务逻辑
}
</code></pre>
<h2 id="原则">原则</h2>
<p>记住一下几点：</p>
<ul>
<li>
<p><code>@RequestBody </code>注解，必须与 <code>contentType</code> 类型<code>application/json</code>配合使用。</p>
</li>
<li>
<p><code>@RequestParam </code>注解，必须与 <code>contentType</code> 类型<code>application/x-www-form-urlencoded</code>配合使用，其为默认类型。</p>
</li>
<li>
<p><code>JSON.stringify()</code> 把对象类型转换为字符串类型，一般配合 <code>@RequestBody </code>注解和<code>contentType</code> 类型<code>application/json</code>使用。</p>
</li>
</ul>
<h2 id="扩展">扩展</h2>
<p>在以上只涉及了两种 <code>contentType</code> 类型，其实还有两种常见的类型：</p>
<h4 id="multipartform-data"><code>multipart/form-data</code></h4>
<p>一般用于表单文件上传，必须让 form 的 enctype 等于这个值。</p>
<pre><code><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>
</code></pre>
<h4 id="textxml"><code>text/xml</code></h4>
<p>做过微信支付的小伙伴一定会知道，微信就喜欢用这种方式，去年还发生过 <code>XXE</code> 漏洞，在解析XML文档时，解析器通过 ENTITY 扩展的功能，读取本地受保护的文件，并且使用扩展功能将受保护的文件发送到远程地址。</p>
<h2 id="小结">小结</h2>
<p>不敢说是最完整的传参方案，但绝对敢保证是最正确的，因为所有的传参方式都经过 360° 官方检验。</p>
</div>
<div id="MySignature" role="contentinfo">
<div style="font-size: small">
<img src="https://blog.52itstyle.vip/usr/uploads/6359488940289160158582279.gif">
<p>
作者：
小柒
</p>
<p>
出处：
https://blog.52itstyle.vip
</p>
<img src="https://blog.52itstyle.vip/usr/uploads/2018/08/3608211975.jpg">
<p>
分享是快乐的，也见证了个人成长历程，文章大多都是工作经验总结以及平时学习积累，基于自身认知不足之处在所难免，也请大家指正，共同进步。
</p>
<p>
本文版权归作者所有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出,
如有问题， 可邮件（345849402@qq.com）咨询。
</p>
</div><br><br>
来源：https://www.cnblogs.com/smallSevens/p/11758718.html
頁:
[1]