Confluence插件开发 - 1 - 开发环境准备

写在前面

Confluence插件开发系列为我个人在实际项目中积累的开发经验，所有内容基于官方文档教程和Google搜索，在开发过程中遇到的一些内容官方文档中没有详细说明的地方做一些个人的记录。如果英文能力好的同学可自行阅读官方指导文档进行开发，本系列指导说明适用于期望快速上手不需要深入了解官方指导文档的同学。

Confluence简单介绍

Confluence是Atlassian公司一款产品，是一个专业的知识管理协同软件，方便企业构建wiki文档，使用简单方便，强大的编辑器和协同文档处理能力让企业办公中方便管理知识文档、积累经验。官网地址

Confluence插件是什么？可以做什么？

Confluence插件是对软件功能的扩展，通过插件开发不局限于官方软件能力，可以实现一些定制化的能力例如：企业定制化的消息通知、增加自定义wiki内用户同步、增加单点登录能力等等。插件包括两种：（1）系统app，提供系统核心能力（2）自定义的第三方插件：自定义开发的或者第三方开发者定制的扩展confluence已有功能的程序。

Confluence Plugin（or add-on）是由一个或者多个子模块组成，插件可以执行很多事情，比如说监听事件，注册servlet执行加载页面等等，插件是由java语言开发。

环境准备

本文开发环境以及相关示例在macos系统内执行，windows相关的操作步骤大体一致，仅是安装包不同，文中在相关的位置会标注说明。
编程语言：Java
Java version：示例中使用jdk1.8版本
IDE：自己喜欢的工具就好，本文示例使用Intellj

着手开发Confluence插件

Confluence plugin SDK 安装

下载安装包

执行此操作之前，你需要正确安装JDK，JDK安装自行百度或者谷歌，建议安装JDK1.8版本。

WIndow安装Plugin SDK

通过官方下载链接下载exe安装包，执行安装，地址

Mac OSX下安装

有两种安装方式，通过dmg安装包安装，下载地址

也可以直接使用homebrew进行安装，这里方便以后卸载和升级建议使用homebrew安装，操作如下：

• 增加Tap brew tap atlassian/tap
• 安装sdk brew install atlassian/tap/atlassian-plugin-sdk
• 如果后续需要升级可以执行 brew update brew upgrade atlassian/tap/atlassian-plugin-sdk
  注意：国内homebrew下载地址可能会比较慢，建议修改homebrew源，修改操作可以参考：http://mirrors.ustc.edu.cn/help/homebrew-cask.git.html

其他系统安装SDK

RPM/RHEL/CentOs/Fedora(YUM)
Debian/Ubuntu
上述系统安装SDK请参照这里

验证sdk安装成功

系统打开命令行终端输入atlas-version输入如下内容即表示安装成功

➜  ~ atlas-version

ATLAS Version:    8.0.16
ATLAS Home:       /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec
ATLAS Scripts:    /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/bin
ATLAS Maven Home: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4
AMPS Version:     8.0.2
--------
Executing: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4/bin/mvn --version -gs /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4/conf/settings.xml
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-18T02:33:14+08:00)
Maven home: /usr/local/Cellar/atlassian-plugin-sdk/8.0.16/libexec/apache-maven-3.5.4
Java version: 9, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/jdk-9.jdk/Contents/Home
Default locale: zh_CN, platform encoding: UTF-8
OS name: "mac os x", version: "10.15.3", arch: "x86_64", family: "mac"

创建一个"Hello World"的插件

打开终端程序，输入命令：

atlas-create-confluence-plugin

提示输入groupId、artifactId、version、package后输入Y确认自动创建项目工程


在当前目录下可以看到创建好的子目录plugin-demo，进入到plugin-demo中我们可以看到目录结构如下：

.
├── LICENSE    项目的license
├── README    说明文档
├── pom.xml     pom文件
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── atlassian
    │   │           └── tutorial
    │   │               └── myPlugin
    │   │                   ├── api
    │   │                   │   └── MyPluginComponent.java    示例Api接口
    │   │                   └── impl
    │   │                       └── MyPluginComponentImpl.java    示例Api代码实现类
    │   └── resources
    │       ├── META-INF
    │       │   └── spring
    │       │       └── plugin-context.xml    spring-context配置文件
    │       ├── atlassian-plugin.xml    插件项目主要配置文件
    │       ├── css
    │       │   └── myPlugin.css    示例css文件
    │       ├── images
    │       │   ├── pluginIcon.png   插件图片
    │       │   └── pluginLogo.png   插件logo图片
    │       ├── myPlugin.properties   项目相关的变量配置文件
    │       └── js
    │           └── myPlugin.js  插件示例js文件
    └── test    单元测试目录以及资源文件
        ├── java
        │   ├── it
        │   │   └── com
        │   │       └── atlassian
        │   │           └── tutorial
        │   │               └── myPlugin
        │   │                   └── MyComponentWiredTest.java
        │   └── ut
        │       └── com
        │           └── atlassian
        │               └── tutorial
        │                   └── myPlugin
        │                       └── MyComponentUnitTest.java
        └── resources
            └── atlassian-plugin.xml

至此，一个最简单的空插件已经创建完成了

插件开发常用命令

首先介绍一下常用命令

atlas-clean

进入到插件根目录执行，清理删除target目录

atlas-mvn package

进入到插件根目录执行，对当前插件编译、打包操作，正确打包结束后，目标文件为target/xxxxx.jar target/xxxxx.obr两个文件，这两个文件都可以上传部署到Confluence系统内。

atlas-run

本地运行Confluence测试环境安装插件，需要在插件根目录执行，因启动一个完成的Confluence测试环境需要内容较多，建议至少保证系统空闲2GB内存，运行成功后可打开浏览器输入http://localhost:1990/confluence进入测试界面，默认的管理员账号密码为admin/admin

示例代码

https://github.com/chaoyz/plugin-demo

参考

Confluence plugin guide
Getting started