web

README

web

web 是一个比较完整的 API 开发框架，相对于简单的路由，提供了更多的便利功能。 如果你只是需要一个简单的路由工具，那么你可以移步到 mux。

package main

import "github.com/issue9/web"

// main.go
func main() {
    srv := web.NewServer("web", "1.0.0", &web.Options{})
    router := srv.Routers().NewRouter()
    router.Get("/admins", getAdmins).
        Get("/groups", getGroups)

    srv.Serve()
}

func getAdmins(ctx* web.Context) web.Responser {
    return ctx.NotImplemented();
}

func getGroups(ctx* web.Context) web.Responser {
    return ctx.NotImplemented();
}

字符集和文档类型

文档类型由 Server.Mimetypes 指定。 字符类型无需用户指定，https://www.iana.org/assignments/character-sets/character-sets.xhtml 中列出的字符集都能自动转换。

import "github.com/issue9/web"

srv := web.NewServer("app", "1.0.0", &web.Options{})

srv.Mimetypes().Add("application/json", json.Marshal, json.Unmarshal)
srv.Mimetypes().Add("application/xml", xml.Marshal, xml.Unmarshal)

srv.Serve()

客户端只要在请求时设置 Accept 报头就可返回相应类型的数据，而 Accept-Charset 报头可设置接收的字符集。 Content-Type 则可以有向服务器指定提交内容的文档类型和字符集。

错误处理

框架提供了一种输出错误信息内容的机制，用户只需要实现 Problem 接口，即可自定义输出的错误信息格式。 可参考内置的 RFC7807 实现：internal/problems.rfc7807。

中间件

• https://github.com/issue9/middleware 提供了部分中间件。
• https://github.com/issue9/validator 提供了部分验证方法。

版权

本项目采用 MIT 开源授权许可证，完整的授权说明可在 LICENSE 文件中找到。

Documentation

Overview

Package web 通用的 web 开发框架

Index

• Constants
• func NewConfigError(field string, msg any) *errs.ConfigError
• func NewLocaleError(format string, v ...any) error
• func NewStackError(err error) error
• type CTXSanitizer
• type ConfigError
• type Context
• type HandlerFunc
• type Job
• type JobFunc
• type LocaleStringer
  • func Phrase(key message.Reference, v ...any) LocaleStringer
• type Logger
• type Middleware
• type MiddlewareFunc
• type Options
• type QueryUnmarshaler
• type Responser
  • func Created(v any, location string) Responser
  • func NoContent() Responser
  • func OK(v any) Responser
  • func Object(status int, body any, kv ...string) Responser
  • func Redirect(status int, url string) Responser
  • func Status(code int, kv ...string) Responser
• type ResponserFunc
• type Router
• type Rule
  • func NewRule(msg LocaleStringer, v Validator) *Rule
  • func NewRuleFunc(msg LocaleStringer, f func(any) bool) *Rule
• type Scheduler
• type Server
  • func NewServer(name, version string, o *Options) (*Server, error)
• type Service
• type ValidateFunc
• type Validation
• type Validator

Constants

const (
	// 特殊的值，当不想向用户展示 type 值时，该对象的 type 会被设置为该值。
	ProblemAboutBlank = problems.ProblemAboutBlank

	// 400
	ProblemBadRequest                   = problems.ProblemBadRequest
	ProblemUnauthorized                 = problems.ProblemUnauthorized
	ProblemPaymentRequired              = problems.ProblemPaymentRequired
	ProblemForbidden                    = problems.ProblemForbidden
	ProblemNotFound                     = problems.ProblemNotFound
	ProblemMethodNotAllowed             = problems.ProblemMethodNotAllowed
	ProblemNotAcceptable                = problems.ProblemNotAcceptable
	ProblemProxyAuthRequired            = problems.ProblemProxyAuthRequired
	ProblemRequestTimeout               = problems.ProblemRequestTimeout
	ProblemConflict                     = problems.ProblemConflict
	ProblemGone                         = problems.ProblemGone
	ProblemLengthRequired               = problems.ProblemLengthRequired
	ProblemPreconditionFailed           = problems.ProblemPreconditionFailed
	ProblemRequestEntityTooLarge        = problems.ProblemRequestEntityTooLarge
	ProblemRequestURITooLong            = problems.ProblemRequestURITooLong
	ProblemUnsupportedMediaType         = problems.ProblemUnsupportedMediaType
	ProblemRequestedRangeNotSatisfiable = problems.ProblemRequestedRangeNotSatisfiable
	ProblemExpectationFailed            = problems.ProblemExpectationFailed
	ProblemTeapot                       = problems.ProblemTeapot
	ProblemMisdirectedRequest           = problems.ProblemMisdirectedRequest
	ProblemUnprocessableEntity          = problems.ProblemUnprocessableEntity
	ProblemLocked                       = problems.ProblemLocked
	ProblemFailedDependency             = problems.ProblemFailedDependency
	ProblemTooEarly                     = problems.ProblemTooEarly
	ProblemUpgradeRequired              = problems.ProblemUpgradeRequired
	ProblemPreconditionRequired         = problems.ProblemPreconditionRequired
	ProblemTooManyRequests              = problems.ProblemTooManyRequests
	ProblemRequestHeaderFieldsTooLarge  = problems.ProblemRequestHeaderFieldsTooLarge
	ProblemUnavailableForLegalReasons   = problems.ProblemUnavailableForLegalReasons

	// 500
	ProblemInternalServerError           = problems.ProblemInternalServerError
	ProblemNotImplemented                = problems.ProblemNotImplemented
	ProblemBadGateway                    = problems.ProblemBadGateway
	ProblemServiceUnavailable            = problems.ProblemServiceUnavailable
	ProblemGatewayTimeout                = problems.ProblemGatewayTimeout
	ProblemHTTPVersionNotSupported       = problems.ProblemHTTPVersionNotSupported
	ProblemVariantAlsoNegotiates         = problems.ProblemVariantAlsoNegotiates
	ProblemInsufficientStorage           = problems.ProblemInsufficientStorage
	ProblemLoopDetected                  = problems.ProblemLoopDetected
	ProblemNotExtended                   = problems.ProblemNotExtended
	ProblemNetworkAuthenticationRequired = problems.ProblemNetworkAuthenticationRequired
)

