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>