编写一个Xmind插件

ゝ一世哀愁。 2024-04-18 19:45 0阅读 0赞

### 文章目录 ###

*  xmind AI debug plug-in
 *   *  description
     *  run
     *  use
     *  code
     *  about xmind & RCP

# xmind AI debug plug-in #

## description ##

这是一个xmind的插件，用于AI日志可视化。因为最近新项目用了行为树，所以用xmind来做配置，但是策划用的不是很习惯，经常出错，所以写一个插件，帮助策划查找错在哪里。

## run ##

*  从git上下载xmind的源码。具体的地址可以从`xmind的官网->开发者->Download Source Code`得知。撰写此文时地址为[xmind][]。我下载的版本是R3.7.5。
 *  检查`features/org.xmind.cathy.platform.feature/feature.xml`文件是否有如下内容，如果没有，则追加即可。如果缺失此内容会报错：`java.lang.ClassNotFoundException: org.eclipse.swt.SWTError cannot be found by org.eclipse.ui.workbench_3.108.0.v20160602-1232`。这里的解决方案参考了git工程中的一篇[issue][]
    
        <plugin id="org.eclipse.equinox.launcher.win32.win32.x86_64" os="win32" ws="win32" arch="x86_64" download-size="0" install-size="0" version="0.0.0" fragment="true"/>
        
           <plugin id="org.eclipse.swt.win32.win32.x86_64" os="win32" ws="win32" arch="x86_64" download-size="0" install-size="0" version="0.0.0" fragment="true" unpack="false"/>
 *  将`xmind\bundles\org.xmind.ui.menus`文件删除，并将此工程放置在`xmind\bundles`下
    
     *  本来应该新建一个工程来做插件，但是我新建了工程后，发现以debug模式运行时，此插件不工作，于是就在原有的menus插件工程中开发，后续可能会以新插件的方式来做。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70]

*  按照git上readme文件描述启动此工程：
    
    > 1.  Download and install [JDK v1.8 or higher][].
    > 2.  Download and install [Eclipse SDK v4.6 or higher][].
    > 3.  Make a clean workspace.
    > 4.  Import all bundles, features and releng projects into the workspace.
    > 5.  Open `org.xmind.cathy.target/cathy.target` with the default *Target Editor* and click on ‘Set as Target Platform’ in the top-right corner of the opened editor (you may have to wait for Eclipse to download all necessary dependencies).
    > 6.  Open `org.xmind.cathy.product/cathy.product` with the default *Product Configuration Editor* and, in the first ‘Overview’ tab, click on ‘Launch an Eclipse application’ or ‘Launch an Eclipse application in Debug mode’.
    
     *  这是我使用的环境：
        
        > jdk: Java HotSpot™ 64-Bit Server VM (build 25.152-b16, mixed mode)
        > 
        > eclipse: eclipse-SDK-4.13M1-win32-x86\_64
        > 
        > windows: Windows®,Enterprise edition

## use ##

*  运行后可以在工具栏看到六个控件，这六个控件的icon都是我用Photoshop画的，获得灵魂画手称号  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 1]
    
    1.  运行
        
         *  点击时会根据ip和端口连接到指定服务器，开始接收从服务器发来的日志，如果日志满足AI日志的格式，并且此日志的内容是当前打开的xmind文件对应的内容，则会将整个路径渲染成黄色，并且在渲染下一条时将旧路径渲染成天蓝色。
    2.  调试
        
         *  点击时会根据ip和端口连接到指定服务器。开始接收从服务器发来的日志。如果日志满足AI日志的格式，并且此日志的内容是当前打开的xmind文件对应的内容，则会将整个路径渲染成黄色。但是在接收到第二条时不会立即渲染，而是要点击下一步才会开始渲染，以后每点击一次，则渲染一条。服务器发来的日志会被缓存，最大缓存一万条，超过则直接丢弃最新的消息。
    3.  下一步
        
         *  只有在调试模式下才有用。每点击一次，则渲染一条。
    4.  结束
        
         *  断开服务器连接。并将所有缓存内容/状态清空。
    5.  IP输入框
        
         *  游戏服务器-global的地址，如果不填，则默认为本机地址
    6.  端口输入框
        
         *  游戏服务器-global的AI调试端口，默认为19001

