构建之法阅读笔记02

对应章节：第四章 两人合作 - 代码规范与复审
核心观点：规范的代码是团队协作的基础设施

个人感受：
01 过去做法：
在实习时参与Java后台开发，曾为了快速完成任务写出如下代码：

java
public List getData(int t){ // 参数t表示类型，1=A类 2=B类
List res = new ArrayList<>();
for(Data d : allData){
if(d.getType()==t) res.add(d);
}
return res;
}
02 问题分析：

违反书中4.2节提出的"代码即文档"原则：

魔数问题：t=1的含义只有原作者知道

命名模糊：res无法表达业务含义

后果：两个月后其他同事修改该代码时，误将t==1改为t!=1导致线上故障

03 解决方案：

重构策略：

java
public enum DataType { TYPE_A, TYPE_B } // 使用枚举替代魔数
public List filterDataByType(DataType targetType) {
List filteredData = new ArrayList<>();
for(Data current : allData){
if(current.getType() == targetType) filteredData.add(current);
}
return filteredData;
}
自动化保障：配置Checkstyle插件强制检查以下规则：

方法参数必须带@param注释

禁止单字母变量名（除循环变量）