一个月总结(基础代码规范)
昨天负责的功能上线了,这一个月995差不多。不过很动词十点多下班。比较累吧,不过也学到了很多东西
这篇随笔主要总结下遇到的一些代码规范问题;
1,入参类的创建以Param结尾,(名称以条件最多的表为主);
查询的出参以DTO结尾(返回集合,对外提供),查询集合为空,返回空集合对象;
返回给前端的以VO结尾(返回集合);
2,入参字段必填校验;
3,入参日志打印。如果能把日志的说明提供一个具有辨识度的标识,看日志的时候,会更醒目,更便捷;比如:“JSF结算:::查看列表{}”);
4,查询结果是否为空,集合元素是否唯一。(每次查询结果都进行是否为空校验,如果是唯一,校验值是否唯一);
5,Integer 大小比较用equals;
6,枚举值:提供给其他服务的接口,如果是更新数据状态,需要校验所更新的状态是否为需要文档要求的状态,即接口定义为更新数据的状态为失效,那么就需要校验 paramState.equals(Enum.dataState) 才可以进行更新;
7,sql查询结果最好使用resultMap,省去很多起别名时间;
8,建议:导出功能的sql,字段转换为对应的中文含义;其他sql不转换,返回给前端的,前端自行转换;
可以看出来这都是很基本的一些要求。但是做了四年的开发,以往的项目测试都是“点点点”;自己也不注意规范。最近一个月的出现的问题基本就是以上的现象,回想一下,是花了不少时间的。

浙公网安备 33010602011771号