跳到主要内容

Jenkins 插件架构

Jenkins是一个高度可扩展的持续集成和持续交付（CI/CD）工具，其核心功能可以通过插件进行扩展。Jenkins插件是Jenkins生态系统的核心组成部分，它们允许用户根据需求定制和增强Jenkins的功能。本文将详细介绍Jenkins插件的架构，帮助你理解如何设计和开发自定义插件。

什么是Jenkins插件？​

Jenkins插件是一个独立的模块，用于扩展Jenkins的功能。插件可以添加新的构建步骤、触发器、用户界面元素、报告工具等。Jenkins插件通常以.hpi或.jpi文件的形式分发，并可以通过Jenkins的插件管理器进行安装和管理。

Jenkins 插件的基本架构​

Jenkins插件的架构主要由以下几个部分组成：

  1. 插件描述文件（pom.xml）：用于定义插件的元数据、依赖项和构建配置。
  2. 插件入口点（src/main/java）：包含插件的Java代码，定义了插件的核心逻辑。
  3. 资源文件（src/main/resources）：包含插件的配置文件、UI模板、图标等资源。
  4. 测试代码（src/test/java）：包含插件的单元测试和集成测试代码。

插件描述文件（pom.xml）​

pom.xml是Maven项目的配置文件，用于定义插件的元数据、依赖项和构建配置。以下是一个简单的pom.xml示例：

xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.jenkins-ci.plugins</groupId>
        <artifactId>plugin</artifactId>
        <version>4.40</version>
    </parent>
    <groupId>com.example</groupId>
    <artifactId>my-jenkins-plugin</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>hpi</packaging>
    <name>My Jenkins Plugin</name>
    <description>A simple Jenkins plugin example.</description>
    <dependencies>
        <dependency>
            <groupId>org.jenkins-ci.plugins</groupId>
            <artifactId>credentials</artifactId>
            <version>2.3.0</version>
        </dependency>
    </dependencies>
</project>

插件入口点（src/main/java）​

插件的核心逻辑通常定义在src/main/java目录下的Java类中。以下是一个简单的插件示例，它添加了一个新的构建步骤：

java
package com.example.myjenkinsplugin;

import hudson.Extension;
import hudson.Launcher;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.BuildListener;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.Builder;
import hudson.tasks.Publisher;
import org.kohsuke.stapler.DataBoundConstructor;

public class MyBuilder extends Builder {

    private final String name;

    @DataBoundConstructor
    public MyBuilder(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    @Override
    public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) {
        listener.getLogger().println("Hello, " + name + "!");
        return true;
    }

    @Extension
    public static final class DescriptorImpl extends BuildStepDescriptor<Builder> {

        @Override
        public boolean isApplicable(Class<? extends AbstractProject> jobType) {
            return true;
        }

        @Override
        public String getDisplayName() {
            return "Say Hello";
        }
    }
}

资源文件（src/main/resources）​

资源文件通常包括插件的配置文件、UI模板、图标等。以下是一个简单的config.jelly文件示例，用于定义插件的用户界面：

xml
<?jelly escape-by-default='true'?>
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
    <f:entry title="Name" field="name">
        <f:textbox />
    </f:entry>
</j:jelly>

测试代码（src/test/java）​

测试代码用于验证插件的功能。以下是一个简单的单元测试示例：

java
package com.example.myjenkinsplugin;

import hudson.model.FreeStyleBuild;
import hudson.model.FreeStyleProject;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.JenkinsRule;

import static org.junit.Assert.assertTrue;

public class MyBuilderTest {

    @Rule
    public JenkinsRule jenkins = new JenkinsRule();

    @Test
    public void testPerform() throws Exception {
        FreeStyleProject project = jenkins.createFreeStyleProject();
        project.getBuildersList().add(new MyBuilder("World"));
        FreeStyleBuild build = project.scheduleBuild2(0).get();
        assertTrue(build.getLog().contains("Hello, World!"));
    }
}

实际案例​

假设我们想要开发一个插件，用于在构建过程中打印自定义消息。我们可以按照以下步骤进行开发：

  1. 创建一个新的Maven项目，并配置pom.xml。
  2. 在src/main/java目录下创建MyBuilder类，实现Builder接口。
  3. 在src/main/resources目录下创建config.jelly文件，定义插件的用户界面。
  4. 在src/test/java目录下创建MyBuilderTest类，编写单元测试。

总结​

Jenkins插件架构是Jenkins扩展性的核心。通过理解插件的基本组成部分，你可以轻松地开发和定制自己的Jenkins插件。本文介绍了插件的描述文件、入口点、资源文件和测试代码，并通过一个简单的示例展示了如何开发一个自定义插件。

附加资源​

练习​

  1. 尝试开发一个简单的Jenkins插件，用于在构建过程中打印当前时间。
  2. 为你的插件添加一个配置项，允许用户自定义打印的消息。
  3. 编写单元测试，验证插件的功能。

通过完成这些练习，你将更深入地理解Jenkins插件的开发过程，并能够创建更复杂的插件。