net.sohelp.boot.admin.core.base

类 BaseController

java.lang.Object

net.sohelp.boot.admin.core.base.BaseController

直接已知子类:

ApplicationController, ApplicationController, ApplicationController, AppMenuController, AppNoticeController, AppNoticeController, AutocodeController, BackupController, BusiController, CacheController, CloudAppCategoryController, CloudAppController, CloudModuleCategoryController, CloudModuleController, CloudPluginsCategoryController, CloudPluginsController, CloudServiceCategoryController, CloudServiceController, CodeConfigController, CodeSchemeController, CodeTemplateController, ComponentController, ConstParamCategoryController, ConstParamCategoryController, ConstParamController, ConstParamController, DatasourceController, DBController, DesignerController, DictCategoryController, DictCategoryController, DictController, DictionaryDataController, DictionaryDataController, DocumentController, DownloadController, EngineCrudController, EngineDownloadController, EngineExportController, EngineFileController, EngineImportController, EngineReportController, EngineUploadController, EngineWorkflowController, EntityController, EntityExtendController, EntityFormController, EntityGridController, EntityRefController, ExportController, FormBuilderController, GridBuilderController, GridController, I18nCategoryController, I18nController, I18nController, I18nController, ImportController, JavaBuilderController, LangController, LanguageController, LayoutController, LoginController, LoginController, LoginDingController, LoginEmailController, LoginLogController, LoginLogController, LoginPhoneController, LoginQQController, LoginQywxController, LoginRegisterController, LoginWxController, LoginWxPubController, MagicApiConfigController, MagicController, MenuController, MenuController, MenuController, ModuleController, ModuleController, ModuleCustomController, ModuleFormController, ModuleGridController, ModuleLayoutController, MonitorController, MyAppController, MyInstallController, MyInstallController, MyInstallController, MyInstallController, MyModuleController, MyPluginController, MyServiceController, NoticeController, OAuth2Controller, OAuthController, OnlineController, OnlineUserController, OnlineUserController, OperationLogController, OperationLogController, OperationLogController, OrgController, OrgController, OrgController, PermissionController, PowerController, PowerController, RedisMonitorController, ReportController, ReportController, RoleController, RoleController, RoleController, SequenceController, ServiceController, SizeController, SohelpBootConfigController, SohelpBootResourceController, SQLController, SysConfigController, SystemConfigController, SystemInfoController, TableController, TaskController, TenantController, TenantController, TenantController, ThemeController, ThemeController, ThemeSizeController, ThirdPartController, UniappBuilderControler, UpdaterController, UploadController, UserConstParamController, UserConstParamController, UserController, UserController, UserController, UserController, UserController, UserLangController, UserTenantController, UserTenantController, UserThemeController, UserThirdpartController, UserThirdpartDingdingController, UserThirdpartDingdingController, UserThirdpartEmailController, UserThirdpartEmailController, UserThirdpartPhoneController, UserThirdpartPhoneController, UserThirdpartQQController, UserThirdpartQQController, UserThirdpartQywxController, UserThirdpartQywxController, UserThirdpartWeiXinController, UserThirdpartWeiXinController, UserThirdpartWxPubController, UserThirdpartWxPubController, WorkBenchController, WorkFlowController, WorkspaceResourceController

public class BaseController
extends Object

Controller基类，提供基础功能封装，如用户认证、分页处理、国际化支持等。

从以下版本开始:

2023/8/17 20:56

作者:

AaronFung

字段概要

字段

限定符和类型	字段和说明
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpServletResponse	response

构造器概要

构造器

构造器和说明
BaseController()

方法概要

