add 整合 springdoc-openapi-javadoc 基于代码注释生成文档

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysUserController.java

@@ -1,232 +1,228 @@
package com.ruoyi.web.controller.system;



import java.util.List;

import java.util.stream.Collectors;

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.DeleteMapping;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.PutMapping;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import org.springframework.web.multipart.MultipartFile;

import com.ruoyi.common.annotation.Log;

import com.ruoyi.common.constant.UserConstants;

import com.ruoyi.common.core.controller.BaseController;

import com.ruoyi.common.core.domain.AjaxResult;

import com.ruoyi.common.core.domain.entity.SysRole;

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.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.TokenService;

import com.ruoyi.system.service.ISysPostService;

import com.ruoyi.system.service.ISysRoleService;

import com.ruoyi.system.service.ISysUserService;



/**

 * 用户信息

 * 
 * @author ruoyi

 */

@RestController

@RequestMapping("/system/user")

public class SysUserController extends BaseController

{

    @Autowired

    private ISysUserService userService;



    @Autowired

    private ISysRoleService roleService;



    @Autowired

    private ISysPostService postService;



    @Autowired

    private TokenService tokenService;



    /**

     * 获取用户列表

     */

    @PreAuthorize("@ss.hasPermi('system:user:list')")

    @GetMapping("/list")

    public TableDataInfo list(SysUser user)

    {

        startPage();

        List<SysUser> list = userService.selectUserList(user);

        return getDataTable(list);

    }



    @Log(title = "用户管理", businessType = BusinessType.EXPORT)

    @PreAuthorize("@ss.hasPermi('system:user:export')")

    @GetMapping("/export")

    public AjaxResult export(SysUser user)

    {

        List<SysUser> list = userService.selectUserList(user);

        ExcelUtil<SysUser> util = new ExcelUtil<SysUser>(SysUser.class);

        return util.exportExcel(list, "用户数据");

    }



    @Log(title = "用户管理", businessType = BusinessType.IMPORT)

    @PreAuthorize("@ss.hasPermi('system:user:import')")

    @PostMapping("/importData")

    public AjaxResult importData(MultipartFile file, boolean updateSupport) throws Exception

    {

        ExcelUtil<SysUser> util = new ExcelUtil<SysUser>(SysUser.class);

        List<SysUser> userList = util.importExcel(file.getInputStream());

        LoginUser loginUser = tokenService.getLoginUser(ServletUtils.getRequest());

        String operName = loginUser.getUsername();

        String message = userService.importUser(userList, updateSupport, operName);

        return AjaxResult.success(message);

    }



    @GetMapping("/importTemplate")

    public AjaxResult importTemplate()

    {

        ExcelUtil<SysUser> util = new ExcelUtil<SysUser>(SysUser.class);

        return util.importTemplateExcel("用户数据");

    }



    /**

     * 根据用户编号获取详细信息

     */

    @PreAuthorize("@ss.hasPermi('system:user:query')")

    @GetMapping(value = { "/", "/{userId}" })

    public AjaxResult getInfo(@PathVariable(value = "userId", required = false) Long userId)

    {

        AjaxResult ajax = AjaxResult.success();

        List<SysRole> roles = roleService.selectRoleAll();

        ajax.put("roles", SysUser.isAdmin(userId) ? roles : roles.stream().filter(r -> !r.isAdmin()).collect(Collectors.toList()));

        ajax.put("posts", postService.selectPostAll());

        if (StringUtils.isNotNull(userId))

        {

            ajax.put(AjaxResult.DATA_TAG, userService.selectUserById(userId));

            ajax.put("postIds", postService.selectPostListByUserId(userId));

            ajax.put("roleIds", roleService.selectRoleListByUserId(userId));

        }

        return ajax;

    }



    /**

     * 新增用户

     */

    @PreAuthorize("@ss.hasPermi('system:user:add')")

    @Log(title = "用户管理", businessType = BusinessType.INSERT)

    @PostMapping

    public AjaxResult add(@Validated @RequestBody SysUser user)

