霹雳霹雳 pilipili
一个简单纯粹的在线点播案例
快速启动
设置淘宝的软件源,并开启 GO111MODULE,PowerShell 操作以下指令:
$env:GOPROXY = 'https://mirrors.aliyun.com/goproxy/'
$env:GO111MODULE = 'on'
go run main.go
一起进入 Golang 的世界吧!
项目相关(简单说明)
- main 函数执行,首先读取相关配置文件,初始化项目,包括,读取项目运行变量,设置日志级别,连接数据库
- 其次,装载路由,设置 middleware 中间件,设置和获取 session ,cores,currentUser 相关内容
- 相关路由内容,设置版本类型,链接相关功能接口,分发到 api 文件夹中,实现服务分发,service 文件夹中代码即是功能相关处理逻辑。
文件夹存在意义
- serializar 序列化操作,统一化实现,定义一个通用规则,避免重复造轮子。
- model ,具体模型的对应内容,对应字段,相关函数,
- util 工具,辅助操作相关内容。
- conf 配置文件内容,带国际化操作。
- cache 内容,Redis 操作,辅助数据的读取和存储。
历史版本操作
V0.1 基础模型搭建
操作
基础内容创建
模块划分层面
- 模型 model
- 控制器 server
- 服务 service
- 视图
- 序列化器 serializer
V0.2 视频系列模块
相关接口
- 投稿视频接口:POST api/v1/videos
- 测试:JSON 带上 title 和 info
- 视频详情接口:GET api/v1/video/:id
- 视频列表接口:GET api/v1/videos
- 更新视频接口:PUT api/v1/video/:id
- 测试:JSON 带上 title 和 info
- 删除视频接口:DELETE api/v1/video/:id
- 注意:删除记录,只是软删除,记录删除而已。当然是对外不可见
相关知识
后端中的 MVC,view 现在是直接操作 JSON 数据了。
关于状态码的返回,一般只操作 200,无论操作是否成功,返回 HTTP 200,JSON 记录并返回相关错误信息。项目中统一化了错误信息的返回,更加单纯唯一。
改动文件
modified: README.md
new file: api/video.go
modified: conf/i18n.go
modified: model/migration.go
new file: model/video.go
new file: serializer/video.go
modified: server/router.go
new file: service/create_video_service.go
new file: service/delete_video_service.go
new file: service/list_video_service.go
new file: service/show_video_service.go
new file: service/update_video_service.go
V0.3 热度排行榜
相关接口
热度查询接口:GET /api/v1/rank/daily
相关知识
Redis
获取某一视频打开量:GET "view:video:[ id ]"
播放量+1:INCR "view:video:[ id ]",给 view:video:[ id ] 给 这个内容+1
删除某个键,删除数据:DEL "rank:daily",删除 rank:daily 数据
清空 redis 所有数据:FLUSHALL,清空 redis 数据
排行榜加分:ZINCRBY “rank:daily” 1 “10” ,给 rank:daily 10 号视频 +1
获取排行:ZREVRANGE “rank:daily” 0 9 ,获取排行前 10 的内容
改动文件
new file: api/rank.go
new file: cache/keys.go
new file: cache/main.go
new file: service/daily_rank_service.go
new file: tasks/cron.go
new file: tasks/rank.go
modified: conf/conf.go
modified: model/video.go
modified: serializer/video.go
modified: server/router.go
modified: service/daily_rank_service.go
modified: service/show_video_service.go
modified: tasks/cron.go
modified: tasks/rank.go
V0.4 修正 BUG: fixed & format project
改动文件
modified: conf/conf.go,配置文件加载翻译文件补上
modified: conf/i18n.go,重命名 Dictionary
modified: server/router.go,路由,用户登陆保护的 auth := v1.Group("/"),加上路径
modified: tasks/cron.go,定时任务的 error 条件判定缺失
modified: tasks/rank.go
V0.5 用户系统
相关接口
用户登陆:POST api/v1/user/register
用户注册:POST api/v1/user/login
用户详情:GET api/v1//user/me
用户退出:DELETE api/v1/user/logout
相关知识
POINTS: 加密问题,session 处理问题。
Cookie
保存在用户浏览器上一个文本文件,可以记录用户信息,待下次发送请求带上,从而进行其他相关操作。
Session
加密版的cookie。有多种存储方式,Redis etc。防止恶意用户修改cookie操作相关服务。
操作session方式:
1,保存到服务器磁盘上,用户保存一个 session ID,实际上是一个文件名,请求后到服务器上找文件,用户无法串改,安全高,用户没有任何方法修改,对分布式不友好,多台服务器登陆状态成问题;
2,分布式负载均衡发送会话到不同的服务器上,勾上会话保持后,设置一个 cookie 后,之后用户永远只能访问指定的服务器。但这过于依赖会话保持。新一种方式,cookie 存在于用户机器上,用户发送请求时带上,任何一台服务器解密后进行服务,有一定安全性,不绝对。
3,利用 Redis,之前的把 session ID 和 文件名绑定放到同一个服务器上存在问题,发送请求时,带上 cookie 中的 value 值(相当于键) 去服务器的 redis 中找 userID。
汇总,仅仅是一个 userID 存放问题。
改动文件
api/main.go
api/user.go
middleware/auth.go
middleware/session.go
model/user.go
serializar/user.go
server/router.go
service/user_login_service.go
service/user_register_service.go
V0.6 翻页操作
相关接口
无更新
相关知识
翻页操作需要封装 数据内容 and 数据总个数 给前端操作
改动文件
modified: README.md
modified: serializer/common.go
modified: service/list_video_service.go
V0.7 OSS 文件上传
相关接口
- 文件上传:POST /api/v1/upload/token
- 测试:JSON 请求 {"filename":"new.png"}
相关知识
使用 OSS 文件存储方式进行。不经过后端服务器。
需要 OSS_ACCESS_KEY,使用 子账户 操作,需要给用户 OSS 操作的相关权限。
在前后端分离的情况下,需要保存文件的存储地址,仓库不变,端点不变。(为什么?保证分布式进行,多台服务器可以随意直接访问)
为什么需要使用 OSS 直传?
1,带宽充足,降低了服务器消耗。
2,操作分布式,记录 文件地址后,可以直接访问文件,不用经过后端服务器。
上传流程
简述:首先获取钥匙,探测可操作请求,上传文件,GET 回显内容。
这里会有三个请求,顺序进行,详情如下:
- POST请求:先找阿里云拿 token,获取一个签名or钥匙,返回给一个上传的钥匙。这里把未来上传的地址 和 下载的地址都预签名好。(为什么不用 GET?避免跨域攻击)
- OPTIONS请求:上传不通过后端服务器,直传阿里云,这里涉及一个跨域问题,前端会发出一个 OPTIONS 请求,从 Response 探测 了解能进行的操作,请求类型,请求域名 etc。
- PUT 请求:然后,再发送一个 PUT 请求,把图片上传上去。
改动文件
new file: api/upload.go
modified: model/video.go
modified: serializer/video.go
modified: server/router.go
new file: service/upload_token_service.go
V0.8 相关部署文件
说明
增加文件:Dockerfile,docker-compose.yml.example,fabfile.py.example
Dockerfile:Docker部署文件。编译打包文件;
docker-compose.yml.example:docker 部署指令,项目环境的配置,mysql,redis,api 服务 etc;
fabfile.py.example:自动化部署。注意,相关服务不是跑在本地的,是跑在目标服务器上的;
改动文件
new file: .dockerignore
new file: Dockerfile
modified: README.md
new file: docker-compose.yml.example
new file: fabfile.py.example