限定符和类型	方法和说明
protected <T> ApiResult<T>	error(Exception e) 构造一个包含异常堆栈信息的错误结果对象。
protected <T> ApiResult<T>	error(String message) 构造一个包含自定义错误信息的错误结果对象。
protected <T> ApiResult<T>	fail() 构造一个默认失败消息的失败结果对象。
protected <T> ApiResult<T>	fail(String message) 构造一个表示操作失败的结果对象。
protected <T> ApiResult<T>	fail(T data, String message) 构造一个带有数据和错误信息的操作失败结果对象。
protected long	getLoginID() 获取当前登录用户的唯一标识符。
protected String	getLoginName() 获取当前登录账户的用户名。
protected long	getLoginOrgID() 获取当前登录用户的组织ID。
protected String	getLoginOrgName() 获取当前登录用户的组织名称。
protected Map<String,Object>	getLoginUser() 获取当前登录用户的信息映射表。
protected String	getNickname() 获取当前登录用户的昵称。
protected long	getTenantId() 获取当前登录用户的租户ID。
protected String	getUserName() 获取当前登录用户的真实姓名。
protected String	getUserNo() 获取当前登录用户的编号。
protected String	i18n(String key) 获取指定键对应的国际化字符串。
protected String	i18n(String baseName, String key) 获取指定语言包下对应键的国际化字符串。
protected boolean	isAdministrator() 判断当前登录用户是否为系统管理员。
protected boolean	isDeveloper() 判断当前登录用户是否为开发者角色。
protected int	limit() 获取分页大小限制，默认为20。
protected int	offset() 计算分页查询时的起始偏移量（从第几条记录开始）。
protected <T> ApiResult<T>	ok() 构造一个默认成功消息的成功结果对象。
protected <T> ApiResult<T>	ok(String message) 构造一个带自定义成功消息的成功结果对象。
protected org.springframework.http.ResponseEntity<byte[]>	response(String fileName, org.springframework.http.MediaType mediaType, String content) 根据文件名、媒体类型和内容生成响应实体。
<T> ApiResult<Pager<T>>	success(com.baomidou.mybatisplus.core.metadata.IPage<T> iPage) 将MyBatis Plus的IPage转换成分页结果并构造成功响应对象。
<T> ApiResult<Pager<T>>	success(List<T> list, Long count) 构造一个分页查询结果的成功响应对象。
protected <T> ApiResult<T>	success(T data) 构造一个成功的操作结果对象，并携带返回数据。
protected <T> ApiResult<T>	success(T data, String message) 构造一个自定义成功消息的成功结果对象。
protected boolean	validateToken() 验证当前请求中的JWT Token是否有效。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

构造器详细资料

BaseController

public BaseController()

方法详细资料

validateToken

protected boolean validateToken()

验证当前请求中的JWT Token是否有效。

返回:

如果token有效则返回true，否则返回false

offset

protected int offset()

计算分页查询时的起始偏移量（从第几条记录开始）。

返回:

分页偏移量，默认每页20条数据

limit

protected int limit()

获取分页大小限制，默认为20。

返回:

每页显示的数据条数

getLoginOrgID

protected long getLoginOrgID()
                      throws TokenAuthenticationException,
                             SQLException

获取当前登录用户的组织ID。

返回:

组织ID

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

getLoginOrgName

protected String getLoginOrgName()
                          throws TokenAuthenticationException,
                                 SQLException

获取当前登录用户的组织名称。

返回:

组织名称

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

getLoginUser

protected Map<String,Object> getLoginUser()
                                   throws TokenAuthenticationException,
                                          SQLException

获取当前登录用户的信息映射表。

返回:

用户信息Map对象

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

getLoginID

protected long getLoginID()
                   throws TokenAuthenticationException

获取当前登录用户的唯一标识符。

返回:

登录ID

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

getLoginName

protected String getLoginName()
                       throws TokenAuthenticationException,
                              SQLException

获取当前登录账户的用户名。

返回:

登录账号名

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

getUserName

protected String getUserName()
                      throws TokenAuthenticationException,
                             SQLException

获取当前登录用户的真实姓名。

返回:

用户真实姓名

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

getUserNo

protected String getUserNo()
                    throws TokenAuthenticationException,
                           SQLException

获取当前登录用户的编号。

返回:

用户编号

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

getNickname

