文章目录
  1. 1. 前提说明
  2. 2. HelloWorld插件工程
    1. 2.1. 步骤一,创建工程
    2. 2.2. 步骤二,运行工程
    3. 2.3. 步骤三,确认插件已安装
  3. 3. 下一步
  4. 4. 参考资料

前提说明

  1. 你需要先安装好confluence开发用的SDK,请参考 confluence宏插件开发01-搭建开发环境

HelloWorld插件工程

步骤一,创建工程

Confluence SDK提供了atlas-create-confluence-plugin 命令,来创建一个插件的工程。

  1. 打开一个命令行窗口,切换到你想要创建工程的目录

  2. 执行 atlas-create-confluence-plugin 命令,填写必要的参数,你会看到类似以下的输出:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    Define value for groupId: : com.example
    Define value for artifactId: : myConfluenceMacro
    Define value for version: 1.0.0-SNAPSHOT: :
    Define value for package: com.example: :
    Use OSGi Java Config: (Y/N/y/n) N: :
    Confirm properties configuration:
    groupId: com.example
    artifactId: myConfluenceMacro
    version: 1.0.0-SNAPSHOT
    package: com.example
    use OSGi Java Config: N
    Y: :
  3. 填写完毕后,工具会自动下载依赖的文件,需要保证网络是通的。下载创建完毕后,你会看到类似这样的输出:

    1
    2
    3
    4
    5
    6
    7
    [INFO] Project created from Archetype in dir: C:\work\demo\confluence-demo\myConfluenceMacro
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 07:15 min
    [INFO] Finished at: 2021-03-01T12:40:43+08:00
    [INFO] ------------------------------------------------------------------------
  4. 现在你可以打开 myConfluenceMacro 文件夹,查看刚刚创建好的文件了。

步骤二,运行工程

  1. 确保命令行目录在 myConfluenceMacro 目录下,执行 atlas-run 命令,这个命令是把 一个本地的 confluence开发环境运行起来,第一次运行的时候会需要好长一段时间,需要下载大量的依赖,这个时候你可以先去干点别的,但请保证系统不会自动进入睡眠状态。

    1
    2
    cd myConfluenceMacro
    atlas-run
  2. 如果你看到命令行里的输出 慢下来了,你可以试着用浏览器访问 http://localhost:1990/confluence ,打开网页后使用 默认的用户名admin,密码admin登录。

步骤三,确认插件已安装

  1. 浏览器里 点击右上角的小齿轮,点击下拉菜单里的“管理应用”
  2. 打开的界面里搜索 myConfluenceMacro 插件,下拉的分类里选择 系统,如下图: 应用管理图示

下一步

到这里,插件的安装及运行就已经完成了,但似乎这个插件啥也干不了,接下来我们在这个基础上开发一个自定义宏

参考资料

https://developer.atlassian.com/server/framework/atlassian-sdk/create-a-confluence-hello-world-macro/

文章目录
  1. 1. 前提说明
  2. 2. HelloWorld插件工程
    1. 2.1. 步骤一,创建工程
    2. 2.2. 步骤二,运行工程
    3. 2.3. 步骤三,确认插件已安装
  3. 3. 下一步
  4. 4. 参考资料