如何在 Go 的 HTTP 包中自定义错误处理？

当前位置：剧情吧 > php教程>

电视猫时间： 2024-12-22 15:22:52

在 Go 的 HTTP 包中，错误处理通常涉及到如何处理 HTTP 请求期间可能发生的错误，并向客户端返回适当的响应。Go 提供了灵活的工具来实现自定义错误处理，包括自定义错误页面、记录日志以及分类错误等。

以下是实现自定义错误处理的几种常见方式：

1. 使用自定义的 `http.Handler`

自定义一个中间件或 http.Handler，拦截处理错误并生成适当的响应。

package main

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

// 自定义错误处理中间件
func errorHandler(next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		defer func() {
			if err := recover(); err != nil {
				// 捕获 panic 并处理
				http.Error(w, fmt.Sprintf("Internal Server Error: %v", err), http.StatusInternalServerError)
				log.Printf("Recovered from panic: %v", err)
			}
		}()
		next.ServeHTTP(w, r)
	})
}

func helloHandler(w http.ResponseWriter, r *http.Request) {
	// 模拟触发错误
	if r.URL.Path == "/error" {
		panic("something went wrong!")
	}
	w.Write([]byte("Hello, World!"))
}

func main() {
	mux := http.NewServeMux()
	mux.HandleFunc("/", helloHandler)

	// 包装原始处理器，添加错误处理
	http.ListenAndServe(":8080", errorHandler(mux))
}

2. 自定义错误页面

通过拦截错误状态码并提供自定义的错误页面。

package main

import (
	"net/http"
)

// 自定义错误处理函数
func customErrorPage(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusNotFound)
	w.Write([]byte("<h1>404 - Page Not Found</h1><p>The page you are looking for does not exist.</p>"))
}

func helloHandler(w http.ResponseWriter, r *http.Request) {
	if r.URL.Path != "/" {
		customErrorPage(w, r)
		return
	}
	w.Write([]byte("Hello, World!"))
}

func main() {
	http.HandleFunc("/", helloHandler)
	http.ListenAndServe(":8080", nil)
}

3. 使用中间件记录和分类错误

在一个复杂的系统中，可以通过中间件捕获和分类错误，例如记录日志、区分客户端错误（4xx）和服务端错误（5xx）。

package main

import (
	"log"
	"net/http"
)

// 错误分类中间件
func errorLoggingMiddleware(next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		recorder := &responseRecorder{ResponseWriter: w, statusCode: http.StatusOK}
		next.ServeHTTP(recorder, r)

		// 分类错误并记录
		if recorder.statusCode >= 400 {
			log.Printf("Error: %d %s", recorder.statusCode, http.StatusText(recorder.statusCode))
		}
	})
}

// 自定义 ResponseWriter 用于捕获状态码
type responseRecorder struct {
	http.ResponseWriter
	statusCode int
}

func (rec *responseRecorder) WriteHeader(code int) {
	rec.statusCode = code
	rec.ResponseWriter.WriteHeader(code)
}

func helloHandler(w http.ResponseWriter, r *http.Request) {
	if r.URL.Path != "/" {
		http.Error(w, "Not Found", http.StatusNotFound)
		return
	}
	w.Write([]byte("Hello, World!"))
}

func main() {
	mux := http.NewServeMux()
	mux.HandleFunc("/", helloHandler)

	// 添加错误分类和记录中间件
	http.ListenAndServe(":8080", errorLoggingMiddleware(mux))
}

4. 使用 `http.Server` 的 `ErrorLog`

Go 的 http.Server 提供了一个 ErrorLog 字段，可以用来自定义错误日志记录。

package main

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

func helloHandler(w http.ResponseWriter, r *http.Request) {
	http.Error(w, "This is a test error", http.StatusInternalServerError)
}

func main() {
	server := &http.Server{
		Addr:    ":8080",
		Handler: http.HandlerFunc(helloHandler),
		ErrorLog: log.New(os.Stderr, "HTTP ERROR: ", log.LstdFlags), // 自定义错误日志记录
	}

	server.ListenAndServe()
}

5. 使用第三方库（如 `chi` 或 `gorilla/mux`）实现更复杂的错误处理

一些第三方库提供了更简洁的路由管理和中间件支持，可以轻松集成自定义错误处理逻辑。

package main

import (
	"log"
	"net/http"

	"github.com/go-chi/chi/v5"
	"github.com/go-chi/chi/v5/middleware"
)

func main() {
	r := chi.NewRouter()

	// 使用中间件自动处理错误和恢复
	r.Use(middleware.Logger)
	r.Use(middleware.Recoverer)

	// 自定义路由和错误处理
	r.Get("/", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("Welcome to the home page!"))
	})

	r.Get("/error", func(w http.ResponseWriter, r *http.Request) {
		panic("An unexpected error occurred!")
	})

	log.Fatal(http.ListenAndServe(":8080", r))
}