yahuian / go-bjut

A bbs system.

Go-bjut

项目规范

git commit

一个 commit 尽可能只做一件事

1. added: 添加，一般在添加了新功能时使用
2. improved: 改进，一般在优化和改进代码时使用
3. refactored：重构，一般在优化代码结构和设计时使用
4. fixbug: 修复bug，一般在修复bug时使用

命名规范

1. 文件名统一用小驼峰法，例如：bjutRegister
2. 路由命名统一用"-"，例如：bjut-register
3. 包名统一用小写字母，例如：student

版本约定

1. 采用主版本号.子版本号.修正版本号，比如：V1.2.1
2. 修正版本号一般在修复bug时使用
3. 子版本号一般在添加了新功能时使用
4. 主版本号一般是在积累了较多新功能且代码稳定时使用

更新日志

1. added: 添加的新功能
2. changed: 功能的变更
3. fixed: 修改的bug
4. security: 修改的关于安全的bug
5. removed: 删除的功能

go-bjut's Issues

大佬有没有数据库的建表文~

大佬有没有数据库的建表文~

请问这是个纯后端项目吗

学长，请问这个bbs是练手的还是已经在用了^^

你好,问一下有没有前台页面?

推荐一个vscdoe 规范化git 的commit工具

如果使用vscode的话,vscode商店搜索git-commit-lint-vscode

[review] 一些建议

config 配置文件加入 gitignore

测试短信模板是无效的，但是看相关密码等可能暴露一些隐私信息，最好完全移除项目的所有 commit 并重新提交，防止搜索引擎索引

sms api 调用参数错误

代码 https://github.com/YahuiAn/Go-bjut/blob/be5b6a472377c9e98205ee8cb56f3132ca59aaa7/service/card/message.go#L50 处 rand 一个 int 然后强转 string，这个 int 会被当作 byte 字节这种对应到字符，大部份时候它是个乱码，此参数应该是个随机字符串，并且有一定长度

代码中大量调用 viper 库获取配置

viper 库配置文件在以前是无法并发读取的，现在有没有坑不清楚，参考 issue spf13/viper#482

错误处理问题

很多地方错误处理不正确，譬如 https://github.com/YahuiAn/Go-bjut/blob/be5b6a472377c9e98205ee8cb56f3132ca59aaa7/service/card/message.go#L92 http 实际返回的错误 json 串是无法反序列化到你的结构体的，所以会造成错误信息丢失，出现问题无法排查

log 处理

推荐你直接使用 logrus 库，而不是造轮子

关键性 配置抽离

针对 sms 抽象合理接口，腾讯云的送达率并不 ok，或者说国内的送达率可能在某一段时间你会切换 sms 提供商，譬如阿里大鱼；而且通知未来可能扩充到 邮件、微信...

其他的太晚了，懒得看了....