建立HelloWorld插件工程

时间 2019-11-08 标签建立 helloworld 插件工程

en:https://developer.atlassian.com/server/framework/atlassian-sdk/create-a-helloworld-plugin-project/css

如今你已经有了一个为Atlassian SDK配置的本地开发环境，接下来你将建立你的第一个Atlassian服务器插件。java

重要：这份指导介绍了如何为Atlassian服务器构建一个插件。若是你想要为Atlassian云开发一个应用，请查看the JIRA Cloud Getting Started guide.spring

这个插件将会很是的简单，可是你将学习建立一个插件并启动你的应用程序环境的基本步骤。apache

若是你被卡住了，你能够把你的程序与咱们的源码作比对。这份想到是基于Atlassian Plugin SDK 6.2.9测试运行的。api

Step 1. 使用Atlassian SDK构建一个插件框架

进入系统上你想要建立你的插件的目录里，咱们将要运行的命令会建立一个包含插件目录的文件夹。浏览器
在命令行窗口使用atlas-create-jira-plugin命名建立一个插件工程：服务器
```
atlas-create-jira-plugin
```
这个命名是使用maven构建一个插件框架。屏幕上出现的一些日志信息显示正执行的maven命令行，以及正使用的JIRA版本。框架

会提示你提供关于你的插件的一些信息。在本例中，输入以下：maven

 
     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继续执行。ide

 
     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上提供一个菜单吧。

Modify the Plugin