Java是否支持默认参数值

技术背景

在许多编程语言中，函数或方法可以为参数设置默认值，这样在调用时如果不提供该参数，就会使用默认值。例如在 C++ 中，可以这样定义函数：

public: void myFunction(int a, int b=5, string c="test") { ... }

然而，Java 原生并不支持这种默认参数值的语法。

实现步骤

方法重载

方法重载是 Java 中模拟默认参数值的常用方法。通过定义多个具有不同参数列表的同名方法，来实现不同的调用方式。

public class Example {
    public void myFunction(int a, int b, String c) {
        // 方法逻辑
    }

    public void myFunction(int a, int b) {
        myFunction(a, b, "test");
    }

    public void myFunction(int a) {
        myFunction(a, 5);
    }
}

构建器模式

构建器模式可以让一些字段具有默认值或成为可选字段。

class Student {
    private String name;
    private int age;
    private String motto;

    private Student(StudentBuilder builder) {
        this.name = builder.name;
        this.age = builder.age;
        this.motto = builder.motto;
    }

    static class StudentBuilder {
        private String name;
        private int age = 0;
        private String motto = "";

        public StudentBuilder name(String name) {
            this.name = name;
            return this;
        }

        public StudentBuilder age(int age) {
            this.age = age;
            return this;
        }

        public StudentBuilder motto(String motto) {
            this.motto = motto;
            return this;
        }

        public Student buildStudent() {
            return new Student(this);
        }
    }
}

使用示例：

Student s1 = new Student.StudentBuilder().name("Eli").buildStudent();
Student s2 = new Student.StudentBuilder()
        .name("Spicoli")
        .age(16)
        .motto("Aloha, Mr Hand")
        .buildStudent();

使用可变参数

在 Java 1.5 及以上版本，可以使用可变参数来模拟默认参数。

void MyParameterizedFunction(String param1, int param2, Boolean... params) {
    assert params.length <= 1;
    boolean param3 = params.length > 0 ? params[0].booleanValue() : false;
}

使用 Optional 功能

import java.util.Optional;
import javax.annotation.Nullable;

public class OptionalExample {
    void parameterizedMethod(String param1, int param2, @Nullable Boolean param3) {
        param3 = Optional.ofNullable(param3).orElse(false);
        // 使用所有三个参数
    }
}

参数对象模式

public class Foo {
    private static class ParameterObject {
        int param1 = 1;
        String param2 = "";
    }

    public static void main(String[] args) {
        new Foo().myMethod(new ParameterObject() {{ param1 = 10; param2 = "bar";}});
    }

    private void myMethod(ParameterObject po) {
    }
}

Java Method Invocation Builder

可以使用 Java Method Invocation Builder 来自动生成带有默认值的构建器。

import se.bjurr.gitchangelog.api.annotations.Default;
import se.bjurr.gitchangelog.api.annotations.GenerateMethodInvocationBuilder;

@GenerateMethodInvocationBuilder
public class CarService {
    public CarService() {
    }

    public String getCarsByFilter(
            @Default("Color.BLUE") Color color,
            @Default("new ProductionYear(2001)") ProductionYear productionYear,
            @Default("Tomas") String owner
    ) {
        return "Filtering... " + color + productionYear + owner;
    }
}

使用示例：

CarService instance = new CarService();
String carsByFilter = CarServiceGetCarsByFilterBuilder.getCarsByFilter()
        .invoke(instance);

CarService instance2 = new CarService();
String carsByFilter2 = CarServiceGetCarsByFilterBuilder.getCarsByFilter()
        .withColor(Color.YELLOW)
        .invoke(instance2);

核心代码

方法重载核心代码

public class OverloadExample {
    public void method(int a, String b) {
        System.out.println("a: " + a + ", b: " + b);
    }

    public void method(int a) {
        method(a, "default");
    }
}

构建器模式核心代码

class User {
    private String name;
    private int age;

    private User(UserBuilder builder) {
        this.name = builder.name;
        this.age = builder.age;
    }

    static class UserBuilder {
        private String name;
        private int age = 0;

        public UserBuilder name(String name) {
            this.name = name;
            return this;
        }

        public UserBuilder age(int age) {
            this.age = age;
            return this;
        }

        public User build() {
            return new User(this);
        }
    }
}

最佳实践

• 方法重载：适用于参数数量较少且简单的情况，代码简洁易读。
• 构建器模式：当参数较多，且部分参数可选时，使用构建器模式可以提高代码的可读性和可维护性。
• 可变参数：在处理少量可选参数时可以使用，但要注意参数类型的一致性。
• Optional 功能：适用于 Java 8 及以上版本，使用包装类来处理可能为 null 的参数。
• 参数对象模式：当参数较多且逻辑复杂时，可以将参数封装到一个对象中，便于管理。
• Java Method Invocation Builder：如果需要自动生成带有默认值的构建器，可以使用该工具。

常见问题

空指针异常问题

在使用可变参数或手动检查 null 时，可能会出现空指针异常。例如：

public MyParameterizedFunction(String param1, int param2, Boolean param3) {
    if(param3 == null) {
        param3 = false;
    }
}

如果代码中存在错误，导致 boolean 类型的参数没有赋值，不会抛出 NullPointerException，而是默认为 false，这可能会给调试带来困难。

方法重载的歧义问题

虽然方法重载可以模拟默认参数值，但在某些情况下可能会导致方法调用的歧义。因此，在设计方法时，要确保参数列表的差异足够明显。