深度分析插件开发技术简介

• 概述：
  为应对用户个性化的算法开发需求，9.0版本系列产品在深度分析模块引入插件技术。
• 工具需求：
  

  工具	版本	用途
  Pycharm（推荐使用）	略	用于插件开发的IDE
  Yonghong Z-Suite、Desktop	V9.0	可以即时查看自己编写插件的运行效果
  Yonghong DM-Engine	V1.1	为Yonghong Z-Suite、Desktop提供计算服务，如果在产品上看看自己写的插件的运行效果，建议安装。
  YonghongAI-0.1-py3-none-any.whl	0.1	插件SDK，开发插件必备，为插件提供了调用接口。Yonghong DM-Engine已默认内置，如果使用Yonghong DM-Engine运行调试插件，可以不用自行安装。

• 插件工程作用:
  
  插件工程由插件SDK提供的模板创建的，包含了插件的必备资源，在此模板基础上编写插件的功能实现。
• 插件工程结构详解：  
  
  

           插件工程目录结构如下图：

                                               

其中,

YH_PluginTemplate为插件工程根目录，可根据自己的需求自行修改；

resource为资源目录，为方便大家编辑manifest.xml文件，在该目录中存放了xsd/manifest.xsd文件用于约束manifest.xml文件的编写合法性，请勿修改。

src为插件代码目录，所有的python脚本必须放在该目录中，支持定义子目录和子包，main.py文件为插件程序入口文件；

test为测试根目录，测试用的所有数据资源及测试脚本均放在此目录中。

5.开发环境搭建

5.1 DM-Engine 安装步骤：

     （1）将文件Yonghong DM-Engine拷贝到电脑上。

     （2）打开插件开发环境路径：Yonghong-DM-Engine-> bin -> startDeployEnv.bat

5.2 生成插件源码工程

（1）输入创建插件工程命令：python -m yonghong -n path/to/your/project

5.3 编写插件代码

（1）使用pycharm打开插件工程文件

（2）main 文件介绍

说明：main编写函数主体运行逻辑。

（2）Testplugin文件介绍

说明：Testplugin是单元测试文件

5.4 Bulid 插件

（1）check 插件代码编写是否符合规范

（2）编辑插件

5.5 插件打包

Z-Suite 和 DeskTop版本号为 V9.0或 V9.1，将jar发送给永洪开发人员进行打包。

5.6 插件安装

5.6.1 Z-Suite 产品安装插件配置流程

(1)新建文件路径（例如 D:\test），存储安装插件的userlocal。

(2)编辑产品目录下的 产品安装路径\Yonghong\bihome\bi.properties，添加dynamic.class.dir=新建的文件路径（例如：D:\test）。【注意斜杠方向】

(3)编辑Yonghong\tomcat\bin\setclasspath.bat,找到setCLASSPATH，添加新建文件路径（例如：D:\test）。使用分号与之前文本隔开。

(4)启动软件，安装完算子后，重启

5.6.2 Desktop产品安装插件配置流程：

（1）编辑产品目录下的【安装目录】\YonghongBI\Yonghong\bihome\bi.properties，例如E:\安装路径\YonghongBI\Yonghong\bihome\bi.properties添加dynamic.class.dir=产品安装路径/YonghongBI/jetty/resources。【注意斜杠方向】

（2）将附件resources.ini文件复制到产品安装路径\YonghongBI\jetty\appbase\start.d

（3）启动软件，安装完算子后，重启

5.6.3 插件安装流程

（1）新插件安装路径：管理系统->应用管理->本地安装

（2）更新后插件安装路径：管理系统->应用管理->本地更新