JIRA插件开发

[更新1]终于做出了一个对Original Estimate字段生成的Stack Bar Chart，用户可以设置横坐标的统计字段（Statistics Field）和纵坐标的统计字段，每个区域分别是相应Issue的总Original Estimate时间。

 

（1）如何使得Issue出现Original Estimate字段：在Administration页面的Time Tracking中将time tracking启用。这样才能在新建Issue的时候看到该字段。

 

（2）如何获得一个图形插件：在google中搜索JIRA Charting Plugin可以找的一个官方的插件，你可以从那里下载到该插件的源代码。然后看一下这个能否满足你的需求。我们项目中还要求对Original Estimate做一个pie chart。基于该插件的workload pie chart，我们很容易实现了——原图是对spent time进行统计，我们只是在config页面中加了一个选项，让用户设置对那个时间做统计：Original Estimate，Current Estimate， Spent Time。然后根据用户选项确定统计时间。这样Java代码只改了一行。

 

（3）如何生成stack bar chart：可以参考Recently Created Issue这个图的源代码。我没有找到源代码，而是通过atlassian-jira.jar反编译出来的。从里面可以看出来如何生成一个stack bar chart。实际上你只要参考JFreeChart的demo就好了。具体可以参考后面评论

给出的链接。

 

（4）如何获取数据：获取数据是关键。同样参考Recently Created Issue Chart对应的代码，你可以发现关键是通过一个SearchProvider进行查找，这个SearchProvider需要有一个DocumentHitCollector参数。SearchProvider会每次讲一个Document传递给DocumentHitCollector的一个collect方法。因此你需要继承DocumentHitCollector并且覆盖它的collect以增加自己的处理逻辑。Document是lucene里面的一个对象，它索引了Issue的各个属性。所以通过Document你可以获知它的Original Estimate以及你指定的X和Y维度的统计项。这里有个关键问题是如何将X、Y维度的统计项与document中的索引域对应起来。用户在config页面中设置了Issue Type和Priority两项，实际传到后台的字符串是issuetype和priorities。而在document对应的索引项则是type和priority。这个问题折腾了我好久。其实这个本来也很简单，只是一开始不知道而已。为X、Y统计项分别生成两个StatisticsMapper，具体生产方法可以参考Workload Pie Chart的代码。然后这个类有一个方法叫做getDocumentConstant()，得到的就是对应的索引域名字。如果你选择priority这样的统计项的话，你会发现document对应的值是1，2，3之类的数值，而不是high，major，low这样的字符串，这样在显示图片的时候又是问题。我们用如下的方法

 

//indexField对应的是issuetype, prorities之类的统计项的值，是从config页面中传来的

//value则是Issue的indexField属性值，如issuetype如果为bug，则值可能是2

 //mapper即为你的X或Y轴统计项对应的StatisticsMapper

 

 private String getOptionLabel(String value, String indexField, StatisticsMapper mapper){

Object genericObj = mapper.getValueFromLuceneField(value);      //获取一个GenericObject

//下面new所需的参数很容易拿到。

com.atlassian.jira.issue.statistics.util.FieldValueToDisplayTransformer fieldValueToDisplayTransformer = newDefaultFieldValueToDisplayTransformer(i18nHelper, constantsManager, customFieldManager);

//indexField

label = (String)ObjectToFieldValueMapper.transform(indexField, genericObj, null, fieldValueToDisplayTransformer);

return label;

}

 

（5）如何给图片加上tooltip和url：这个问题也很折腾了很久。首先需要给Chart设置URLGenerator和ToolTipGenerator，这个可以参考Recently Created Chart。关键问题在于chart对应的gadget xml文件需要设置一个属性usemap里面要以“#”大头,如

usemap: '#'+ args.chart.imageMapName

具体可以在workload pie chart对应的gadget xml中搜索usemap。一开始我们设置了generator之后，还是没有url和tooltip，让我们很是绝望。后来在firebug的帮助下，发现我们的图片的usemap属性不是以#开始，而workload pie chart是。改了之后就可以了。

 

（6）gadget放大之后显示表格：如果你的gadget可以最大化的话，可以在最大化的时候增加一个与图形对应的table以显示数据。这个主要是在一个类似这样的代码中实现

var dataTable = AJS.gadgets.templater.Table ....

 

 

=======================================================================

 

网上下载了JIRA Charting Plugin却不能在JIRA SDK中运行，很是奇怪。后来发现可能要修改一下Plugin的pom.xml。

参考http://confluence.atlassian.com/display/DEVNET/Converting+your+Plugin+to+the+new+Atlassian+Plugin+SDK

 

JIRA SDK命令行

http://confluence.atlassian.com/display/DEVNET/Plugin+SDK+Commands

 

如何构建JIRA Plugin

http://confluence.atlassian.com/display/DEVNET/How+to+Build+an+Atlassian+Plugin

 

其实文档都在那里，但是要找到真正有用的还真是不容易。

 

report plugin development sample

 

http://confluence.atlassian.com/display/DEVNET/Plugin+Tutorial+-+Creating+a+JIRA+Report#PluginTutorial-CreatingaJIRAReport-Step1.CreatethePluginProject

 

Gaget plugin

http://confluence.atlassian.com/display/DEVNET/Plugin+Tutorial+-+Writing+Gadgets+for+JIRA

 

 

java doc for jira

http://docs.atlassian.com/jira/latest/overview-summary.html