Documentation
¶
Overview ¶
package server 实现服务器层，负责 HTTP 服务器的配置和启动。
package server 实现服务器层，负责 HTTP 服务器的配置和启动。
package server 实现服务器层，负责 HTTP 服务器的配置和启动。
Index ¶
Constants ¶
View Source
const (
// OperationListSms 是查询短信列表操作的名称，需要基本认证。
OperationListSms = "/api.sms.SmsService/ListSms"
)
Variables ¶
View Source
var ( // ProviderSet 是服务器层的依赖注入提供者集合。 // 包含 Web 服务器和认证器的创建函数。 ProviderSet = wire.NewSet( NewAuthenticator, NewWebServer, ) )
Functions ¶
This section is empty.
Types ¶
type Authenticator ¶
type Authenticator interface {
// Authenticate 验证用户名和密码是否正确。
// 用于基本认证中间件的验证函数。
//
// 参数：
// - ctx context.Context：上下文。
// - username string：用户名。
// - password string：密码。
//
// 返回值：
// - bool：如果认证成功，返回 true；否则返回 false。
Authenticate(ctx context.Context, username, password string) bool
}
Authenticator 定义了身份验证器的接口。
func NewAuthenticator ¶
NewAuthenticator 创建一个新的身份验证器实例。
参数：
- logger log.Logger：日志记录器。
- cfg *config.Config：应用配置。
返回值：
- Authenticator：身份验证器接口实例。
- func()：清理函数，用于资源释放。
- error：初始化过程中可能发生的错误。
type WebServer ¶
type WebServer interface {
// Start 启动 Web 服务器。
// 返回：
// - error：启动过程中可能发生的错误。
Start() error
}
WebServer 定义了 Web 服务器的接口。
func NewWebServer ¶
func NewWebServer(logger log.Logger, cfg *config.Config, smsService sms.SmsServiceHTTPServer, auth Authenticator) (WebServer, func(), error)
NewWebServer 创建 Web 服务器实例。
参数：
- logger log.Logger：日志记录器。
- cfg *config.Config：应用配置。
- smsService sms.SmsServiceHTTPServer：短信服务 HTTP 接口实例。
- auth Authenticator：认证器实例。
返回值：
- WebServer：Web 服务器接口实例。
- func()：清理函数，用于资源释放。
- error：初始化过程中可能发生的错误。
Source Files
Click to show internal directories.
Click to hide internal directories.