动易sitefactory系统插件开发说明

1、插件开发说明目录 TOC o 1-5 h z HYPERLINK l bookmark0 o Current Document 插件开发环境说明 2 HYPERLINK l bookmark4 o Current Document 插件开发过程简述 5插件安装卸载配置说明 7Install 节为插件安装步骤 8 HYPERLINK l bookmark8 o Current Document 可用操作详细说明： 8 HYPERLINK l bookmark10 o Current Document Load （加载插件操作） 可以分为： 8 HYPERLINK l bookmark12 o C

2、urrent Document File （文件操作） 8 HYPERLINK l bookmark14 o Current Document Database （数据库操作） 9 HYPERLINK l bookmark16 o Current Document Menu （菜单操作） 10 HYPERLINK l bookmark18 o Current Document Uninstall 节点， 10 HYPERLINK l bookmark20 o Current Document Upgrade 节点 11 HYPERLINK l bookmark22 o Current Docu

3、ment 插件接口说明 11插件实例 HelloWorld 13 HYPERLINK l bookmark24 o Current Document 系统扩展点说明 13插件开发环境说明1、使用 VS2010/2008 新建一个空的 WebApplicationSolution ExplorerH3 Xal si*左 Solution WebApplicationl 1 projectj Q WebApplicati o-nl圈 Properti es/ References.2、 把动易程序放在项目根目录下，并点击显示所有文件.；App_Erow5er&.：App_Lata.；.；App_E

4、row5er&.：App_Lata.；Ap p_G I ob a Iu rces.：App.Tlnernes:bin:Comment汇Commo-n_i Comm&nTemplate；ConfiqSolution Ejcplo-rer導|岬丨*|J3 SolutioKWebApplication 1 (1 proj ect j W&bApplicationl 国 Properties jjj R&feren ce&:AdminClientEinAPIDLL3、 把 bin 目录改名为 DLL 目录APIDLL3、 把 bin 目录改名为 DLL 目录Solution Ejcplo-rerTBl

5、 Sl|J3 Solution WebApplicatio-nl 1 projectj WebApplieatianl 国 PropertiesReferen ces.i Admin”.i App_Browsers：App Data.i App_GlobalResources: App_Th ernes:ClientEini Comm-ent；Comm-onCommo-nT em plateConfi gControls4、把DLL目录的所有DLL添加引用到项目中。SHF炖石期沖h PcwirEtny.9十!口ry.EiqA_dlLWW17 皈DLL Art阿KB. RoeEwy.Sieadc

6、ifyiHliSapdiJDLIVWl? 3lLTOLL EH：Lj4H9 kbs PowarEiny.Gvirlnry.RI壬iMrcupdlJDIWL? iL7口 LL立碎却KBj. Roe*Ei5.Sifac1cify.BISikHiflidll2DLIW17 31LTOLL 立H：G9 KB* F*ci-irEiny.yiAriDry.BIJurwydlJDLi7 SL7DLL Art37 KB,* Povi-irEinY.SiivJriDrY.Hl.TflrrlKflijdlimqwu slt LL 宜H：m KHj. Roe*EM.SiJciC!fy.BliUpg*Brikpdll

7、2DLW17 ML?OLL EH：232 KB 仙1irEjny.5十irlHryRlJLHrMarugiiHI2DLU17 iL7DLL Art&7 KBj. Rwe*ESifac1cifYiBli7aieidlJDLIVWl? SLTOLL 立H：4KB* PowarEinv.GvirlnryBI.WiHI20Lti7 SL7口 l宜碎9 KBj. Rowe*EM.Eieacici!ry.BliWafkxil2DLW17 ML?OLL EH：14KEIj. Roe*E.Siedoi.DaxFdl2DLIW17 31LTOLL彌32 KEI,? PcwirEtny.9十!口rylMSIMHV

8、W SL7DLL AML4d KB* Pc-weEwy.E-i-adcify.MMtlidlJDLIVWl? 3lLTOLL EH：IZ2 KBn owarEiny.GvirlnryMISBmr&iLdlJDIWL? iL7口 LL立碎2jOJ KBj. R(Me*E.Sifac1cify.W#bSif.dl2DLIW17 31LTOLL 立H：3.731 KBFftirEiny.ilrmjp.AftiirYKfljLQnimQrdlF*owwEjny.&flrjrcup.!A-.Trjm.MrlUa_.MMW1?虫订jmWL?如 7口 LL如 口 LI宜碎12 KB27 kBj. Roe*E

9、iTempMeErtfl!rtexll2DLW17 ML?OLL EH：LSKEI-, iJb4mAhJjKaVnuilEEiDrLDaiiJI2DLU17 逓DLL Art呦KBj.加BmWebiOaaVu&SMficiriihJDLIVWl?泗OLL 立H：L.4B3 KB” m ibmAAhv1niionilaiKFixll口 l宜碎42 KBJDLl?泗OLL立浮倔KBLJKi-RiLtrdTeiaJd L 还Jj-vnErk iLl18, lESbirijC1 Shu-jEijlilULB Ewsic Eap. illBrssBfTrsidcss kbir界寸”rRihriry” 皿

10、 iLl/ i EmrfL ErKLieil Enrjri aslilS：i CajiwuLt IlLii 0Ufc：t.畝3”由于项目比较多，可能这个操作需要比较久的时间。经过上面四步，插件开发环境就搭建好了。当然这里的开发环境不是唯一的标准，如果你对 熟悉，可以以其他形式开发。具体实现效果可以参考插件DEMO工程。插件开发过程简述1、我们把新增功能所需要的新增文件包含到项目中Solution Ejtpl&rerBI SIA Ij 議 WebAppli匚mtioni:=ai Propertie-s Referencesi J Ad min.；Analytics丫 API.；App_Erows

11、er&.j App_Data；App G lob a I Resources Hinn!|.i App_Th ernesD bin:BLL层BLL:BLL层C ClientBin.；CommentP j Common.:CoimmonTem p latei _j Config.；Controlsi J Da I Fa doryi J Datsbse.i DLLJ、$ Editor数据层i IAA IDal 2、配置好相关配置文件J L_J Configj AjaxHand丨已config j APLconfigj AP,UC.conf g j AppS-eltin g t.confi gj A

12、u th 已 ntiuaijon,configj Au toCrea te. confi gL j CodeSnippstPaneLcontfigj CommonMailS-erver.co-nfg j Conn ection St ring s. configCon sum er Ext ersio nO-bj ect. coritfi g L j CreateCo-l I ecti onW o rk. confi gAppS etti n g s-. co nfi gSource Control ExploreAppS etti n g s-. co nfi gSource Control

13、 Exploreversion 1. 0 &n.codirLntf-S? 和-包含自定文应用程障设贵。E appSetting3)add key=aPoierEasy; Def aultUp 1 oadSuff ins value jpg g：if jpEg png. 1add key=，vVersion valuer3. 6. 0. C )| 和数据连接字符串，即可正常运行程序。（在此之前先把数据库建立好，数据库脚本为：SQLServerSchema2005.sql-架构，SQLServerData2005.sql-默认数据，也要注意数据库版本。）-&F7JmptCut3PDelOpenOp

