如何在Jenkins中捕获REST请求体？

Jenkins支持通过REST请求体传递数据，你可以用POST请求将带特殊字符的长字符串放入请求体内，再在流水线中读取并解析。以下是具体实现步骤：

一、构造触发请求 #

使用POST请求调用Jenkins流水线的构建接口，将长字符串放入请求体（推荐用JSON格式方便后续解析）。示例curl命令：

curl -X POST \
  -H "Authorization: Bearer YOUR_JENKINS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "longContent": "这里是包含特殊字符的超长字符串..."
  }' \
  http://your-jenkins-server/job/your-pipeline-name/build

二、在流水线中读取请求体 #

通过Jenkins内置对象和API获取请求体内容，以下是两种常见实现方式：

1. 获取原始请求体 #

利用RemoteCause类获取完整请求体（首次运行需完成脚本权限审批）：

pipeline {
    agent any
    stages {
        stage('读取请求体') {
            steps {
                script {
                    def remoteCause = currentBuild.rawBuild.getCause(hudson.model.Cause.RemoteCause)
                    if (remoteCause) {
                        def rawBody = remoteCause.requestBody
                        echo "原始请求体内容: ${rawBody}"
                    }
                }
            }
        }
    }
}

2. 解析JSON格式请求体 #

如果请求体是JSON结构，结合readJSON步骤直接解析为可操作的对象：

pipeline {
    agent any
    stages {
        stage('解析请求体') {
            steps {
                script {
                    def remoteCause = currentBuild.rawBuild.getCause(hudson.model.Cause.RemoteCause)
                    if (remoteCause) {
                        def bodyObj = readJSON text: remoteCause.requestBody
                        echo "提取的长字符串: ${bodyObj.longContent}"
                        // 后续可直接使用bodyObj.longContent进行业务处理
                    }
                }
            }
        }
    }
}

三、关键注意事项 #

• 脚本权限审批：首次运行流水线时，Jenkins会提示需要审批currentBuild.rawBuild.getCause等方法，前往Manage Jenkins > In-process Script Approval完成审批即可。
• 请求头设置：必须指定正确的Content-Type（如application/json），否则Jenkins可能无法正确识别请求体格式。
• 适用场景：请求体方式是处理超长、带特殊字符参数的最优方案，避免了URL参数编码的繁琐问题。

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