抖音极简版

• 第三届字节跳动青训营 - 后端专场
• 抖音项目说明

抖音极简版是 2022 年字节跳动青训营的结营项目。

技术栈

• Go
• Gin
• GORM
• MySQL
• JWT
• 乐观锁
• FFmpeg

文件结构

.
│  config.yaml        ──── 配置文件
│
├─app
│  │  main.go         ──── 项目入口
│  │  router.go       ──── API路由配置
│  │
│  ├─api              ──── [API层]
│  │    user.go       ──── 注册、登录、用户信息
│  │    relation.go   ──── 关注、粉丝
│  │    feed.go       ──── 视频流
│  │    publish.go    ──── 视频投稿
│  │    comment.go    ──── 视频评论
│  │    favorite.go   ──── 视频点赞
│  │
│  ├─config           ──── [项目配置]
│  │
│  ├─dao              ──── [持久化层]
│  │    db.go         ──── 数据库初始化
│  │
│  ├─errs             ──── [错误管理]
│  │
│  └─service          ──── [服务层]
│
├─pkg                 ──── [公共依赖]
│
├─test                ──── [测试相关]
│
└─docs                ──── [项目文档]

配置

项目配置文件为项目根目录的 config.yaml 文件。

名称 (key)	说明	示例值
port	项目服务监听的端口	8080
static.base-url	静态资源的 base url，与客户端配置的 base url 一致	http://10.51.155.205:8080
gin.log-level	Gin 的日志级别，生产环境请设置为 release	debug
gorm.log-level	GORM 的日志级别，info 级别会输出所执行的 SQL	info
mysql.host	数据库的 host 和 port	localhost:3306
mysql.database	存储项目数据的数据库名称	douyin_db
mysql.username	数据库的用户名	root
mysql.password	数据库的密码	admin
jwt.issuer	JWT Payload 里的 issuer 信息	douyin
jwt.secret	签署 JWT 的密钥	example
jwt.expires-in	JWT 的有效期	2h

运行

方式一：使用 Docker 运行

先配置好 config.yaml 文件里的 static.base-url，然后执行：

docker-compose up

方式二：在本机运行

启动项目前需完成运行环境的配置：

• 安装 Go
• 安装 FFmpeg
• 启动 MySQL 8.0 并确保有一个名为 douyin_db 的数据库
• 在 config.yaml 文件中配置好数据库的地址和账号密码

然后执行此命令即可运行：

go run ./app

若想编译可执行文件，请执行命令：

go build -o ./bin/app ./app

这会将可执行文件保存到 ./bin 目录。

测试

测试环境的配置文件为 test/config.yaml ，测试前请做好配置工作。

客户端

抖音极简版 APP

APK 安装包下载地址：飞书文档

项目文档

• API 文档
• 开发环境配置
• Git 使用规范

问题

由于本项目的 API 设计是训练营安排的且不可修改，存在的以下问题我们不考虑解决：

• 注册和登录时，通过 URL 参数传密码存在安全问题
• 通过 URL 参数传鉴权 Token 存在安全问题
• 部分列表查询没有分页