simple-demo

抖音项目服务端简单示例

具体功能内容参考飞书说明文档

项目使用的go版本是go1.20

项目需要同时运行cmd中的main.go和router.go

go run cmd/*

or

go build -o server cmd/*
./server

项目目录说明

• cmd 存放启动 server 相关
• common 存放公共的基础模块，比如全局错误码，封装的工具（为了简化开发，将一系列逻辑封装成一个函数）
  • config 配置模块，包括配置文件读取的实现，项目以 app.yaml 作为配置文件
  • log 封装的日志模块，应该仅用于与业务相关的部分
  • model 模型部分，包括数据库中的表结构、service层接口的定义、repository层接口的定义
  • result 封装的返回结果模块
• middleware 业务中间件模块，比如用户鉴权
• controller 负责对发送的数据进行处理，调用 service 中实现的业务逻辑，并根据所调用的 service 层的函数的返回值判断并处理返回一次请求的响应信息（比如 200 OK 跟上相应的数据）
• service 业务逻辑的实现，比如一次点赞，在 service 层要调用 repository 层，对数据库进行操作，并检查是否产生错误，若无返回 nil ，有则抛给调用该 service 函数的 controller，将错误交给 controller，并在 controller 中判断接下来应该怎么做，比如直接将错误信息和错误代码返回给用户
• repository 数据库CURD操作的实现，原则上一个文件对应一个数据表，如repository/user.go封装service层所有对user表的操作
• doc 一些文档
• util 封装了一些辅助实现代码逻辑而构成的小工具
• test 业务测试模块，主要是调用controller层进行集成测试

开发注意点

• service层若需要执行多次sql语句，最好套一层Transaction保持一致性（即使没有多次写入）
• token默认已经经过中间件验证，并保存用户ID在gin.Context中
• 错误处理可以更加直接一点
• 使用全局Logger进行日志保存