类 SohelpLogin

java.lang.Object
net.sohelp.boot.admin.core.web.SohelpLogin

@Component public class SohelpLogin extends Object
登录信息处理类,用于获取当前登录用户的各类信息及操作相关缓存。
从以下版本开始:
2024/7/8 13:35
作者:
AaronFung
  • 字段详细资料

    • request

      public jakarta.servlet.http.HttpServletRequest request
  • 构造器详细资料

    • SohelpLogin

      public SohelpLogin()
  • 方法详细资料

    • getRequest

      @Comment("\u83b7\u53d6\u539f\u751fHttpServletRequest") public jakarta.servlet.http.HttpServletRequest getRequest()
      获取原始的 HttpServletRequest 对象。
      返回:
      当前请求的 HttpServletRequest 实例
    • getResponse

      @Comment("\u83b7\u53d6\u539f\u751fHttpServletResponse") public jakarta.servlet.http.HttpServletResponse getResponse()
      获取原始的 HttpServletResponse 对象。
      返回:
      当前响应的 HttpServletResponse 实例
    • getLoginUser

      @Comment("\u83b7\u53d6\u767b\u5f55\u4eba\u5458\u4fe1\u606f") public Map<String,Object> getLoginUser() throws TokenAuthenticationException
      获取当前登录用户的信息。
      返回:
      用户信息映射表(key-value)
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • reloadCache

      @Comment("\u5237\u65b0\u4e1a\u52a1\u6570\u636e\u7f13\u5b58,\u5305\u62ec\u7528\u6237\u3001\u7ec4\u7ec7\u3001\u5b57\u5178\u3001\u7528\u6237\u83dc\u5355\u3001\u7528\u6237\u5b57\u5178\u3001\u5c97\u4f4d\u3001\u7528\u6237\u5c97\u4f4d\u3002") public void reloadCache() throws SQLException
      清空并重新加载所有相关的业务数据缓存。 包括:用户、组织、字典、角色等缓存。
      抛出:
      SQLException - 数据库访问异常时抛出
    • getOrgName

      @Comment("\u83b7\u53d6\u7ec4\u7ec7\u540d\u79f0") public String getOrgName() throws TokenAuthenticationException, SQLException
      获取当前登录用户所属组织的名称。
      返回:
      组织名称字符串,若无则返回 null
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
      SQLException - 数据库访问异常时抛出
    • getLoginId

      @Comment("\u83b7\u53d6\u767b\u5f55\u767b\u5f55\u7528\u6237ID") public long getLoginId() throws TokenAuthenticationException
      获取当前登录用户的 ID。
      返回:
      用户唯一标识符(long 类型)
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • getUserId

      @Comment("\u83b7\u53d6\u767b\u5f55\u767b\u5f55\u7528\u6237ID") public long getUserId() throws TokenAuthenticationException
      获取当前登录用户的 ID(别名方法)。
      返回:
      用户唯一标识符(long 类型)
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • getUserNo

      @Comment("\u83b7\u53d6\u767b\u5f55\u7528\u6237\u7f16\u53f7") public String getUserNo() throws TokenAuthenticationException
      获取当前登录用户的编号。
      返回:
      用户编号字符串
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • getPowerType

      @Comment("\u83b7\u53d6\u767b\u5f55\u7528\u6237\u6570\u636e\u6743\u9650\u7c7b\u578b") public Integer getPowerType() throws TokenAuthenticationException
      获取当前登录用户的数据权限类型。
      返回:
      权限类型的整数值
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • formatOperatorLog

      @Comment("\u683c\u5f0f\u64cd\u4f5c\u65e5\u5fd7\u4fe1\u606f") public void formatOperatorLog(Map<String,Object> dataMap) throws TokenAuthenticationException, SQLException
      格式化并替换操作日志中的字段信息。 如将 id_insert_org 替换为其对应的组织对象。
      参数:
      dataMap - 操作日志数据映射表
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
      SQLException - 数据库访问异常时抛出
    • formatByInsert

      @Comment("\u66f4\u65b0\u64cd\u4f5c\u65e5\u5fd7\u4fe1\u606f") public void formatByInsert(Map<String,Object> dataMap) throws SQLException
      在执行插入操作时初始化操作日志相关信息。 设置创建人、创建时间、租户 ID 等字段,并移除更新相关字段。
      参数:
      dataMap - 插入操作的数据映射表
      抛出:
      SQLException - 数据库访问异常时抛出
    • formatByUpdate

      @Comment("\u66f4\u65b0\u64cd\u4f5c\u65e5\u5fd7\u4fe1\u606f") public void formatByUpdate(Map<String,Object> dataMap) throws SQLException
      在执行更新操作时初始化操作日志相关信息。 设置更新人、更新时间等字段,并移除创建相关字段。
      参数:
      dataMap - 更新操作的数据映射表
      抛出:
      SQLException - 数据库访问异常时抛出
    • isLogin

      @Comment("\u662f\u5426\u767b\u5f55") public boolean isLogin()
      判断当前用户是否已登录。
      返回:
      true 表示已登录;false 表示未登录
    • getLoginName

      @Comment("\u83b7\u53d6\u767b\u5f55\u767b\u5f55\u5e10\u6237") public String getLoginName() throws TokenAuthenticationException
      获取当前登录用户的账户名。
      返回:
      账户名字符串
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • getNickName

      @Comment("\u83b7\u53d6\u767b\u5f55\u59d3\u540d") public String getNickName() throws TokenAuthenticationException
      获取当前登录用户的昵称。
      返回:
      昵称字符串
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • getTenantId

      @Comment("\u83b7\u53d6\u767b\u5f55\u79df\u6237ID") public Long getTenantId() throws TokenAuthenticationException, SQLException
      获取当前登录用户的租户 ID。
      返回:
      租户 ID 值
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
      SQLException - 数据库访问异常时抛出
    • getOrgId

      @Comment("\u83b7\u53d6\u767b\u5f55\u7ec4\u7ec7ID") public Long getOrgId() throws TokenAuthenticationException
      获取当前登录用户所在的组织 ID。
      返回:
      组织 ID 值,可能为 null
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • isDev

      @Comment("\u767b\u5f55\u7528\u6237\u662f\u5426\u4e3a\u5f00\u53d1\u4eba\u5458") public boolean isDev() throws TokenAuthenticationException
      判断当前登录用户是否是开发人员。
      返回:
      true 表示是开发人员;false 表示不是
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常
    • isAdmin

      @Comment("\u767b\u5f55\u7528\u6237\u662f\u5426\u4e3a\u7ba1\u7406\u4eba\u5458") public boolean isAdmin() throws TokenAuthenticationException
      判断当前登录用户是否是管理员。
      返回:
      true 表示是管理员;false 表示不是
      抛出:
      TokenAuthenticationException - 若无法解析或验证 token 则抛出异常