首页    技术博客    PHP教程    数据库技术    前端开发   HTML5    Nginx    php论坛
新用户注册 | 会员登录
加入会员，解锁专属内容
取消
热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

Java调用JenkinsAPI获取任务构建归档文件

作者：min-章_998 | 来源：互联网 | 2023-08-30 13:17
基础API示例移步另一篇文章1、什么是JenkinsAPI2、JenkinsAPI分类①、JSONAPI②、XMLAPI③、PythonAPI④、其他3、使用Java调用Jenk

基础API示例移步另一篇文章

1、什么是Jenkins API
2、Jenkins API分类
①、JSON API
②、XML API
③、Python API
④、其他
3、使用Java调用Jenkins API
①、View
Ⅰ、创建View
Ⅱ、获取View
Ⅲ、获取View配置 XML 信息
Ⅳ、更新View
Ⅴ、删除View
②、Job
Ⅰ、创建Job
Ⅱ、更新Job
Ⅲ、获取Job基本信息
Ⅳ、获取Maven Job信息
Ⅴ、获取Job列表
Ⅵ、根据View名称获取Job列表
Ⅶ、查看Job XML信息
Ⅷ、无参数 Job build
Ⅸ、有参构建
Ⅹ、停止最后构建的 Job Build
ⅩⅠ、禁用 Job
ⅩⅡ、启用Job
ⅩⅢ、删除 Job
③、编译
Ⅰ、获取Build基本信息
Ⅱ、获取 Job 最后的 Build
Ⅲ、获取 Job 首次 Build
Ⅳ、根据 Job Build 编号获取编译信息
Ⅴ、获取全部 Job Build列表
Ⅵ、获取 Job 一定范围的 Build 列表
Ⅶ、获取Build详细信息
Ⅷ、获取 Build Log 日志信息
Ⅸ、获取正在执行构建任务的日志信息
④、其他
Ⅰ、获取主机信息
Ⅱ、重启Jenkins
Ⅲ、安全重启Jenkins
Ⅳ、安全结束Jenkins
Ⅴ、关闭连接
Ⅵ、根据 Label 查找代理节点信息
Ⅶ、判断Jenkins是否运行
Ⅷ、获取 Jenkins 插件信息
4、问题处理
①、HttpResponseException: Forbidden
Ⅰ、关闭跨域保护&＃xff08;高版本&＃xff09;
Ⅱ、携带Token建立连接

1、什么是Jenkins API
Jenkins 远程 API 能够通过 Http 协议远程调用相关命令操作 Jenkins 进行 Jenkins 视图、任务、插件、构建信息、任务日志信息、统计信息等&＃xff0c;非常容易与其配合更好的完成 CI/CD 工作

2、Jenkins API分类
①、JSON API
浏览器打开http://JenkinsURL/api/json

格式化如下

{"_class":"hudson.model.Hudson","assignedLabels":[{"name":"master"}],"mode":"NORMAL","nodeDescription":"the master Jenkins node","nodeName":"","numExecutors":2,"description":null,"jobs":[{"_class":"hudson.maven.MavenModuleSet","name":"CenterServer","url":"http://192.168.225.130/job/CenterServer/","color":"blue"},{"_class":"hudson.maven.MavenModuleSet","name":"HelloWorld","url":"http://192.168.225.130/job/HelloWorld/","color":"blue"},{"_class":"hudson.maven.MavenModuleSet","name":"PMServer","url":"http://192.168.225.130/job/PMServer/","color":"blue"}],"overallLoad":{},"primaryView":{"_class":"hudson.model.AllView","name":"all","url":"http://192.168.225.130/"},"quietDownReason":null,"quietingDown":false,"slaveAgentPort":-1,"unlabeledLoad":{"_class":"jenkins.model.UnlabeledLoadStatistics"},"url":"http://192.168.225.130/","useCrumbs":true,"useSecurity":true,"views":[{"_class":"hudson.model.AllView","name":"all","url":"http://192.168.225.130/"}]
}



②、XML API
浏览器打开http://JenkinsURL/api/xml

