Mattermost项目中避免使用SELECT *的SQL查询优化实践

背景介绍

在Mattermost这个开源企业级即时通讯平台的数据库访问层中，存在一个需要优化的技术点：在compliance_store.go文件中使用了SELECT *这样的SQL查询语句。这种写法虽然方便，但会带来严重的数据库兼容性问题。

问题分析

SELECT *语句会返回表中所有列的数据，当数据库表结构发生变化时（例如添加新列），会导致以下问题：

1. 旧版本服务器无法正确处理新版本数据库中的新增列
2. 增加了不必要的网络传输数据量
3. 降低了查询性能
4. 使代码对数据库结构变更更加敏感

解决方案

Mattermost团队提出了一个分步骤的优化方案：

第一步：将字符串SQL查询迁移到SQLBuilder

将硬编码的SQL字符串查询改为使用SQLBuilder构建查询。例如：

// 旧写法
_, err = s.GetReplica().Get("SELECT * FROM Table WHERE Id = ?", id)

// 新写法
query := s.getQueryBuilder().
    Select("*").
    From("Table").
    Where(sq.Eq{"Id": id})
_, err = s.GetReplica().GetBuilder(query)

第二步：显式指定查询列

将SELECT("*")替换为显式指定所需列：

query := s.getQueryBuilder().
    Select("Column1", "Column2").
    From("Table").
    Where(sq.Eq{"Id": id})

对于多次使用的查询，建议在存储构造函数中定义基础查询：

type SqlTableStore struct {
    *SqlStore
    tableSelectQuery sq.SelectBuilder
}

func newSqlTableStore(sqlStore *SqlStore) store.TableStore {
    s := SqlTableStore{
        SqlStore: sqlStore,
    }

    s.tableSelectQuery = s.getQueryBuilder().
        Select("Column1", "Column2").
        From("Table")

    return &s
}

第三步：测试验证

修改完成后，需要运行相关的单元测试来验证修改的正确性：

go test -run TestTableStore

实施建议

1. 建议在修改前先充分理解现有代码的业务逻辑
2. 确保明确知道每个查询实际需要哪些列
3. 修改时保持原子性，一次只修改一个存储文件
4. 修改后需要进行充分的测试验证
5. 考虑添加注释说明为什么需要这些特定列

总结

通过这种优化，Mattermost项目可以：

1. 提高数据库兼容性
2. 减少不必要的数据传输
3. 提升查询性能
4. 使代码更加健壮和可维护

这种优化方式不仅适用于Mattermost项目，对于其他使用SQL数据库的Go项目也具有参考价值，是编写高质量数据库访问代码的良好实践。