Documentation
¶
Index ¶
- Constants
- Variables
- func TokenHash(value string) string
- type Actor
- type App
- func (a *App) ActorForSession(id string) (*Actor, error)
- func (a *App) Authenticate(token string) (*Actor, error)
- func (a *App) CacheSetting(ctx context.Context, row models.Setting) error
- func (a *App) CheckRoles(current *Actor, ids []uint) error
- func (a *App) Close() error
- func (a *App) CreateAdmin(username, password string) error
- func (a *App) FileDisk(ctx context.Context, location *storage.Config) (fs.Filesystem, storage.Config, error)
- func (a *App) Handler() (http.Handler, error)
- func (a *App) InstallDefaults(ctx context.Context, username, password string) error
- func (a *App) Key(d constants.Definition, args ...any) string
- func (a *App) MenuList(locale string) []Menu
- func (a *App) Menus(actor *Actor, locale string) ([]Menu, error)
- func (a *App) PermissionList(locale string) map[string]Permission
- func (a *App) Setting(ctx context.Context, key string) (json.RawMessage, error)
- func (a *App) SyncSettings(ctx context.Context) error
- func (a *App) ValidateMenu(menu *models.Menu, editing bool) error
- type LinkSystem
- type Menu
- type Options
- type Permission
- type Runtime
- type SettingDefinition
- type SettingOption
Constants ¶
View Source
const DefaultAdminPassword = "123456"
Variables ¶
View Source
var StableKey = regexp.MustCompile(`^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)+$`)
Functions ¶
Types ¶
type App ¶
type App struct {
Options Options
DB *gorm.DB
Redis redis.UniversalClient
Runtime Runtime
Router *gin.Engine
Disk fs.Filesystem
Realtime *realtime.Hub
CacheKeys map[string]constants.Definition
PermissionDefinitions map[string]Permission
MenuDefinitions []Menu
SettingDefinitions map[string]SettingDefinition
}
App 持有后台定义和容器提供的共享资源。
func New ¶
func New(o Options, runtime Runtime, db *gorm.DB, client redis.UniversalClient, disk fs.Filesystem) (*App, error)
func (*App) ActorForSession ¶
ActorForSession reloads a durable session and its current roles for background work.
func (*App) Authenticate ¶
Authenticate 从数据库读取当前账号和角色, 修改授权无需等待旧缓存过期.
func (*App) CacheSetting ¶
CacheSetting 只接受较新的配置版本,避免多实例并发时旧值回写。
func (*App) CheckRoles ¶
CheckRoles 防止管理员给自己或下属分配超出自身权限的角色.
func (*App) CreateAdmin ¶
CreateAdmin 只在显式命令中创建账号, 不重置已有管理员密码.
func (*App) FileDisk ¶
func (a *App) FileDisk(ctx context.Context, location *storage.Config) (fs.Filesystem, storage.Config, error)
FileDisk使用文件原始存储位置;切换上传驱动不改变已上传附件的位置。
func (*App) InstallDefaults ¶
InstallDefaults 仅在安装时补齐基础资料,不重置管理员或覆盖已编辑的数据。
func (*App) Key ¶
func (a *App) Key(d constants.Definition, args ...any) string
Key adds the application/environment namespace to a registered key pattern.
func (*App) PermissionList ¶
func (a *App) PermissionList(locale string) map[string]Permission
func (*App) SyncSettings ¶
SyncSettings 补齐组和新字段,不覆盖已有配置。
type LinkSystem ¶
LinkSystem 显式注册受信任的外部系统, 不向后台开放任意系统密钥编辑.
type Menu ¶
type Menu struct {
Type int `json:"type"`
Key string `json:"key"`
ParentKey string `json:"parent_key"`
Title string `json:"title"`
Path string `json:"path"`
Component string `json:"component,omitempty"`
Permission string `json:"permission,omitempty"`
Icon string `json:"icon,omitempty"`
Sort int `json:"sort"`
URL string `json:"url,omitempty"`
Mode string `json:"mode,omitempty"`
SystemKey string `json:"system_key,omitempty"`
Hidden bool `json:"hidden,omitempty"`
Status int `json:"status"`
KeepAlive bool `json:"keep_alive"`
FixedTab bool `json:"fixed_tab"`
FullPage bool `json:"full_page"`
Children []Menu `json:"children,omitempty"`
}
type Options ¶
type Options struct {
Name string
Environment string
WSAddr string
WSPath string
AdminPrefix string
Storage string
Disk fs.Filesystem
AllowedOrigins []string
Menus []Menu
Permissions []Permission
CacheKeys []constants.Definition
Settings []SettingDefinition
LinkSystems []LinkSystem
Routes func(*App, *gin.RouterGroup)
PublicRoutes func(*App, *gin.Engine)
WSValidate func(context.Context, realtime.Principal) error
WSAuthorize func(context.Context, realtime.Principal, string) error
Realtime func(*App, *realtime.Hub) error
AccessTTL time.Duration
RefreshTTL time.Duration
}
Options 仅声明应用实际需要配置的入口, 业务直接追加代码定义.
type Permission ¶
type Runtime ¶
type Runtime interface {
NewHTTPServer(context.Context, string) (*http.Server, error)
Close(...time.Duration) error
}
Runtime 提供应用已有的HTTP服务与退出能力。
type SettingDefinition ¶
type SettingDefinition struct {
Key string `json:"key"`
Title string `json:"title"`
Group string `json:"group"`
Kind string `json:"kind"`
Input string `json:"input"`
Options []SettingOption `json:"options,omitempty"`
Remark string `json:"remark,omitempty"`
Sort int `json:"sort"`
Default any `json:"default"`
Secret bool `json:"secret"`
When map[string]any `json:"when,omitempty"`
}
type SettingOption ¶
Source Files
¶
Click to show internal directories.
Click to hide internal directories.