jira插件开发技术文档

1 搭建插件开发环境

以下是搭建插件开发环境的步骤.

目前开发的PALMS的Plugin插件主要是想在Palms System下的Browser Project中显示。

准备：JDK1.5，Atlassian Plugin SDK 3.0.1，JIRA 4.0.1（无所谓）。最好机子能连上网，我在公司可是悲剧的了，总是拷来拷去的。

Setting up your Plugin Development Environment：

1.1 install your java（配置java环境略去）。

1.2 Install the Atlassian Plugin SDK 3.0.1

Download：

https:///content/repositories/atlassian-public/com/atlassian /amps/atlassian-plugin-sdk/选择符合你要求的版本，一个看你使用JIRA版本、JDK版本。

download 完了，unzip Atlassian Plugin SDK3.0.1zip 到你想的目录下。如

（D:\Atlassian\atlassian-plugin-sdk-3.0.1，接下来我们把路径

D:\Atlassian\atlassian-plugin-sdk-3.0.1\bin与

D:\Atlassian\atlassian-plugin-sdk-3.0.1\apache-maven\bin添加到我的环境变量Path 下。右键“我的电脑”-“属性”-“高级”-“环境变量”-选择“系统变量”或当前用户“用户变量”，选择“Path”-“编辑”，将其上粘贴上即可。如下图

好啦，现在Atlassian Plugin SDK3.0.1安装好了。看看能不能用吧。

Open a command window（window+R：输入cmd），键入c:\>mvn -v可查看JDK版本及其他信息，再键入c:\>mvn，回车后看到一大堆信息，显而易见的有个Build Error信息。没关系，出现这个就是说该安装环境很Ok的啦。如图：

Plugin SDK 已经安装ok，接下来安装Development IDE，本文档使用的是eclipse作为开发IDE工具，当然还有其他的IDE也行，只要能支持maven2行，需要知道更多就到

/display/DEVNET/Setting+up+your+Plugin+Developme

nt+Environme nt

看JIRA提供的Steps。

2 Configuring eclipse to user the SDK

要想Eclipse能使用的Atlassian Plugin SDK，首先的先创建一个Plugin Project。官网上的步骤是这样的。

好了，既然要创建一个Plugin Project，我们就给他创建一个吧，而且创建的Plugin Project 都是用maven命令来完成的。

Create a Plugin Skeleton（创建一个插件框架）

我们在任意的Disk中的某一个目录下创建这个Plugin Project，这个没有绝对的约束。

2.1 用命令进入一个插件开发工作空间目录cd /…/工作空间目录

比如在本地进入C:\BOCCC_WORKSPACE\PALMS，接下来马上使用maven中的命令真正开始Plugin Skeleton的创建吧。

2.2 接着上面的命令在目前所在工作空间中再输入：atlas-create-jira-plugin

按回车键，当看到该命令停止时，会让你输入四个参数,输入的第一个参数groupId是默认的package（官网上有提到），第二参数artifactId就是你创建Plugin的名称啦，第三个version一看就知道是版本号啦，最后一个就是你的package名称，执行过程中也许会从不同站点下载很多的资源，当然很多都是用不到的，这个就没办法控制啦。如果执行顺利，我们会在最后看到Build Successful字样。如下图则表示这一步命令已经OK啦。

注意：执行该命令期间，需要看看log信息，以便解决一些问题。如有些警告错误，没关系，这可以忽略，只要不是出现missing之类且让你安装该资源时，特别是一些jar。一旦出现让你安装丢失的一些jars时，你可要按照下面的命令去安装你自己从网上刚download下的jar，如果我们丢失的是jira-soapclient-4.0.1-1.jar资源，那么我们将执行下面的命令（注意看改名中附带的参数与我们jar关系），-Dfile参数后面使我们下载该jar存放在我们本地的路径。执行该命令后，我们再次启动输入命令atlas-create-jira-plugin，这样的话就可以解决该丢失问题。

安装额外的jar的命令：（如安装TIMCommon.jar）

mvn install:install-file

-DgroupId=com.atlassian.jira.plugins-DartifactId=TIMCommon -Dversion=1.0

-Dpackaging=jar -Dfile=C:\mnt\san\COMMON\lib\tim\TIMCommon.jar

当atlas-create-jira-plugin这一步成功后，我们回到本地去查看到底发生了什么变化。进入到Disk C:\BOCCC_WORKSPACE\PALMS下，你看到了什么？对，这里已经创建了一个以TestPluginProject的文件夹，那么该文件夹的结构如何呢？看下图

这就是执行atlas-create-jira-plugin命令后给我们带来的结果。注意该文件下的有一个pom.xml文件，等接下来的所有命令都会在此文件的根目录下去执行。好，我们接着下一步操作。

Start the Host Application with your Plugin Installed.

Open comman window 中进入到pom.xml文件所在的根目录

C:\BOCCC_WORKSPACE\PALMS\TestPluginProject下，输入命令：atlas-run 只要执行完成看到图中红框所示信息，则这一步也是成功的。看图