预定义的 Problem id 值

const (
	ServiceStopped = scheduled.Stopped // 停止状态，默认状态
	ServiceRunning = scheduled.Running // 正在运行
	ServiceFailed  = scheduled.Failed  // 出错，不再执行后续操作
)

服务的几种状态

const Version = "0.62.0"

Version 当前框架的版本

Functions

func NewConfigError

func NewConfigError(field string, msg any) *errs.ConfigError

NewConfigError 返回表示配置文件错误的对象

field 表示错误的字段名； msg 表示错误信息，可以是任意类型，如果 msg 是 ConfigError 类型，那么此操作仅修改此类型的 Field 值；

func NewLocaleError

func NewLocaleError(format string, v ...any) error

NewLocaleError 本地化的错误信息

func NewStackError

func NewStackError(err error) error

NewStackError 为 err 带上调用信息

Types

type CTXSanitizer

type CTXSanitizer = server.CTXSanitizer

type ConfigError

type ConfigError = errs.ConfigError

type Context

type Context = server.Context

type HandlerFunc

type HandlerFunc = server.HandlerFunc

type Job

type Job = scheduled.Job

type JobFunc

type JobFunc = scheduled.JobFunc

type LocaleStringer

type LocaleStringer = localeutil.LocaleStringer

LocaleStringer 本地化字符串需要实在的接口

部分 error 返回可能也实现了该接口。

func Phrase

func Phrase(key message.Reference, v ...any) LocaleStringer

Phrase 生成本地化的语言片段

type Logger

type Logger = logs.Logger

type Middleware

type Middleware = server.Middleware

type MiddlewareFunc

type MiddlewareFunc = server.MiddlewareFunc

type Options

type Options = server.Options

type QueryUnmarshaler

type QueryUnmarshaler = query.Unmarshaler

QueryUnmarshaler 对查询参数的解析接口

type Responser

type Responser = server.Responser

func Created

func Created(v any, location string) Responser

func NoContent

func NoContent() Responser

func OK

func OK(v any) Responser

OK 返回 200 状态码下的对象

func Object

func Object(status int, body any, kv ...string) Responser

Object 输出状态和对象至客户端

body 表示需要输出的对象，该对象最终会被转换成相应的编码； kv 为报头，必须以偶数数量出现，奇数位为报头名，偶数位为对应的报头值；

func Redirect

func Redirect(status int, url string) Responser

Redirect 重定向至新的 URL

func Status

func Status(code int, kv ...string) Responser

Status 仅向客户端输出状态码和报头

kv 为报头，必须以偶数数量出现，奇数位为报头名，偶数位为对应的报头值；

NOTE: 即使 code 为 400 等错误代码，当前函数也不会返回 [Problem] 对象。

type ResponserFunc

type ResponserFunc = server.ResponserFunc

type Router

type Router = server.Router

type Rule

type Rule = server.Rule

func NewRule

func NewRule(msg LocaleStringer, v Validator) *Rule

NewRule 新建验证规则

func NewRuleFunc

func NewRuleFunc(msg LocaleStringer, f func(any) bool) *Rule

NewRuleFunc 新建验证规则

type Scheduler

type Scheduler = scheduled.Scheduler

type Server

type Server = server.Server

func NewServer

func NewServer(name, version string, o *Options) (*Server, error)

type Service

type Service = service.Service

type ValidateFunc

type ValidateFunc = server.ValidateFunc

type Validation

type Validation = server.Validation

type Validator

type Validator = server.Validator