Jenkins插件开发手册

Jenkins插件开发搭建开发环境为了能开发插件，开发环境需要安装Maven和JDK 6.0以上版本。

1、安装JDK打开cmd，输入java –version如下图，说明安装完成。

图12、安装Maven1.下载Maven如下图：图2将安装包解压到任意地址，我的路径是D:\apache-maven-3.0.5 新建环境变量M2_HOME 指向D:\apache-maven-3.0.5在path添加路径%M2_HOME%\bin打开cmd 输入mvn –v，如下图：图3安装成功。

给eclipse安装插件m2eclipse。

1、打开eclipse2、Help-Install New Software出现下图：图43、点击Add图5在name输入m2e在Location输入4、确定后出现下图：图65、勾选Maven Integration for Eclipse6、然后一直下一步直到安装完毕7、检查是否安装成功（1）点击Help – about eclipse – installation details,看是否存在Maven Integrationfor Eclipse(Required),如下图：图7（2）再检查eclipse是否可以创建Maven项目了，File-New-Other图8到此Maven安装完成了。

3、安装jenkins下载jenkins将jenkins.war，拷贝到D:\jenkins下，打开cmd，转到D:\jenkins目录下然后运行java –jar jenkins.war最后出现jenkins is fully up an running。

说明安装成功。

访问图9插件开发流程1、设置环境由于是使用maven进行开发，需要对%USERPROFILE%\.m2\settings.xml（USERPROFILE 为用户名路径如C:\Documents and Settings下的用户）文件添加以下内容：<settings><pluginGroups><pluginGroup>org.jenkins-ci.tools</pluginGroup></pluginGroups><profiles><!-- Give access to Jenkins plugins --><profile><id>jenkins</id><activation><activeByDefault>true</activeByDefault><!-- change this to false, if you don't like to have it on per default --></activation><repositories><repository><id></id><url>/public/</url></repository></repositories><pluginRepositories><pluginRepository><id></id><url>/public/</url></pluginRepository></pluginRepositories></profile></profiles><mirrors><mirror><id></id><url>/public/</url><mirrorOf>m.g.o-public</mirrorOf></mirror></mirrors>这将可以使用缩短的命令来执行运行。

2、生成新的插件开发新的插件，执行以下命令：mvn –U hpi:create将会提示出现需要输入groupid和artifactid，如下：groupid：com.jysong.jenkinsartifactid: newplugin这样便生成了新的插件，会生成一个简单的例子，同时在当前目录下生成新的文件夹newplugin，然后再执行下面的命令。

cd newpluginmvn package使用这个命令将工程进行打包，不过由于版本的不同可能会出现错误。

如果出现错误参考下面的源代码部分进行修改。

在第一次执行命令时会下载很多的文件，需要耐心的等待。

3、编译插件mvn install运行此命令将会生成文件./target/newplugin.hpi。

可以把它加载到jenkins中。

并且将./target/newplugin.hpi、pom.xml、./target/newplugin.jar这几个文件安装到maven的本地仓库中，就可以被其他的工程调用了。

也可以使用mvn package,只是进行打包生成所需文件，并不安装到本地仓库中。

4、为IDE设置开发环境使用eclipse进行代码开发。

mvn -DdownloadSources=true -DdownloadJavadocs=true –DoutputDirectory= target/eclipse-classes eclipse:eclipse或者mvn eclipse:eclipse在此目录中生成eclipse工程，可以使用eclipse将工程进行导入。

如下图：图105、工作空间布局导入之后目录结构如下图：图11src/main/java :存放java源文件。

src/main/resources：jelly/Groovy视图文件。

src/main/webapp：静态资源文件，例如图片，HTML文件。

pom.xml：配置文件，Maven使用此文件编译插件。

6、源代码在src/main/java/com/jysong/jenkins目录下可能有个null文件夹，在文件夹下面有HelloWorldBuilder.java文件，将HelloWorldBuilder.java文件拷贝到jenkins文件夹下面，将null文件夹删除。

并且将HelloWorldBuilder.java文件中的第一行的package最后面的.null删除。

HelloWorldBuilder.java文件是一个开发插件的模板，包含了开发一个简单插件的所有内容。

后面将对这个文件代码进行详细分析。

