Go语言工程实践

结构体定义

Post

type Post struct {
    ID         int64
    Title      string
    Content    string
    CreateTime int64
}

Topic

type Topic struct {
    ID         int64
    ParentID   int64
    Content    string
    CreateTime int64
}

初始化本地文件索引

主要步骤

使用 os.Open 打开文件，检查错误。
创建一个 Scanner 对象进行逐行读取。
创建临时 map 索引存储读取的数据。
使用 for scanner.Scan(){...} 循环读取和解析每一行。
将临时 map 赋给全局的 map，完成初始化。

路由设计

r.GET("/community/page/get/:id", func(c *gin.Context) {
    topicId := c.Param("id")
})

Controller 层

输入和输出结构

PageData

type PageData struct {
    Code int64
    Msg  string
    Data interface{}
}

Service 层

QueryPageInfoFlow 结构体

type QueryPageInfoFlow struct {
    TopicID  int64
    PageInfo *PageInfo
    Topic    *repository.Topic
    Posts    []*repository.Post
}

主要逻辑

检验传参: 确保 ID 大于0。
获取信息: 使用并行 goroutines 加锁，异步获取 topic 和 posts。
数据打包: 使用 PageInfo 结构体。

PageInfo 结构体

type PageInfo struct {
    Topic    *repository.Topic
    PostList []*repository.Post
}

测试

初始化

func TestMain(m *testing.M) {
    repository.Init("../data/")
    os.Exit(m.Run())
}

单元测试

assert.NotEqual(t, nil, pageInfo)
assert.Equal(t, 7, len(pageInfo.PostList))

反思总结

1. MVC三层架构

该例子采用了Model-View-Controller（MVC）三层架构，这种设计模式有助于将业务逻辑、用户界面和数据模型分离，使得代码更加模块化和可维护。

2. 业务逻辑的解耦

Controller 层只负责处理用户输入和输出，而 Service 层则负责复杂的业务逻辑和数据处理。这种分层设计有助于代码的复用和测试。

3. 并发与性能

通过使用 Go 的并发特性（goroutines和sync.WaitGroup），可以高效地并行处理多个任务。这不仅提高了程序的响应速度，也使得系统资源得到了更好的利用。

4. 错误处理和验证

在每个关键步骤（如文件打开、数据解析等）都有错误检查和处理机制，确保程序的健壮性。

5. 数据结构与索引

使用 map 结构作为索引，提供了快速的数据查找能力。这在大量数据的场景下是非常关键的。

6. 测试驱动开发（TDD）

采用单元测试来确保每个组件的功能和性能都达到预期，有助于提早发现问题，减少后期维护成本。

7. 灵活的数据输出

通过使用 Go 的接口和多态，可以方便地改变数据输出的格式（如 JSON、XML 等），使得系统更加灵活。

8. 代码可读性和可维护性

通过合理的命名、注释和文档，以及遵循 Go 的编码规范，使得代码易于理解和维护。

9. 持续迭代与优化

不断地重构和优化代码，追求更高的性能和用户体验。例如，可以考虑使用缓存来进一步提高数据访问速度。

10. 模块化与可扩展性

通过良好的设计和组织，代码易于扩展。例如，后续可以轻易地添加新的功能，如 append 功能或是更多的API接口。

这些方法论和思想不仅适用于这个特定的项目，也可以广泛应用于其他 Go 语言或 Web 开发项目，为编写高质量代码提供了有力的指导。

Go语言工程实践 | 青训营