builder

package
v0.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 26, 2025 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Builder 

type Builder struct {
	// contains filtered or unexported fields
}

Builder Sa-Token builder for fluent configuration | Sa-Token构建器，用于流式配置

func NewBuilder 

func NewBuilder() *Builder

NewBuilder creates a new builder with default configuration | 创建新的构建器（使用默认配置）

func (*Builder) ActiveTimeout 

func (b *Builder) ActiveTimeout(seconds int64) *Builder

ActiveTimeout sets active timeout in seconds | 设置活跃超时（秒）

func (*Builder) AutoRenew 

func (b *Builder) AutoRenew(autoRenew bool) *Builder

AutoRenew sets whether to auto-renew token | 设置是否自动续期

func (*Builder) Build 

func (b *Builder) Build() *manager.Manager

Build builds Manager and prints startup banner | 构建Manager并打印启动Banner

func (*Builder) CookieConfig 

func (b *Builder) CookieConfig(cfg *config.CookieConfig) *Builder

CookieConfig sets complete cookie configuration | 设置完整的Cookie配置

func (*Builder) CookieDomain 

func (b *Builder) CookieDomain(domain string) *Builder

CookieDomain sets cookie domain | 设置Cookie域名

func (*Builder) CookieHttpOnly 

func (b *Builder) CookieHttpOnly(httpOnly bool) *Builder

CookieHttpOnly sets cookie httpOnly flag | 设置Cookie的HttpOnly标志

func (*Builder) CookieMaxAge 

func (b *Builder) CookieMaxAge(maxAge int) *Builder

CookieMaxAge sets cookie max age | 设置Cookie的最大年龄

func (*Builder) CookiePath 

func (b *Builder) CookiePath(path string) *Builder

CookiePath sets cookie path | 设置Cookie路径

func (*Builder) CookieSameSite 

func (b *Builder) CookieSameSite(sameSite config.SameSiteMode) *Builder

CookieSameSite sets cookie sameSite attribute | 设置Cookie的SameSite属性

func (*Builder) CookieSecure 

func (b *Builder) CookieSecure(secure bool) *Builder

CookieSecure sets cookie secure flag | 设置Cookie的Secure标志

func (*Builder) DataRefreshPeriod 

func (b *Builder) DataRefreshPeriod(seconds int64) *Builder

DataRefreshPeriod sets data refresh period | 设置数据刷新周期

func (*Builder) IsConcurrent 

func (b *Builder) IsConcurrent(concurrent bool) *Builder

IsConcurrent sets whether to allow concurrent login | 设置是否允许并发登录

func (*Builder) IsLog 

func (b *Builder) IsLog(isLog bool) *Builder

IsLog sets whether to enable logging | 设置是否输出日志

func (*Builder) IsPrintBanner 

func (b *Builder) IsPrintBanner(isPrint bool) *Builder

IsPrintBanner sets whether to print startup banner | 设置是否打印启动Banner

func (*Builder) IsReadBody 

func (b *Builder) IsReadBody(isRead bool) *Builder

IsReadBody sets whether to read token from request body | 设置是否从请求体读取Token

func (*Builder) IsReadCookie 

func (b *Builder) IsReadCookie(isRead bool) *Builder

IsReadCookie sets whether to read token from cookie | 设置是否从Cookie读取Token

func (*Builder) IsReadHeader 

func (b *Builder) IsReadHeader(isRead bool) *Builder

IsReadHeader sets whether to read token from header | 设置是否从Header读取Token

func (*Builder) IsShare 

func (b *Builder) IsShare(share bool) *Builder

IsShare sets whether to share token | 设置是否共享Token

func (*Builder) JwtSecretKey 

func (b *Builder) JwtSecretKey(key string) *Builder

JwtSecretKey sets JWT secret key | 设置JWT密钥

func (*Builder) KeyPrefix 

func (b *Builder) KeyPrefix(prefix string) *Builder

KeyPrefix sets storage key prefix | 设置存储键前缀 Automatically adds ":" suffix if not present (except for empty string) | 自动添加 ":" 后缀（空字符串除外） Examples: "satoken" -> "satoken:", "myapp" -> "myapp:", "" -> "" Use empty string "" for Java sa-token compatibility | 使用空字符串 "" 兼容 Java sa-token

func (*Builder) MaxLoginCount 

func (b *Builder) MaxLoginCount(count int) *Builder

MaxLoginCount sets maximum login count | 设置最大登录数量

func (*Builder) MustBuild 

func (b *Builder) MustBuild() *manager.Manager

MustBuild builds Manager and panics if validation fails | 构建Manager，验证失败时panic

func (*Builder) NeverExpire 

func (b *Builder) NeverExpire() *Builder

NeverExpire sets token to never expire | 设置Token永不过期

func (*Builder) NoActiveTimeout 

func (b *Builder) NoActiveTimeout() *Builder

NoActiveTimeout disables active timeout | 禁用活跃超时

func (*Builder) RenewPoolConfig 

func (b *Builder) RenewPoolConfig(cfg *pool.RenewPoolConfig) *Builder

RenewPoolConfig sets the token renewal pool configuration | 设置Token续期池配置

func (*Builder) Storage 

func (b *Builder) Storage(storage adapter.Storage) *Builder

Storage sets storage adapter | 设置存储适配器

func (*Builder) Timeout 

func (b *Builder) Timeout(seconds int64) *Builder

Timeout sets timeout in seconds | 设置超时时间（秒）

func (*Builder) TimeoutDuration 

func (b *Builder) TimeoutDuration(d time.Duration) *Builder

TimeoutDuration sets timeout with duration | 设置超时时间（时间段）

func (*Builder) TokenName 

func (b *Builder) TokenName(name string) *Builder

TokenName sets token name | 设置Token名称

func (*Builder) TokenSessionCheckLogin 

func (b *Builder) TokenSessionCheckLogin(check bool) *Builder

TokenSessionCheckLogin sets whether to check token session on login | 设置登录时是否检查Token会话

func (*Builder) TokenStyle 

func (b *Builder) TokenStyle(style config.TokenStyle) *Builder

TokenStyle sets token generation style | 设置Token风格

func (*Builder) UnlimitedLogin 

func (b *Builder) UnlimitedLogin() *Builder

UnlimitedLogin allows unlimited concurrent logins | 允许无限并发登录

func (*Builder) Validate 

func (b *Builder) Validate() error

Validate validates the builder configuration | 验证构建器配置

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.