Golang如何开发简单的请求日志记录功能_Golang请求日志记录项目实战

答案:通过函数包装实现Go语言HTTP请求日志中间件,记录方法、路径、IP、耗时及状态码,并支持输出到文件。首先定义loggingMiddleware拦截请求,记录开始信息并包装ResponseWriter以捕获状态码,处理完成后记录耗时;再将中间件应用于路由或全局mux;最后通过os.OpenFile重定向log输出至文件,实现生产级日志记录。

在Go语言开发中,记录HTTP请求日志是调试、监控和安全审计的重要手段。一个简单的请求日志记录功能可以帮助你了解每个请求的来源、路径、耗时和状态码。下面介绍如何快速实现一个实用的请求日志中间件。

1. 使用标准库实现基础日志中间件

Go的net/http包没有内置中间件机制,但你可以通过函数包装的方式实现。定义一个日志记录中间件,拦截每个请求并输出关键信息。

示例代码:

logMiddleware.go

package main

import (
    "log"
    "net/http"
    "time"
)

func loggingMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        start := time.Now()

        // 记录请求信息
        log.Printf(
            "method=%s path=%s remote_addr=%s user_agent=%s",
            r.Method,
            r.URL.Path,
            r.RemoteAddr,
            r.UserAgent(),
        )

        // 调用下一个处理器
        next.ServeHTTP(w, r)

        // 请求处理完成后记录耗时
        duration := time.Since(start)
        log.Printf("path=%s duration=%v", r.URL.Path, duration)
    })
}

2. 结合路由使用日志中间件

将中间件应用到具体的处理器上,可以只对部分接口启用日志,也可以全局使用。

示例:

func helloHandler(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Hello, World!"))
}

func main() {
    mux := http.NewServeMux()
    mux.Handle("/hello", loggingMiddleware(http.HandlerFunc(helloHandler)))
    
    // 或者包装整个mux
    loggedMux := loggingMiddleware(mux)
    
    log.Println("Server starting on :8080...")
    http.ListenAndServe(":8080", loggedMux)
}

3. 增强日志内容:记录响应状态码

标准的ResponseWriter不提供状态码访问,需要自定义包装来捕获写入的状态。

创建一个responseWriter结构体:

type responseWriter struct {
    http.ResponseWriter
    statusCode int
}

func (rw *responseWriter) WriteHeader(code int) {
    rw.statusCode = code
    rw.ResponseWriter.WriteHeader(code)
}

修改中间件以记录状态码:

func loggingMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        start := time.Now()

        // 包装ResponseWriter
        rw := &responseWriter{ResponseWriter: w, statusCode: 200}

        log.Printf("start method=%s path=%s ip=%s ua=%s",
            r.Method, r.URL.Path, r.RemoteAddr, r.UserAgent())

        next.ServeHTTP(rw, r)

        duration := time.Since(start)
        log.Printf("done path=%s status=%d duration=%v",
            r.URL.Path, rw.statusCode, duration)
    })
}

4. 输出到文件而非控制台

生产环境中通常需要将日志写入文件。可以使用os.OpenFile重定向log输出。

示例:

file, err := os.OpenFile("requests.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
if err != nil {
    log.Fatal("无法打开日志文件:", err)
}
defer file.Close()

log.SetOutput(file) // 所有log.Print将写入文件

基本上就这些。通过简单封装,你就能为Go服务添加实用的请求日志功能。不需要引入复杂框架,标准库足够应对大多数场景。关键是理解中间件模式和ResponseWriter的包装技巧。