开发过程中的规范问题

1,664 阅读1分钟

一,背景

最近在用过滤器做相关接口传输的加解密时发现很多不规范问题,再次列出警醒一下开发人员.

二,问题

2.1 URL命名

  • 在过滤器和网关对URL过滤时发现前缀一致导致部分接口也被裹挟进入处理 /base/group/{groupId}例如这种,鬼知道这个接口是想干什么,不能从URL上直观的知道其意义.
  • 要确保每个controller中的URL唯一,就这个/base/group/{groupId}来说,它在过滤器或者网关那边拦截的就是/base/group/,相当于这个controller都被处理了,会导致粒度和精度的问题.

2.2 表字段

  • 在定义类型的表字段时候,没有相关的注释,没有相关的常量类,使其意义不明,到时候只要有人没按规范来使用,开了头就会出现五花八门的数据
  • 表字段的长度没定义好,有些表字段里面存的内容就是一文章,或者设置的长度实际上用不到,比如status这个字段用int表示,不会超过两位数,长度确是64,极大的浪费了资源.

三,解决方案

  • 无他,规范,规范
  • URL要见名知意,要唯一存在
  • 表字段类型注释和常量一定要有,长度设置要适量,可以预留
  • 写成文档落实下去