Engine

pkg/net/http/blademaster/server.go

  1. // Engine is the framework's instance, it contains the muxer, middleware and configuration settings.
  2. // Create an instance of Engine, by using New() or Default()
  3. type Engine struct {
  4.     RouterGroup
  6.     lock sync.RWMutex
  7.     conf *ServerConfig
  9.     address string
  11.     trees     methodTrees
  12.     server    atomic.Value                      // store *http.Server
  13.     metastore map[string]map[string]interface{} // metastore is the path as key and the metadata of this path as value, it export via /metadata
  15.     pcLock        sync.RWMutex
  16.     methodConfigs map[string]*MethodConfig
  18.     injections []injection
  20.     // If enabled, the url.RawPath will be used to find parameters.
  21.     UseRawPath bool
  23.     // If true, the path value will be unescaped.
  24.     // If UseRawPath is false (by default), the UnescapePathValues effectively is true,
  25.     // as url.Path gonna be used, which is already unescaped.
  26.     UnescapePathValues bool
  28.     // If enabled, the router checks if another method is allowed for the
  29.     // current route, if the current request can not be routed.
  30.     // If this is the case, the request is answered with 'Method Not Allowed'
  31.     // and HTTP status code 405.
  32.     // If no other Method is allowed, the request is delegated to the NotFound
  33.     // handler.
  34.     HandleMethodNotAllowed bool
  36.     allNoRoute  []HandlerFunc
  37.     allNoMethod []HandlerFunc
  38.     noRoute     []HandlerFunc
  39.     noMethod    []HandlerFunc
  41.     pool sync.Pool
  42. }

Context

pkg/net/http/blademaster/context.go

  1. type Context struct {
  2.     type Context struct {
  3.     context.Context
  5.     Request *http.Request
  6.     Writer  http.ResponseWriter
  8.     // flow control
  9.     index    int8
  10.     handlers []HandlerFunc
  12.     // Keys is a key/value pair exclusively for the context of each request.
  13.     Keys map[string]interface{}
  14.     // This mutex protect Keys map
  15.     keysMutex sync.RWMutex
  17.     Error error
  19.     method string
  20.     engine *Engine
  22.     RoutePath string
  24.     Params Params
  25. }
  • blademaster 会使用配置的 server timeout (默认1s) 作为一次请求整个过程中的超时时间，使用该context调用dao做数据库、缓存操作查询时均会将该超时时间传递下去，一旦抵达deadline，后续相关操作均会返回context deadline exceeded。
  • Request 和 Writer 字段用于获取当前请求的与输出响应。
  • index 和 handlers 用于 handler 的流程控制；handlers 中存储了当前请求需要执行的所有 handler，index 用于标记当前正在执行的 handler 的索引位。
  • Keys 用于在 handler 之间传递一些额外的信息。
  • Error 用于存储整个请求处理过程中的错误。
  • method 用于检查当前请求的 Method 是否与预定义的相匹配。
  • engine 字段指向当前 blademaster 的 Engine 实例。