开发日志2022/3/1

2022/3/1

在与新人一起编程的过程中，开始给他做了需求分析，写了接口定义，然后让他去实现，之后出了问题我来帮忙分析定位最终解决了，发现了很多编程中的习惯问题，记录如下。

关于系统日志

1. 在流程主方法里，最好写上入口日志，把参数打印出来; 正常退出可以写一下出参日志。
2. 每一处处理异常流程的代码处，都应该写上ERROR或WARN级别的日志。
3. 代码中调用重要的方法前后要输出日志，方便查找bug，日志级别用INFO或DEBUG需要自己考究。

关于已有代码

1. 非必要情况下，不改动旧的代码，保持开放-关闭原则。
2. 在已有工程上做二次开发和bug修复，要注意自己的代码线在哪里，不要随意修改到其它代码块去了。
3. 修改已有代码一定要小心，看懂了才能动手。

关于命名规范

1. 方法命名要规范，表明含义, 尽量具有很好的可都性。
2. 类名、方法名、变量名等，不要用简写，可以参考Spring框架库代码，命名都是很长的英文单词，很少用简写。
3. 不要用中文拼音来命名，除非完全没有办法。
4. 要看清楚自己代码所在的位置, 命名有所不同。
   当你的类名已经是很具体的，你可以把方法名写的简洁一些，因为整体上是类名+方法名来理解。
   当你的类名不大具体，比如是一个统一的门面类，这个时候你就不能把方法名写的简单，不然从类名+方法名是看不出是什么接口的。

关于返回值的判断检查

1. 只要接口返回有多种情况的，一定要编写检查判断代码，不能想当然一定是返回正常数据!
2. 对String类型的变量进行检查为空，一定要对null和空字符串都进行检查。
   spring框架有提供StringUtils.isEmpty()
3. 对集合类型的变量进行检查为空，一定要对null和size()==0都进行检查。
   spring框架有提供CollectionUtils.isEmpty()

关于写代码细心敏捷问题

1. 在已有工程上添加功能或修复bug，要观察一下周围代码，以前的程序员是怎么处理的，有什么样的代码风格等等。
   我们对别人代码视而不见，更不应该的是我们自己写错了，只要稍微看看老代码模仿着做都不会出问题，我们还搞出事来。
   随意破坏前人的代码风格，比如以前的代码注释和日志很丰富，新写代码却完全一团糟，懒得很。
2. 网上查看文档时，注意概览全文，挑选有用的部分，不要不加验证就乱写，加大代码调测难度，浪费时间。
3. 对开源库和一些语法用法的使用，要去看文档，不要想当然就使用，测试的时候才发现问题，浪费调测时间。

关于代码格式问题

1. 要遵循Java世界里默认的代码风格，命令采用驼峰法。
   class Device {
   private String placeCode;
   }
2. 要遵循Java世界里默认的代码风格，很多地方要一个空格。
   if (age == 18) {
   }
   for (int i = 0; i < n; i++) {
   }
   int code = getCode();
3. 代码块之间要空一行，至于什么是代码块，自己要有审美观。