写出更简洁的Java代码：@ExtensionMethod的隐藏超能力-优快云博客

本文链接：https://blog.youkuaiyun.com/dandandeshangni/article/details/146057321

引言：

在Java开发中，我们经常使用工具方法来执行代码库中重复或可重用的任务。这些方法通常是静态的，并被放置在工具类中，例如Math、Collections或StringUtils。尽管这种方式行之有效，但它往往会导致代码显得杂乱无章，需要不断从工具类中调用静态方法。这时，Lombok的@ExtensionMethod注解就派上了用场！

Lombok中的@ExtensionMethod注解允许我们在不直接修改现有类的情况下扩展其功能，使我们能够像调用实例方法一样调用工具方法。本文将带您了解@ExtensionMethod的基础知识、使用场景以及一些实用示例。

Lombok中的@ExtensionMethod是什么？

@ExtensionMethod注解允许您通过工具类中的方法扩展一个类的功能。它使得静态工具方法可以像被扩展类的实例方法一样被调用。

以下是简单的对比：

• 不使用@ExtensionMethod：以传统方式调用静态工具方法，使用ClassName.methodName()。
• 使用@ExtensionMethod：可以将工具方法调用得仿佛它们直接属于该类，使得代码更简洁且易读。

它是如何工作的？

在使用@ExtensionMethod时，Lombok会生成样板代码，将被扩展类的调用重定向到相应的工具类方法。

考虑以下示例：

传统方式（不使用@ExtensionMethod）：

import org.apache.commons.lang3.StringUtils;

public class StringProcessor {
    public static void main(String[] args) {
        String str = " Lombok ";
        
        // 传统方式调用工具方法
        String trimmedString = StringUtils.trim(str);  // 静态调用
        System.out.println(trimmedString);
    }
}

在这里，我们使用Apache Commons的StringUtils来修剪字符串。虽然有效，但每次都需要静态调用该方法。

使用@ExtensionMethod：
通过@ExtensionMethod，您可以让StringUtils.trim()方法看起来像是String类的实例方法：

import lombok.experimental.ExtensionMethod;
import org.apache.commons.lang3.StringUtils;

@ExtensionMethod(StringUtils.class)
public class StringProcessor {
    public static void main(String[] args) {
        String str = " Lombok ";
        
        // 使用@ExtensionMethod，trim()表现得像是String的原生方法
        String trimmedString = str.trim();  // 看起来更简洁且易读
        System.out.println(trimmedString);
    }
}

发生了什么？

我们使用了@ExtensionMethod注解，并将StringUtils.class作为参数传入。这指示Lombok使用StringUtils中的静态工具方法扩展String类。
现在，我们可以直接调用str.trim()，仿佛trim()是String类的实例方法。Lombok在幕后通过将方法调用重定向到StringUtils.trim()完成了这一魔法。

使用多个工具类与@ExtensionMethod：

您还可以同时用多个工具类扩展一个类。让我们看一个同时扩展StringUtils和Math工具类的例子：

import lombok.experimental.ExtensionMethod;
import org.apache.commons.lang3.StringUtils;

@ExtensionMethod({StringUtils.class, Math.class})
public class UtilityProcessor {
    public static void main(String[] args) {
        String str = " Hello World ";
        String trimmedString = str.trim();  // 调用StringUtils.trim()
        System.out.println(trimmedString);

        int value = -10;
        int absValue = value.abs();  // 调用Math.abs()
        System.out.println(absValue);
    }
}

这里：

• 我们使用StringUtils进行字符串操作。
• 我们使用Math进行数学运算，如abs()。
• 两种工具方法都被用作实例方法，使代码更加整洁。

使用@ExtensionMethod的最佳实践：

1. 谨慎使用：虽然@ExtensionMethod使代码更简洁，但应避免以可能让未来开发者困惑的方式过度使用。最好在扩展广为人知且直观的工具方法时使用。
2. 保持工具方法简单：尽量扩展执行简单、易懂操作的方法（如trim()、isEmpty()或abs()）。过于复杂的扩展可能会降低代码可读性。
3. 避免方法冲突：如果两个工具类具有同名方法，可能会导致歧义。确保您的扩展清晰且不重叠。

现实世界的用例

让我们看一个现实世界的例子，假设您经常使用工具方法检查集合或字符串是否为空。

不使用@ExtensionMethod：

import java.util.List;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.collections4.CollectionUtils;

public class DataValidator {
    public static void main(String[] args) {
        List<String> items = List.of();
        String input = " ";
        
        if (StringUtils.isEmpty(input)) {
            System.out.println("Input is empty");
        }

        if (CollectionUtils.isEmpty(items)) {
            System.out.println("Items list is empty");
        }
    }
}

使用@ExtensionMethod：

import lombok.experimental.ExtensionMethod;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.collections4.CollectionUtils;
import java.util.List;

@ExtensionMethod({StringUtils.class, CollectionUtils.class})
public class DataValidator {
    public static void main(String[] args) {
        List<String> items = List.of();
        String input = " ";
        
        // 使用@ExtensionMethod处理String和Collection工具
        if (input.isEmpty()) {
            System.out.println("Input is empty");
        }

        if (items.isEmpty()) {
            System.out.println("Items list is empty");
        }
    }
}

关键收获：