Controller如何寫的更簡化
摘要：
Controller層相當於MVC中的C，也是安卓或者前端請求的介面。
首先說Controller為什麼需要寫的更加簡化?
第一、Controller是不能複用的；
第二、即便是將Controller分類，如果Controller程式碼過於龐大，不利於維護;
第三、Contro...
Controller層相當於MVC中的C，也是安卓或者前端請求的介面。
首先說Controller為什麼需要寫的更加簡化?
第一、Controller是不能複用的；
第二、即便是將Controller分類，如果Controller程式碼過於龐大，不利於維護;
第三、Controller中的CRUD之類的基本都是重複的，要麼是返回資料，要麼是返回狀態碼(通常定義一個ResultBean即可搞定);
我在第一個專案和第二個專案以及現在的專案犯了很多錯誤。
關於第一個專案和第二個專案的錯誤，今天暫不說。
第三個專案也就是現在的專案，Controller寫的是過於龐大，引數表單校驗都寫在裡面。
正常情況下，像比如引數非空校驗之類的很常見，完全可以封裝成一個ValidateUtils來校驗，犯不著重複寫了很多，雖然Hutool這個開源專案封裝的StrUtils裡面有對應的判斷方法，但是感覺寫了很多遍，著實不爽。覺得不經意間又犯了很多錯誤。重複寫，顯得程式碼冗餘。
下面以人人開源的程式碼生成器為例，人人開源的程式碼生成器生成的Controller是這樣的,程式碼如下:
@RestController @RequestMapping("/sys/menu") public class SysMenuController extends AbstractController { @Autowired private SysMenuService sysMenuService; /** * 導航選單 */ @RequestMapping("/nav") public R nav(){ List<SysMenuEntity> menuList = sysMenuService.getUserMenuList(getUserId()); return R.ok().put("menuList", menuList); } /** * 所有選單列表 */ @RequestMapping("/list") @RequiresPermissions("sys:menu:list") public List<SysMenuEntity> list(){ List<SysMenuEntity> menuList = sysMenuService.selectList(null); for(SysMenuEntity sysMenuEntity : menuList){ SysMenuEntity parentMenuEntity = sysMenuService.selectById(sysMenuEntity.getParentId()); if(parentMenuEntity != null){ sysMenuEntity.setParentName(parentMenuEntity.getName()); } } return menuList; } /** * 選擇選單(新增、修改選單) */ @RequestMapping("/select") @RequiresPermissions("sys:menu:select") public R select(){ //查詢列表資料 List<SysMenuEntity> menuList = sysMenuService.queryNotButtonList(); //新增頂級選單 SysMenuEntity root = new SysMenuEntity(); root.setMenuId(0L); root.setName("一級選單"); root.setParentId(-1L); root.setOpen(true); menuList.add(root); return R.ok().put("menuList", menuList); } /** * 選單資訊 */ @RequestMapping("/info/{menuId}") @RequiresPermissions("sys:menu:info") public R info(@PathVariable("menuId") Long menuId){ SysMenuEntity menu = sysMenuService.selectById(menuId); return R.ok().put("menu", menu); } /** * 儲存 */ @SysLog("儲存選單") @RequestMapping("/save") @RequiresPermissions("sys:menu:save") public R save(@RequestBody SysMenuEntity menu){ //資料校驗 verifyForm(menu); sysMenuService.insert(menu); return R.ok(); } /** * 修改 */ @SysLog("修改選單") @RequestMapping("/update") @RequiresPermissions("sys:menu:update") public R update(@RequestBody SysMenuEntity menu){ //資料校驗 verifyForm(menu); sysMenuService.updateById(menu); return R.ok(); } /** * 刪除 */ @SysLog("刪除選單") @RequestMapping("/delete") @RequiresPermissions("sys:menu:delete") public R delete(long menuId){ if(menuId <= 31){ return R.error("系統選單，不能刪除"); } //判斷是否有子選單或按鈕 List<SysMenuEntity> menuList = sysMenuService.queryListParentId(menuId); if(menuList.size() > 0){ return R.error("請先刪除子選單或按鈕"); } sysMenuService.delete(menuId); return R.ok(); } /** * 驗證引數是否正確 */ private void verifyForm(SysMenuEntity menu){ if(StringUtils.isBlank(menu.getName())){ throw new RRException("選單名稱不能為空"); } if(menu.getParentId() == null){ throw new RRException("上級選單不能為空"); } //選單 if(menu.getType() == Constant.MenuType.MENU.getValue()){ if(StringUtils.isBlank(menu.getUrl())){ throw new RRException("選單URL不能為空"); } } //上級選單型別 int parentType = Constant.MenuType.CATALOG.getValue(); if(menu.getParentId() != 0){ SysMenuEntity parentMenu = sysMenuService.selectById(menu.getParentId()); parentType = parentMenu.getType(); } //目錄、選單 if(menu.getType() == Constant.MenuType.CATALOG.getValue() || menu.getType() == Constant.MenuType.MENU.getValue()){ if(parentType != Constant.MenuType.CATALOG.getValue()){ throw new RRException("上級菜單隻能為目錄型別"); } return ; } //按鈕 if(menu.getType() == Constant.MenuType.BUTTON.getValue()){ if(parentType != Constant.MenuType.MENU.getValue()){ throw new RRException("上級菜單隻能為選單型別"); } return ; } } }
再看看我的Controller吧,程式碼示例如下:
@RestController
@RequiresAuthentication
@RequestMapping("/sysMenu")
public class SysMenuController {
@Autowired
private SysModuleServicesysModuleService;
@Autowired
private SysMenuService sysMenuService;
@Autowired
private SysUserService sysUserServicec;
/**
* 選單分頁查詢
* @param request
* @return
*/
@GetMapping(value="/menuPagingQuery",produces="application/json;charset=utf-8")
@ApiOperation(value="選單分頁查詢",httpMethod="GET",notes="選單分頁查詢")
public JSONObject modulePageQuery(HttpServletRequest request) {
JSONObject json = new JSONObject();
//公司編碼
String companyCode = request.getParameter("companyCode");
//獲取前臺當前頁
String currentPage = request.getParameter("pageno");
//獲取前臺每頁顯示資料
String pageSize = request.getParameter("pagesize");
//將前臺通過request獲取的currentPage引數轉為Integer型別
Integer pageno = Integer.parseInt(currentPage.trim());
//將前臺通過request獲取的pageSize引數轉為Integer型別
Integer pagesize = Integer.parseInt(pageSize.trim());
//將條件放入Map中
Map<String,Object> conditionMap = new HashMap<String,Object>();
conditionMap.put("companyCode", companyCode);
conditionMap.put("start", (pageno-1)*pagesize);
conditionMap.put("size", pagesize);
//呼叫查詢集合資料方法
List<SysMenu> list = sysMenuService.queryMenuPagingListInfo(conditionMap);
int count =sysMenuService.queryMenuPagingTotalCount(conditionMap);
//總頁數計算 初始化為0
int totalPageCount = 0;
if ( count % pagesize == 0 ) {
totalPageCount = count / pagesize;
} else {
totalPageCount = count / pagesize + 1;
}
//判斷集合資料是否為空
if(!list.isEmpty()) {
Page<SysMenu> page = new Page<SysMenu>();
page.setDatas(list);
page.setTotalno(totalPageCount);
page.setTotalsize(count);
json.put(CommonEnum.RETURN_MSG, "獲得選單資訊");
json.put("page", page);
json.put(CommonEnum.RETURN_CODE, "000000");
}else {
json.put(CommonEnum.RETURN_MSG, "暫無資料");
json.put(CommonEnum.RETURN_CODE, "111111");
}
return json;
}
/**
* 根據模組編碼獲得對應的選單資訊
* @param moduleCodes
* @return
*/
@GetMapping(value = "/getMenuListInfo",produces="application/json;charset=utf-8")
@ApiOperation(value="根據模組編碼獲得對應的選單資訊",httpMethod="GET",notes="根據模組編碼獲得對應的選單資訊")
public JSONObject getMenuListInfo(String moduleCodes) {
JSONObject json = new JSONObject();
try {
if(!StrUtil.isEmpty(moduleCodes)) {
EntityWrapper<SysMenu> wrapper = new EntityWrapper<SysMenu>();
wrapper.eq("module_codes", moduleCodes);
List<SysMenu> sysMenuList = sysMenuService.selectList(wrapper);
if(!sysMenuList.isEmpty()) {
json.put(CommonEnum.RETURN_CODE, "000000");
json.put(CommonEnum.RETURN_MSG, "獲得該模組下的所有選單資訊");
json.put("sysMenuList", sysMenuList);
json.put("menuSize", sysMenuList.size());
}else {
json.put(CommonEnum.RETURN_CODE, "111111");
json.put(CommonEnum.RETURN_MSG, "沒有資料");
}
}else {
json.put(CommonEnum.RETURN_CODE, "333333");
json.put(CommonEnum.RETURN_MSG, "引數異常:引數不能為空");
}
} catch (Exception e) {
json.put(CommonEnum.RETURN_CODE, "444444");
json.put(CommonEnum.RETURN_MSG, "其他異常");
}
return json;
}
/**
* 新增選單
* @return
*/
@PostMapping(value = "/addMenu",produces="application/json;charset=utf-8")
@ApiOperation(value="新增選單",httpMethod="POST",notes="新增選單")
public JSONObject addMenu(@RequestBody MenuDto menuDto) {
JSONObject json = new JSONObject();
try {
//引數非空校驗
if(!StrUtil.isEmptyIfStr(menuDto)) {
//根據使用者編號獲取操作使用者資訊
EntityWrapper<SysUser> wrapper=new EntityWrapper<SysUser>();
wrapper.eq("user_code", menuDto.getUserCode());
SysUser user = sysUserServicec.selectOne(wrapper);
//根據模組名字獲取對應模組資訊
EntityWrapper<SysModule> wrapper2 = new EntityWrapper<SysModule>();
wrapper2.eq("module_name", menuDto.getModuleName());
SysModule module = sysModuleService.selectOne(wrapper2);
SysMenu menu = new SysMenu();
menu.setMenuCode(String.valueOf(RandomUtil.randomInt(666666)));
menu.setMenuName(menuDto.getMenuName());
menu.setMenuHref(menuDto.getMenuHref());
menu.setMenuIcon(menuDto.getMenuIcon());
menu.setMenuType(menuDto.getMenuType());
menu.setCreateBy(user.getUserName());
menu.setIsShow(menuDto.getIsShow());
menu.setTreeSort(menuDto.getTreeSort());
menu.setSysCode(module.getModuleCode());
menu.setModuleCodes(module.getModuleCode());
menu.setPermission(menuDto.getPermission());
menu.setCreateDate(DateUtil.date().toString());
menu.setUpdateBy(user.getUserName());
menu.setUpdateDate(DateUtil.date().toString());
menu.setRemarks(menuDto.getRemarks());
//呼叫新增邏輯
boolean isAddMenu = sysMenuService.insert(menu);
if(isAddMenu) {
json.put(CommonEnum.RETURN_CODE, "000000");
json.put(CommonEnum.RETURN_MSG, "新增選單成功");
}else {
json.put(CommonEnum.RETURN_CODE, "111111");
json.put(CommonEnum.RETURN_MSG, "新增選單失敗");
}
}else {
json.put(CommonEnum.RETURN_CODE, "222222");
json.put(CommonEnum.RETURN_MSG, "引數校驗異常");
}
} catch (Exception e) {
json.put(CommonEnum.RETURN_CODE, "333333");
json.put(CommonEnum.RETURN_MSG, "其他異常");
}
return json;
}
/**
* 根據選單編號獲取對應的選單資訊
* @param menuCode
* @return
*/
@GetMapping(value="/selectByMenuCodeInfo",produces="application/json;charset=utf-8")
@ApiOperation(value="根據選單編號獲取對應的選單資訊",httpMethod="GET",notes="根據選單編號獲取對應的選單資訊")
public JSONObject selectByMenuCodeInfo(String menuCode) {
JSONObject json = new JSONObject();
try {
if(!StrUtil.isEmpty(menuCode)) {
EntityWrapper<SysMenu> wrapper = new EntityWrapper<SysMenu>();
wrapper.eq("menu_code", menuCode);
SysMenu menu = sysMenuService.selectOne(wrapper);
if(menu!=null) {
json.put("menu", menu);
json.put(CommonEnum.RETURN_CODE, "000000");
json.put(CommonEnum.RETURN_MSG, "獲取選單資訊成功");
}else {
json.put(CommonEnum.RETURN_CODE, "1111111");
json.put(CommonEnum.RETURN_MSG, "獲取選單資訊失敗");
}
}else {
json.put(CommonEnum.RETURN_CODE, "222222");
json.put(CommonEnum.RETURN_MSG, "引數異常");
}
} catch (Exception e) {
json.put(CommonEnum.RETURN_CODE, "333333");
json.put(CommonEnum.RETURN_MSG, "其他異常");
}
return json;
}
/**
* 刪除選單
* @param menuCode
* @return
*/
@PostMapping(value="/deleteMenuInfo",produces="application/json;charset=utf-8")
@ApiOperation(value="刪除選單",httpMethod="POST",notes="刪除選單")
public JSONObject deleteMenuInfo(String menuCode) {
JSONObject json = new JSONObject();
try {
if(!StrUtil.isEmpty(menuCode)) {
boolean isDelete = sysMenuService.deleteById(menuCode);
if(isDelete) {
json.put(CommonEnum.RETURN_CODE, "000000");
json.put(CommonEnum.RETURN_MSG, "刪除成功");
}else {
json.put(CommonEnum.RETURN_CODE, "111111");
json.put(CommonEnum.RETURN_MSG, "刪除失敗");
}
}else {
json.put(CommonEnum.RETURN_CODE, "222222");
json.put(CommonEnum.RETURN_MSG, "引數異常");
}
} catch (Exception e) {
json.put(CommonEnum.RETURN_CODE, "333333");
json.put(CommonEnum.RETURN_MSG, "其他異常");
}
return json;
}
/**
* 修改選單
* @return
*/
@PostMapping(value = "/modifyMenu",produces="application/json;charset=utf-8")
@ApiOperation(value="修改選單",httpMethod="POST",notes="修改選單")
public JSONObject modifyMenu(@RequestBody MenuDto menuDto) {
JSONObject json = new JSONObject();
try {
//引數非空校驗
if(!StrUtil.isEmptyIfStr(menuDto)) {
//根據使用者編號獲取操作使用者資訊
EntityWrapper<SysUser> wrapper=new EntityWrapper<SysUser>();
wrapper.eq("user_code", menuDto.getUserCode());
SysUser user = sysUserServicec.selectOne(wrapper);
//根據模組名字獲取對應模組資訊
EntityWrapper<SysModule> wrapper2 = new EntityWrapper<SysModule>();
wrapper2.eq("module_name", menuDto.getModuleName());
SysModule module = sysModuleService.selectOne(wrapper2);
SysMenu menu = new SysMenu();
menu.setMenuCode(menuDto.getMenuCode());
menu.setMenuName(menuDto.getMenuName());
menu.setMenuHref(menuDto.getMenuHref());
menu.setMenuIcon(menuDto.getMenuIcon());
menu.setMenuType(menuDto.getMenuType());
menu.setIsShow(menuDto.getIsShow());
menu.setTreeSort(menuDto.getTreeSort());
menu.setSysCode(module.getModuleCode());
menu.setPermission(menuDto.getPermission());
menu.setModuleCodes(module.getModuleCode());
menu.setUpdateBy(user.getUserName());
menu.setUpdateDate(DateUtil.date().toString());
menu.setRemarks(menuDto.getRemarks());
//呼叫修改邏輯
boolean isAddMenu = sysMenuService.updateById(menu);
if(isAddMenu) {
json.put(CommonEnum.RETURN_CODE, "000000");
json.put(CommonEnum.RETURN_MSG, "修改選單成功");
}else {
json.put(CommonEnum.RETURN_CODE, "111111");
json.put(CommonEnum.RETURN_MSG, "修改選單失敗");
}
}else {
json.put(CommonEnum.RETURN_CODE, "222222");
json.put(CommonEnum.RETURN_MSG, "引數校驗異常");
}
} catch (Exception e) {
json.put(CommonEnum.RETURN_CODE, "333333");
json.put(CommonEnum.RETURN_MSG, "其他異常");
}
return json;
}
/**
* 圖示儲存(以Cookie的形式儲存)
* @param icon
* @param response
* @return
*/
@GetMapping(value="iconStorage",produces="application/json;charset=utf-8")
@ApiOperation(value="圖示儲存",httpMethod="GET",notes="圖示儲存")
public JSONObject iconStorage(String icon,HttpServletResponse response) {
JSONObject json = new JSONObject();
try {
if(!StrUtil.isEmpty(icon)) {
CookieUtils.setCookie(response, "icon", icon, 3600);
json.put(CommonEnum.RETURN_CODE, "000000");
json.put(CommonEnum.RETURN_MSG, "圖示儲存成功");
}else {
json.put(CommonEnum.RETURN_CODE, "1111111");
json.put(CommonEnum.RETURN_MSG, "圖示儲存失敗");
}
} catch (Exception e) {
json.put(CommonEnum.RETURN_CODE, "222222");
json.put(CommonEnum.RETURN_MSG, "其他異常");
}
return json;
}
}
兩者比較，前者對重複的程式碼和一些常見的引數校驗和異常捕捉攔截做了很好的封裝，後者則相反。俗話說：向好同學學習。
下面我將貼一下上面的封裝類:
R.java
import java.util.HashMap;
import java.util.Map;
public class R extends HashMap<String, Object> {
private static final long serialVersionUID = 1L;
public R() {
put("code", 0);
put("msg", "success");
}
public static R error() {
return error(500, "未知異常，請聯絡管理員");
}
public static R error(String msg) {
return error(500, msg);
}
public static R error(int code, String msg) {
R r = new R();
r.put("code", code);
r.put("msg", msg);
return r;
}
public static R ok(String msg) {
R r = new R();
r.put("msg", msg);
return r;
}
public static R ok(Map<String, Object> map) {
R r = new R();
r.putAll(map);
return r;
}
public static R ok() {
return new R();
}
@Override
public R put(String key, Object value) {
super.put(key, value);
return this;
}
}
RRException.java
import io.renren.common.utils.R; import org.apache.shiro.authz.AuthorizationException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.dao.DuplicateKeyException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; /** * 異常處理器 * * @author Mark [email protected] * @since 1.0.0 2016-10-27 */ @RestControllerAdvice public class RRExceptionHandler { private Logger logger = LoggerFactory.getLogger(getClass()); /** * 處理自定義異常 */ @ExceptionHandler(RRException.class) public R handleRRException(RRException e){ R r = new R(); r.put("code", e.getCode()); r.put("msg", e.getMessage()); return r; } @ExceptionHandler(DuplicateKeyException.class) public R handleDuplicateKeyException(DuplicateKeyException e){ logger.error(e.getMessage(), e); return R.error("資料庫中已存在該記錄"); } @ExceptionHandler(AuthorizationException.class) public R handleAuthorizationException(AuthorizationException e){ logger.error(e.getMessage(), e); return R.error("沒有許可權，請聯絡管理員授權"); } @ExceptionHandler(Exception.class) public R handleException(Exception e){ logger.error(e.getMessage(), e); return R.error(); } }
小結:
本次講解的是如何將Controller寫的更加簡潔，同時也不要忘記一點，前面說到Controller的程式碼不能過於龐大，那麼service可以稍微龐大點，前提是在業務需要的情況下。當然了，最好還是那句話，程式碼能寫短點就短點，利於維護，提高效能。當然了，凡事沒有絕對，不一定程式碼寫的長，執行效能就差。這就需要開發者們實際開發中多注意。同時關於程式碼規範，可以參考借鑑《阿里巴巴Java開發手冊》，畢竟是咱們中國人自己開創的。另外最近再看一本新書叫《碼出高效》，翻了幾章，覺得挺不錯的，在此推薦給大家。