在 Google App Engine (GAE) 中，很多 Web 应用的 Handler 都需要执行一些通用的初始化任务，例如用户认证、区域设置检测、加载翻译字符串、检查 Memcache 值等等。如何在每个 Handler 中避免重复编写这些通用逻辑，是提升代码质量和开发效率的关键。本文将介绍一种使用 Go 语言实现这一目标的方法，并提供详细的代码示例。
自定义 Handler 类型
一种优雅的解决方案是定义一个自定义的 Handler 类型，该类型实现了 ServeHTTP 接口，并在内部调用原始的 Handler 函数。这样，我们就可以在 ServeHTTP 方法中执行通用的初始化任务，然后再调用实际的 Handler 函数。
以下是一个简单的示例：
package main
import (
"fmt"
"log"
"net/http"
)
type wrappedHandler func(w http.ResponseWriter, r *http.Request)
func (h wrappedHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
log.Println("执行通用初始化任务...")
h(w, r)
}
func handler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "你好!")
}
func main() {
http.Handle("/", wrappedHandler(handler))
http.ListenAndServe(":8080", nil)
}在这个例子中，wrappedHandler 是一个函数类型，它接受 http.ResponseWriter 和 *http.Request 作为参数。ServeHTTP 方法首先打印一条日志信息，然后调用原始的 handler 函数。
传递参数到 Handler
如果需要将一些参数传递给 Handler 函数，可以在自定义的 Handler 类型中添加这些参数。例如，假设我们需要传递一个数据库连接对象到 Handler 函数：
package main
import (
"fmt"
"log"
"net/http"
)
// 假设存在一个 db 包，其中包含连接数据库的逻辑
type Connection struct {}
func CreateConnection() *Connection {
// 这里应该是创建数据库连接的逻辑
return &Connection{}
}
func (c *Connection) AllTheData() string {
return "数据库中的数据"
}
type wrappedHandler func(w http.ResponseWriter, r *http.Request, conn *Connection)
func (h wrappedHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
conn := CreateConnection()
h(w, r, conn)
}
func handler(w http.ResponseWriter, r *http.Request, conn *Connection) {
data := conn.AllTheData()
fmt.Fprintf(w, data)
}
func main() {
http.Handle("/", wrappedHandler(handler))
http.ListenAndServe(":8080", nil)
}在这个例子中，wrappedHandler 接受一个 *Connection 类型的参数，并在 ServeHTTP 方法中创建数据库连接，然后将其传递给 handler 函数。
App Engine 完整示例
下面是一个更完整的 App Engine 示例，展示了如何使用自定义 Handler 类型进行配置加载：
package main
import (
"fmt"
"log"
"net/http"
"google.golang.org/appengine"
"google.golang.org/appengine/datastore"
"github.com/gorilla/context"
"github.com/gorilla/mux"
)
type Config struct {
DefaultLocale string
DefaultTimezone string
}
type ContextKey int
const (
SiteConfig ContextKey = iota
// ...
)
type InitHandler func(http.ResponseWriter, *http.Request, appengine.Context)
func (h InitHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
// 所有 Handler 初始化任务都在这里进行
c := appengine.NewContext(r)
k := datastore.NewKey(c, "Config", "site:config", 0, nil)
config := new(Config)
if err := datastore.Get(c, k, config); err != nil {
log.Fatalf("无法从 Datastore 读取配置: %s\n", err.Error())
}
context.Set(r, SiteConfig, config)
// 最后，调用 Handler 本身
h(w, r, c)
}
func main() {
r := mux.NewRouter()
r.Handle("/", InitHandler(home)) // 注意：不是 r.HandleFunc!
http.Handle("/", r)
appengine.Main() // Required for App Engine execution
}
func home(w http.ResponseWriter, r *http.Request, c appengine.Context) {
site := context.Get(r, SiteConfig).(*Config)
fmt.Fprintf(w, "区域设置: %s, 时区: %s.", site.DefaultLocale, site.DefaultTimezone)
}注意事项：
- 在这个示例中，使用了 gorilla/context 包来在请求上下文中存储配置信息。
- 需要使用 router.Handle 而不是 router.HandleFunc。
- 确保在 App Engine 中正确配置 Datastore。
总结
通过自定义 Handler 类型，我们可以有效地将通用的初始化任务从各个 Handler 函数中分离出来，从而提高代码的可重用性和可维护性。这种方法也符合中间件的设计模式，使得我们可以灵活地添加和删除通用的处理逻辑。
在实际开发中，可以根据具体的需求，将用户认证、区域设置检测、缓存管理等通用任务封装到自定义 Handler 类型的 ServeHTTP 方法中。这样，每个 Handler 函数只需要关注自身的业务逻辑，而无需关心通用的初始化任务。
