1
0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-04-05 17:37:53 +08:00

完善注释

This commit is contained in:
shengzhang 2021-01-22 20:58:49 +08:00
parent 575f8f38bc
commit c3303e4212
7 changed files with 23 additions and 21 deletions

View File

@ -1,16 +1,17 @@
package cn.dev33.satoken.action;
/**
* sa-token内置操作接口
* sa-token逻辑代理接口
* <p>此接口将会代理框架内部的一些关键性逻辑方便开发者进行按需重写</p>
* @author kong
*
*/
public interface SaTokenAction {
/**
* 生成一个token
* @param loginId 账号id
* @param loginKey 账号标识key
* 根据一定的算法生成一个token
* @param loginId 账号id
* @param loginKey 账号体系key
* @return 一个token
*/
public String createToken(Object loginId, String loginKey);

View File

@ -18,9 +18,9 @@ public class SaTokenActionDefaultImpl implements SaTokenAction {
*/
@Override
public String createToken(Object loginId, String loginKey) {
// 生成各种花式token
// 根据配置的tokenStyle生成不同风格的token
String tokenStyle = SaTokenManager.getConfig().getTokenStyle();
// uuid
// uuid
if(tokenStyle.equals("uuid")) {
return UUID.randomUUID().toString();
}

View File

@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 标注一个路由方法当前会话必须已登录才能通过
* 登录校验标注在一个方法上当前会话必须已经登录才能进入该方法
* <p> 可标注在类上其效果等同于标注在此类的所有方法上
* @author kong
*

View File

@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 标注一个路由方法当前会话必须具有指定权限才可以通过
* 权限校验标注一个方法当前会话必须具有指定权限才能进入该方法
* <p> 可标注在类上其效果等同于标注在此类的所有方法上
* @author kong
*
@ -16,13 +16,13 @@ import java.lang.annotation.Target;
public @interface SaCheckPermission {
/**
* 需要的权限码
* @return 需要的权限码
* 需要验的权限码
* @return 需要验的权限码
*/
String [] value() default {};
/**
* 指定验证模式是AND还是OR默认AND
* 验证模式AND | OR默认AND
* @return 验证模式
*/
SaMode mode() default SaMode.AND;

View File

@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 标注一个路由方法当前会话必须具有指定角色标识才可以通过
* 角色校验标注一个方法当前会话必须具有指定角色标识才能进入该方法
* <p> 可标注在类上其效果等同于标注在此类的所有方法上
* @author kong
*
@ -16,13 +16,13 @@ import java.lang.annotation.Target;
public @interface SaCheckRole {
/**
* 需要的角色标识
* @return 需要验证的权限码
* 需要验的角色标识
* @return 需要校验的角色标识
*/
String [] value() default {};
/**
* 指定验证模式是AND还是OR默认AND
* 验证模式AND | OR默认AND
* @return 验证模式
*/
SaMode mode() default SaMode.AND;

View File

@ -1,7 +1,7 @@
package cn.dev33.satoken.annotation;
/**
* 指定注解鉴权的验证模式
* 注解鉴权的验证模式
* @author kong
*
*/

View File

@ -1,7 +1,8 @@
package cn.dev33.satoken.config;
/**
* sa-token 配置类Model
* sa-token 配置类 Model
* <p> 你可以通过ymlpropertiesjava代码等形式配置本类参数具体请查阅官方文档
* @author kong
*
*/
@ -10,10 +11,10 @@ public class SaTokenConfig {
/** token名称 (同时也是cookie名称) */
private String tokenName = "satoken";
/** token有效期,单位/秒 默认30天, -1代表永久 */
/** token的长久有效期(单位:秒) 默认30天, -1代表永久 */
private long timeout = 30 * 24 * 60 * 60;
/** token临时有效期 (指定时间内无操作就视为token过期) 单位/秒, 默认-1 代表不限制 (例如可以设置为1800代表30分钟内无操作就过期) */
/** token临时有效期 [指定时间内无操作就视为token过期] (单位/秒), 默认-1 代表不限制 (例如可以设置为1800代表30分钟内无操作就过期) */
private long activityTimeout = -1;
/** 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录) */
@ -31,13 +32,13 @@ public class SaTokenConfig {
/** 是否尝试从cookie里读取token */
private Boolean isReadCookie = true;
/** token风格 */
/** token风格(默认可取值uuid、simple-uuid、random-32、random-64、random-128、tik) */
private String tokenStyle = "uuid";
/** 默认dao层实现类中每次清理过期数据间隔的时间 (单位: 秒) 默认值30秒设置为-1代表不启动定时清理 */
private int dataRefreshPeriod = 30;
/** 获取token专属session时是否必须登录 (如果配置为true会在每次获取token专属session时校验是否登录) */
/** 获取[token专属session]时是否必须登录 (如果配置为true会在每次获取[token-session]时校验是否登录) */
private Boolean tokenSessionCheckLogin = true;
/** 是否在初始化配置时打印版本字符画 */