![在这里插入图片描述][2019091110594393.jpg]

## code ##

*简单介绍一下本插件是如何编写的*

*  添加一个工具栏菜单组。如果不想添加，就得在它原有的工具栏组里加，我觉得这样写出来乱糟糟的。
    
    1.  打开`org.xmind.ui.menus/fragment.e4xmi`如果你用的是eclipse sdk 版本，他会自动用`Eclipse 4 model editor` 打开。
    2.  `右击 Model Fragment Definition->Model Fragments->Model Fragment 选择Add child->Toolbar`
    3.  填写ID`org.xmind.ui.toolbar.ai`.这个地方内容可以随意填，但是不能跟已有的id重复，因为在RCP里，所有的单元都有一个唯一的ID。
    4.  继续选中这个Toolbar添加两个子元素
        
        1.  `Add child->Speparator` 将id设置为`org.xmind.ui.menus.toolbarseparator.ai`
            
            > 在工具栏上的UI表现就是有一个竖线
        2.  `Add child->ToolControl` 将id设置为`org.xmind.ui.menus.toolcontrol.address`将Class URI设置为`bundleclass://org.xmind.ui.menus/org.xmind.ui.menus.wt.AddressTextView`.
            
            > 想要在工具栏上加文本框，就得先添加一个ToolControl然后在代码中手动画，然后把代码绑定到这个 ToolControl.
            > 
            > 绑定类必须实现一个 void functinname (Composite parent) 方法，然后此方法用@PostConstruct注解标记，在程序刚开始运行时会调用此方法绘制UI
    
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 2]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 3]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 4]
 *  如何添加一个toolbar
    
    1.  打开`org.xmind.ui.menus/plugin.xml`如果你用的是eclipse sdk 版本，他会自动用`Plug in Manifest Editor` 打开。
    2.  选择Extensions页签，点击`Add`在弹出窗口的搜索框输入`org.eclipse.ui.menus`,选中`org.eclipse.ui.menus`并点击`Finish`,最后一个`org.eclipse.ui.menus`就是刚刚添加的菜单，然后选中后`鼠标右击->new->menuContribution`
    3.  将这个menuContribution的locationURI设置为`toolbar:org.xmind.ui.toolbar.ai?after=org.xmind.ui.menus.toolbarseparator.ai`,这个URI分为两个部分，第一个部分指定这个工具栏要放置到那个工具栏中。`org.xmind.ui.toolbar.ai`就是上文中添加的Toolbar的id。每一个Toolbar下可以挂载多个toolbar，所以得指定他们之间的先后顺序，第二个部分`org.xmind.ui.menus.toolbarseparator.ai`是上文中添加的Separation的id。它的意思是要把这个toolbar放置在这个Separation之后  
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 5]
 *  如何添加一个按钮并为他绑定对应的代码
    
    1.  点击Add添加一个`org.eclipse.ui.commands`。`右键->new->command`.
    2.  选中这个command修改它的属性
        
         *  id: `org.xmind.ui.menus.wt.start` id随便起名字，但是不能跟已有的id重复。
         *  name: `start` 这个名字随便起，可以重复
         *  defaultHandler: `org.xmind.ui.menus.wt.handler.StartHandler` 这个类就是这个命令对应的类。这个类必须继承`AbstractHandler`并实现`public Object execute(ExecutionEvent event)`方法。当调用这个命令时，就会执行此方法。其实这个地方应该绑定handler，然后再handler里绑定代码，但是这个命令只有一个需要响应的内容，所以我也懒得写的那么规范了。每个command下可以挂载多个handler。
    3.  选中上文中创建的`toolbar:org.xmind.ui.toolbar.ai?after=org.xmind.ui.menus.toolbarseparator.ai`.然后`右键->new->command`.选中command，然后修改它的如下属性：
        
         *  commandId：`org.xmind.ui.menus.wt.start` 这个地方必须跟上文中command的id一致
         *  label：start 随便写
         *  id: `toolbar.wt.start.label` id随便起名字，但是不能跟已有的id重复。
         *  icon:`icons/toolbar/e/start.png`
         *  tooltip:`开始` 鼠标悬浮在这个按钮上时会有这个提示  
            ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 6]
 *  如何添加外部依赖jar&&引入本工程里的其他工程
    
    > 因为要用到netty，所以得引入netty的jar。但是因为OSGI有一套自己的类加载体系，所以如果按照以往的处理方式会发现写代码的时候能编译通过，运行的时候就开始Class not found.
    > 
    > 这个部分的内容都在MANIFEST.MF文件中，可以手动加，也可以通过UI操作。
    
    1.  还是打开plugin.xml，但是选中的是Runtime页签
    2.  在Classpath编辑页里点击add添加jar，这个jar必须是放在这个工程目录下的。我的是lib/netty-all-4.1.33.Final.jar
        
        \[外链图片转存失败(img-muAtnRAU-1568170577710)(readmejpg/runtime.jpg “引入外部依赖jar”)\]
    3.  因为在写代码的时候使用了org.xmind.ui的内容，所以得添加项目依赖.还是打开plugin.xml，但是选中的是Dependencies页签，然后在Required Plug-ins中添加想要依赖的插件

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 7]