    {

        if (UserConstants.NOT_UNIQUE.equals(userService.checkUserNameUnique(user.getUserName())))

        {

            return AjaxResult.error("新增用户'" + user.getUserName() + "'失败，登录账号已存在");

        }

        else if (StringUtils.isNotEmpty(user.getPhonenumber())

                && UserConstants.NOT_UNIQUE.equals(userService.checkPhoneUnique(user)))

        {

            return AjaxResult.error("新增用户'" + user.getUserName() + "'失败，手机号码已存在");

        }

        else if (StringUtils.isNotEmpty(user.getEmail())

                && UserConstants.NOT_UNIQUE.equals(userService.checkEmailUnique(user)))

        {

            return AjaxResult.error("新增用户'" + user.getUserName() + "'失败，邮箱账号已存在");

        }

        user.setCreateBy(SecurityUtils.getUsername());

        user.setPassword(SecurityUtils.encryptPassword(user.getPassword()));

        return toAjax(userService.insertUser(user));

    }



    /**

     * 修改用户

     */

    @PreAuthorize("@ss.hasPermi('system:user:edit')")

    @Log(title = "用户管理", businessType = BusinessType.UPDATE)

    @PutMapping

    public AjaxResult edit(@Validated @RequestBody SysUser user)

    {

        userService.checkUserAllowed(user);

        if (StringUtils.isNotEmpty(user.getPhonenumber())

                && UserConstants.NOT_UNIQUE.equals(userService.checkPhoneUnique(user)))

        {

            return AjaxResult.error("修改用户'" + user.getUserName() + "'失败，手机号码已存在");

        }

        else if (StringUtils.isNotEmpty(user.getEmail())

                && UserConstants.NOT_UNIQUE.equals(userService.checkEmailUnique(user)))

        {

            return AjaxResult.error("修改用户'" + user.getUserName() + "'失败，邮箱账号已存在");

        }

        user.setUpdateBy(SecurityUtils.getUsername());

        return toAjax(userService.updateUser(user));

    }



    /**

     * 删除用户

     */

    @PreAuthorize("@ss.hasPermi('system:user:remove')")

    @Log(title = "用户管理", businessType = BusinessType.DELETE)

    @DeleteMapping("/{userIds}")

    public AjaxResult remove(@PathVariable Long[] userIds)

    {

        return toAjax(userService.deleteUserByIds(userIds));

    }



    /**

     * 重置密码

     */

    @PreAuthorize("@ss.hasPermi('system:user:resetPwd')")

    @Log(title = "用户管理", businessType = BusinessType.UPDATE)

    @PutMapping("/resetPwd")

    public AjaxResult resetPwd(@RequestBody SysUser user)

    {

        userService.checkUserAllowed(user);

        user.setPassword(SecurityUtils.encryptPassword(user.getPassword()));

        user.setUpdateBy(SecurityUtils.getUsername());

        return toAjax(userService.resetPwd(user));

    }



    /**

     * 状态修改

     */

    @PreAuthorize("@ss.hasPermi('system:user:edit')")

    @Log(title = "用户管理", businessType = BusinessType.UPDATE)

    @PutMapping("/changeStatus")

    public AjaxResult changeStatus(@RequestBody SysUser user)

    {

        userService.checkUserAllowed(user);

        user.setUpdateBy(SecurityUtils.getUsername());

        return toAjax(userService.updateUserStatus(user));

    }



    /**

     * 根据用户编号获取授权角色

     */

    @PreAuthorize("@ss.hasPermi('system:user:query')")

    @GetMapping("/authRole/{userId}")

    public AjaxResult authRole(@PathVariable("userId") Long userId)

    {

        AjaxResult ajax = AjaxResult.success();

        SysUser user = userService.selectUserById(userId);

        List<SysRole> roles = roleService.selectRolesByUserId(userId);

        ajax.put("user", user);

        ajax.put("roles", SysUser.isAdmin(userId) ? roles : roles.stream().filter(r -> !r.isAdmin()).collect(Collectors.toList()));

        return ajax;

    }



    /**

     * 用户授权角色

     */

    @PreAuthorize("@ss.hasPermi('system:user:edit')")

    @Log(title = "用户管理", businessType = BusinessType.GRANT)

    @PutMapping("/authRole")

    public AjaxResult insertAuthRole(Long userId, Long[] roleIds)

    {

        userService.insertUserAuth(userId, roleIds);

        return success();

    }

}

package com.ruoyi.web.controller.system;

