From a6fb88d74c20cc28043d75e8a5097fce49cf9a78 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期五, 15 十月 2021 15:19:42 +0800
Subject: [PATCH] update [重大更新]全业务 增加 接口文档注解 格式化代码
---
ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java | 126 +++++++++++++++++++----------------------
1 files changed, 59 insertions(+), 67 deletions(-)
diff --git a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java
index 4661d02..cd525c4 100644
--- a/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java
+++ b/ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysRoleController.java
@@ -1,6 +1,5 @@
package com.ruoyi.web.controller.system;
-import cn.hutool.core.lang.Validator;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.constant.UserConstants;
import com.ruoyi.common.core.controller.BaseController;
@@ -9,87 +8,83 @@
import com.ruoyi.common.core.domain.entity.SysUser;
import com.ruoyi.common.core.domain.model.LoginUser;
import com.ruoyi.common.core.page.TableDataInfo;
+import com.ruoyi.common.core.service.TokenService;
import com.ruoyi.common.enums.BusinessType;
-import com.ruoyi.common.utils.SecurityUtils;
-import com.ruoyi.common.utils.ServletUtils;
+import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.poi.ExcelUtil;
-import com.ruoyi.framework.web.service.SysPermissionService;
-import com.ruoyi.framework.web.service.TokenService;
import com.ruoyi.system.domain.SysUserRole;
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
+import com.ruoyi.system.service.SysPermissionService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
+import javax.servlet.http.HttpServletResponse;
import java.util.List;
/**
* 瑙掕壊淇℃伅
*
- * @author ruoyi
+ * @author Lion Li
*/
+@Validated
+@Api(value = "瑙掕壊淇℃伅鎺у埗鍣�", tags = {"瑙掕壊淇℃伅绠＄悊"})
+@RequiredArgsConstructor(onConstructor_ = @Autowired)
@RestController
@RequestMapping("/system/role")
-public class SysRoleController extends BaseController
-{
- @Autowired
- private ISysRoleService roleService;
+public class SysRoleController extends BaseController {
- @Autowired
- private TokenService tokenService;
+ private final ISysRoleService roleService;
+ private final TokenService tokenService;
+ private final ISysUserService userService;
+ private final SysPermissionService permissionService;
- @Autowired
- private SysPermissionService permissionService;
-
- @Autowired
- private ISysUserService userService;
-
+ @ApiOperation("鏌ヨ瑙掕壊淇℃伅鍒楄〃")
@PreAuthorize("@ss.hasPermi('system:role:list')")
@GetMapping("/list")
- public TableDataInfo list(SysRole role)
- {
+ public TableDataInfo<SysRole> list(SysRole role) {
return roleService.selectPageRoleList(role);
}
+ @ApiOperation("瀵煎嚭瑙掕壊淇℃伅鍒楄〃")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.EXPORT)
@PreAuthorize("@ss.hasPermi('system:role:export')")
@GetMapping("/export")
- public AjaxResult export(SysRole role)
- {
+ public void export(SysRole role, HttpServletResponse response) {
List<SysRole> list = roleService.selectRoleList(role);
- ExcelUtil<SysRole> util = new ExcelUtil<SysRole>(SysRole.class);
- return util.exportExcel(list, "瑙掕壊鏁版嵁");
+ ExcelUtil.exportExcel(list, "瑙掕壊鏁版嵁", SysRole.class, response);
}
/**
* 鏍规嵁瑙掕壊缂栧彿鑾峰彇璇︾粏淇℃伅
*/
+ @ApiOperation("鏍规嵁瑙掕壊缂栧彿鑾峰彇璇︾粏淇℃伅")
@PreAuthorize("@ss.hasPermi('system:role:query')")
@GetMapping(value = "/{roleId}")
- public AjaxResult getInfo(@PathVariable Long roleId)
- {
+ public AjaxResult<SysRole> getInfo(@PathVariable Long roleId) {
+ roleService.checkRoleDataScope(roleId);
return AjaxResult.success(roleService.selectRoleById(roleId));
}
/**
* 鏂板瑙掕壊
*/
+ @ApiOperation("鏂板瑙掕壊")
@PreAuthorize("@ss.hasPermi('system:role:add')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.INSERT)
@PostMapping
- public AjaxResult add(@Validated @RequestBody SysRole role)
- {
- if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role)))
- {
+ public AjaxResult<Void> add(@Validated @RequestBody SysRole role) {
+ if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role))) {
return AjaxResult.error("鏂板瑙掕壊'" + role.getRoleName() + "'澶辫触锛岃鑹插悕绉板凡瀛樺湪");
- }
- else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role)))
- {
+ } else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role))) {
return AjaxResult.error("鏂板瑙掕壊'" + role.getRoleName() + "'澶辫触锛岃鑹叉潈闄愬凡瀛樺湪");
}
- role.setCreateBy(SecurityUtils.getUsername());
+ role.setCreateBy(getUsername());
return toAjax(roleService.insertRole(role));
}
@@ -97,28 +92,23 @@
/**
* 淇敼淇濆瓨瑙掕壊
*/
+ @ApiOperation("淇敼淇濆瓨瑙掕壊")
@PreAuthorize("@ss.hasPermi('system:role:edit')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping
- public AjaxResult edit(@Validated @RequestBody SysRole role)
- {
+ public AjaxResult<Void> edit(@Validated @RequestBody SysRole role) {
roleService.checkRoleAllowed(role);
- if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role)))
- {
+ if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleNameUnique(role))) {
return AjaxResult.error("淇敼瑙掕壊'" + role.getRoleName() + "'澶辫触锛岃鑹插悕绉板凡瀛樺湪");
- }
- else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role)))
- {
+ } else if (UserConstants.NOT_UNIQUE.equals(roleService.checkRoleKeyUnique(role))) {
return AjaxResult.error("淇敼瑙掕壊'" + role.getRoleName() + "'澶辫触锛岃鑹叉潈闄愬凡瀛樺湪");
}
- role.setUpdateBy(SecurityUtils.getUsername());
+ role.setUpdateBy(getUsername());
- if (roleService.updateRole(role) > 0)
- {
+ if (roleService.updateRole(role) > 0) {
// 鏇存柊缂撳瓨鐢ㄦ埛鏉冮檺
- LoginUser loginUser = tokenService.getLoginUser(ServletUtils.getRequest());
- if (Validator.isNotNull(loginUser.getUser()) && !loginUser.getUser().isAdmin())
- {
+ LoginUser loginUser = getLoginUser();
+ if (StringUtils.isNotNull(loginUser.getUser()) && !loginUser.getUser().isAdmin()) {
loginUser.setPermissions(permissionService.getMenuPermission(loginUser.getUser()));
loginUser.setUser(userService.selectUserByUserName(loginUser.getUser().getUserName()));
tokenService.setLoginUser(loginUser);
@@ -131,11 +121,11 @@
/**
* 淇敼淇濆瓨鏁版嵁鏉冮檺
*/
+ @ApiOperation("淇敼淇濆瓨鏁版嵁鏉冮檺")
@PreAuthorize("@ss.hasPermi('system:role:edit')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping("/dataScope")
- public AjaxResult dataScope(@RequestBody SysRole role)
- {
+ public AjaxResult<Void> dataScope(@RequestBody SysRole role) {
roleService.checkRoleAllowed(role);
return toAjax(roleService.authDataScope(role));
}
@@ -143,85 +133,87 @@
/**
* 鐘舵�佷慨鏀�
*/
+ @ApiOperation("鐘舵�佷慨鏀�")
@PreAuthorize("@ss.hasPermi('system:role:edit')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.UPDATE)
@PutMapping("/changeStatus")
- public AjaxResult changeStatus(@RequestBody SysRole role)
- {
+ public AjaxResult<Void> changeStatus(@RequestBody SysRole role) {
roleService.checkRoleAllowed(role);
- role.setUpdateBy(SecurityUtils.getUsername());
+ role.setUpdateBy(getUsername());
return toAjax(roleService.updateRoleStatus(role));
}
/**
* 鍒犻櫎瑙掕壊
*/
+ @ApiOperation("鍒犻櫎瑙掕壊")
@PreAuthorize("@ss.hasPermi('system:role:remove')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.DELETE)
@DeleteMapping("/{roleIds}")
- public AjaxResult remove(@PathVariable Long[] roleIds)
- {
+ public AjaxResult<Void> remove(@PathVariable Long[] roleIds) {
return toAjax(roleService.deleteRoleByIds(roleIds));
}
/**
* 鑾峰彇瑙掕壊閫夋嫨妗嗗垪琛�
*/
+ @ApiOperation("鑾峰彇瑙掕壊閫夋嫨妗嗗垪琛�")
@PreAuthorize("@ss.hasPermi('system:role:query')")
@GetMapping("/optionselect")
- public AjaxResult optionselect()
- {
+ public AjaxResult<List<SysRole>> optionselect() {
return AjaxResult.success(roleService.selectRoleAll());
}
/**
* 鏌ヨ宸插垎閰嶇敤鎴疯鑹插垪琛�
*/
+ @ApiOperation("鏌ヨ宸插垎閰嶇敤鎴疯鑹插垪琛�")
@PreAuthorize("@ss.hasPermi('system:role:list')")
@GetMapping("/authUser/allocatedList")
- public TableDataInfo allocatedList(SysUser user)
- {
- return userService.selectAllocatedList(user);
+ public TableDataInfo<SysUser> allocatedList(SysUser user) {
+ return userService.selectAllocatedList(user);
}
/**
* 鏌ヨ鏈垎閰嶇敤鎴疯鑹插垪琛�
*/
+ @ApiOperation("鏌ヨ鏈垎閰嶇敤鎴疯鑹插垪琛�")
@PreAuthorize("@ss.hasPermi('system:role:list')")
@GetMapping("/authUser/unallocatedList")
- public TableDataInfo unallocatedList(SysUser user)
- {
+ public TableDataInfo<SysUser> unallocatedList(SysUser user) {
return userService.selectUnallocatedList(user);
}
/**
* 鍙栨秷鎺堟潈鐢ㄦ埛
*/
+ @ApiOperation("鍙栨秷鎺堟潈鐢ㄦ埛")
@PreAuthorize("@ss.hasPermi('system:role:edit')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.GRANT)
@PutMapping("/authUser/cancel")
- public AjaxResult cancelAuthUser(@RequestBody SysUserRole userRole)
- {
+ public AjaxResult<Void> cancelAuthUser(@RequestBody SysUserRole userRole) {
return toAjax(roleService.deleteAuthUser(userRole));
}
/**
* 鎵归噺鍙栨秷鎺堟潈鐢ㄦ埛
*/
+ @ApiOperation("鎵归噺鍙栨秷鎺堟潈鐢ㄦ埛")
+ @PreAuthorize("@ss.hasPermi('system:role:edit')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.GRANT)
@PutMapping("/authUser/cancelAll")
- public AjaxResult cancelAuthUserAll(Long roleId, Long[] userIds)
- {
+ public AjaxResult<Void> cancelAuthUserAll(Long roleId, Long[] userIds) {
return toAjax(roleService.deleteAuthUsers(roleId, userIds));
}
/**
* 鎵归噺閫夋嫨鐢ㄦ埛鎺堟潈
*/
+ @ApiOperation("鎵归噺閫夋嫨鐢ㄦ埛鎺堟潈")
+ @PreAuthorize("@ss.hasPermi('system:role:edit')")
@Log(title = "瑙掕壊绠＄悊", businessType = BusinessType.GRANT)
@PutMapping("/authUser/selectAll")
- public AjaxResult selectAuthUserAll(Long roleId, Long[] userIds)
- {
+ public AjaxResult<Void> selectAuthUserAll(Long roleId, Long[] userIds) {
return toAjax(roleService.insertAuthUsers(roleId, userIds));
}
}
--
Gitblit v1.9.3