代码重构：提取代码到泛型方法以消除重复

本文介绍了如何通过提取代码到泛型方法来消除代码重复，以提高代码的可维护性和可读性。通过创建一个泛型方法来处理不同类型的列表，并使用类型擦除的特性，可以有效地简化代码，减少冗余，并遵循 DRY（Don't Repeat Yourself）原则。本文提供了具体的代码示例和步骤，帮助开发者理解和应用这种重构技巧。

在软件开发中，代码重复是一个常见的问题，它会导致代码冗余、难以维护和扩展。 重构是解决代码重复的有效方法之一。本文将重点介绍如何通过提取代码到泛型方法来消除代码重复，提高代码的质量。

提取泛型方法

假设我们有以下代码片段，其中 withUnit 和 withTime 方法存在重复的逻辑：

class Builder {
    private final List<UnitIf> unit = new ArrayList<>();
    private final List<TimeIf> time = new ArrayList<>();

    public Builder withUnit(final UnitIf aUnit) {
        if (aUnit != null) {
            unit.add(aUnit);
        }
        return this;
    }

    public Builder withTime(final TimeIf aTime) {
        if (aTime != null) {
            time.add(aTime);
        }
        return this;
    }
}

可以看到，withUnit 和 withTime 方法中，判断参数是否为 null 并添加到列表的逻辑是重复的。为了消除这种重复，我们可以提取一个泛型方法来处理不同类型的列表。

实现泛型方法

我们可以创建一个名为 addIfNonNull 的泛型方法，该方法接收一个列表和一个对象作为参数，如果对象不为 null，则将其添加到列表中。

public <T> Builder addIfNonNull(List<T> dst, T x) {
    if (x != null) {
        dst.add(x);
    }
    return this;
}

在这个方法中，<T> 表示一个类型参数，List<T> 表示一个泛型列表，T x 表示一个类型为 T 的对象。

使用泛型方法

现在，我们可以使用 addIfNonNull 方法来简化 withUnit 和 withTime 方法：

public Builder withUnit(final UnitIf aUnit) {
    return addIfNonNull(unit, aUnit);
}

public Builder withTime(final TimeIf aTime) {
    return addIfNonNull(time, aTime);
}

通过这种方式，我们成功地消除了代码重复，使代码更加简洁和易于维护。

代码小浣熊

代码小浣熊是基于商汤大语言模型的软件智能研发助手，覆盖软件需求分析、架构设计、代码编写、软件测试等环节

51

查看详情

非泛型版本

如果你不想使用泛型方法，也可以创建一个非泛型版本。在这种情况下，你需要将类型参数 T 移除，并将参数 x 的类型更改为 Object：

public Builder addIfNonNull(List dst, Object x) {
    if (x != null) {
        dst.add(x);
    }
    return this;
}

需要注意的是，使用非泛型版本时，编译器会发出警告，因为类型安全无法保证。但是，由于 Java 的类型擦除特性，List<T> 在运行时会被擦除为 List，因此这种方法在技术上是可行的。

类型擦除

Java 的类型擦除是指在编译时将泛型类型信息擦除，将其替换为原始类型。例如，List<String> 在运行时会被擦除为 List。这意味着在运行时，无法区分 List<String> 和 List<Integer>。

类型擦除的主要目的是为了兼容旧版本的 Java 代码，因为在 Java 5 之前，泛型是不存在的。

总结

通过提取代码到泛型方法，我们可以有效地消除代码重复，提高代码的可维护性和可读性。在选择使用泛型方法还是非泛型方法时，需要权衡类型安全和代码简洁性。在大多数情况下，建议使用泛型方法，以确保类型安全。

注意事项：

• 确保泛型方法的类型参数能够满足所有可能的类型需求。
• 在使用非泛型方法时，要注意类型安全问题。
• 在重构代码时，要进行充分的测试，以确保代码的正确性。

通过本文的学习，相信你已经掌握了如何通过提取代码到泛型方法来消除代码重复的技巧。希望你能在实际开发中灵活运用这些技巧，编写出高质量的代码。

以上就是代码重构：提取代码到泛型方法以消除重复的详细内容，更多请关注php中文网其它相关文章！