WebGo: 轻量级Golang Web微框架使用指南

WebGo是一个轻量级的Golang Web框架，它提供了构建Web应用所需的核心功能，同时保持了极简的设计理念。下面我将详细介绍WebGo的使用方法，并提供示例代码。

安装WebGo

首先需要安装WebGo包：

go get github.com/bnkamalesh/webgo/v6

基本使用示例

package main

import (
	"fmt"
	"net/http"
	
	"github.com/bnkamalesh/webgo/v6"
)

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

func main() {
	// 定义路由
	routes := []*webgo.Route{
		{
			Name:     "hello",
			Method:   http.MethodGet,
			Pattern:  "/",
			Handlers: []http.HandlerFunc{hello},
		},
	}

	// 创建WebGo配置
	cfg := &webgo.Config{
		Host:         "localhost",
		Port:         "8080",
		ReadTimeout:  10,
		WriteTimeout: 10,
	}

	// 创建路由器
	router := webgo.NewRouter(cfg, routes...)

	// 启动服务器
	webgo.GracefulShutdown(router)
}

核心功能

1. 路由定义

WebGo支持RESTful风格的路由定义：

routes := []*webgo.Route{
	{
		Name:     "get-users",
		Method:   http.MethodGet,
		Pattern:  "/users",
		Handlers: []http.HandlerFunc{getUsers},
	},
	{
		Name:     "get-user",
		Method:   http.MethodGet,
		Pattern:  "/users/:id",
		Handlers: []http.HandlerFunc{getUser},
	},
	{
		Name:     "create-user",
		Method:   http.MethodPost,
		Pattern:  "/users",
		Handlers: []http.HandlerFunc{createUser},
	},
}

2. 路径参数获取

func getUser(w http.ResponseWriter, r *http.Request) {
	params := webgo.Context(r).Params()
	userID := params["id"]
	
	// 查询数据库或其他操作
	fmt.Fprintf(w, "User ID: %s", userID)
}

3. 中间件支持

WebGo支持中间件链：

func loggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		fmt.Printf("Request: %s %s\n", r.Method, r.URL.Path)
		next(w, r)
	}
}

routes := []*webgo.Route{
	{
		Name:     "hello",
		Method:   http.MethodGet,
		Pattern:  "/",
		Handlers: []http.HandlerFunc{loggingMiddleware, hello},
	},
}

4. 静态文件服务

routes := []*webgo.Route{
	{
		Name:    "static",
		Method:  http.MethodGet,
		Pattern: "/static/:filename",
		Handlers: []http.HandlerFunc{
			func(w http.ResponseWriter, r *http.Request) {
				params := webgo.Context(r).Params()
				http.ServeFile(w, r, "static/"+params["filename"])
			},
		},
	},
}

5. JSON响应

func getUsers(w http.ResponseWriter, r *http.Request) {
	users := []struct {
		ID   int    `json:"id"`
		Name string `json:"name"`
	}{
		{1, "Alice"},
		{2, "Bob"},
	}
	
	webgo.R200(w, users)
}

高级功能

1. 自定义错误处理

func customErrorHandler(w http.ResponseWriter, r *http.Request, err error) {
	w.Header().Set("Content-Type", "application/json")
	w.WriteHeader(http.StatusInternalServerError)
	json.NewEncoder(w).Encode(map[string]string{
		"error": err.Error(),
	})
}

cfg := &webgo.Config{
	Host:         "localhost",
	Port:         "8080",
	ErrorHandler: customErrorHandler,
}

2. 优雅关闭

func main() {
	// ... 路由和配置初始化
	
	// 设置优雅关闭
	webgo.GracefulShutdown(router, &webgo.GracefulConfig{
		Timeout: 10 * time.Second,
		PreHook: func() {
			fmt.Println("Shutting down server...")
		},
		PostHook: func() {
			fmt.Println("Server shutdown complete")
		},
	})
}

3. CORS支持

func enableCORS(next http.HandlerFunc) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Access-Control-Allow-Origin", "*")
		w.Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
		w.Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization")
		
		if r.Method == http.MethodOptions {
			w.WriteHeader(http.StatusOK)
			return
		}
		
		next(w, r)
	}
}

完整示例

下面是一个完整的REST API示例：

package main

import (
	"encoding/json"
	"net/http"
	"strconv"
	
	"github.com/bnkamalesh/webgo/v6"
)

type User struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

var users = []User{
	{1, "Alice"},
	{2, "Bob"},
}

func getUsers(w http.ResponseWriter, r *http.Request) {
	webgo.R200(w, users)
}

func getUser(w http.ResponseWriter, r *http.Request) {
	params := webgo.Context(r).Params()
	id, err := strconv.Atoi(params["id"])
	if err != nil {
		webgo.R400(w, "Invalid user ID")
		return
	}
	
	for _, user := range users {
		if user.ID == id {
			webgo.R200(w, user)
			return
		}
	}
	
	webgo.R404(w, "User not found")
}

func createUser(w http.ResponseWriter, r *http.Request) {
	var newUser User
	err := json.NewDecoder(r.Body).Decode(&newUser)
	if err != nil {
		webgo.R400(w, "Invalid request body")
		return
	}
	
	users = append(users, newUser)
	webgo.R201(w, newUser)
}

func loggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		webgo.LOGHANDLER.Info(r.Method, r.URL.Path)
		next(w, r)
	}
}

func main() {
	routes := []*webgo.Route{
		{
			Name:     "get-users",
			Method:   http.MethodGet,
			Pattern:  "/users",
			Handlers: []http.HandlerFunc{loggingMiddleware, getUsers},
		},
		{
			Name:     "get-user",
			Method:   http.MethodGet,
			Pattern:  "/users/:id",
			Handlers: []http.HandlerFunc{loggingMiddleware, getUser},
		},
		{
			Name:     "create-user",
			Method:   http.MethodPost,
			Pattern:  "/users",
			Handlers: []http.HandlerFunc{loggingMiddleware, createUser},
		},
	}
	
	cfg := &webgo.Config{
		Host:         "localhost",
		Port:         "8080",
		ReadTimeout:  10,
		WriteTimeout: 10,
	}
	
	router := webgo.NewRouter(cfg, routes...)
	webgo.GracefulShutdown(router)
}

WebGo是一个非常适合构建小型到中型Web应用的轻量级框架，它提供了足够的功能而不引入过多的复杂性。通过上述示例，你可以快速开始使用WebGo构建自己的Golang Web应用。