masterNORMALthe master Jenkins node2CenterServerhttp://192.168.225.130/job/CenterServer/blueHelloWorldhttp://192.168.225.130/job/HelloWorld/bluePMServerhttp://192.168.225.130/job/PMServer/blueallhttp://192.168.225.130/false-1http://192.168.225.130/truetrueallhttp://192.168.225.130/



③、Python API
浏览器打开http://JenkinsURL/api/python

格式化如下

{"_class":"hudson.model.Hudson","assignedLabels":[{"name":"master"}],"mode":"NORMAL","nodeDescription":"the master Jenkins node","nodeName":"","numExecutors":2,"description":None,"jobs":[{"_class":"hudson.maven.MavenModuleSet","name":"CenterServer","url":"http://192.168.225.130/job/CenterServer/","color":"blue"},{"_class":"hudson.maven.MavenModuleSet","name":"HelloWorld","url":"http://192.168.225.130/job/HelloWorld/","color":"blue"},{"_class":"hudson.maven.MavenModuleSet","name":"PMServer","url":"http://192.168.225.130/job/PMServer/","color":"blue"}],"overallLoad":{},"primaryView":{"_class":"hudson.model.AllView","name":"all","url":"http://192.168.225.130/"},"quietDownReason":None,"quietingDown":False,"slaveAgentPort":-1,"unlabeledLoad":{"_class":"jenkins.model.UnlabeledLoadStatistics"},"url":"http://192.168.225.130/","useCrumbs":True,"useSecurity":True,"views":[{"_class":"hudson.model.AllView","name":"all","url":"http://192.168.225.130/"}]
}


④、其他
根据以上三种API查询出来的信息中出现了几个任务的url如http://192.168.225.130/job/HelloWorld/&＃xff0c;可以在在后面追加/api/xml访问查看对应Job的构建记录

根据提供了若干构建记录还可以查看构建的详细信息&＃xff0c;直接访问提供的url即可http://192.168.225.130/job/helloworld/11/

3、使用Java调用Jenkins API
创建一个Jenkins API Demo工程

导入依赖

com.offbytwo.jenkinsjenkins-client0.3.8



创建Jenkins链接工具类JenkinsConnectFactory

package com.phz.jenkins_api_demo.factory;import com.offbytwo.jenkins.JenkinsServer;
import com.offbytwo.jenkins.client.JenkinsHttpClient;import java.net.URI;
import java.net.URISyntaxException;/*** &＃64;author PengHuAnZhi* &＃64;ProjectName Jenkins API Demo* &＃64;Description Jenkins连接工具类* &＃64;time 2021/10/8 14:33*/
public class JenkinsConnectFactory {static final String JENKINS_URL &＃61; "http://192.168.225.130";static final String JENKINS_USERNAME &＃61; "PengHuanZhi";static final String JENKINS_PASSWORD &＃61; "123456789";private static JenkinsHttpClient jenkinsHttpClient &＃61; null;private static JenkinsServer jenkinsServer &＃61; null;public static JenkinsHttpClient getClientInstance() {if (jenkinsHttpClient &＃61;&＃61; null) {try {jenkinsHttpClient &＃61; new JenkinsHttpClient(new URI(JENKINS_URL, JENKINS_USERNAME, JENKINS_PASSWORD), "PengHuanZhi", "11622ce96b51846c8658a6390253d87f7e");} catch (URISyntaxException e) {e.printStackTrace();}}return jenkinsHttpClient;}public static JenkinsServer getConnection() {if (jenkinsServer &＃61;&＃61; null) {try {jenkinsServer &＃61; new JenkinsServer(new URI(JENKINS_URL, JENKINS_USERNAME, JENKINS_PASSWORD), "PengHuanZhi", "11622ce96b51846c8658a6390253d87f7e");} catch (URISyntaxException e) {e.printStackTrace();}}return jenkinsServer;}
}


①、View
Ⅰ、创建View

