如何在Jenkins Groovy共享库中实现按参数名传参功能

你遇到的参数为空的问题是Groovy的命名参数语法规则导致的：当你使用name(age: "21", name: "Foo")这种键值对形式调用方法时，Groovy会自动把所有键值对打包为单个Map对象，作为方法的第一个入参传递。你原方法定义了2个入参，相当于调用时仅传了第一个Map类型的参数，第二个参数被默认赋值为null，因此输出的两个变量均为空。

方案1：直接修改方法接收Map参数（最简便） #

将共享库的call方法入参改为单个Map类型，直接从Map中读取对应参数即可，不需要调整你现有的命名参数调用写法：

// name.groovy 改造后的代码
def call(Map params) {
    // 可选：增加必填参数校验，避免漏传参数
    if (!params.name || !params.age) {
        throw new IllegalArgumentException("name和age为必填参数，请检查调用传参")
    }
    sh """
    echo "My name is: ${params.name}"
    echo "My age is: ${params.age}"
    """
}

改造后以下两种调用方式都可以正常运行：

• 命名参数调用（不限制顺序）：name(age: "21", name: "Foo")
• 显式Map写法：name([name: "Foo", age: "21"])

方案2：同时兼容位置传参+命名传参（无侵入改造） #

如果不想修改之前已经写好的位置传参调用代码，可以通过方法重载同时支持两种传参方式：

// name.groovy 兼容两种调用方式的代码
// 适配命名参数调用
def call(Map params) {
    call(params.name, params.age)
}

// 适配原有的位置参数调用
def call(String name, String age) {
    sh """
    echo "My name is: ${name}"
    echo "My age is: ${age}"
    """
}

改造后原有按位置传参的name("Foo", "21")和新的命名传参写法都可以正常执行，不需要调整历史流水线代码。

内容的提问来源于stack exchange，提问作者Metro