SpringBoot 設(shè)置傳入?yún)?shù)非必要的操作

更新時(shí)間：2021年02月27日 15:45:58 作者：Moon Lignt Shadow

這篇文章主要介紹了SpringBoot 設(shè)置傳入?yún)?shù)非必要的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

我就廢話不多說(shuō)了，大家還是直接看代碼吧~

設(shè)置參數(shù)是否為必要參數(shù)

@RequestParam(required = false)

補(bǔ)充：SpringBoot 開發(fā)案例之參數(shù)傳遞的正確姿勢(shì)

前言

開發(fā)這么多年，肯定還有不少小伙伴搞不清各種類型的參數(shù)是如何傳遞的，很多同學(xué)都是拿來(lái)即用，復(fù)制粘貼一把擼，遇到問(wèn)題還是一臉懵逼。

姿勢(shì)

學(xué)習(xí)參數(shù)傳遞的正確姿勢(shì)，先說(shuō)怎么做，再說(shuō)為什么，本質(zhì)上還是復(fù)制粘貼一把擼，問(wèn)題是你想問(wèn)不想問(wèn)為什么！

傳遞

用戶登錄

前端代碼：

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);
  //業(yè)務(wù)邏輯
  return Result.ok("登錄成功");
 }
}

當(dāng)然，你也可以這么實(shí)現(xiàn)，@RequestParam(value="username", required=true) ，required 默認(rèn)為 true，如果前臺(tái)不傳遞此參數(shù)，后臺(tái)會(huì)報(bào)錯(cuò)。如果設(shè)置為 false，如果不傳，默認(rèn)為 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);
 //業(yè)務(wù)邏輯
 return Result.ok("登錄成功");
}

用戶注冊(cè)

前端代碼，提交方式與登錄基本保持一致。

后端代碼：

用一個(gè)對(duì)象來(lái)接收前臺(tái)參數(shù)，一般后端有對(duì)應(yīng)的實(shí)體類。

/**
 * 注冊(cè)
 * https://blog.52itstyle.vip
 */
@PostMapping("/register")
public Result register(SysUser user){
 logger.info("{}，用戶注冊(cè)",user.getUsername());
 //業(yè)務(wù)邏輯
 return Result.ok("注冊(cè)成功");
}

多參數(shù)無(wú)實(shí)體一

前端代碼：

var param = {
 "title": "爪哇筆記",
 "content": "一個(gè)有趣的公眾號(hào)",
 "author": "小柒2012"
}
param = JSON.stringify(param);
$.ajax({
 url: "/sys/multiParameter",
 data: param,
 type: "post",
 contentType: "application/json",
 dataType: "json",
 success: function(data) {
 }
});

后端實(shí)現(xiàn)：

/**
 * 多參數(shù)
 * https://blog.52itstyle.vip
 */
@PostMapping("/multiParameter")
public Result register(@RequestBody Map<String,Object> map){
 logger.info("多參數(shù)傳遞:{},{}",map.get("title"),map.get("content"));
 //業(yè)務(wù)邏輯
 return Result.ok("接收多參數(shù)成功");
}

多參數(shù)無(wú)實(shí)體二

前端代碼：

var param = {
 "title": "爪哇筆記",
 "content": "一個(gè)有趣的公眾號(hào)",
 "author": "小柒2012"
}
$.ajax({
 url: "/sys/multiParameter",
 data: param,
 type: "post",
 dataType: "json",
 success: function(data) {
 }
});

后端實(shí)現(xiàn)：

/**
 * 多參數(shù)
 * https://blog.52itstyle.vip
 */
@PostMapping("/multiParameter")
public Result register(@RequestParam Map<String,Object> map){
 logger.info("多參數(shù)傳遞:{},{}",map.get("title"),map.get("content"));
 //業(yè)務(wù)邏輯
 return Result.ok("接收多參數(shù)成功");
}

傳遞數(shù)組

前端代碼：

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