protected String getNickname()
                      throws TokenAuthenticationException,
                             SQLException

获取当前登录用户的昵称。

返回:

用户昵称

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

getTenantId

protected long getTenantId()
                    throws TokenAuthenticationException,
                           SQLException

获取当前登录用户的租户ID。

返回:

租户ID

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

isDeveloper

protected boolean isDeveloper()
                       throws TokenAuthenticationException,
                              SQLException

判断当前登录用户是否为开发者角色。

返回:

是否是开发者

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

isAdministrator

protected boolean isAdministrator()
                           throws TokenAuthenticationException,
                                  SQLException

判断当前登录用户是否为系统管理员。

返回:

是否是管理员

抛出:

TokenAuthenticationException - 当token验证失败时抛出异常

SQLException - 数据库访问异常

fail

protected <T> ApiResult<T> fail(String message)

构造一个表示操作失败的结果对象。

类型参数:

T - 泛型类型

参数:

message - 错误提示信息

返回:

失败结果对象

i18n

protected String i18n(String key)

获取指定键对应的国际化字符串。

参数:

key - 国际化资源key

返回:

对应的语言文本

i18n

protected String i18n(String baseName,
                      String key)

获取指定语言包下对应键的国际化字符串。

参数:

baseName - 语言包名称

key - 资源key

返回:

对应的语言文本

fail

protected <T> ApiResult<T> fail(T data,
                                String message)

构造一个带有数据和错误信息的操作失败结果对象。

类型参数:

T - 泛型类型

参数:

data - 返回的数据

message - 错误提示信息

返回:

失败结果对象

success

protected <T> ApiResult<T> success(T data)

构造一个成功的操作结果对象，并携带返回数据。

类型参数:

T - 泛型类型

参数:

data - 成功返回的数据

返回:

成功结果对象

success

protected <T> ApiResult<T> success(T data,
                                   String message)

构造一个自定义成功消息的成功结果对象。

类型参数:

T - 泛型类型

参数:

data - 成功返回的数据

message - 自定义成功消息

返回:

成功结果对象

success

public <T> ApiResult<Pager<T>> success(List<T> list,
                                       Long count)

构造一个分页查询结果的成功响应对象。

类型参数:

T - 数据项泛型类型

参数:

list - 当前页数据列表

count - 总记录数

返回:

分页结果对象

success

public <T> ApiResult<Pager<T>> success(com.baomidou.mybatisplus.core.metadata.IPage<T> iPage)

将MyBatis Plus的IPage转换成分页结果并构造成功响应对象。

类型参数:

T - 数据项泛型类型

参数:

iPage - MyBatis Plus分页对象

返回:

分页结果对象

ok

protected <T> ApiResult<T> ok(String message)

构造一个带自定义成功消息的成功结果对象。

类型参数:

T - 泛型类型

参数:

message - 自定义成功消息

返回:

成功结果对象

ok

protected <T> ApiResult<T> ok()

构造一个默认成功消息的成功结果对象。

类型参数:

T - 泛型类型

返回:

成功结果对象

fail

protected <T> ApiResult<T> fail()

构造一个默认失败消息的失败结果对象。

类型参数:

T - 泛型类型

返回:

失败结果对象

error

protected <T> ApiResult<T> error(Exception e)

构造一个包含异常堆栈信息的错误结果对象。

类型参数:

T - 泛型类型

参数:

e - 异常对象

返回:

错误结果对象

error

protected <T> ApiResult<T> error(String message)

构造一个包含自定义错误信息的错误结果对象。

类型参数:

T - 泛型类型

参数:

message - 自定义错误信息

返回:

错误结果对象

response

protected org.springframework.http.ResponseEntity<byte[]> response(String fileName,
                                                                   org.springframework.http.MediaType mediaType,
                                                                   String content)

根据文件名、媒体类型和内容生成响应实体。

参数:

fileName - 文件名

mediaType - 媒体类型

content - 文件内容

返回:

ResponseEntity 包含字节数组的响应实体