message

package
v0.12.2 Latest Latest
Warning

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

Go to latest
Published: Oct 29, 2025 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func APIResponseWithMessage

func APIResponseWithMessage(c *gin.Context, code, msg string, data interface{})

APIResponseWithMessage API响应包含消息

func ConfigureMessage

func ConfigureMessage(options ...func(*Config))

ConfigureMessage 配置消息系统

func DelayedMessage

func DelayedMessage(c *gin.Context, title, content, msgType string, delay time.Duration, options ...func(*Data))

DelayedMessage 延迟消息(用于需要等待的操作)

func Error

func Error(c *gin.Context, title, content string, options ...func(*Data))

Error 错误消息快捷函数

func Info

func Info(c *gin.Context, title, content string, options ...func(*Data))

Info 信息消息快捷函数

func Render

func Render(c *gin.Context, title, content, msgType string, options ...func(*Data))

Render 渲染消息提示页面 可以直接在任意控制器中调用,不需要单独注册路由

func RenderMessageWithRenderer

func RenderMessageWithRenderer(c *gin.Context, title, content, msgType string, renderer Renderer, options ...func(*Data))

RenderMessageWithRenderer 使用指定渲染器渲染消息

func SetGlobalConfigPath

func SetGlobalConfigPath(path string)

SetGlobalConfigPath 设置全局配置文件路径

func SetGlobalRenderer

func SetGlobalRenderer(renderer Renderer)

SetGlobalRenderer 设置全局渲染器

func SetMessageTemplate

func SetMessageTemplate(templateContent string) error

SetMessageTemplate 设置消息模板

func Simple

func Simple(c *gin.Context, content string, isSuccess bool)

Simple 简化版消息提示(最常用的场景)

func Success

func Success(c *gin.Context, title, content string, options ...func(*Data))

Success 成功消息快捷函数

func Warning

func Warning(c *gin.Context, title, content string, options ...func(*Data))

Warning 警告消息快捷函数

func WithAutoRedirect

func WithAutoRedirect(enabled bool) func(*Data)

WithAutoRedirect 启用自动跳转

func WithDefaultMessageType

func WithDefaultMessageType(msgType string) func(*Config)

WithDefaultMessageType 设置默认消息类型

func WithMessageAutoRedirect

func WithMessageAutoRedirect(auto bool) func(*Config)

WithMessageAutoRedirect 设置自动跳转

func WithMessageTitlePrefix

func WithMessageTitlePrefix(prefix string) func(*Config)

WithMessageTitlePrefix 设置标题前缀

func WithMessageTitleSuffix

func WithMessageTitleSuffix(suffix string) func(*Config)

WithMessageTitleSuffix 设置标题后缀

func WithRedirect

func WithRedirect(url string) func(*Data)

WithRedirect 设置跳转链接

func WithReferer

func WithReferer(referer string) func(*Data)

WithReferer 设置返回链接

func WithTemplateContent

func WithTemplateContent(content string) func(*Config)

WithTemplateContent 设置模板内容

func WithTemplatePath

func WithTemplatePath(path string) func(*Config)

WithTemplatePath 设置模板文件路径

Types

type Config

type Config struct {
	TemplatePath    string `json:"template_path"`    // 模板文件路径(可选)
	TemplateContent string `json:"template_content"` // 模板内容(优先使用)
	AutoRedirect    bool   `json:"auto_redirect"`    // 是否自动跳转
	DefaultType     string `json:"default_type"`     // 默认消息类型
	TitlePrefix     string `json:"title_prefix"`     // 标题前缀
	TitleSuffix     string `json:"title_suffix"`     // 标题后缀
}

Config 消息配置结构

type ConfigManager

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

ConfigManager 配置管理器

func GetGlobalConfigManager

func GetGlobalConfigManager() *ConfigManager

GetGlobalConfigManager 获取全局配置管理器

func NewMessageConfigManager

func NewMessageConfigManager(configPath string) *ConfigManager

NewMessageConfigManager 创建配置管理器

func (*ConfigManager) ApplyConfig

func (m *ConfigManager) ApplyConfig() error

ApplyConfig 应用配置到渲染器

func (*ConfigManager) GetConfig

func (m *ConfigManager) GetConfig() *Config

GetConfig 获取配置

func (*ConfigManager) LoadConfig

func (m *ConfigManager) LoadConfig() error

LoadConfig 加载配置

func (*ConfigManager) SaveConfig

func (m *ConfigManager) SaveConfig() error

SaveConfig 保存配置

func (*ConfigManager) UpdateConfig

func (m *ConfigManager) UpdateConfig(updates map[string]interface{}) error

UpdateConfig 更新配置

type Data

type Data struct {
	Title           string // 标题
	Content         string // 内容
	Type            string // 类型:success, error, info
	Referer         string // 返回链接
	RedirectURL     string // 跳转链接
	AutoRedirect    bool   // 是否自动跳转
	AutoRedirectSet bool   // 是否显式设置自动跳转
}

Data 消息提示数据结构

type DefaultMessageRenderer

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

DefaultMessageRenderer 默认消息渲染器实现

func NewDefaultMessageRenderer

func NewDefaultMessageRenderer() *DefaultMessageRenderer

NewDefaultMessageRenderer 创建默认消息渲染器

func (*DefaultMessageRenderer) GetTemplate

func (r *DefaultMessageRenderer) GetTemplate() string

GetTemplate 获取当前模板内容(用于调试)

func (*DefaultMessageRenderer) Render

func (r *DefaultMessageRenderer) Render(c *gin.Context, data *Data) error

Render 渲染消息页面

func (*DefaultMessageRenderer) SetTemplate

func (r *DefaultMessageRenderer) SetTemplate(tpl string) error

SetTemplate 设置自定义模板

type Renderer

type Renderer interface {
	Render(c *gin.Context, data *Data) error
	SetTemplate(tpl string) error
}

Renderer 消息渲染器接口

func GetDefaultRenderer

func GetDefaultRenderer() Renderer

GetDefaultRenderer 获取默认渲染器实例

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL