程序包 io.github.mangocrisp.spring.taybct.module.system.service

接口 ISysUserOnlineService

所有超级接口:
io.github.mangocrisp.spring.taybct.tool.core.bean.service.IBaseService<SysUserOnline>, com.baomidou.mybatisplus.extension.service.IService<SysUserOnline>
所有已知实现类:
SysUserOnlineServiceImpl
public interface ISysUserOnlineService extends io.github.mangocrisp.spring.taybct.tool.core.bean.service.IBaseService<SysUserOnline>
针对表【sys_user_online(在线用户)】的数据库操作Service
另请参阅:

  • 字段概要

    从接口继承的字段 com.baomidou.mybatisplus.extension.service.IService

    DEFAULT_BATCH_SIZE

  • 方法概要

    修饰符和类型
    方法
    说明
    boolean
    chooseTenant(String tenantId)
    登录选择租户
    void
    clearCache(Collection<SysUser> entityList)
    清除缓存
    void
    clearExpires()
    清理超时的登录
    boolean
    force(String[] jti, String message)
    根据 jti 来删除来踢掉线
    boolean
    force(String message, String clientId, String... username)
    强制登出
    void
    forceAllClientUser(String username, String message)
    强退所有当前用户登录的客户端
    void
    forceAllClientUserById(String message, Long... userId)
    根据用户id强退所有当前用户登录的状态
    void
    forceAllClientUserByRole(String message, Long... roleId)
    根据角色 id 强退相关用户登录的所有客户端
    void
    forceAllClientUsers(String message, String clientId)
    强退所有和这个客户端有相关登录操作的用户
    default boolean
    login(com.alibaba.fastjson2.JSONObject dto)
    version 1.0.1
    登录成功之后，需要选择租户才给登录进入首页， 选择了租户之后，就需要再调用一下这个接口来记录是使用租户登录了。
    boolean
    login(com.alibaba.fastjson2.JSONObject dto, boolean sendLoginLog)
    version 1.0.1
    登录成功之后，需要选择租户才给登录进入首页， 选择了租户之后，就需要再调用一下这个接口来记录是使用租户登录了。
    boolean
    logoff(com.alibaba.fastjson2.JSONObject dto, String message)
    登出操作
    List<SysUserOnline>
    onlineList()
    获取在线用户列表
    com.baomidou.mybatisplus.core.metadata.IPage<SysUserOnline>
    onlinePage(Map<String,Object> sqlQueryParams)
    在线分页

    从接口继承的方法 io.github.mangocrisp.spring.taybct.tool.core.bean.service.IBaseService

    customizeGetById, customizeList, customizeList, customizePage, customizePage, customizeQueryPage, customizeQueryPage, customizeQueryWrapper, customizeQueryWrapper, customizeRemoveById, customizeRemoveByIds, customizeSave, customizeSaveBatch, customizeUpdateBatchById, customizeUpdateById, mergeQueryExpansion, queryExpansion, removeExpansion, saveExpansion

    从接口继承的方法 com.baomidou.mybatisplus.extension.service.IService

    count, count, exists, getBaseMapper, getById, getEntityClass, getMap, getObj, getOne, getOne, getOneOpt, getOneOpt, getOptById, ktQuery, ktUpdate, lambdaQuery, lambdaQuery, lambdaUpdate, list, list, list, list, listByIds, listByMap, listMaps, listMaps, listMaps, listMaps, listObjs, listObjs, listObjs, listObjs, page, page, pageMaps, pageMaps, query, remove, removeBatchByIds, removeBatchByIds, removeBatchByIds, removeBatchByIds, removeById, removeById, removeById, removeByIds, removeByIds, removeByMap, save, saveBatch, saveBatch, saveOrUpdate, saveOrUpdate, saveOrUpdateBatch, saveOrUpdateBatch, update, update, update, updateBatchById, updateBatchById, updateById

  • 方法详细资料

    • chooseTenant

      boolean chooseTenant(String tenantId)
      登录选择租户
      参数:
      tenantId - 租户 id
      返回:
      boolean
      从以下版本开始:
      1.0.1

    • login

      boolean login(com.alibaba.fastjson2.JSONObject dto, boolean sendLoginLog)
      version 1.0.1
      登录成功之后，需要选择租户才给登录进入首页， 选择了租户之后，就需要再调用一下这个接口来记录是使用租户登录了。
      选择租户的时候，会把 jti 和 tenant id 作为 kv 存入 redis，在网关 做过滤的时候使用 jti 查询到 tenant id ,然后存入到 Payload 里面，然后就可以使用 SecurityUtil#getTenantId() 去获取这个 tenant id 了，如果没有在 redis 里面获取到 tenant id，就使用默认的 租户 id

      登录成功后记录操作

      参数:
      dto - 用户登录信息
      sendLoginLog - 是否发送登录日志
      返回:
      boolean

    • login

      default boolean login(com.alibaba.fastjson2.JSONObject dto)
      version 1.0.1
      登录成功之后，需要选择租户才给登录进入首页， 选择了租户之后，就需要再调用一下这个接口来记录是使用租户登录了。
      选择租户的时候，会把 jti 和 tenant id 作为 kv 存入 redis，在网关 做过滤的时候使用 jti 查询到 tenant id ,然后存入到 Payload 里面，然后就可以使用 SecurityUtil#getTenantId() 去获取这个 tenant id 了，如果没有在 redis 里面获取到 tenant id，就使用默认的 租户 id

      登录成功后记录操作

      参数:
      dto - 用户登录信息
      返回:
      boolean

    • logoff

      boolean logoff(com.alibaba.fastjson2.JSONObject dto, String message)
      登出操作
      参数:
      dto - 用户登录信息
      message - 被登出的原因
      返回:
      boolean

    • onlineList

      List<SysUserOnline> onlineList()
      获取在线用户列表
      返回:
      List<SysUserOnline>

    • onlinePage

      com.baomidou.mybatisplus.core.metadata.IPage<SysUserOnline> onlinePage(Map<String,Object> sqlQueryParams)
      在线分页
      参数:
      sqlQueryParams - 分页信息
      返回:
      <E extends IPage<SysUserOnline>> E

    • force

      boolean force(String message, String clientId, String... username)
      强制登出
      参数:
      message - 被登出的原因
      clientId - 客户端标识
      username - 用户名
      返回:
      是否操作成功

    • force

      boolean force(String[] jti, String message)
      根据 jti 来删除来踢掉线
      参数:
      jti - JWT Token id
      message - 被登出的原因
      返回:
      boolean

    • forceAllClientUsers

      void forceAllClientUsers(String message, String clientId)
      强退所有和这个客户端有相关登录操作的用户
      参数:
      message - 被登出的原因
      clientId - 客户端 id

    • forceAllClientUserByRole

      void forceAllClientUserByRole(String message, Long... roleId)
      根据角色 id 强退相关用户登录的所有客户端
      参数:
      message - 被登出的原因
      roleId - 角色 id

    • forceAllClientUserById

      void forceAllClientUserById(String message, Long... userId)
      根据用户id强退所有当前用户登录的状态
      参数:
      message - 被登出的原因
      userId - 用户 id

    • forceAllClientUser

      void forceAllClientUser(String username, String message)
      强退所有当前用户登录的客户端
      参数:
      message - 被登出的原因
      username - 用户名

    • clearCache

      void clearCache(Collection<SysUser> entityList)
      清除缓存
      参数:
      entityList - 用户集合

    • clearExpires

      void clearExpires()
      清理超时的登录
      从以下版本开始:
      1.0.0