import cn.dev33.satoken.annotation.SaCheckPermission;
import cn.dev33.satoken.secure.BCrypt;
import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.ArrayUtil;
import cn.hutool.core.util.ObjectUtil;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.constant.UserConstants;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.PageQuery;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.domain.entity.SysDept;
import com.ruoyi.common.core.domain.entity.SysRole;
import com.ruoyi.common.core.domain.entity.SysUser;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.excel.ExcelResult;
import com.ruoyi.common.helper.LoginHelper;
import com.ruoyi.common.utils.StreamUtils;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.vo.SysUserExportVo;
import com.ruoyi.system.domain.vo.SysUserImportVo;
import com.ruoyi.system.listener.SysUserImportListener;
import com.ruoyi.system.service.ISysPostService;
import com.ruoyi.system.service.ISysRoleService;
import com.ruoyi.system.service.ISysUserService;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * 用户信息
 *
 * @author Lion Li
 */
@Validated
@Tag(name ="用户信息控制器", description = "用户信息管理")
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/user")
public class SysUserController extends BaseController {

    private final ISysUserService userService;
    private final ISysRoleService roleService;
    private final ISysPostService postService;

    /**
     * 获取用户列表
     */
    @SaCheckPermission("system:user:list")
    @GetMapping("/list")
    public TableDataInfo<SysUser> list(SysUser user, PageQuery pageQuery) {
        return userService.selectPageUserList(user, pageQuery);
    }

    @Log(title = "用户管理", businessType = BusinessType.EXPORT)
    @SaCheckPermission("system:user:export")
    @PostMapping("/export")
    public void export(SysUser user, HttpServletResponse response) {
        List<SysUser> list = userService.selectUserList(user);
        List<SysUserExportVo> listVo = BeanUtil.copyToList(list, SysUserExportVo.class);
        for (int i = 0; i < list.size(); i++) {
            SysDept dept = list.get(i).getDept();
            SysUserExportVo vo = listVo.get(i);
            if (ObjectUtil.isNotEmpty(dept)) {
                vo.setDeptName(dept.getDeptName());
                vo.setLeader(dept.getLeader());
            }
        }
        ExcelUtil.exportExcel(listVo, "用户数据", SysUserExportVo.class, response);
    }

    @Parameters({
        @Parameter(name = "file", description = "导入文件", required = true),
    })
    @Log(title = "用户管理", businessType = BusinessType.IMPORT)
    @SaCheckPermission("system:user:import")
    @PostMapping("/importData")
    public R<Void> importData(@RequestPart("file") MultipartFile file, boolean updateSupport) throws Exception {
        ExcelResult<SysUserImportVo> result = ExcelUtil.importExcel(file.getInputStream(), SysUserImportVo.class, new SysUserImportListener(updateSupport));
        return R.ok(result.getAnalysis());
    }

    @PostMapping("/importTemplate")
    public void importTemplate(HttpServletResponse response) {
        ExcelUtil.exportExcel(new ArrayList<>(), "用户数据", SysUserImportVo.class, response);
    }

    /**
     * 根据用户编号获取详细信息
     */
    @SaCheckPermission("system:user:query")
    @GetMapping(value = {"/", "/{userId}"})
    public R<Map<String, Object>> getInfo(@Parameter(name = "用户ID") @PathVariable(value = "userId", required = false) Long userId) {
        userService.checkUserDataScope(userId);
        Map<String, Object> ajax = new HashMap<>();
        List<SysRole> roles = roleService.selectRoleAll();
        ajax.put("roles", LoginHelper.isAdmin(userId) ? roles : StreamUtils.filter(roles, r -> !r.isAdmin()));
        ajax.put("posts", postService.selectPostAll());
        if (ObjectUtil.isNotNull(userId)) {
            SysUser sysUser = userService.selectUserById(userId);
            ajax.put("user", sysUser);
            ajax.put("postIds", postService.selectPostListByUserId(userId));
            ajax.put("roleIds", StreamUtils.toList(sysUser.getRoles(), SysRole::getRoleId));
        }
        return R.ok(ajax);
    }