14、-en With.二 I View Code 阖Vi ew DesignerView MarkupView Compo-nent DesignerView Code Gen FileSet As Start 日已In du de In Project电 Copy X Del ete-&F7JmptCut3PDelOpenOp-en With.二 I View Code 阖Vi ew DesignerView MarkupView Compo-nent DesignerView Code Gen FileSet As Start 日已In du de In Project电 Copy X Del

15、 eteRenarrie当 Prope-rtiesd 口 adFilessicProxy.sspitAlt-h Enterrtegory.aspx. J De-fault.aspK1 faviccjn.iccrBrowse- With.Shift+F7Ctrl+XCtrl+CbSarvi ces3、 插件开发完毕后的打包插件开发完成后，打包程序，先把程序发布出来，然后保留新增功能文件。并根据安装 配置需要分别打包。具体可以参考插件 DEMO 中的打包方式。容称:-f Plugin.config诃 Tieba.Installdll這 TieBa.zip插件信息配置文件统一为：Plugin.con

16、figPlugin.confg 模板：Hello WorldPluginUr卜 HYPERLINK v/PluginUr%e5%8d%9c v/PluginUr卜Hello World JannocklnstallStep Action=Load Description-检查环境InstallStep Action=File Description复制插件文件ActionType=sqlActionType=sql(Database Type=txtInstallStep Action=Load Description-加载插件 InstallStep Action=Menu Descript

17、ion设置菜单Install 节为插件安装步骤其中 InstallStep 为一步。这里可以同时处理同一类操作的集合。 InstallStep 可用操作有 Action 为 ：Load （加载插件操作）File （文件操作）Database （数据库操作）Menu （菜单操作）Description 为操作说明可用操作详细说明：Load （加载插件操作） 可以分为：Type 为：check 类 直接执行插件类，一般用于环境检查操作，也可用于其他操作 同时必须要有参数FilePath 以“/”开头即为网站根目录，否则是当前插件目录 NameSpace 插件命名空间service 类 服务类插件，

18、系统启动时加载。同时必须有参数FilePath 以“/”开头即为网站根目录，否则是当前插件目录 NameSpace 插件命名空间File （文件操作）Type 为：zip 文件解压必须参数OriginPath 源文件路径 以“/”开头即为网站根目录，否则是当前插件目录 TargetPath 目标路径 以“/”开头即为网站根目录，否则是当前插件目录Description 为操作说明copy 文件复制必须参数OriginPath 源文件路径 以“/”开头即为网站根目录，否则是当前插件目录 TargetPath 目标路径 以“/”开头即为网站根目录，否则是当前插件目录 Description 为操作

19、说明edit 文件编辑必须参数FilePath 源文件路径 以“/”开头即为网站根目录，否则是当前插件目录 ActionType 操作类型OriginString 被替换内容TargetString 替换内容Description 为操作说明当 ActionType 为 sql 时，限查询数据库替换。例：当 ActionType 为 txt 时。即替换文本del 删除文件必须参数FilePath 文件路径 以“/”开头即为网站根目录，否则是当前插件目录Description 为操作说明Database （数据库操作）Type 类型file 执行脚本文件Database 的 InnerText

20、为脚本文件路径，以“/”开头即为网站根目录，否则是当前插件目录 前面分 2000 或 2005 数据库例如脚本文件为：2005Task.sql此处只需写上 Task.sql txt 执行 SQL 语句Database 的 InnerText 为 SQL 语句Menu （菜单操作） Type 类型admin 后台菜单操作FilePath为后台SiteMap路径。必须是/开头 user 会员中心菜单操作FilePath菜单xml。必须是/开头Action 类型lnstall 菜单安装Uninstall 菜单删除注：菜单操作需注意菜单组织结构，需对系统菜单有一定的了解才行。同类型的操作只能出 现一个

21、，即不能如下：两个后台菜单同时出现，可以Uninstall 节点，UninstallStep 中的操作和上面的基本相同。其中菜单部份 后台菜单需要添加属性TitleList 菜单的标题（菜单命名时需要注意不能与系统的相同） 菜单标题可以是多个，使用 | 分开。前台菜单也要增加属性id 前台菜单对应的 id。Upgrade 节点操作和上面的基本相同。特殊路径：TemplateDir模板路径SkinDir样式路径插件接口说明/ / public interface IPlugin/ / 是否出错/ bool IsErrorget;set;/ / 执行方法/ / 插件路径 /执行信息/错误信息 st

22、ring Exe(string pluginPath);插件实例 HelloWorld系统扩展点说明系统插件扩展点统一放在解决方FowrE 4E7, 0 i c i alJQT 个项目-：- FiwsrEasy. F&undkt i in-_戲PowerE asy. Foundati on+ 窃I Properti es+ Q引用+ - Li.II_J Cont ext_J Drawing.:obj_J SiteCache_J Sit eConfig_J UrLRewri ting：眄 AEzemblyEfiELecti on. ce 眄 IFLugin. ce;F *;F * erEasy.

23、 F u umli11 on. c spr u j.e c cI Settings. StvlCot这里为扩展点。在系统启动时可以加载外部插件。插件编写新建项目-l3 FlugirLHmoYfoi-ld+ 圉 Pr&psrti-引用_J P owerE asy. 7 cniiLd=it 1 on-I System=O System . Cor eq口 System.Q System. Data. Il；it：iS已tExt已tl乌i oilsQ System, fietiO System. K(TilSystem. Xml. Li rqKell off arid, csHelloWorld 继承 IPluginLnt4t E4?24 PonFmiridati mlnamespaEe- Pl ugiJiHel 1 oWcrl dpublic class HellcWcrld : IPliJEirpiriblic Iot1 IsErrorpublic string Eefstiing pliiginPath)1PE Event. LogjLiiiSiu +- nw PE E vent - Log! nSuHanifLer C1 ogjn);catch (Ex