*  剩下的就是纯代码的处理了，没啥可说的

## about xmind & RCP ##

*  RCP（rich client platform 富客户端平台）
    
     *  Eclipse RCP是eclipse团队对OSGI框架的是实现，它以插件的形式开发，使得UI桌面程序能够快速开发，迭代，扩展。我觉得它最好的地方就是解耦。通过大量的xml配置，将代码之间完全解耦，不过这其中使用了很多反射，逻辑之间复杂的调用，导致这种软件都很慢。eclipse卡的不要不要的。
     *  我在开发的过程中参考了两本书
        
         *  [Eclipse RCP深入浅出(原书第2版).pdf][Eclipse RCP_2_.pdf]
         *  [Eclipse插件开发 原书第3版中文版.pdf][Eclipse_ _3_.pdf]
        
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 8]
 *  xmind
    
     *  xmind是一个国内的公司用Eclipse RCP开发的软件。它自己本身分为三个部分
        
        1.  主体框架`org.xmind.cathy`这个部分绘制了整个软件的窗体布局，后续的功能都以此为基础，使用插件的方式来逐个添加功能。
        2.  `org.xmind.cathy.product`是整个工程的启动入口，cathy.product文件中描述了启动时要加载那些feature。一共有三个  
            \- `org.xmind.cathy.platform.feature` 描述了启动平台所需要的插件-  
            \- `org.xmind.hebe.feature` 描述了xmind自身的功能插件  
            \- `org.xmind.cathy.feature` 包含了自身启动时必须要有的插件
        3.  其他扩展插件。包括UI，数据结构（鱼骨图，甘特图等都是数据结构）
        
        ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 9]
     *  对于xmind的而言，map中的每个topic都是一个 BranchFigure，每个BranchFigure下包含了自身TopicFigure，以及其他子节点的BranchFigure。想要修改topic的节点，需要获取TopicFigure对象，通过其中的装饰器来修改它的填充色。

[xmind]: https://github.com/xmindltd/xmind
[issue]: https://github.com/xmindltd/xmind/issues/324
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/c77b351ad739460c8f2e29c6dfce8c6a.jpg
[JDK v1.8 or higher]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
[Eclipse SDK v4.6 or higher]: http://download.eclipse.org/eclipse/downloads/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/3abf85ee56604d6382966fd023630529.jpg
[2019091110594393.jpg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/af4bfbab169e4f4b9a19951edca13931.jpg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/ecae4cb9a7604ccb966a21c1ae54dbed.jpg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/7dcf5f5e8e9d45dca8dd23ca37738fb5.jpg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/79fb3051eaf64abe84ce32d4eb29daeb.jpg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/a914e8233f434e7ca67aaf8939f8f02d.jpg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/aaf9d3e087a54e978c0bfa002024fb46.jpg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/60614ae043524d71b46c0143aaa412f8.jpg
[Eclipse RCP_2_.pdf]: https://book.douban.com/subject/6113985/
[Eclipse_ _3_.pdf]: https://book.douban.com/subject/4849548/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/8f246d181714437bb309a5aa2a49f88c.jpg
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmd0b25nOTU_size_16_color_FFFFFF_t_70 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/d03f82defc574084b472ffe2ebcdfe67.jpg