java doc fix

This commit is contained in:
paulch 2024-06-27 11:31:25 +08:00
parent 87633e2062
commit 4881d1448e
4 changed files with 27 additions and 27 deletions

View File

@ -14,7 +14,7 @@ public class Base64Utils {
* @param source 原始 Base64 字符串 * @param source 原始 Base64 字符串
* @return decoded string * @return decoded string
* *
* aHR0cHM6Ly9maWxlLmtla2luZy5jbi9kZW1vL%2BS4reaWhy5wcHR4 -> https://file.keking.cn/demo/%E4%B8%AD%E6%96%87.pptx -> https://file.keking.cn/demo/中文.pptx * aHR0cHM6Ly9maWxlLmtla2luZy5jbi9kZW1vL%2BS4reaWhy5wcHR4 解码为 https://file.keking.cn/demo/%E4%B8%AD%E6%96%87.pptx 再解码为 https://file.keking.cn/demo/中文.pptx
*/ */
public static String decodeUrl(String source) { public static String decodeUrl(String source) {
String url = decodeBase64String(source, StandardCharsets.UTF_8); String url = decodeBase64String(source, StandardCharsets.UTF_8);

View File

@ -163,7 +163,7 @@ public class DateUtils extends org.apache.commons.lang3.time.DateUtils
} }
/** /**
* 增加 LocalDateTime ==> Date * 增加 LocalDateTime to Date
*/ */
public static Date toDate(LocalDateTime temporalAccessor) public static Date toDate(LocalDateTime temporalAccessor)
{ {
@ -172,7 +172,7 @@ public class DateUtils extends org.apache.commons.lang3.time.DateUtils
} }
/** /**
* 增加 LocalDate ==> Date * 增加 LocalDate 转成 Date
*/ */
public static Date toDate(LocalDate temporalAccessor) public static Date toDate(LocalDate temporalAccessor)
{ {

View File

@ -16,7 +16,7 @@ import com.bonus.common.core.web.page.TableDataInfo;
/** /**
* web层通用数据处理 * web层通用数据处理
* *
* @author bonus * @author bonus
*/ */
public class BaseController public class BaseController
@ -25,6 +25,7 @@ public class BaseController
/** /**
* 将前台传递过来的日期格式的字符串自动转化为Date类型 * 将前台传递过来的日期格式的字符串自动转化为Date类型
* @param binder 用于数据绑定的 WebDataBinder 对象
*/ */
@InitBinder @InitBinder
public void initBinder(WebDataBinder binder) public void initBinder(WebDataBinder binder)
@ -120,7 +121,7 @@ public class BaseController
/** /**
* 响应返回结果 * 响应返回结果
* *
* @param rows 影响行数 * @param rows 影响行数
* @return 操作结果 * @return 操作结果
*/ */
@ -131,7 +132,7 @@ public class BaseController
/** /**
* 响应返回结果 * 响应返回结果
* *
* @param result 结果 * @param result 结果
* @return 操作结果 * @return 操作结果
*/ */

View File

@ -20,7 +20,7 @@ import com.bonus.system.api.model.LoginUser;
/** /**
* Token 权限验证逻辑实现类 * Token 权限验证逻辑实现类
* *
* @author bonus * @author bonus
*/ */
public class AuthLogic public class AuthLogic
@ -64,7 +64,7 @@ public class AuthLogic
/** /**
* 获取当前用户缓存信息, 如果未登录则抛出异常 * 获取当前用户缓存信息, 如果未登录则抛出异常
* *
* @return 用户缓存信息 * @return 用户缓存信息
*/ */
public LoginUser getLoginUser() public LoginUser getLoginUser()
@ -84,7 +84,7 @@ public class AuthLogic
/** /**
* 获取当前用户缓存信息, 如果未登录则抛出异常 * 获取当前用户缓存信息, 如果未登录则抛出异常
* *
* @param token 前端传递的认证信息 * @param token 前端传递的认证信息
* @return 用户缓存信息 * @return 用户缓存信息
*/ */
@ -95,7 +95,7 @@ public class AuthLogic
/** /**
* 验证当前用户有效期, 如果相差不足120分钟自动刷新缓存 * 验证当前用户有效期, 如果相差不足120分钟自动刷新缓存
* *
* @param loginUser 当前用户信息 * @param loginUser 当前用户信息
*/ */
public void verifyLoginUserExpire(LoginUser loginUser) public void verifyLoginUserExpire(LoginUser loginUser)
@ -105,7 +105,7 @@ public class AuthLogic
/** /**
* 验证用户是否具备某权限 * 验证用户是否具备某权限
* *
* @param permission 权限字符串 * @param permission 权限字符串
* @return 用户是否具备某权限 * @return 用户是否具备某权限
*/ */
@ -116,9 +116,8 @@ public class AuthLogic
/** /**
* 验证用户是否具备某权限, 如果验证未通过则抛出异常: NotPermissionException * 验证用户是否具备某权限, 如果验证未通过则抛出异常: NotPermissionException
* *
* @param permission 权限字符串 * @param permission 权限字符串
* @return 用户是否具备某权限
*/ */
public void checkPermi(String permission) public void checkPermi(String permission)
{ {
@ -130,7 +129,7 @@ public class AuthLogic
/** /**
* 根据注解(@RequiresPermissions)鉴权, 如果验证未通过则抛出异常: NotPermissionException * 根据注解(@RequiresPermissions)鉴权, 如果验证未通过则抛出异常: NotPermissionException
* *
* @param requiresPermissions 注解对象 * @param requiresPermissions 注解对象
*/ */
public void checkPermi(RequiresPermissions requiresPermissions) public void checkPermi(RequiresPermissions requiresPermissions)
@ -165,7 +164,7 @@ public class AuthLogic
/** /**
* 验证用户是否含有指定权限只需包含其中一个 * 验证用户是否含有指定权限只需包含其中一个
* *
* @param permissions 权限码数组 * @param permissions 权限码数组
*/ */
public void checkPermiOr(String... permissions) public void checkPermiOr(String... permissions)
@ -186,7 +185,7 @@ public class AuthLogic
/** /**
* 判断用户是否拥有某个角色 * 判断用户是否拥有某个角色
* *
* @param role 角色标识 * @param role 角色标识
* @return 用户是否具备某角色 * @return 用户是否具备某角色
*/ */
@ -197,7 +196,7 @@ public class AuthLogic
/** /**
* 判断用户是否拥有某个角色, 如果验证未通过则抛出异常: NotRoleException * 判断用户是否拥有某个角色, 如果验证未通过则抛出异常: NotRoleException
* *
* @param role 角色标识 * @param role 角色标识
*/ */
public void checkRole(String role) public void checkRole(String role)
@ -210,7 +209,7 @@ public class AuthLogic
/** /**
* 根据注解(@RequiresRoles)鉴权 * 根据注解(@RequiresRoles)鉴权
* *
* @param requiresRoles 注解对象 * @param requiresRoles 注解对象
*/ */
public void checkRole(RequiresRoles requiresRoles) public void checkRole(RequiresRoles requiresRoles)
@ -227,7 +226,7 @@ public class AuthLogic
/** /**
* 验证用户是否含有指定角色必须全部拥有 * 验证用户是否含有指定角色必须全部拥有
* *
* @param roles 角色标识数组 * @param roles 角色标识数组
*/ */
public void checkRoleAnd(String... roles) public void checkRoleAnd(String... roles)
@ -244,7 +243,7 @@ public class AuthLogic
/** /**
* 验证用户是否含有指定角色只需包含其中一个 * 验证用户是否含有指定角色只需包含其中一个
* *
* @param roles 角色标识数组 * @param roles 角色标识数组
*/ */
public void checkRoleOr(String... roles) public void checkRoleOr(String... roles)
@ -265,7 +264,7 @@ public class AuthLogic
/** /**
* 根据注解(@RequiresLogin)鉴权 * 根据注解(@RequiresLogin)鉴权
* *
* @param at 注解对象 * @param at 注解对象
*/ */
public void checkByAnnotation(RequiresLogin at) public void checkByAnnotation(RequiresLogin at)
@ -275,7 +274,7 @@ public class AuthLogic
/** /**
* 根据注解(@RequiresRoles)鉴权 * 根据注解(@RequiresRoles)鉴权
* *
* @param at 注解对象 * @param at 注解对象
*/ */
public void checkByAnnotation(RequiresRoles at) public void checkByAnnotation(RequiresRoles at)
@ -293,7 +292,7 @@ public class AuthLogic
/** /**
* 根据注解(@RequiresPermissions)鉴权 * 根据注解(@RequiresPermissions)鉴权
* *
* @param at 注解对象 * @param at 注解对象
*/ */
public void checkByAnnotation(RequiresPermissions at) public void checkByAnnotation(RequiresPermissions at)
@ -311,7 +310,7 @@ public class AuthLogic
/** /**
* 获取当前账号的角色列表 * 获取当前账号的角色列表
* *
* @return 角色列表 * @return 角色列表
*/ */
public Set<String> getRoleList() public Set<String> getRoleList()
@ -329,7 +328,7 @@ public class AuthLogic
/** /**
* 获取当前账号的权限列表 * 获取当前账号的权限列表
* *
* @return 权限列表 * @return 权限列表
*/ */
public Set<String> getPermiList() public Set<String> getPermiList()
@ -347,7 +346,7 @@ public class AuthLogic
/** /**
* 判断是否包含权限 * 判断是否包含权限
* *
* @param authorities 权限列表 * @param authorities 权限列表
* @param permission 权限字符串 * @param permission 权限字符串
* @return 用户是否具备某权限 * @return 用户是否具备某权限
@ -360,7 +359,7 @@ public class AuthLogic
/** /**
* 判断是否包含角色 * 判断是否包含角色
* *
* @param roles 角色列表 * @param roles 角色列表
* @param role 角色 * @param role 角色
* @return 用户是否具备某角色权限 * @return 用户是否具备某角色权限