动易sitefactory系统插件开发说明.docx

插件开发说明目录插件开发环境说明2插件开发过程简述5插件安装卸载配置说明7Install 节为插件安装步骤8可用操作详细说明：8Load （加载插件操作） 可以分为：8File （文件操作）8Database （数据库操作）9Menu （菜单操作）10Uninstall 节点，10Upgrade 节点11插件接口说明11插件实例 HelloWorld13系统扩展点说明13插件开发环境说明1、 使用VS2010/2008新建一个空的WebApplication2、 把动易程序放在项目根目录下，并点击显示所有文件3、 把bin目录改名为DLL目录4、 把DLL目录的所有DLL添加引用到项目中。由于项目比较多，可能这个操作需要比较久的时间。经过上面四步，插件开发环境就搭建好了。当然这里的开发环境不是唯一的标准，如果你对熟悉，可以以其他形式开发。具体实现效果可以参考插件DEMO工程。插件开发过程简述1、 我们把新增功能所需要的新增文件包含到项目中2、 配置好相关配置文件和数据连接字符串，即可正常运行程序。（在此之前先把数据库建立好，数据库脚本为：SQLServerSchema2005.sql-架构，SQLServerData2005.sql-默认数据，也要注意数据库版本。）3、 插件开发完毕后的打包插件开发完成后，打包程序，先把程序发布出来，然后保留新增功能文件。并根据安装配置需要分别打包。具体可以参考插件DEMO中的打包方式。插件安装卸载配置说明插件信息配置文件统一为：Plugin.configPlugin.confg 模板： Hello World Hello World Jannock Install 节为插件安装步骤其中InstallStep 为一步。这里可以同时处理同一类操作的集合。InstallStep可用操作有 Action 为 ：Load （加载插件操作）File （文件操作）Database （数据库操作）Menu （菜单操作）Description 为操作说明可用操作详细说明：Load （加载插件操作） 可以分为：Type 为：check 类直接执行插件类，一般用于环境检查操作，也可用于其他操作。同时必须要有参数FilePath 以“/”开头即为网站根目录，否则是当前插件目录NameSpace 插件命名空间service 类服务类插件，系统启动时加载。同时必须有参数FilePath 以“/”开头即为网站根目录，否则是当前插件目录NameSpace 插件命名空间File （文件操作）Type 为：zip文件解压必须参数OriginPath 源文件路径 以“/”开头即为网站根目录，否则是当前插件目录TargetPath 目标路径 以“/”开头即为网站根目录，否则是当前插件目录Description 为操作说明copy 文件复制必须参数OriginPath 源文件路径 以“/”开头即为网站根目录，否则是当前插件目录TargetPath 目标路径 以“/”开头即为网站根目录，否则是当前插件目录Description 为操作说明edit 文件编辑必须参数FilePath 源文件路径 以“/”开头即为网站根目录，否则是当前插件目录ActionType 操作类型OriginString 被替换内容TargetString 替换内容Description 为操作说明当ActionType 为 sql 时，限查询数据库替换。例 ：当ActionType 为txt 时。即替换文本del 删除文件必须参数FilePath 文件路径 以“/”开头即为网站根目录，否则是当前插件目录Description 为操作说明Database （数据库操作）Type 类型file 执行脚本文件Database 的InnerText 为脚本文件路径，以“/”开头即为网站根目录，否则是当前插件目录前面分2000 或2005数据库 例如脚本文件为：2005Task.sql 此处只需写上 Task.sql txt 执行SQL语句Database 的InnerText 为SQL语句Menu （菜单操作）Type 类型admin 后台菜单操作FilePath 为后台SiteMap路径。必须是/ 开头user 会员中心菜单操作FilePath 菜单xml。必须是/ 开头Action 类型Install 菜单安装Uninstall 菜单删除注：菜单操作需注意菜单组织结构，需对系统菜单有一定的了解才行。同类型的操作只能出现一个，即不能如下：两个后台菜单同时出现，可以Uninstall 节点， UninstallStep 中的操作和上面的基本相同。其中菜单部份后台菜单需要添加属性TitleList 菜单的标题（菜单命名时需要注意不能与系统的相同）菜单标题可以是多个，使用 | 分开。前台菜单也要增加属性id 前台菜单对应的id。Upgrade 节点 操作和上面的基本相同。特殊路径：TemplateDir 模板路径 SkinDir 样式路径插件接口说明 / / / public interface IPlugin / / 是否出错 / bool IsError get; set; / / 执行方法 / / 插件路径 / 执行信息/错误信息 string Exe(string pluginPath);插件实例 HelloWorld系统扩展点说明系统插件扩展点统一放在这里为扩展点。在系统启动时可以加载外部插件。插件编写新建项目HelloWorld继承IPlugin实现接口函数，添加事件弹出 Hell