Golang中SQL Server测试API错误问题排查

在Golang中使用Gin框架和sqlx时，Android应用通过Retrofit调用出现数组索引错误，通常是由于JSON响应结构与Android端预期不匹配导致的。以下是可能的问题点和排查方向：

1. JSON响应结构不一致

Golang端返回的JSON结构可能与Android端解析的模型不匹配。

示例代码：

// 错误的示例 - 返回了嵌套结构
type User struct {
    ID   int    `db:"id" json:"id"`
    Name string `db:"name" json:"name"`
}

func getUsers(c *gin.Context) {
    var users []User
    err := db.Select(&users, "SELECT id, name FROM users")
    if err != nil {
        c.JSON(500, gin.H{"error": err.Error()})
        return
    }
    
    // 直接返回数组可能导致问题
    c.JSON(200, users)
}

// 正确的示例 - 使用统一的结构包装
func getUsersFixed(c *gin.Context) {
    var users []User
    err := db.Select(&users, "SELECT id, name FROM users")
    if err != nil {
        c.JSON(500, gin.H{"error": err.Error()})
        return
    }
    
    // 使用明确的响应结构
    response := gin.H{
        "success": true,
        "data":    users,
        "count":   len(users),
    }
    c.JSON(200, response)
}

2. 空数组与null的区别

sqlx可能返回空数组，而Android端可能期望null。

func getUsers(c *gin.Context) {
    var users []User
    query := "SELECT id, name FROM users WHERE id = ?"
    err := db.Select(&users, query, -1) // 无结果
    
    if err != nil {
        c.JSON(500, gin.H{"error": err.Error()})
        return
    }
    
    // users是空数组 []，不是nil
    if len(users) == 0 {
        // 返回空数组而不是null
        c.JSON(200, []User{})
        return
    }
    
    c.JSON(200, users)
}

3. 数据库字段映射问题

sqlx的字段映射可能导致JSON标签不生效。

type User struct {
    UserID   int    `db:"user_id" json:"userId"` // 注意大小写和命名
    FullName string `db:"full_name" json:"fullName"`
}

func getUser(c *gin.Context) {
    id := c.Param("id")
    var user User
    
    // 使用Get而不是Select获取单条记录
    err := db.Get(&user, "SELECT user_id, full_name FROM users WHERE user_id = ?", id)
    if err != nil {
        if err == sql.ErrNoRows {
            c.JSON(404, gin.H{"error": "User not found"})
            return
        }
        c.JSON(500, gin.H{"error": err.Error()})
        return
    }
    
    c.JSON(200, gin.H{"user": user})
}

4. 添加详细的错误处理和日志

添加中间件记录请求和响应：

func LoggerMiddleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        // 记录请求
        log.Printf("Request: %s %s", c.Request.Method, c.Request.URL.Path)
        
        c.Next()
        
        // 记录响应状态
        log.Printf("Response: %d", c.Writer.Status())
    }
}

func main() {
    r := gin.Default()
    r.Use(LoggerMiddleware())
    
    // 路由定义
    r.GET("/users", getUsers)
    r.Run(":8080")
}

5. 使用统一的错误响应格式

type ApiResponse struct {
    Success bool        `json:"success"`
    Data    interface{} `json:"data,omitempty"`
    Error   string      `json:"error,omitempty"`
    Message string      `json:"message,omitempty"`
}

func getUsers(c *gin.Context) {
    var users []User
    err := db.Select(&users, "SELECT id, name FROM users")
    
    response := ApiResponse{}
    
    if err != nil {
        response.Success = false
        response.Error = err.Error()
        c.JSON(500, response)
        return
    }
    
    response.Success = true
    response.Data = users
    c.JSON(200, response)
}

6. 测试API响应

创建测试端点验证响应结构：

func testResponse(c *gin.Context) {
    // 返回一个明确的测试结构
    testData := []map[string]interface{}{
        {"id": 1, "name": "John", "active": true},
        {"id": 2, "name": "Jane", "active": false},
    }
    
    response := gin.H{
        "status":  "success",
        "data":    testData,
        "count":   len(testData),
        "message": "Test response",
    }
    
    c.JSON(200, response)
}

在Android Retrofit中，确保Model类与Go端的JSON结构完全匹配，特别是字段名称和类型。使用Postman和Android应用分别调用API，比较两者的原始响应数据，通常能发现结构不一致的问题。