在src/main/resources/com/jysong/jenkins目录下可能有个null文件夹，在文件夹下面有个HelloWorldBuilder文件夹，将HelloWorldBuilder文件夹拷贝到jenkins文件夹下面，将null文件夹删除。

在HelloWorldBuilder文件夹下面有global.jelly和config.jelly配置文件。

这两个文件是进行页面配置的文件。

7、调试插件在windows系统上，执行以下命令：set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket, server=y, address=8000, suspend=nmvn hpi:run使用动了端口为8000的调试器，可以在这个端口开启一个调试会话。

如果8080的端口被占用，将会出现错误，不会运行jetty服务器。

可以更改端口使用以下命令：mvn hpi:run –Djetty.port=8090设置上下文路径mvn hpi:run –Dhpi.prefix=/Jenkins执行这个命令之后登录地址将变为http://localhost:8090/jenkins8、发布插件运行以下命令，生成你的插件的图片。

mvn package生成./target/*.hpi文件，其他使用者可以使用jenkins的web界面上传到jenkins。

9、安装插件在jenkins的web界面中由Manage Jenkins>Manage Plugins>Advanced图12点击Choose File,选择你的插件的target目录下的hpi文件。

选择之后点击Upload，插件就会配置到jenkins中。

到此一个简单的插件开发完成了，可以在此基础上进行更复杂的开发。

详细开发插件流程的地址https:///display/JENKINS/Plugin+tutorial源码分析1、java源代码在目录src/main/java/com/jysong/jenkins下有文件HelloWorldBuilder.java。

代码如下：public class HelloWorldBuilder extends Builder {private final String name;// Fields in config.jelly must match the parameter names in the "DataBoundConstructor"@DataBoundConstructorpublic HelloWorldBuilder(String name) { = name;}/*** We'll use this from the <tt>config.jelly</tt>.*/public String getName() {return name;}@Overridepublic boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener) {// This is where you 'build' the project.// Since this is a dummy, we just say 'hello world' and call that a build.// This also shows how you can consult the global configuration of the builderif (getDescriptor().getUseFrench())listener.getLogger().println("Bonjour, "+name+"!");elselistener.getLogger().println("Hello, "+name+"!");return true;}// Overridden for better type safety.// If your plugin doesn't really define any property on Descriptor, // you don't have to do this.@Overridepublic DescriptorImpl getDescriptor() {return (DescriptorImpl)super.getDescriptor();}/*** Descriptor for {@link HelloWorldBuilder}. Used as a singleton.* The class is marked as public so that it can be accessed from views. ** <p>* See<tt>src/main/resources/hudson/plugins/hello_world/HelloWorldBuilder/* .jelly</tt>* for the actual HTML fragment for the configuration screen.*/@Extension// This indicates to Jenkins that this is an implementationof an extension point.public static final class DescriptorImpl extendsBuildStepDescriptor<Builder> {/*** To persist global configuration information,* simply store it in a field and call save().** <p>* If you don't want fields to be persisted, use <tt>transient</tt>. */private boolean useFrench;/*** Performs on-the-fly validation of the form field 'name'.** @param value* This parameter receives the value that the user has typed. * @return* Indicates the outcome of the validation. This is sent to the browser.*/public FormValidation doCheckName(@QueryParameter String value) throws IOException, ServletException {if (value.length() == 0)return FormValidation.error("Please set a name");if (value.length() < 4)return FormValidation.warning("Isn't the name too short?");return FormValidation.ok();}public boolean isApplicable(Class<? extends AbstractProject> aClass) {// Indicates that this builder can be used with all kinds of project typesreturn true;}/*** This human readable name is used in the configuration screen. */public String getDisplayName() {return"Say hello world";}@Overridepublic boolean configure(StaplerRequest req, JSONObject formData)throws FormException {// To persist global configuration information,// set that to properties and call save().useFrench = formData.getBoolean("useFrench");// ^Can also use req.bindJSON(this, formData);// (easier when there are many fields; need set* methods for this, like setUseFrench)save();return super.configure(req,formData);}/*** This method returns true if the global configuration says we should speak French.** The method name is bit awkward because global.jelly calls this method to determine* the initial state of the checkbox by the naming convention. */public boolean getUseFrench() {return useFrench;}}}这里主要使用了jenkins的Builder作为扩展点，Builder扩展点是编译时的功能。