传参为空赋默认值注解 java

原创

mob64ca12f028ff 2024-09-06 06:16:40 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12f028ff的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java中的传参与默认值设置

在Java中，方法的参数是一个重要的组成部分。然而，在许多场景中，方法调用时参数可能为空，此时我们通常希望为这些空参数提供默认值。通过使用注解和其他技巧，我们可以优雅地实现这一目标。本文将带您了解如何在Java中处理传参为空的情况，并为其赋予默认值。

什么是注解

注解是Java的一种基本特性，用于在代码中添加额外的信息，这些信息可以在运行时被读取。通过注解，我们可以实现一些自动化的功能，例如参数验证、日志记录等。为了处理参数为空的情况，我们可以创建一个自定义注解。

自定义注解示例

首先，我们定义一个自动赋值的注解@DefaultValue，它可以用来标识需要赋默认值的方法参数：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface DefaultValue {
    String value();
}

在这里，@Retention(RetentionPolicy.RUNTIME)表示该注解在运行时仍然可用，@Target(ElementType.PARAMETER)指定该注解可以用在方法参数上。

实现傻瓜式的小工具

接下来，我们需要一个工具类，能够处理方法参数并在参数为空时使用默认值。以下是一个简单的工具类示例：

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;

public class ParameterUtil {

    public static void invokeWithDefaults(Object obj, String methodName, Object... params) throws Exception {
        Method method = obj.getClass().getMethod(methodName, getParameterTypes(params));
        Parameter[] parameters = method.getParameters();

        for (int i = 0; i < parameters.length; i++) {
            if (params[i] == null) {
                DefaultValue defaultValue = parameters[i].getAnnotation(DefaultValue.class);
                if (defaultValue != null) {
                    params[i] = defaultValue.value();
                }
            }
        }

        method.invoke(obj, params);
    }

    private static Class<?>[] getParameterTypes(Object... params) {
        return Stream.of(params).map(Object::getClass).toArray(Class<?>[]::new);
    }
}

这段代码中，我们定义了一个invokeWithDefaults方法，它会检查每个参数，如果参数为null且注释了@DefaultValue，则会使用指定的默认值。

测试自定义注解

接下来，我们将创建一个包含使用这个工具的示例类：

public class Example {

    public void displayGreeting(@DefaultValue("Hello, World!") String greeting) {
        System.out.println(greeting);
    }

    public static void main(String[] args) throws Exception {
        Example example = new Example();
        ParameterUtil.invokeWithDefaults(example, "displayGreeting", null);
    }
}

在这个示例中，我们创建了一个方法displayGreeting，它的参数有一个默认值。当我们调用invokeWithDefaults方法并传入一个空的值时，它会自动填充默认值“Hello, World!”。

旅行图

在我们的代码示例背后，我们可以把这个过程看作一个旅行。以下是一个旅行图，描述了从方法调用到参数赋值的过程。

journey
    title 参数传递与默认值赋值流程
    section 方法调用
      调用openMethod : 5: 无
    section 处理参数
      检查参数是否为空 : 3: 无
      赋值默认值 : 5: 无
    section 方法执行
      执行方法 : 4: 无

序列图

下面是序列图，展示了在调用方法时参数的传递过程：

sequenceDiagram
    participant Caller as 调用者
    participant MethodUtil as 参数工具
    participant Target as 目标对象

    Caller->>MethodUtil: invokeWithDefaults()
    MethodUtil->>Target: 检查参数
    alt 参数为空
        MethodUtil->>Target: 获取默认值
    end
    MethodUtil->>Target: invoke()