技术分享 | 跨平台API对接（Java）

深入了解测试过程中被测系统的架构与数据流，有助于理解业务逻辑，梳理业务用例以及促进部门协同。
更深的理解业务逻辑是指要分析公司是做什么的，公司的重要的商务决策是什么，公司内部数据流是怎么运行的，有哪些常见的业务场景。这也能考验对公司业务的负责程度，可以更好的去服务业务部门，为公司创造价值。

本章介绍基于 Jenkins API 调用的跨平台 API 对接。

基于Jenkins实现跨平台API对接

Jenkins 提供了远程访问应用编程接口（Remote Access API），能够通过 Http 协议远程调用相关命令操作 Jenkins 进行 Jenkins 视图、任务、插件、构建信息、任务日志信息、统计信息等，非常容易与其配合更好的完成 CI/CD 工作。
Jenkins API 总共有三种格式，分别为：

• XML API
• 可以使用 xml 方式进行 API 的使用，这种方式的优势在于可以使用强大的 xpath 特性进行相关的访问控制。如我们下文将要介绍的 Jenkins 客户端底层就是基于 XML API 实现的。
• • JSON API
• 使用 JSON 方式进行操作，因为 json 基本上已经是应用之间数据交换的准标准格式之一，这种方式比较方便 Javascript 或者和其他应用的集成。
• • Python API 可以通过 python-jenkins 库对 Jenkins 进行控制操作。此库对 Jenkins 的 API 进行了进一步的包装，使用起来更加方便，但是一般需要安装 python-jenkins，并通过 python 脚本的执行来达到集成的方式。

为什么基于Jenkins API对接

• 频繁创建 Job 时，降低手工错误的概率
• 在工作中，如果需要创建的 Jenkins 的 Job 非常多，而大多又呈现有规律的方式时，Job 的创建成为了一个繁琐而又需要频繁操作的任务。在这种场景下，使用 API 结合脚本进行自动化可以提高效率，降低手工错误的几率。
• • 满足特定条件时自动触发 Jenkins
• 如果需要动态的创建 Jenkins Job ，如根据中间结果在某个触发点自动生成，再如生成的 Job 需要使用的参数也是动态运行阶段才能取到值的场景下。
• • 基于 Jenkins 自研产品或工具
• 如果产品或工具相关的功能，需要基于 Jenkins 进行研发，而且不希望用户直接使用 Jenkins，仅将 Jenkins 作为背后的执行引擎的场景，这种情况下也需要使用 Jenkins API 才能完成。

快速开始

下面我们通过实战学习下如何将 Spring Boot 和 Jenkins 进行集成，实现跨平台 API 对接。

<dependency>
    <groupId>com.offbytwo.jenkins</groupId>
        <artifactId>jenkins-client</artifactId>
            <version>0.3.8</version>
            </dependency>

我们先引入 Jenkins-client 用于和 Jenkins 进行交互。而 Jenkins-client 的底层实现其实就是调用 Jenkins XML API 来完成操作 Jenkins 的，如下表部分示例所示。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-K6RmJC8o-1650007164295)(https://ceshiren.com/uploads/default/original/3X/3/7/377192077682f782b3648d242cfd209f6a827dce.png)]

• JenkinsHttpClient：封装了调用 JenkinsAPI 的底层方法JenkinsHttpClient(URI uri, String username, String password)
  [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wZ9yHps8-1650007165831)(https://ceshiren.com/uploads/default/original/3X/b/0/b08b56f84c375845d34af6ed1dd4f626a348c6d3.png)]

• JenkinsServer：封装了调用 JenkinsAPI 的语义级别的方法，其本质调用的是 JenkinsHttpClient 类中的方法，只是根据操作 Jenkins 的功能进行了语义级别的封装JenkinsServer(JenkinsHttpConnection client)
  [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-k6Ameflh-1650007168270)(https://ceshiren.com/uploads/default/original/3X/c/7/c7a33e689ff122553da02c461612d1f352bf713a.png)]
  [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KLzbpFG8-1650007169548)(https://ceshiren.com/uploads/default/original/3X/0/2/024fe96ccff0