如何在Jenkins中不硬编码分支名使用共享库？

问题场景 #

你在my-branch分支的Jenkinsfile里用下面的代码导入共享库类：

@Library('my-branch') _
import foo.bar.info.stuff

但创建测试分支（比如my-branch-2）后，硬编码的分支名会让Jenkinsfile还是指向原分支的共享库。你尝试用动态获取分支的方式修复：

def branch = scm.branches[0].name.with{ b -> b.substring( (b.startsWith('*/') ? 2 : 0)) }
library("${branch}")
import foo.bar.info.stuff

结果碰到“unable to resolve class”错误，就算删掉library语句也报错。

问题根源 #

Jenkins的import是脚本初始化阶段就执行的，而library()是运行时才调用的——这就导致import执行的时候，共享库还没加载，自然找不到类。另外@Library注解是编译时生效的，和运行时的library()调用时机完全不搭。

可行解决方案 #

1. 用library()返回值直接调用类（不用import） #

动态加载共享库后，通过库的返回对象直接访问类，跳过import步骤：

def branch = scm.branches[0].name.with{ b -> b.startsWith('*/') ? b.substring(2) : b }
def myLib = library("${branch}")

// 直接通过库对象实例化类
def myInstance = myLib.foo.bar.info.stuff.new()
// 调用类的方法
myInstance.someMethod()

2. 用Jenkins自带的环境变量动态指定@Library分支 #

如果是Git类型的Jenkins任务，Jenkins会自动设置BRANCH_NAME环境变量，直接用它来指定共享库分支就行：

@Library("${env.BRANCH_NAME}") _
import foo.bar.info.stuff

// 正常实例化使用
def myInstance = new stuff()

提示：多分支流水线任务里BRANCH_NAME会自动对应当前分支；普通流水线任务要确保配置里正确传递了分支名到环境变量。

3. 处理复杂分支路径（比如带refs/heads的情况） #

如果scm.branches[0].name返回的是完整路径（比如refs/heads/my-branch-2），可以用更稳妥的方式提取分支名：

def branchName = scm.branches[0].tokenize('/').last()
@Library("${branchName}") _
import foo.bar.info.stuff

注意点 #

• @Library注解必须放在脚本最顶部，不能塞到代码块或条件判断里，所以要保证分支变量在初始化阶段就能拿到。
• 动态加载的分支必须确实存在对应的共享库，不然会加载失败。
• 多分支流水线优先用env.BRANCH_NAME，这是最靠谱的方式，不用手动解析scm对象。

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