en:https://developer.atlassian.com/server/framework/atlassian-sdk/create-a-helloworld-plugin-project/
现在你已经有了一个为Atlassian SDK配置的本地开发环境,接下来你将创建你的第一个Atlassian服务器插件。
重要:这份指导介绍了如何为Atlassian服务器构建一个插件。如果你想要为Atlassian云开发一个应用,请查看the JIRA Cloud Getting Started guide.
这个插件将会非常的简单,但是你将学习创建一个插件并启动你的应用程序环境的基本步骤。
如果你被卡住了,你可以把你的程序与我们的源码做比对。这份想到是基于Atlassian Plugin SDK 6.2.9测试运行的。
Step 1. 使用Atlassian SDK构建一个插件框架
-
进入系统上你想要创建你的插件的目录里,我们将要运行的命令会创建一个包含插件目录的文件夹。
-
在命令行窗口使用atlas-create-jira-plugin命名创建一个插件工程:
atlas-create-jira-plugin
这个命名是使用maven构建一个插件框架。屏幕上出现的一些日志信息显示正执行的maven命令行,以及正使用的JIRA版本。
-
会提示你提供关于你的插件的一些信息。在本例中,输入如下:
Define value for groupId: : com.atlassian.tutorial Define value for artifactId: : myPlugin Define value for version: 1.0.0-SNAPSHOT: : 1.0.0-SNAPSHOT Define value for package: com.atlassian.tutorial: : com.atlassian.tutorial.myPlugin
-
然后会提示你确认你的配置信息。检查详细信息确保他们都是正确的,然后输入Y继续执行。
Confirm properties configuration: groupId: com.atlassian.tutorial artifactId: myPlugin version: 1.0.0-SNAPSHOT package: com.atlassian.tutorial.myPlugin Y: : Y
你的Atlassian JIRA插件的基础框架就在myPlugin目录中创建好了。
. ├── LICENSE ├── README ├── pom.xml └── src ├── main │ ├── java │ │ └── com │ │ └── atlassian │ │ └── tutorial │ │ └── myPlugin │ │ ├── api │ │ │ └── MyPluginComponent.java │ │ └── impl │ │ └── MyPluginComponentImpl.java │ └── resources │ ├── META-INF │ │ └── spring │ │ └── plugin-context.xml │ ├── atlassian-plugin.xml │ ├── css │ │ └── myPlugin.css │ ├── images │ │ ├── pluginIcon.png │ │ └── pluginLogo.png │ ├── myPlugin.properties │ └── js │ └── myPlugin.js └── test ├── java │ ├── it │ │ └── com │ │ └── atlassian │ │ └── tutorial │ │ └── myPlugin │ │ └── MyComponentWiredTest.java │ └── ut │ └── com │ └── atlassian │ └── tutorial │ └── myPlugin │ └── MyComponentUnitTest.java └── resources └── atlassian-plugin.xml
在继续之前,可以花点时间浏览下Atlassian SDK创建的不同文件。
Step 2. 启动安装了插件的JIRA
在这一步中,我们将使用atlas-run命令行来运行应用程序(在本例中指JIRA),并安装插件。然后来确认JIRA已经启动并安装了在第一步中创建的插件。
-
切换到myPlugin目录,并输入如下命令:
atlas-run
这将会使用你前面创建的插件框架中的信息来下载JIRA,以及所有插件本身所需要的其他东西,然后启动安装了你插件的JIRA。
第一次执行时可能需要花费几分钟的时间完成。
一旦JIRA启动完成,我们会在命令行窗口中看到如下信息:
[INFO] [talledLocalContainer] Aug 08, 2016 5:51:33 PM org.apache.catalina.startup.Catalina start [INFO] [talledLocalContainer] INFO: Server startup in 234207 ms [INFO] [talledLocalContainer] Tomcat 8.x started on port [2990] [INFO] jira started successfully in 332s at http://DESKTOP-EF2CA9N:2990/jira [INFO] Type Ctrl-D to shutdown gracefully [INFO] Type Ctrl-C to exit
-
打开一个浏览器窗口,导航至localhost:2990/jira。 使用如下身份信息登录:
Username : admin Password : admin
-
将会出现一个欢迎对话框,并让你配置一些JIRA基本设置。
这些事情你只需要做一次,然后这些设置会在你下次使用atlas-run命令时被记住。
-
输入gg,然后输入manage。从出现的列表中选择Manage Add-ons。
(除此之外,你可以点击齿轮图标来打开管理员对话框,然后选择Add-ons,最后在Atlassian MarketPlace管理员页面打开后,选择右边的Manage add-ons。) -
在User-installed add-ons中打开myPlugin列表,然后点击他们展开。
-
你看到其中一个列表是插件本身,另外一个是插件测试。注意,插件有一些由SDK创建的基础模块。
-
关闭浏览器,回到正运行JIRA的命令行窗口。
-
使用CTRL+D (在OSX和Linux上) 或 CTRL+Z (在Windows上)优雅的关闭JIRA。
下一步
你已经有了一个基础插件框架,所以让我们学习如何修改和定制它来在JIRA上提供一个菜单吧。