CSGHub项目用户搜索功能问题分析与修复方案

问题背景

在CSGHub v0.9.0版本中，组织管理员尝试邀请新成员时遇到了功能异常。具体表现为当在组织详情页面点击"邀请"按钮并输入用户名进行搜索时，系统返回404错误。这个问题影响了组织管理的核心功能，需要及时修复。

问题分析

通过深入分析，我们发现问题的根源在于前后端API接口的不匹配：

1. 前端实现：前端代码通过GET请求访问/api/v1/users?search=username接口来搜索用户
2. 后端路由：后端只定义了POST和PUT方法的用户路由，缺少GET方法的用户搜索接口

这种前后端不一致导致系统无法正确处理用户搜索请求，从而返回404错误。

技术细节

前端请求方式

前端使用异步函数发送GET请求，查询参数为search，期望返回匹配的用户列表：

async function getUsers(username) {
    const usersEndpoint = `/users?search=${username}`
    const options = {
      method: 'GET',
      headers: {
        'Content-Type': 'application/json'
      }
    }
    // ...
}

后端路由缺失

后端路由配置中只包含创建用户和更新用户的路由：

apiGroup.POST("/users", userProxyHandler.ProxyToApi("/api/v1/user"))
apiGroup.PUT("/users/:username", userProxyHandler.ProxyToApi("/api/v1/user/%v", "username"))

解决方案

我们通过以下步骤修复了这个问题：

1. 添加GET路由：在后端路由中添加GET方法的用户搜索接口

apiV1Group.GET("/users", userHandler.SearchByName)

2. 实现搜索逻辑：创建对应的处理函数，通过用户名进行模糊查询

func (h *UserHandler) SearchByName(ctx *gin.Context) {
    userName := ctx.Query("search")
    user, err := h.c.SearchByName(ctx, userName)
    if err != nil {
        slog.Error("Failed to get user", slog.Any("error", err))
        httpbase.ServerError(ctx, err)
        return
    }
    slog.Info("Search user succeed", slog.String("userName", userName))
    httpbase.OK(ctx, user)
}

3. 数据库查询：实现数据库层面的模糊查询功能

func (s *UserStore) FindUsersByName(ctx context.Context, username string) (users []User, err error) {
    err = s.db.Operator.Core.NewSelect().Model(&users).Where("username like ?", fmt.Sprintf("%s%%", username)).Scan(ctx)
    return
}

技术要点

1. RESTful API设计：GET方法应该用于查询操作，符合RESTful设计原则
2. 模糊查询实现：使用SQL的LIKE操作符实现用户名前缀匹配
3. 错误处理：完善的错误日志记录和HTTP状态码返回机制
4. 日志记录：使用slog记录关键操作日志，便于问题追踪

总结

这个问题的修复不仅解决了用户搜索功能异常，还完善了系统的API设计。在开发过程中，前后端接口的严格定义和一致性检查非常重要，可以避免类似问题的发生。建议在项目开发中：

1. 建立完善的API文档
2. 实施接口测试
3. 进行前后端联调
4. 建立接口变更通知机制

通过这些措施，可以显著提高系统的稳定性和开发效率。