gf/g/net/ghttp/ghttp_server.go

// Copyright 2017 gf Author(https://gitee.com/johng/gf). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://gitee.com/johng/gf.

package ghttp

import (
    "os"
    "sync"
    "errors"
    "strings"
    "reflect"
    "net/http"
    "gitee.com/johng/gf/g/os/glog"
    "gitee.com/johng/gf/g/os/gcache"
    "gitee.com/johng/gf/g/util/gconv"
    "gitee.com/johng/gf/g/container/gmap"
    "gitee.com/johng/gf/g/container/gtype"
    "gitee.com/johng/gf/g/container/gqueue"
    "fmt"
    "gitee.com/johng/gf/g/os/gpm"
    "net"
    "os/signal"
    "syscall"
    "time"
    "gitee.com/johng/gf/g/os/gcmd"
)

const (
    gHTTP_METHODS              = "GET,PUT,POST,DELETE,PATCH,HEAD,CONNECT,OPTIONS,TRACE"
    gDEFAULT_SERVER            = "default"
    gDEFAULT_DOMAIN            = "default"
    gDEFAULT_METHOD            = "ALL"
    gDEFAULT_COOKIE_PATH       = "/"             // 默认path
    gDEFAULT_COOKIE_MAX_AGE    = 86400*365       // 默认cookie有效期(一年)
    gDEFAULT_SESSION_MAX_AGE   = 600             // 默认session有效期(600秒)
    gDEFAULT_SESSION_ID_NAME   = "gfsessionid"   // 默认存放Cookie中的SessionId名称
    gDEFAULT_COMMAND_PORT      = 336816          // 默认本地命令控制端口
)

// ghttp.Server结构体
type Server struct {
    // 基本属性变量
    name             string                   // 服务名称，方便识别
    config           ServerConfig             // 配置对象
    status           int8                     // 当前服务器状态(0：未启动，1：运行中)
    servers          []*gracefulServer        // 底层http.Server列表
    cmdPort          int                      // 本地Web Server命令控制端口
    methodsMap       map[string]bool          // 所有支持的HTTP Method(初始化时自动填充)
    servedCount      *gtype.Int               // 已经服务的请求数(4-8字节，不考虑溢出情况)，同时作为请求ID
    closeQueue       *gqueue.Queue            // 请求结束的关闭队列(存放的是需要异步关闭处理的*Request对象)
    signalQueue      chan os.Signal           // 终端命令行监听队列
    // 服务注册相关
    hmmu             sync.RWMutex             // handler互斥锁
    hmcmu            sync.RWMutex             // handlerCache互斥锁
    handlerMap       HandlerMap               // 所有注册的回调函数(静态匹配)
    handlerTree      map[string]interface{}   // 所有注册的回调函数(动态匹配，树型+链表优先级匹配)
    handlerCache     *gcache.Cache            // 服务注册路由内存缓存
    // 事件回调注册
    hhmu             sync.RWMutex             // hooks互斥锁
    hhcmu            sync.RWMutex             // hooksCache互斥锁
    hooksTree        map[string]interface{}   // 所有注册的事件回调函数(动态匹配，树型+链表优先级匹配)
    hooksCache       *gcache.Cache            // 回调事件注册路由内存缓存
    // 自定义状态码回调
    hsmu             sync.RWMutex             // status handler互斥锁
    statusHandlerMap map[string]HandlerFunc   // 不同状态码下的注册处理方法(例如404状态时的处理方法)
    // COOKIE
    cookieMaxAge     *gtype.Int               // Cookie有效期
    cookies          *gmap.IntInterfaceMap    // 当前服务器正在服务(请求正在执行)的Cookie(每个请求一个Cookie对象)
    // SESSION
    sessionMaxAge    *gtype.Int               // Session有效期
    sessionIdName    *gtype.String            // SessionId名称
    sessions         *gcache.Cache            // Session内存缓存
    // 日志相关属性
    logPath          *gtype.String            // 存放日志的目录路径
    logHandler       *gtype.Interface         // 自定义日志处理回调方法
    errorLogEnabled  *gtype.Bool              // 是否开启error log
    accessLogEnabled *gtype.Bool              // 是否开启access log
    accessLogger     *glog.Logger             // access log日志对象
    errorLogger      *glog.Logger             // error log日志对象
    // 多进程管理控制
    manager          *gproc.Manager // 多进程管理
    heartbeats
}

// 域名、URI与回调函数的绑定记录表
type HandlerMap  map[string]*HandlerItem

// 路由对象
type Router struct {
    Uri      string       // 注册时的pattern - uri
    Method   string       // 注册时的pattern - method
    Domain   string       // 注册时的pattern - domain
    Priority int          // 优先级，用于链表排序，值越大优先级越高
}

