编辑“︁Gin单元测试”︁

= Gin单元测试 =

'''Gin单元测试'''是指针对使用[[Gin框架]]开发的Web应用程序中的独立组件（如路由、中间件、处理器函数）进行隔离验证的过程。通过模拟HTTP请求和响应，开发者可以确保代码逻辑在不同场景下按预期执行，而无需启动完整服务。

== 核心概念 ==

单元测试在Gin中主要关注三个层面：
# '''路由测试'''：验证URL路径与处理函数的绑定关系
# '''中间件测试'''：检查预处理/后处理逻辑
# '''处理器测试'''：确认业务逻辑的正确性

=== 测试工具链 ===
Gin测试通常依赖以下Go测试包：
* <code>net/http/httptest</code> - 提供HTTP测试模拟器
* <code>github.com/stretchr/testify/assert</code> - 断言库
* <code>testing</code> - Go原生测试框架

== 基础测试示例 ==

以下展示对简单路由的测试案例：

<syntaxhighlight lang="go">
package main

import (
	"net/http"
	"net/http/httptest"
	"testing"
	
	"github.com/gin-gonic/gin"
	"github.com/stretchr/testify/assert"
)

func setupRouter() *gin.Engine {
	r := gin.Default()
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})
	return r
}

func TestPingRoute(t *testing.T) {
	router := setupRouter()
	
	w := httptest.NewRecorder()
	req, _ := http.NewRequest("GET", "/ping", nil)
	router.ServeHTTP(w, req)
	
	assert.Equal(t, 200, w.Code)
	assert.Equal(t, `{"message":"pong"}`, w.Body.String())
}
</syntaxhighlight>

'''执行结果分析'''：
<pre>
=== RUN   TestPingRoute
--- PASS: TestPingRoute (0.00s)
</pre>

关键组件说明：
* <code>httptest.NewRecorder()</code> - 创建响应记录器
* <code>http.NewRequest()</code> - 模拟HTTP请求
* <code>assert.Equal()</code> - 验证响应状态码和内容

== 中间件测试 ==

测试认证中间件的典型流程：

<mermaid>
sequenceDiagram
    participant T as TestCase
    participant R as Router
    participant M as Middleware
    participant H as Handler
    
    T->>R: 发送带Header的请求
    R->>M: 执行认证逻辑
    alt 认证成功
        M->>H: 调用处理器
        H-->>R: 返回业务数据
    else 认证失败
        M-->>R: 返回401错误
    end
    R-->>T: 返回最终响应
</mermaid>

代码实现：

<syntaxhighlight lang="go">
func authMiddleware() gin.HandlerFunc {
	return func(c *gin.Context) {
		token := c.GetHeader("Authorization")
		if token != "valid_token" {
			c.AbortWithStatusJSON(401, gin.H{"error": "Unauthorized"})
			return
		}
		c.Next()
	}
}

func TestAuthMiddleware_Success(t *testing.T) {
	r := gin.New()
	r.GET("/protected", authMiddleware(), func(c *gin.Context) {
		c.String(200, "Access granted")
	})
	
	w := httptest.NewRecorder()
	req, _ := http.NewRequest("GET", "/protected", nil)
	req.Header.Set("Authorization", "valid_token")
	r.ServeHTTP(w, req)
	
	assert.Equal(t, 200, w.Code)
	assert.Contains(t, w.Body.String(), "Access granted")
}
</syntaxhighlight>

== 高级测试技巧 ==

=== 依赖注入 ===
通过结构体封装路由依赖：

<syntaxhighlight lang="go">
type App struct {
	DB *sql.DB
}

func (a *App) userHandler(c *gin.Context) {
	// 使用a.DB查询数据库
}

func TestWithDependencies(t *testing.T) {
	app := &App{DB: mockDB} // 使用模拟数据库
	r := gin.New()
	r.GET("/user", app.userHandler)
	
	// 测试逻辑...
}
</syntaxhighlight>

=== 表格驱动测试 ===
批量测试多组输入输出：

<syntaxhighlight lang="go">
func TestLoginEndpoint(t *testing.T) {
	testCases := []struct {
		name     string
		payload  string
		expected int
	}{
		{"valid", `{"user":"admin","pass":"123"}`, 200},
		{"invalid", `{"user":"guest","pass":"456"}`, 401},
	}
	
	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			w := httptest.NewRecorder()
			req, _ := http.NewRequest("POST", "/login", strings.NewReader(tc.payload))
			req.Header.Set("Content-Type", "application/json")
			
			router.ServeHTTP(w, req)
			assert.Equal(t, tc.expected, w.Code)
		})
	}
}
</syntaxhighlight>

== 性能考量 ==

使用<code>gin.SetMode(gin.TestMode)</code>可以禁用调试日志提高测试速度。基准测试示例：

<syntaxhighlight lang="go">
func BenchmarkRoute(b *testing.B) {
	router := setupRouter()
	req, _ := http.NewRequest("GET", "/ping", nil)
	
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		router.ServeHTTP(httptest.NewRecorder(), req)
	}
}
</syntaxhighlight>

输出示例：
<pre>
BenchmarkRoute-8   	  500000	      2876 ns/op
</pre>

== 常见问题 ==

{| class="wikitable"
|-
! 问题现象 !! 解决方案
|-
| 测试时报路由404 || 检查<code>gin.TestMode</code>设置和路由注册顺序
|-
| 中间件未生效 || 确认中间件是否在路由注册前添加
|-
| JSON断言失败 || 使用<code>assert.JSONEq()</code>代替普通字符串比较
|}

== 最佳实践 ==

1. 每个测试用例只验证一个行为
2. 使用<code>t.Cleanup()</code>清理测试数据
3. 对JSON响应使用结构体反序列化验证
4. 隔离测试环境与生产配置

通过系统化的单元测试，可以显著提高Gin应用的可靠性和可维护性。建议结合持续集成(CI)流程实现自动化测试。

[[Category:后端框架]]
[[Category:Gin]]
[[Category:Gin测试]]