摘要: 安全规约 用户数据 用户个人的页面 【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。 说明:防止没有做水平权限校验就可随意访问、修改、删除别人的数据,比如查看他人的私信内容。 用户敏感数据 【强制】用户敏感数据禁止直接展示,必须对展示数据进行脱敏。 说明:中国大陆个人手机号码显示:139* 阅读全文
posted @ 2022-09-27 16:54 gcbeen 阅读(30) 评论(0) 推荐(0)
摘要: 异常日志-日志规约 使用日志框架 SLF4J 【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架(SLF4J、JCL--Jakarta Commons Logging)中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。 说明: 阅读全文
posted @ 2022-09-27 15:53 gcbeen 阅读(342) 评论(0) 推荐(0)
摘要: 异常日志-异常处理 异常定义 定义时区分 unchecked / checked 异常 【推荐】定义时区分 unchecked / checked 异常,避免直接抛出 new RuntimeException(),更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异 阅读全文
posted @ 2022-09-27 15:42 gcbeen 阅读(88) 评论(0) 推荐(0)
摘要: 异常日志-错误码 错误码的制定 错误码的制定原则 【强制】错误码的制定原则:快速溯源、沟通标准化。 说明: 错误码想得过于完美和复杂,就像康熙字典中的生僻字一样,用词似乎精准,但是字典不容易随身携带并且简单易懂。 正例:错误码回答的问题是谁的错?错在哪? 1)错误码必须能够快速知晓错误来源,可快速判 阅读全文
posted @ 2022-09-27 11:51 gcbeen 阅读(179) 评论(0) 推荐(0)
摘要: 编程规约-其他 工具类 避免用 Apache Beanutils 【强制】避免用 Apache Beanutils 进行属性的 copy。 说明:Apache BeanUtils 性能较差,可以使用其他方案比如 Spring BeanUtils, Cglib BeanCopier,注意均是浅拷贝。 阅读全文
posted @ 2022-09-27 11:25 gcbeen 阅读(32) 评论(0) 推荐(0)
摘要: 编程规约-前后端 前后端交互的 API 【强制】前后端交互的 API,需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体。 说明: A. 协议:生产环境必须使用 HTTPS。 B. 路径:每一个 API 需对应一个路径,表示 API 具体的请求地址: 代表一种资源,只能为名词,推荐使用复数 阅读全文
posted @ 2022-09-27 10:42 gcbeen 阅读(213) 评论(0) 推荐(0)
摘要: MySQL 数据库-ORM 映射规约 字段 POJO 类的布尔属性不能加 is,而数据库字段必须加 is_ 【强制】POJO 类的布尔属性不能加 is,而数据库字段必须加 is_,要求在 resultMap 中进行字段与属性之间的映射。 说明:参见定义 POJO 类以及数据库字段定义规定,在 sql 阅读全文
posted @ 2022-09-26 18:03 gcbeen 阅读(159) 评论(0) 推荐(0)
摘要: MySQL 数据库-SQL 语句规约 统计 标准统计行数的语法count(*) 【强制】不要使用 count(列名)或 count(常量)来替代 count(*),count(*)是 SQL92 定义的标准统计行数的语法,跟数据库无关,跟 NULL 和非 NULL 无关。 说明:count(*)会统 阅读全文
posted @ 2022-09-26 17:42 gcbeen 阅读(81) 评论(0) 推荐(0)
摘要: MySQL 数据库-索引规约 字段场景 业务上具有唯一特性的字段 【强制】业务上具有唯一特性的字段,即使是组合字段,也必须建成唯一索引。 说明:不要以为唯一索引影响了 insert 速度,这个速度损耗可以忽略,但提高查找速度是明显的;另外,即使在应用层做了非常完善的校验控制,只要没有唯一索引,根据墨 阅读全文
posted @ 2022-09-26 16:37 gcbeen 阅读(96) 评论(0) 推荐(0)
摘要: MySQL 数据库-建表规约 一、命名规约 小写字母或数字或下划线 表名、字段名必须使用小写字母或数字,禁止出现数字开头,禁止两个下划线中间只出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。 说明:MySQL 在 Windows 下不区分大小写,但在 Linux 阅读全文
posted @ 2022-09-26 16:06 gcbeen 阅读(115) 评论(0) 推荐(0)