代码规范:
JAVA
命名规范
包名全小写
例: com.quanta.demo
bean
config
controller
类名大驼峰
AdminController
AdminService
AdminServiceImpl
变量/方法名 小驼峰
data
userData
userList
禁用中文命名
代码中不要出现中文命名
目录结构规范
bean 一些中间转换用的类
config 配置类
constants 常量
controller 控制器
dto 接收前端传值对象
entity 实体类
mapper 数据库操作接口
service 服务类
serviceImpl 实现类
utils 工具类
vo 返回前端的对象
Mysql
命名规范
库名/表名/字段名
全小写&使用下划线连接
student 学生表
id 学生id
username 学生姓名
course 课程表
id 课程id
name 课程名称
student_course 选课表
id 选课表id
student_id 学生id
course_id 课程id
索引命名
主键索引 pk_字段名
唯一索引 uk_字段名
普通索引 index_字段名
建表规范
CREATE TABLE `demo` ( `id` int UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '编号', `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间', PRIMARY KEY (`id`) USING BTREE, UNIQUE INDEX `pk_id`(`id`) USING BTREE COMMENT '主键索引', ) ENGINE = InnoDB AUTO_INCREMENT = 16 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;
必备字段
id 自增
gmt_create 数据创建时间 CURRENT_TIMESTAMP
gmt_modified 数据修改时间 CURRENT_TIMESTAMP 根据当前时间戳更新
可选字段(二选一,根据已有字段判断)
id_deleted 逻辑删除(选) tinyint null为未删除
1为已删除
deleted_at 逻辑删除(选) datetime null为未删除
已删除记录删除时间
索引规范
必须索引
主键索引
pk_id
唯一字段
uk_字段
可选索引
常用查询字段索引
Git 规范
提交规范
格式
<type>(<scope>): <subject> // 空一行 <body> // 空一行 <footer>
提交类型type
类型 | 描述 |
---|---|
feat(常用) | 新特性,新功能 |
fix(常用) | 修复bug |
docs | 文档修改 |
build | 编译相关的修改,例如发布版本,对项目构建或者依赖的改动 |
chore | 其他修改,比如改变构建流程,或者增加依赖库,工具等 |
perf | 优化相关,比如提升性能,体验 |
style | 代码格式修改 |
test | 测试用例修改 |
ci | 持续集成修改 |
refactor | 代码重构 |
revert | 回滚上一个版本 |
作用域 scope (可选)
作用域(scope)表示此次提交影响的范围。
主题 subject
简短的一句话,简单说明此次提交的内容。
正文 body(非必须)
对本次 commit 的详细描述,可以分成多行
页脚footer
用来关闭 Issue或以BREAKING CHANGE(破坏性的变更)开头,后面是对变动的描述以及变动理由和迁移方法
关闭Issue
closes #Issue的id
BREAKING CHANGE
BREAKING CHANGE: 需要重新构建
例
feat: 完善登录功能 - 完善小程序登录功能 利用wechat code获取openid来唯一标识用户 - 完善web端的登录功能
fix(登录): 修复登录功能 - 修复登录功能跨域问题 closes #1
《数学之美》读后感
《贾里尼克和现代语言处理》:贾里尼克是为世界级的大师,不仅在于他的学术成就,更在于他的风范。贾里尼克教授少年坎坷,也并非开始就投身到自然语言方面的研究,关键是他的思想和他的道。贾里克尼教授治学严谨、用心对待自己的学生。贾里克尼教授一生专注学习,最后在办公桌前过世了。读了这章我总结出的一句话是“思想决定一个人的高度”。在这章中对于少年时的教育,以下几点值得借鉴:1、学习是一个人一辈子的过程。2、书本的内容可以早学,也可以晚学,但是错过了成长阶段却是无法补回来的。