// http回调函数注册信息
type HandlerItem struct {
    ctype    reflect.Type // 控制器类型
    fname    string       // 回调方法名称
    faddr    HandlerFunc  // 准确的执行方法内存地址(与以上两个参数二选一)
    router   *Router      // 注册时绑定的路由对象
}

// http注册函数
type HandlerFunc func(r *Request)

// Server表，用以存储和检索名称与Server对象之间的关联关系
var serverMapping = gmap.NewStringInterfaceMap()

// 获取/创建一个默认配置的HTTP Server(默认监听端口是80)
// 单例模式，请保证name的唯一性
func GetServer(name...interface{}) (*Server) {
    sname := gDEFAULT_SERVER
    if len(name) > 0 {
        sname = gconv.String(name[0])
    }
    if s := serverMapping.Get(sname); s != nil {
        return s.(*Server)
    }
    s := &Server {
        name             : sname,
        servers          : make([]*gracefulServer, 0),
        cmdPort          : gDEFAULT_COMMAND_PORT,
        methodsMap       : make(map[string]bool),
        handlerMap       : make(HandlerMap),
        statusHandlerMap : make(map[string]HandlerFunc),
        handlerTree      : make(map[string]interface{}),
        hooksTree        : make(map[string]interface{}),
        handlerCache     : gcache.New(),
        hooksCache       : gcache.New(),
        cookies          : gmap.NewIntInterfaceMap(),
        sessions         : gcache.New(),
        cookieMaxAge     : gtype.NewInt(gDEFAULT_COOKIE_MAX_AGE),
        sessionMaxAge    : gtype.NewInt(gDEFAULT_SESSION_MAX_AGE),
        sessionIdName    : gtype.NewString(gDEFAULT_SESSION_ID_NAME),
        servedCount      : gtype.NewInt(),
        closeQueue       : gqueue.New(),
        signalQueue      : make(chan os.Signal),
        logPath          : gtype.NewString(),
        accessLogEnabled : gtype.NewBool(),
        errorLogEnabled  : gtype.NewBool(true),
        accessLogger     : glog.New(),
        errorLogger      : glog.New(),
        logHandler       : gtype.NewInterface(),
        manager          : gproc.New(),
        signalChan       : make(chan os.Signal),
    }
    s.errorLogger.SetBacktraceSkip(4)
    s.accessLogger.SetBacktraceSkip(4)
    // 设置路由解析缓存上限，使用LRU进行缓存淘汰
    s.hooksCache.SetCap(10000)
    s.handlerCache.SetCap(10000)
    for _, v := range strings.Split(gHTTP_METHODS, ",") {
        s.methodsMap[v] = true
    }
    s.SetConfig(defaultServerConfig)
    serverMapping.Set(sname, s)
    return s
}

// 阻塞执行监听
func (s *Server) Run() error {
    if s.status == 1 {
        return errors.New("server is already running")
    }

    // 底层http server配置
    if s.config.Handler == nil {
        s.config.Handler = http.HandlerFunc(s.defaultHttpHandle)
    }

    // 开启异步关闭队列处理循环
    s.startCloseQueueLoop()

    // 开启Web Server执行
    s.startServer()
    return nil
}

// 开启底层Web Server执行
func (s *Server) startServer() {
    // 主进程只负责创建子进程
    if !s.isChildProcess() {
        s.forkChildProcess()
        time.Sleep(10*time.Second)
        time.Sleep(1000*time.Second)
        return
    }
    // 信号量控制监听
    go s.handleSignals()
    // 开始执行底层Web Server创建，端口监听
    var fd     = 3
    var wg     sync.WaitGroup
    var fcount = s.processFileCount()
    var server *gracefulServer
    if len(s.config.HTTPSCertPath) > 0 && len(s.config.HTTPSKeyPath) > 0 {
        // HTTPS
        if len(s.config.HTTPSAddr) == 0 {
            if len(s.config.Addr) > 0 {
                s.config.HTTPSAddr = s.config.Addr
            } else {
                s.config.HTTPSAddr = gDEFAULT_HTTPS_ADDR
            }
        }
        array := strings.Split(s.config.HTTPSAddr, ",")
        for _, v := range array {
            wg.Add(1)
            go func(addr string) {
                if s.isChildProcess() && fcount > 0 {
                    server = s.newGracefulServer(addr, fd)
                    fd++
                } else {
                    server = s.newGracefulServer(addr)
                }
                s.servers = append(s.servers, server)
                if err := server.ListenAndServeTLS(s.config.HTTPSCertPath, s.config.HTTPSKeyPath); err != nil {
                    // 如果非关闭错误，那么提示报错，否则认为是正常的服务关闭操作
                    if !strings.EqualFold(http.ErrServerClosed.Error(), err.Error()) {
                        glog.Error(err)
                    }
                    wg.Done()
                }
            }(v)
        }
    }
    // HTTP
    if s.servedCount.Val() == 0 && len(s.config.Addr) == 0 {
        s.config.Addr = gDEFAULT_HTTP_ADDR
    }
    array := strings.Split(s.config.Addr, ",")
    for _, v := range array {
        wg.Add(1)
        go func(addr string) {
            if s.isChildProcess() && fcount > 0 {
                server = s.newGracefulServer(addr, fd)
                fd++
            } else {
                server = s.newGracefulServer(addr)
            }
            s.servers = append(s.servers, server)
            if err := server.ListenAndServe(); err != nil {
                // 如果非关闭错误，那么提示报错，否则认为是正常的服务关闭操作
                if !strings.EqualFold(http.ErrServerClosed.Error(), err.Error()) {
                    glog.Println(fd)
                    glog.Println(os.Args)
                    glog.Error(err)
                }
                wg.Done()
            }
        }(v)
    }

    s.status = 1

    // 阻塞执行，直到所有Web Server退出
    wg.Wait()
}