    /**
     * 新增用户
     */
    @SaCheckPermission("system:user:add")
    @Log(title = "用户管理", businessType = BusinessType.INSERT)
    @PostMapping
    public R<Void> add(@Validated @RequestBody SysUser user) {
        if (UserConstants.NOT_UNIQUE.equals(userService.checkUserNameUnique(user.getUserName()))) {
            return R.fail("新增用户'" + user.getUserName() + "'失败，登录账号已存在");
        } else if (StringUtils.isNotEmpty(user.getPhonenumber())
            && UserConstants.NOT_UNIQUE.equals(userService.checkPhoneUnique(user))) {
            return R.fail("新增用户'" + user.getUserName() + "'失败，手机号码已存在");
        } else if (StringUtils.isNotEmpty(user.getEmail())
            && UserConstants.NOT_UNIQUE.equals(userService.checkEmailUnique(user))) {
            return R.fail("新增用户'" + user.getUserName() + "'失败，邮箱账号已存在");
        }
        user.setPassword(BCrypt.hashpw(user.getPassword()));
        return toAjax(userService.insertUser(user));
    }

    /**
     * 修改用户
     */
    @SaCheckPermission("system:user:edit")
    @Log(title = "用户管理", businessType = BusinessType.UPDATE)
    @PutMapping
    public R<Void> edit(@Validated @RequestBody SysUser user) {
        userService.checkUserAllowed(user);
        userService.checkUserDataScope(user.getUserId());
        if (StringUtils.isNotEmpty(user.getPhonenumber())
            && UserConstants.NOT_UNIQUE.equals(userService.checkPhoneUnique(user))) {
            return R.fail("修改用户'" + user.getUserName() + "'失败，手机号码已存在");
        } else if (StringUtils.isNotEmpty(user.getEmail())
            && UserConstants.NOT_UNIQUE.equals(userService.checkEmailUnique(user))) {
            return R.fail("修改用户'" + user.getUserName() + "'失败，邮箱账号已存在");
        }
        return toAjax(userService.updateUser(user));
    }

    /**
     * 删除用户
     */
    @SaCheckPermission("system:user:remove")
    @Log(title = "用户管理", businessType = BusinessType.DELETE)
    @DeleteMapping("/{userIds}")
    public R<Void> remove(@Parameter(name = "角色ID串") @PathVariable Long[] userIds) {
        if (ArrayUtil.contains(userIds, getUserId())) {
            return R.fail("当前用户不能删除");
        }
        return toAjax(userService.deleteUserByIds(userIds));
    }

    /**
     * 重置密码
     */
    @SaCheckPermission("system:user:resetPwd")
    @Log(title = "用户管理", businessType = BusinessType.UPDATE)
    @PutMapping("/resetPwd")
    public R<Void> resetPwd(@RequestBody SysUser user) {
        userService.checkUserAllowed(user);
        userService.checkUserDataScope(user.getUserId());
        user.setPassword(BCrypt.hashpw(user.getPassword()));
        return toAjax(userService.resetPwd(user));
    }

    /**
     * 状态修改
     */
    @SaCheckPermission("system:user:edit")
    @Log(title = "用户管理", businessType = BusinessType.UPDATE)
    @PutMapping("/changeStatus")
    public R<Void> changeStatus(@RequestBody SysUser user) {
        userService.checkUserAllowed(user);
        userService.checkUserDataScope(user.getUserId());
        return toAjax(userService.updateUserStatus(user));
    }

    /**
     * 根据用户编号获取授权角色
     */
    @SaCheckPermission("system:user:query")
    @GetMapping("/authRole/{userId}")
    public R<Map<String, Object>> authRole(@Parameter(name = "用户ID") @PathVariable("userId") Long userId) {
        SysUser user = userService.selectUserById(userId);
        List<SysRole> roles = roleService.selectRolesByUserId(userId);
        Map<String, Object> ajax = new HashMap<>();
        ajax.put("user", user);
        ajax.put("roles", LoginHelper.isAdmin(userId) ? roles : StreamUtils.filter(roles, r -> !r.isAdmin()));
        return R.ok(ajax);
    }

    /**
     * 用户授权角色
     */
    @Parameters({
        @Parameter(name = "userId", description = "用户Id", in = ParameterIn.QUERY),
        @Parameter(name = "roleIds", description = "角色ID串", in = ParameterIn.QUERY)
    })
    @SaCheckPermission("system:user:edit")
    @Log(title = "用户管理", businessType = BusinessType.GRANT)
    @PutMapping("/authRole")
    public R<Void> insertAuthRole(Long userId, Long[] roleIds) {
        userService.checkUserDataScope(userId);
        userService.insertUserAuth(userId, roleIds);
        return R.ok();
    }
}