重构手法——代码健壮性增强类 | 防御性编程 | 重命名字段

57 阅读1分钟

简介

"重命名字段"(Rename Field)重构手法用于提升代码可读性和领域表现力。通过更准确的命名反映字段的真实用途和业务含义。

典型代码坏味道

  • 字段名称使用技术术语而非业务语言
  • 命名存在拼写错误或缩写歧义
  • 名称无法清晰表达数据取值范围
  • 与关联字段命名风格不一致

重构步骤

  1. 分析字段用途

    • 理解字段真实业务含义
    • 确定新的合适名称
    • 检查命名冲突可能性
  2. 安全重命名

    • 使用IDE重构工具批量修改
    • 分阶段逐步替换(先添加新字段)
    • 处理数据库列映射(如有)
  3. 验证与测试

    • 检查所有引用点更新
    • 验证序列化/反序列化
    • 确保日志输出准确性

示例

重构前:

class Customer {
    private String phn; // Phone Number缩写容易误解
}

重构后:

class Customer {
    private String phoneNumber;
}

专项练习

基础练习

  1. 修正订单日期字段

    class Order {
        private Date dt; // 需改为orderDate
    }
    

进阶练习

  1. 处理数据库映射字段

    
    @Entity
    class Product {
        @Column(name = "prod_nm")
        private String productName;
    }
    

代码审查清单

优势验证

  • 代码可读性提升50%以上
  • 领域术语一致性达100%
  • 减少文档解释需求

风险提示

  • 可能破坏ORM框架映射
  • 需要同步更新文档注释
  • 影响JSON序列化字段名