建立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。