从“祖传”代码到简洁优美的代码演进之旅

2023-10-18 10:20:02

在软件开发的浩瀚海洋中，我们经常会遇到各式各样的代码，有的清晰易读，有的晦涩难懂。前者如同明镜般让我们一目了然，而后者则像是一团迷雾，让我们摸不着头脑。今天，我将与大家分享一次我将一段“祖传”代码简化的经历，从中探索代码优化之道。

背景

某天，我在工作中遇到了一段“祖传”代码，它就像一座古老的城堡，历经岁月的洗礼，显得陈旧而复杂。据说是公司某位早已离职的前辈所写，代码逻辑混乱，注释稀少，可读性极差。

作为一名怀揣着代码洁癖的开发者，我实在无法忍受如此糟糕的代码质量。于是，我决定对其进行一番改造，让它焕发新的生机。

原始代码

public class LegacyCode {

    private String name;
    private int age;

    public LegacyCode(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String toString() {
        return "LegacyCode [name=" + name + ", age=" + age + "]";
    }

    public static void main(String[] args) {
        LegacyCode legacyCode = new LegacyCode("John", 30);
        System.out.println(legacyCode);
    }
}

这段代码用来表示一个人的姓名和年龄，并提供了相应的 getter 和 setter 方法。然而，它的结构非常臃肿，充满了冗余的代码，可扩展性和可维护性都很差。

改造过程

面对如此复杂的代码，我决定采用循序渐进的方式进行改造。

首先，我将类名从 LegacyCode 改为 Person，使其更加语义化。然后，我提取了 getter 和 setter 方法，并使用 Lombok 注解使其更加简洁。

import lombok.Data;

@Data
public class Person {

    private String name;
    private int age;

    public static void main(String[] args) {
        Person person = new Person("John", 30);
        System.out.println(person);
    }
}

接下来，我将 toString() 方法重写为：

@Override
public String toString() {
    return String.format("Person [name=%s, age=%d]", name, age);
}

这样一来，Person 对象的字符串表示更加直观和易读。

最后，我使用 Java 8 的 lambda 表达式进一步简化了 main() 方法：

public static void main(String[] args) {
    Person person = new Person("John", 30);
    System.out.println(person.toString());
}

成果

经过一番改造，原本臃肿不堪的代码变得简洁优雅，可读性和可维护性都得到了极大的提升。下面是改造后的最终代码：

import lombok.Data;

@Data
public class Person {

    private String name;
    private int age;

    public static void main(String[] args) {
        Person person = new Person("John", 30);
        System.out.println(person.toString());
    }

    @Override
    public String toString() {
        return String.format("Person [name=%s, age=%d]", name, age);
    }
}