了解HTTP请求日志的重要性
在开发和维护http服务器时，记录请求日志是至关重要的一环。它不仅有助于监控服务器的运行状态、分析用户行为、发现潜在问题，还能为安全审计提供关键数据。常见的请求日志内容包括请求来源ip地址、请求方法（get/post等）、请求的url路径等。
识别问题：fmt.Printf与文件日志
在Go语言中，fmt.Printf函数默认将格式化的字符串输出到标准输出（即终端）。如果希望将内容写入文件，则需要使用能够指定写入目标的函数。最初的代码示例中，日志功能使用了fmt.Printf：
func Log(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Printf("%s %s %s\n", r.RemoteAddr, r.Method, r.URL) // 输出到终端
handler.ServeHTTP(w, r)
})
}这导致日志信息只显示在运行服务器的终端上，而未能保存到指定的文件中。
解决方案一：使用fmt.Fprintf将日志写入文件
fmt.Fprintf函数允许我们将格式化的字符串写入任何实现了io.Writer接口的对象。文件句柄（*os.File）就实现了这个接口，因此我们可以通过fmt.Fprintf将日志写入文件。
首先，我们需要在程序启动时创建或打开一个日志文件，并将其文件句柄保存起来供日志函数使用。
立即学习“go语言免费学习笔记（深入）”；
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"os" // 引入os包用于文件操作
"encoding/json" // 引入json包用于配置解析
)
// Options 结构体用于解析配置文件
type Options struct {
Path string
Port string
}
// 定义一个全局变量来保存日志文件句柄
var logFile *os.File
// Log 是一个HTTP中间件，用于记录请求信息
func Log(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// 使用fmt.Fprintf将日志写入logFile
if logFile != nil {
fmt.Fprintf(logFile, "%s %s %s\n", r.RemoteAddr, r.Method, r.URL)
} else {
// 如果logFile未初始化，则退回到标准输出
fmt.Printf("%s %s %s\n", r.RemoteAddr, r.Method, r.URL)
}
handler.ServeHTTP(w, r)
})
}
func main() {
// 1. 初始化日志文件
var err error
logFile, err = os.OpenFile("logfile.txt", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
if err != nil {
log.Fatalf("无法创建或打开日志文件: %v", err) // 使用log.Fatalf在错误时退出
}
defer logFile.Close() // 确保程序退出时关闭文件句柄
// 2. 解析配置
op := &Options{Path: "./", Port: "8001"} // 默认值
data, err := ioutil.ReadFile("./config.json")
if err != nil {
log.Printf("警告: 无法读取config.json文件，使用默认配置: %v", err)
} else {
err = json.Unmarshal(data, op)
if err != nil {
log.Printf("警告: 无法解析config.json文件，使用默认配置: %v", err)
}
}
// 3. 启动HTTP服务器
http.Handle("/", http.FileServer(http.Dir(op.Path)))
log.Printf("服务器正在端口 %s 上运行，提供文件服务目录: %s", op.Port, op.Path)
err = http.ListenAndServe(":"+op.Port, Log(http.DefaultServeMux))
if err != nil {
log.Fatalf("ListenAndServe 错误: %v", err) // 使用log.Fatalf在错误时退出
}
}代码解析与注意事项：
-
os.OpenFile("logfile.txt", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644):
- os.OpenFile 用于打开或创建文件。
- os.O_APPEND: 如果文件存在，新写入的内容将追加到文件末尾。
- os.O_CREATE: 如果文件不存在，则创建该文件。
- os.O_WRONLY: 以只写模式打开文件。
- 0644: 文件权限，表示文件所有者可读写，其他用户只读。
- defer logFile.Close(): 这是一个非常重要的语句。它确保无论程序如何退出，文件句柄都会被正确关闭，释放系统资源并避免数据丢失。
- 错误处理: 对os.OpenFile和json.Unmarshal等可能出错的操作进行错误检查，并使用log.Fatalf或log.Printf进行处理。log.Fatalf会在打印日志后调用os.Exit(1)退出程序。
解决方案二：使用Go标准库log包进行专业日志记录
Go语言的log包提供了更灵活和功能强大的日志记录机制。它可以配置输出目标、日志前缀、日志标志等，是生产环境中更推荐的日志方式。
我们可以将log包的输出目标设置为我们的日志文件。
package main
import (
"io/ioutil"
"log"
"net/http"
"os"
"encoding/json"
)
// Options 结构体用于解析配置文件
type Options struct {
Path string
Port string
}
// Log 是一个HTTP中间件，用于记录请求信息
func Log(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// 使用log包记录请求信息
log.Printf("%s %s %s", r.RemoteAddr, r.Method, r.URL)
handler.ServeHTTP(w, r)
})
}
func main() {
// 1. 初始化日志文件并配置log包的输出
logFile, err := os.OpenFile("logfile.txt", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
if err != nil {
log.Fatalf("无法创建或打开日志文件: %v", err)
}
defer logFile.Close()
// 将log包的输出设置为文件句柄
log.SetOutput(logFile)
// 可以设置日志前缀和标志，例如：
// log.SetPrefix("[HTTP_ACCESS] ")
// log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile) // 日期、时间、短文件名
// 2. 解析配置
op := &Options{Path: "./", Port: "8001"} // 默认值
data, err := ioutil.ReadFile("./config.json")
if err != nil {
log.Printf("警告: 无法读取config.json文件，使用默认配置: %v", err)
} else {
err = json.Unmarshal(data, op)
if err != nil {
log.Printf("警告: 无法解析config.json文件，使用默认配置: %v", err)
}
}
// 3. 启动HTTP服务器
http.Handle("/", http.FileServer(http.Dir(op.Path)))
log.Printf("服务器正在端口 %s 上运行，提供文件服务目录: %s", op.Port, op.Path) // 这条日志也会写入文件
err = http.ListenAndServe(":"+op.Port, Log(http.DefaultServeMux))
if err != nil {
log.Fatalf("ListenAndServe 错误: %v", err)
}
}代码解析与注意事项：
- log.SetOutput(logFile): 这是关键一步，它将log包的所有输出重定向到我们创建的logfile.txt文件。在此之后，所有通过log.Print, log.Printf, log.Println等函数输出的内容都会写入该文件。
-
log.SetPrefix和log.SetFlags:
- log.SetPrefix可以为每条日志添加一个固定的前缀，例如[HTTP_ACCESS]。
- log.SetFlags可以控制日志中包含的信息，如日期、时间、源文件和行号等。常用的标志包括log.Ldate、log.Ltime、log.Lmicroseconds、log.Llongfile、log.Lshortfile、log.LUTC、log.LstdFlags。
- 统一日志输出: 使用log包的好处是，所有的日志（包括服务器启动信息、错误信息和请求日志）都可以统一输出到同一个文件，便于管理和分析。
总结
无论是使用fmt.Fprintf直接写入文件，还是通过log.SetOutput重定向log包的输出，核心都在于将日志流从标准输出转向文件。对于更复杂的日志需求，例如日志轮转、不同级别的日志输出、结构化日志等，可以考虑使用更专业的第三方日志库，如logrus或zap。然而，对于简单的HTTP请求日志记录，Go标准库提供的功能已经足够强大和灵活。始终记住在程序启动时正确初始化日志文件，并在程序退出前妥善关闭文件句柄，以确保日志的完整性和系统的稳定性。