/*** &＃64;description 创建View* &＃64;author PengHuAnZhi* &＃64;date 2021/10/8 17:20*/
public void createView() {try {// 创建一个 xml 字符串&＃xff0c;里面设置一个 view 描述信息String xml &＃61; "\n" &＃43;"用于测试的视图\n" &＃43;"";JenkinsConnectFactory.getConnection().createView("test-view", xml);} catch (IOException e) {e.printStackTrace();}
}


Ⅱ、获取View
 

/*** &＃64;description 获取视图基本信息* &＃64;author PengHuAnZhi* &＃64;date 2021/10/8 17:20*/
public void getView() {try {// 视图名String viewName &＃61; "test-view";// 获取视图基本信息View view &＃61; JenkinsConnectFactory.getConnection().getView(viewName);System.out.println(view.getName());System.out.println(view.getUrl());System.out.println(view.getDescription());// 获取视图xml信息String viewXml &＃61; JenkinsConnectFactory.getClientInstance().get("/view/" &＃43; viewName &＃43; "/api/xml");System.out.println(viewXml);} catch (IOException e) {e.printStackTrace();}
}


Ⅲ、获取View配置 XML 信息

/*** &＃64;description 获取视图基本信息* &＃64;author PengHuAnZhi* &＃64;date 2021/10/8 17:20*/
public void getViewConfig() {try {// 视图名String viewName &＃61; "test-view";// 获取视图配置xml信息String viewConfigXml &＃61; JenkinsConnectFactory.getClientInstance().get("/view/" &＃43; viewName &＃43; "/config.xml");System.out.println(viewConfigXml);} catch (IOException e) {e.printStackTrace();}
}


Ⅳ、更新View

/*** &＃64;description 更新视图信息* &＃64;author PengHuAnZhi* &＃64;date 2021/10/8 17:20*/
public void updateView() {try {// 创建一个 xml 字符串&＃xff0c;里面设置一个要修改的某些字段,具体xml可以到jenkins查看// 例如&＃xff0c;下面xml文件是从地址&＃xff1a;https://Jenkins-IP/jenkins/view/test-view/config.xml 获取的String xml &＃61; "\n" &＃43;"test-view\n" &＃43;"用于测试的视图1111\n" &＃43;"false\n" &＃43;"false\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"\n" &＃43;"false\n" &＃43;"";JenkinsConnectFactory.getConnection().updateView("test-view", xml);} catch (IOException e) {e.printStackTrace();}
}


 


Ⅴ、删除View

/*** &＃64;description 删除视图* &＃64;author PengHuAnZhi* &＃64;date 2021/10/8 17:20*/
public void deleteView() {try {String viewName &＃61; "test-view";JenkinsConnectFactory.getClientInstance().post("/view/" &＃43; viewName &＃43; "/doDelete");} catch (IOException e) {e.printStackTrace();}
}


②、Job
Ⅰ、创建Job

/*** &＃64;description 创建Job* &＃64;author PengHuAnZhi* &＃64;date 2021/10/8 17:20*/
public void createJob() {try {/**创建一个流水线任务&＃xff0c;且设置一个简单的脚本**/// 创建 Pipeline 脚本String script &＃61; "node(){ \n" &＃43;"echo &＃39;hello world!&＃39; \n" &＃43;"}";// xml配置文件&＃xff0c;且将脚本加入到配置中String xml &＃61; "\n" &＃43;"测试项目\n" &＃43;"\n" &＃43;"\n" &＃43;"true\n" &＃43;"\n" &＃43;"";// 创建 JobJenkinsConnectFactory.getConnection().createJob("test-job", xml);} catch (IOException e) {e.printStackTrace();}
}


 

Ⅱ、更新Job
/**
 * &＃64;description 更新Job 更改之前创建的无参数Job&＃xff0c;更改其为参数Job
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void updateJob() {
    try {
        /**
         * 更改一个流水线任务&＃xff0c;让一个无参数的任务变成带参数任务
         */
        // 创建 Pipeline 脚本&＃xff0c;用一个key变量
        String script &＃61; "node(){ \n" &＃43;
                "echo \"${key}\" \n" &＃43;
                "}";
        // xml配置文件&＃xff0c;且将脚本加入到配置中
        String xml &＃61; "\n" &＃43;
                "\n" &＃43;
                "测试项目\n" &＃43;
                "false\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "key\n" &＃43;
                "用于测试的字符变量\n" &＃43;
                "hello\n" &＃43;
                "false\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "\n" &＃43;
                "true\n" &＃43;
                "\n" &＃43;
                "false\n" &＃43;
                "";
        // 创建 Job
        JenkinsConnectFactory.getConnection().updateJob("test-job", xml);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅲ、获取Job基本信息
/**
 * &＃64;description 获取 Job 基本信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJob() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 获取 Job 名称
        System.out.println(job.getName());
        // 获取 Job URL
        System.out.println(job.getUrl());
        // 获取 Job 下一个 build 编号
        System.out.println(job.getNextBuildNumber());
        // 获取 Job 显示的名称
        System.out.println(job.getDisplayName());
        // 输出 Job 描述信息
        System.out.println(job.getDescription());
        // 获取 Job 下游任务列表
        System.out.println(job.getDownstreamProjects());
        // 获取 Job 上游任务列表
        System.out.println(job.getUpstreamProjects());
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅳ、获取Maven Job信息
/**
 * &＃64;description 获取 Maven Job 信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getMavenJob() {
    try {
        // 获取 Job 信息
        MavenJobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getMavenJob("HelloWorld");
        // 获取 Job 名称
        System.out.println(job.getName());
        // 获取 Job URL
        System.out.println(job.getUrl());
        // 获取 Job 下一个 build 编号
        System.out.println(job.getNextBuildNumber());
        // 获取 Job 显示的名称
        System.out.println(job.getDisplayName());
        // 获取 Job 下游任务列表
        System.out.println(job.getDownstreamProjects());
        // 获取 Job 上游任务列表
        System.out.println(job.getUpstreamProjects());
    } catch (IOException e) {
        e.printStackTrace();
    }
}
\


Ⅴ、获取Job列表
/**
 * &＃64;description 获取 Job 列表
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobList() {
    try {
        // 获取 Job 列表
        Map jobs &＃61; JenkinsConnectFactory.getConnection().getJobs();
        for (Job job : jobs.values()) {
            System.out.println(job.getName());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅵ、根据View名称获取Job列表
/**
 * &＃64;description 根据 View 名称获取 Job 列表
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobListByView() {
    try {
        // 获取 Job 列表
        Map jobs &＃61; JenkinsConnectFactory.getConnection().getJobs("all");
        for (Job job : jobs.values()) {
            System.out.println(job.getName());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅶ、查看Job XML信息
/**
 * &＃64;description 查看 Job 配置信息&＃xff08;XML&＃xff09;
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobConfig() {
    try {
        String xml &＃61; JenkinsConnectFactory.getConnection().getJobXml("test-job");
        System.out.println(xml);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅷ、无参数 Job build
因为修改过本Job为有参Job&＃xff0c;这里测试还需更改为无参job

/**
 * &＃64;description 执行无参数 Job build
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void buildJob() {
    try {
        JenkinsConnectFactory.getConnection().getJob("test-job").build();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

Ⅸ、有参构建
/**
 * &＃64;description 执行带参数 Job build
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void buildParamJob() {
    try {
        /**
         * 例如&＃xff0c;现有一个job&＃xff0c;拥有一个字符参数"key"
         * 现在对这个值进行设置&＃xff0c;然后执行一个输出这个值的脚本
         */
        // 设置参数值
        Map param &＃61; new HashMap<>();
        param.put("key", "hello world!");
        // 执行 build 任务
        JenkinsConnectFactory.getConnection().getJob("test-job").build(param);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅹ、停止最后构建的 Job Build
/**
 * &＃64;description 停止最后构建的 Job Build
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void stopLastJobBuild() {
    try {
        // 获取最后的 build 信息
        Build build &＃61; JenkinsConnectFactory.getConnection().getJob("HelloWorld").getLastBuild();
        // 停止最后的 build
        build.Stop();
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


ⅩⅠ、禁用 Job
/**
 * &＃64;description 禁用 Job
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void disableJob() {
    try {
        JenkinsConnectFactory.getConnection().disableJob("test-job");
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


ⅩⅡ、启用Job
/**
 * 启用 Job
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void enableJob() {
    try {
        JenkinsConnectFactory.getConnection().enableJob("test-job");
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


ⅩⅢ、删除 Job
/**
 * &＃64;description 删除 Job
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void deleteJob() {
    try {
        JenkinsConnectFactory.getConnection().deleteJob("test-job");
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


③、编译
Ⅰ、获取Build基本信息
/**
 * &＃64;param build build对象
 * &＃64;description 将Build内部信息打印
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
private void printBuild(Build build) throws IOException {
    System.out.println(build.getNumber());
    System.out.println(build.getUrl());
    System.out.println(build.getQueueId());
}

Ⅱ、获取 Job 最后的 Build
/**
 * &＃64;description 获取 Job 最后的 Build
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobLastBuild() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 获得最后编译信息
        Build lastBuild &＃61; job.getLastBuild();
        printBuild(lastBuild);
        // 获取最后成功的编译信息
        Build lastSuccessfulBuild &＃61; job.getLastSuccessfulBuild();
        printBuild(lastSuccessfulBuild);
        // 获取最后事变的编译信息
        Build lastFailedBuild &＃61; job.getLastFailedBuild();
        printBuild(lastFailedBuild);
        // 获取最后完成的编译信息
        Build lastCompletedBuild &＃61; job.getLastCompletedBuild();
        printBuild(lastCompletedBuild);
        // 获取最后稳定的编译信息
        Build lastStableBuild &＃61; job.getLastStableBuild();
        printBuild(lastStableBuild);
        // 获取最后不稳定的编译信息
        Build lastUnstableBuild &＃61; job.getLastUnstableBuild();
        printBuild(lastUnstableBuild);
        // 获取最后未成功的编译信息
        Build lastUnsuccessfulBuild &＃61; job.getLastUnsuccessfulBuild();
        printBuild(lastUnsuccessfulBuild);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅲ、获取 Job 首次 Build
/**
 * &＃64;description 获取 Job 首次 Build
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobFirstBuild() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 获得首次编译信息
        Build firstBuild &＃61; job.getFirstBuild();
        printBuild(firstBuild);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅳ、根据 Job Build 编号获取编译信息
/**
 * &＃64;description 根据 Job Build 编号获取编译信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobByNumber() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 根据
        Build numberBuild &＃61; job.getBuildByNumber(1);
        printBuild(numberBuild);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅴ、获取全部 Job Build列表
/**
 * &＃64;description 获取全部 Job Build列表
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobBuildListAll() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 获取全部 Build 信息
        List builds &＃61; job.getAllBuilds();
        for (Build build : builds) {
            System.out.println(build.getNumber());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅵ、获取 Job 一定范围的 Build 列表
/**
 * &＃64;description 获取 Job 一定范围的 Build 列表
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobBuildListRange() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 设定范围
        Range range &＃61; Range.build().from(0).to(2);
        System.err.println(range.getRangeString());
        // 获取一定范围的 Build 信息
        List builds &＃61; job.getAllBuilds(range);
        for (Build build : builds) {
            System.out.println(build.getNumber());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅶ、获取Build详细信息
/**
 * &＃64;description 获取 Build 详细信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobBuildDetailInfo() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 这里用最后一次编译来示例
        BuildWithDetails build &＃61; job.getLastBuild().details();
        // 获取构建的显示名称
        System.out.println(build.getDisplayName());
        // 获取构建的参数信息
        System.out.println(build.getParameters());
        // 获取构建编号
        System.out.println(build.getNumber());
        // 获取构建结果&＃xff0c;如果构建未完成则会显示为null
        System.out.println(build.getResult());
        // 获取执行构建的活动信息
        System.out.println(build.getActions());
        // 获取构建持续多少时间(ms)
        System.out.println(build.getDuration());
        // 获取构建开始时间戳
        System.out.println(build.getTimestamp());
        // 获取构建头信息&＃xff0c;里面包含构建的用户&＃xff0c;上游信息&＃xff0c;时间戳等
        List buildCauses &＃61; build.getCauses();
        for (BuildCause bc : buildCauses) {
            System.out.println(bc.getUserId());
            System.out.println(bc.getShortDescription());
            System.out.println(bc.getUpstreamBuild());
            System.out.println(bc.getUpstreamProject());
            System.out.println(bc.getUpstreamUrl());
            System.out.println(bc.getUserName());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅷ、获取 Build Log 日志信息
/**
 * &＃64;description 获取 Build Log 日志信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getJobBuildLog() {
    try {
        // 获取 Job 信息
        JobWithDetails job &＃61; JenkinsConnectFactory.getConnection().getJob("test-job");
        // 这里用最后一次编译来示例
        BuildWithDetails build &＃61; job.getLastBuild().details();
        // 获取构建的日志&＃xff0c;如果正在执行构建&＃xff0c;则会只获取已经执行的过程日志

        // Text格式日志
        System.out.println(build.getConsoleOutputText());
        // Html格式日志
        System.out.println(build.getConsoleOutputHtml());

        // 获取部分日志,一般用于正在执行构建的任务
        ConsoleLog consoleLog &＃61; build.getConsoleOutputText(0);
        // 获取当前日志大小
        System.out.println(consoleLog.getCurrentBufferSize());
        // 是否已经构建完成&＃xff0c;还有更多日志信息
        System.out.println(consoleLog.getHasMoreData());
        // 获取当前截取的日志信息
        System.out.println(consoleLog.getConsoleLog());
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅸ、获取正在执行构建任务的日志信息
/**
 * &＃64;description 获取正在执行构建任务的日志信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getBuildActiveLog() {
    try {
        // 这里用最后一次编译来示例
        BuildWithDetails build &＃61; JenkinsConnectFactory.getConnection().getJob("test-job").getLastBuild().details();
        // 当前日志
        ConsoleLog currentLog &＃61; build.getConsoleOutputText(0);
        // 输出当前获取日志信息
        System.out.println(currentLog.getConsoleLog());
        // 检测是否还有更多日志,如果是则继续循环获取
        while (currentLog.getHasMoreData()) {
            // 获取最新日志信息
            ConsoleLog newLog &＃61; build.getConsoleOutputText(currentLog.getCurrentBufferSize());
            // 输出最新日志
            System.out.println(newLog.getConsoleLog());
            currentLog &＃61; newLog;
            // 睡眠1s
            Thread.sleep(1000);
        }
    } catch (IOException | InterruptedException e) {
        e.printStackTrace();
    }
}
\


④、其他
Ⅰ、获取主机信息
/**
 * &＃64;description 获取主机信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getComputerInfo() {
    try {
        Map map &＃61; JenkinsConnectFactory.getConnection().getComputers();
        for (Computer computer : map.values()) {
            // 获取当前节点-节点名称
            System.out.println(computer.details().getDisplayName());
            // 获取当前节点-执行者数量
            System.out.println(computer.details().getNumExecutors());
            // 获取当前节点-执行者详细信息
            List executorList &＃61; computer.details().getExecutors();
            // 查看当前节点-是否脱机
            System.out.println(computer.details().getOffline());
            // 获得节点的全部统计信息
            LoadStatistics loadStatistics &＃61; computer.details().getLoadStatistics();
            // 获取节点的-监控数据
            Map monitorData &＃61; computer.details().getMonitorData();
            //......
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅱ、重启Jenkins
/**
 * &＃64;description 重启 Jenkins
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void restart() {
    try {
        JenkinsConnectFactory.getConnection().restart(true);
    } catch (IOException e) {
        e.printStackTrace();
    }
}

Ⅲ、安全重启Jenkins
/**
 * &＃64;description 安全重启 Jenkins
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void safeRestart() {
    try {
        JenkinsConnectFactory.getConnection().safeRestart(true);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
Ⅳ、安全结束Jenkins
/**
 * &＃64;description 安全结束 Jenkins
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void safeExit() {
    try {
        JenkinsConnectFactory.getConnection().safeExit(true);
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅴ、关闭连接
/**
 * &＃64;description 关闭 Jenkins 连接
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void close() {
    JenkinsConnectFactory.getConnection().close();
}

Ⅵ、根据 Label 查找代理节点信息
/**
 * &＃64;description 根据 Label 查找代理节点信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getLabelNodeInfo() {
    try {
        LabelWithDetails labelWithDetails &＃61; JenkinsConnectFactory.getConnection().getLabel("jnlp-agent");
        // 获取标签名称
        System.out.println(labelWithDetails.getName());
        // 获取 Cloud 信息
        System.out.println(labelWithDetails.getClouds());
        // 获取节点信息
        System.out.println(labelWithDetails.getNodeName());
        // 获取关联的 Job
        System.out.println(labelWithDetails.getTiedJobs());
        // 获取参数列表
        System.out.println(labelWithDetails.getPropertiesList());
        // 是否脱机
        System.out.println(labelWithDetails.getOffline());
        // 获取描述信息
        System.out.println(labelWithDetails.getDescription());
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


Ⅶ、判断Jenkins是否运行
/**
 * &＃64;description 判断 Jenkins 是否运行
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void isRunning() {
    boolean isRunning &＃61; JenkinsConnectFactory.getConnection().isRunning();
    System.out.println(isRunning);
}
 


Ⅷ、获取 Jenkins 插件信息
/**
 * &＃64;description 获取 Jenkins 插件信息
 * &＃64;author PengHuAnZhi
 * &＃64;date 2021/10/8 17:20
 */
public void getPluginInfo() {
    try {
        PluginManager pluginManager &＃61; JenkinsConnectFactory.getConnection().getPluginManager();
        // 获取插件列表
        List plugins &＃61; pluginManager.getPlugins();
        for (Plugin plugin : plugins) {
            // 插件 wiki URL 地址
            System.out.println(plugin.getUrl());
            // 版本号
            System.out.println(plugin.getVersion());
            // 简称
            System.out.println(plugin.getShortName());
            // 完整名称
            System.out.println(plugin.getLongName());
            // 是否支持动态加载
            System.out.println(plugin.getSupportsDynamicLoad());
            // 插件依赖的组件
            System.out.println(plugin.getDependencies());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}
 


4、问题处理
①、HttpResponseException: Forbidden
这种跨域问题有两种处理办法&＃xff0c;第一种就是关闭Jenkins的跨域保护

Ⅰ、关闭跨域保护&＃xff08;高版本&＃xff09;
笔者Jenkins服务放在了一台CentOS8虚拟机中

vim /etc/sysconfig/jenkins
1
找到JENKINS_JAVA_OPTIONS配置

在后面追加如下内容

-Dhudson.security.csrf.GlobalCrumbIssuerConfiguration.DISABLE_CSRF_PROTECTION&＃61;true
1


保存退出重启Jenkins服务

systemctl restart jenkins.service 
1
查看配置生效

Ⅱ、携带Token建立连接
进入用户管理页面&＃xff0c;新增一个Token

在创建JenkinsHttpClient和JenkinsServer的时候添加该Token&＃xff0c;如下

                jenkinsHttpClient &＃61; new JenkinsHttpClient(new URI(JENKINS_URL, JENKINS_USERNAME, JENKINS_PASSWORD), "PengHuanZhi", "11622ce96b51846c8658a6390253d87f7e");
                jenkinsServer &＃61; new JenkinsServer(new URI(JENKINS_URL, JENKINS_USERNAME, JENKINS_PASSWORD), "PengHuanZhi", "11622ce96b51846c8658a6390253d87f7e");


准备工作

/*** &＃64;author PengHuAnZhi* &＃64;ProjectName Jenkins API Demo* &＃64;Description Jenkins连接工具类* &＃64;time 2021/10/8 14:33*/
public class JenkinsConnectFactory {private static final String JENKINS_URL &＃61; "http://192.168.225.130";private static final String JENKINS_USERNAME &＃61; "PengHuanZhi";static final String JENKINS_PASSWORD &＃61; "123456789";private static JenkinsHttpClient jenkinsHttpClient &＃61; null;private static JenkinsServer jenkinsServer &＃61; null;public static JenkinsHttpClient getClientInstance() {if (jenkinsHttpClient &＃61;&＃61; null) {try {jenkinsHttpClient &＃61; new JenkinsHttpClient(new URI(JENKINS_URL, JENKINS_USERNAME, JENKINS_PASSWORD), JENKINS_USERNAME, "11622ce96b51846c8658a6390253d87f7e");} catch (URISyntaxException e) {e.printStackTrace();}}return jenkinsHttpClient;}public static JenkinsServer getConnection() {if (jenkinsServer &＃61;&＃61; null) {try {jenkinsServer &＃61; new JenkinsServer(new URI(JENKINS_URL, JENKINS_USERNAME, JENKINS_PASSWORD), JENKINS_USERNAME, "11622ce96b51846c8658a6390253d87f7e");} catch (URISyntaxException e) {e.printStackTrace();}}return jenkinsServer;}
}

private final JenkinsServer server &＃61; JenkinsConnectFactory.getConnection();
private final JenkinsHttpClient client &＃61; JenkinsConnectFactory.getClientInstance();
获取非Maven项目构建后生成的Artifact文件

/*** &＃64;param jobName 任务名称* &＃64;param buildNumber 构建号* &＃64;description 根据任务名称获取其某次构建产生的文件* &＃64;author PengHuAnZhi* &＃64;date 2021/10/13 10:27*/
public void getJobBuildArtifact(String jobName, Integer buildNumber) {try {JobWithDetails job &＃61; server.getJob(jobName);List builds &＃61; job.getBuilds().stream().filter(build -> build.getNumber() &＃61;&＃61; buildNumber).collect(Collectors.toList());Build build;if (builds.size() !&＃61; 1) {throw new Exception("获取构建出错");} else {build &＃61; builds.get(0);}List artifacts &＃61; build.details().getArtifacts();Artifact artifact &＃61; artifacts.get(0);InputStream inputStream &＃61; build.details().downloadArtifact(artifact);String fileName &＃61; artifact.getFileName();File file &＃61; new File("C:\\Users\\Administrator\\Desktop\\" &＃43; fileName);//当前模拟的是一个txt文件&＃xff0c;所以直接用高级字符流输出到文件了&＃xff0c;对于文件类型不确定一般使用字节流好点吧我觉得BufferedReader reader &＃61; new BufferedReader(new InputStreamReader(inputStream));BufferedWriter writer &＃61; new BufferedWriter(new FileWriter(file));String str &＃61; reader.readLine();while (str !&＃61; null) {writer.write(str);str &＃61; reader.readLine();}inputStream.close();reader.close();writer.close();} catch (Exception e) {e.printStackTrace();}
}
获取Maven项目构建后自动归集至Module Builds列表中的Artifact文件

/*** &＃64;param jobName 任务名称* &＃64;param buildNumber 构建号* &＃64;description Maven和普通项目不同&＃xff0c;构建产生的文件输出位置为当前module列表下* &＃64;author PengHuAnZhi* &＃64;date 2021/10/13 15:11*/
public void getMavenJobBuildArtifact(String jobName, Integer buildNumber) {try {MavenJobWithDetails mavenJob &＃61; server.getMavenJob(jobName);MavenBuild mavenBuild;List builds &＃61; mavenJob.getBuilds().stream().filter(build -> build.getNumber() &＃61;&＃61; buildNumber).collect(Collectors.toList());if (builds.size() !&＃61; 1) {throw new Exception("获取构建出错");} else {mavenBuild &＃61; builds.get(0);}MavenModule mavenModule &＃61; mavenBuild.getMavenModule();List moduleRecords &＃61; mavenModule.getModuleRecords();for (MavenModuleRecord record : moduleRecords) {MavenArtifact mainArtifact &＃61; record.getMainArtifact();//URL拼接String urlPath &＃61; record.getUrl().replace("mavenArtifacts", "artifact") &＃43; mainArtifact.getGroupId() &＃43; "/" &＃43; mainArtifact.getArtifactId() &＃43; "/" &＃43; mainArtifact.getVersion() &＃43; "/" &＃43; mainArtifact.getCanonicalName();URI uri &＃61; new URI(urlPath);InputStream inputStream &＃61; client.getFile(uri);File file &＃61; new File("C:\\Users\\Administrator\\Desktop\\" &＃43; mainArtifact.getCanonicalName());byte[] buffer &＃61; new byte[inputStream.available()];FileOutputStream outputStream &＃61; new FileOutputStream(file);int ch;while ((ch &＃61; inputStream.read(buffer)) !&＃61; -1) {outputStream.write(buffer, 0, ch);}inputStream.close();outputStream.close();}} catch (Exception e) {e.printStackTrace();}
}


推荐阅读
author-avatar
min-章_998
这个家伙很懒，什么也没留下！
Tags | 热门标签
RankList | 热门文章
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有