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

疯狂的狮子li

2022-07-07 d9e54388e7fde2462e8b7e0165c5e7da3f202593

 ruoyi-admin/src/main/java/com/ruoyi/web/controller/monitor/SysUserOnlineController.java

@@ -1,92 +1,84 @@
package com.ruoyi.web.controller.monitor;



import java.util.ArrayList;

import java.util.Collection;

import java.util.Collections;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.security.access.prepost.PreAuthorize;

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

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

import com.ruoyi.common.annotation.Log;

import com.ruoyi.common.constant.Constants;

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

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

import com.ruoyi.common.core.domain.model.LoginUser;

import com.ruoyi.common.core.page.TableDataInfo;

import com.ruoyi.common.core.redis.RedisCache;

import com.ruoyi.common.enums.BusinessType;

import com.ruoyi.common.utils.StringUtils;

import com.ruoyi.system.domain.SysUserOnline;

import com.ruoyi.system.service.ISysUserOnlineService;



/**

 * 在线用户监控

 * 
 * @author ruoyi

 */

@RestController

@RequestMapping("/monitor/online")

public class SysUserOnlineController extends BaseController

{

    @Autowired

    private ISysUserOnlineService userOnlineService;



    @Autowired

    private RedisCache redisCache;



    @PreAuthorize("@ss.hasPermi('monitor:online:list')")

    @GetMapping("/list")

    public TableDataInfo list(String ipaddr, String userName)

    {

        Collection<String> keys = redisCache.keys(Constants.LOGIN_TOKEN_KEY + "*");

        List<SysUserOnline> userOnlineList = new ArrayList<SysUserOnline>();

        for (String key : keys)

        {

            LoginUser user = redisCache.getCacheObject(key);

            if (StringUtils.isNotEmpty(ipaddr) && StringUtils.isNotEmpty(userName))

            {

                if (StringUtils.equals(ipaddr, user.getIpaddr()) && StringUtils.equals(userName, user.getUsername()))

                {

                    userOnlineList.add(userOnlineService.selectOnlineByInfo(ipaddr, userName, user));

                }

            }

            else if (StringUtils.isNotEmpty(ipaddr))

            {

                if (StringUtils.equals(ipaddr, user.getIpaddr()))

                {

                    userOnlineList.add(userOnlineService.selectOnlineByIpaddr(ipaddr, user));

                }

            }

            else if (StringUtils.isNotEmpty(userName) && StringUtils.isNotNull(user.getUser()))

            {

                if (StringUtils.equals(userName, user.getUsername()))

                {

                    userOnlineList.add(userOnlineService.selectOnlineByUserName(userName, user));

                }

            }

            else

            {

                userOnlineList.add(userOnlineService.loginUserToUserOnline(user));

            }

        }

        Collections.reverse(userOnlineList);

        userOnlineList.removeAll(Collections.singleton(null));

        return getDataTable(userOnlineList);

    }



    /**

     * 强退用户

     */

    @PreAuthorize("@ss.hasPermi('monitor:online:forceLogout')")

    @Log(title = "在线用户", businessType = BusinessType.FORCE)

    @DeleteMapping("/{tokenId}")

    public AjaxResult forceLogout(@PathVariable String tokenId)

    {

        redisCache.deleteObject(Constants.LOGIN_TOKEN_KEY + tokenId);

        return AjaxResult.success();

    }

}

package com.ruoyi.web.controller.monitor;

import cn.dev33.satoken.annotation.SaCheckPermission;
import cn.dev33.satoken.exception.NotLoginException;
import cn.dev33.satoken.stp.StpUtil;
import cn.hutool.core.bean.BeanUtil;
import com.ruoyi.common.annotation.Log;
import com.ruoyi.common.constant.CacheConstants;
import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.core.domain.dto.UserOnlineDTO;
import com.ruoyi.common.core.page.TableDataInfo;
import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.StreamUtils;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.common.utils.redis.RedisUtils;
import com.ruoyi.system.domain.SysUserOnline;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * 在线用户监控
 *
 * @author Lion Li
 */
@Tag(name ="在线用户监控", description = "在线用户监控管理")
@RequiredArgsConstructor
@RestController
@RequestMapping("/monitor/online")
public class SysUserOnlineController extends BaseController {

    @SaCheckPermission("monitor:online:list")
    @GetMapping("/list")
    public TableDataInfo<SysUserOnline> list(String ipaddr, String userName) {
        // 获取所有未过期的 token
        List<String> keys = StpUtil.searchTokenValue("", -1, 0);
        List<UserOnlineDTO> userOnlineDTOList = new ArrayList<>();
        for (String key : keys) {
            String token = key.replace(CacheConstants.LOGIN_TOKEN_KEY, "");
            // 如果已经过期则踢下线
            if (StpUtil.stpLogic.getTokenActivityTimeoutByToken(token) < 0) {
                continue;
            }
            userOnlineDTOList.add(RedisUtils.getCacheObject(CacheConstants.ONLINE_TOKEN_KEY + token));
        }
        if (StringUtils.isNotEmpty(ipaddr) && StringUtils.isNotEmpty(userName)) {
            userOnlineDTOList = StreamUtils.filter(userOnlineDTOList, userOnline ->
                StringUtils.equals(ipaddr, userOnline.getIpaddr()) &&
                    StringUtils.equals(userName, userOnline.getUserName())
            );
        } else if (StringUtils.isNotEmpty(ipaddr)) {
            userOnlineDTOList = StreamUtils.filter(userOnlineDTOList, userOnline ->
                    StringUtils.equals(ipaddr, userOnline.getIpaddr())
            );
        } else if (StringUtils.isNotEmpty(userName)) {
            userOnlineDTOList = StreamUtils.filter(userOnlineDTOList, userOnline ->
                StringUtils.equals(userName, userOnline.getUserName())
            );
        }
        Collections.reverse(userOnlineDTOList);
        userOnlineDTOList.removeAll(Collections.singleton(null));
        List<SysUserOnline> userOnlineList = BeanUtil.copyToList(userOnlineDTOList, SysUserOnline.class);
        return TableDataInfo.build(userOnlineList);
    }

    /**
     * 强退用户
     */
    @SaCheckPermission("monitor:online:forceLogout")
    @Log(title = "在线用户", businessType = BusinessType.FORCE)
    @DeleteMapping("/{tokenId}")
    public R<Void> forceLogout(@PathVariable String tokenId) {
        try {
            StpUtil.kickoutByTokenValue(tokenId);
        } catch (NotLoginException e) {
        }
        return R.ok();
    }
}