后端實(shí)現(xiàn)：

/**
 * 數(shù)組
 * https://blog.52itstyle.vip
 */
@PostMapping("array")
public Result array(@RequestParam(value = "ids[]") Integer[] ids) {
 logger.info("數(shù)據(jù){}", Arrays.asList(ids));
 //業(yè)務(wù)邏輯
 return Result.ok();
}

傳遞集合

前端代碼與傳遞數(shù)組保持一致。

后端實(shí)現(xiàn)：

/**
 * 集合
 * https://blog.52itstyle.vip
 */
@PostMapping("array")
public Result array(@RequestParam(value = "ids[]") List<Integer> ids) {
 logger.info("數(shù)據(jù){}", ids.toString());
 //業(yè)務(wù)邏輯
 return Result.ok();
}

傳遞集合實(shí)體對(duì)象

比如，后端想接收一個(gè)實(shí)體對(duì)象集合 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("數(shù)據(jù){}", list.size());
 list.forEach(user->{
  //輸出實(shí)體對(duì)象
  System.out.println(user.getUsername());
 });
 //業(yè)務(wù)邏輯
 return Result.ok();
}

傳遞集合實(shí)體對(duì)象一對(duì)多

比如，一個(gè)用戶有多個(gè)角色 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) {
 }
});

后端實(shí)現(xiàn)：

/**
 * 爪哇筆記
 * https://blog.52itstyle.vip
 */
@PostMapping("listUserRole")
public Result listUserRole(@RequestBody List<SysUser> list) {
 logger.info("數(shù)據(jù){}", list.size());
 list.forEach(user->{
  List<SysRole> roleList = user.getRoleList();
  roleList.forEach(role->{
   System.out.println(role.getRoleName());
  });
 });
 return Result.ok();
}

炒雞復(fù)雜

傳輸對(duì)象有實(shí)體，有集合，有各種類型的數(shù)據(jù)，這時(shí)候最簡(jiǎn)單的方式就是傳遞 Key-Value 結(jié)構(gòu)的 JSON 字符串，后臺(tái) Map 類型接收，然后通過(guò)FastJson的 JSON.parseObject() 和 JSON.parseArray() 方法轉(zhuǎn)化為對(duì)應(yīng)的實(shí)體或者集合。

 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 風(fēng)格

比如，訪問(wèn)某篇文章：

/**
 * 爪哇筆記
 * https://blog.52itstyle.vip
 */
@GetMapping("article/{id}")
public void article(@PathVariable("id") String id) {
 logger.info("文章{}",id);
 //業(yè)務(wù)邏輯
}

原則

記住一下幾點(diǎn)：

@RequestBody注解，必須與 contentType 類型application/json配合使用。

@RequestParam注解，必須與 contentType 類型application/x-www-form-urlencoded配合使用，其為默認(rèn)類型。

JSON.stringify() 把對(duì)象類型轉(zhuǎn)換為字符串類型，一般配合 @RequestBody注解和contentType 類型application/json使用。

擴(kuò)展

在以上只涉及了兩種 contentType 類型，其實(shí)還有兩種常見(jiàn)的類型：

multipart/form-data

一般用于表單文件上傳，必須讓 form 的 enctype 等于這個(gè)值。

<form action="/upload" method="post" enctype="multipart/form-data">
 <input type="text" name="description" value="爪哇筆記，一個(gè)神奇的公眾號(hào)">
 <input type="file" name="myFile">
 <button type="submit">Submit</button>
</form>

text/xml

做過(guò)微信支付的小伙伴一定會(huì)知道，微信就喜歡用這種方式，去年還發(fā)生過(guò) XXE 漏洞，在解析XML文檔時(shí)，解析器通過(guò) ENTITY 擴(kuò)展的功能，讀取本地受保護(hù)的文件，并且使用擴(kuò)展功能將受保護(hù)的文件發(fā)送到遠(yuǎn)程地址。