// 异步处理信号量监控
func (s *Server) handleSignals() {
    var sig os.Signal

    signal.Notify(
        s.signalChan,
        syscall.SIGTERM,
        syscall.SIGUSR2,
    )

    for {
        sig = <- s.signalChan
        switch sig {
            case syscall.SIGTERM: s.Shutdown()
            case syscall.SIGUSR2: s.Restart()
            default:
        }
    }
}

// 重启Web Server
func (s *Server) Restart() {
    // 如果是主进程，那么向所有子进程发送重启信号
    if !s.isChildProcess() {
        s.manager.SignalAll(syscall.SIGUSR2)
        return
    }
    if pid, err := s.forkChildProcess(); err != nil {
        glog.Errorf("server restart failed: %v, continue serving\n", err)
    } else {
        glog.Printf("server restart successfully, new pid: %d\n", pid)
        s.Shutdown()
    }
}

// 关闭Web Server
func (s *Server) Shutdown() {
    // 如果是主进程，那么向所有子进程发送关闭信号
    if !s.isChildProcess() {
        s.manager.SignalAll(syscall.SIGTERM)
        return
    }
    for _, v := range s.servers {
        v.shutdown()
    }
}

// 子进程获取的文件打开数
func (s *Server) processFileCount() int {
    return gconv.Int(gcmd.Option.Get("fcount"))
}

// 判断是否为子进程执行
func (s *Server) isChildProcess() bool {
    return s.getTopId() > 0
}

// 获取顶级进程ID(管理进程ID)
func (s *Server) getTopId() int {
    id := gcmd.Option.Get("topid")
    if id != "" {
        return gconv.Int(id)
    }
    return 0
}

// 创建子进程来监听并处理新的HTTP请求，与父进程使用的是同一个socket文件描述符
func (s *Server) forkChildProcess() (int, error) {
    // 获取所有http server的file
    files := []*os.File{os.Stdin,os.Stdout,os.Stderr}
    for _, v := range s.servers {
        if f, e := v.listener.(*net.TCPListener).File(); e == nil {
            files = append(files, f)
        } else {
            return 0, fmt.Errorf("failed to get listener file: %v", e)
        }
    }
    // 开启子进程，并传递socket文件指针
    topId := s.getTopId()
    if topId == 0 {
        topId = os.Getpid()
    }
    args    := make([]string, 4)
    args[0]  = os.Args[0]
    args[1]  = fmt.Sprintf("--name=%s",   s.name)
    args[2]  = fmt.Sprintf("--port=%d",   s.cmdPort)
    args[3]  = fmt.Sprintf("--fcount=%d", len(files) - 3)
    p       := s.manager.NewProcess(os.Args[0], args, os.Environ())
    p.GetAttr().Files = files
    if pid, err := p.Run(); err != nil {
        return 0, fmt.Errorf("failed to fork process: %v", err)
    } else {
        return pid, nil
    }
}

// 清空当前的handlerCache
func (s *Server) clearHandlerCache() {
    s.hmcmu.Lock()
    defer s.hmcmu.Unlock()
    s.handlerCache.Close()
    s.handlerCache = gcache.New()
}

// 清空当前的hooksCache
func (s *Server) clearHooksCache() {
    s.hhcmu.Lock()
    defer s.hhcmu.Unlock()
    s.hooksCache.Close()
    s.hooksCache = gcache.New()
}