致远OA协同办公系统A8插件开发规范.ppt

A8插件开发标准1.0,编制人:谭敏锋日期：2007-11-23,提纲,概念设计原则插件结构启动插件的步骤插件规范插件定义文件命名规范代码规范功能权限插件安装和卸载插件接口需要改造的点,什么是插件,插件在A8平台上独立开发的功能模块，依托于A8平台运行，一般由二次开发完成代码编写。预制插件随A8产品一同发布的标准插件，通过加密狗来确认是否启用。,设计原则,框架基于A8框架：Portal、Spring、Hibernate自动装配插件，无须修改产品本身任何代码代码有无插件不影响产品的正常运行允许新增数据结构不允许独立的SessionFactory和ApplicationContext插件开发既要遵循插件开发规范，还必须要遵循A8开发规范插件的代码可以直接访问A8产品的接口，反之不可以安装预制插件是否启动将进行加密狗验证不支持热启动/卸载插件修改插件配置，需要重启应用服务器,插件的结构,A8平台,A8插件,class,jsp/js/css/images,hibernatemapping文件,SpringbeanXML文件,properties文件,菜单/角色,插件定义文件,SessionFactory,ApplicationContext,PropertyHolderConfigurer,UrlHandlerMapping,插件是一个相对完成的功能模块，具备相应的代码结构。通过插件定义文件，将插件相关的配置文件告知平台,启动插件的步骤,系统启动前期PluginSystemInit从固定位置（conf/plugin/*.xml）读取所有的插件定义文件，获取所有的插件定义信息根据加密狗验证插件的有效性，过滤掉无效的插件系统启动中期PropertyHolderConfigurer，将插件的properties注入ApplicationContext，将插件的Spring-Bean-XML注入SessionFactory，将插件的*.hbm.xml注入SimpleUrlHandlerMapping，将插件的url-mapping注入系统启动后期把插件定义的角色写入系统组织模型-角色管理把插件菜单合并到系统菜单,插件规范-插件定义文件,功能描述了插件各种配置文件的位置、菜单等基本属性技术与系统统一采用spring的技术，符合Spring-bean规范系统提供基础JavaBean（com.seeyon.v3x.plugin.PluginDefintion），一般情况可以直接使用预制插件，需要重写PluginDefintion的isAllowStartup方法，再此验证加密狗所有的插件定义文件统一放置在WEB-INF/classes/conf/plugin下，其它位置无效内容id插件的标识（全局唯一）name插件的显示名称properties配置文件的路径contextConfigLocation功能SpringBeanXML的路径hbmResources新增的表结构的hbm.xmlurlMapping新增controller的url-mappingaccountRoles新增的单位角色（将在单位管理员-角色管理中出现）departmentRoles新增的部门角色。（将在单位管理员-部门管理出现）userMenus前端用户的一级菜单（0-N个）accountMenus单位管理员的一级菜单（0-N个）groupMenus集团管理员的一级菜单（0-N个）systemMenus系统管理员的一级菜单（0-N个）menuI18NResource国际化资源每个一级菜单下面可以配置二级菜单（名称，权限，链接，图标）1-N个,插件规范-命名,每一个插件必须有一个全局唯一的标识,插件规范-代码规范,开发环境系统预制插件的代码要独立，插件定义文件统一放在V3XApp/v3x_congif/conf/plugin下运行环境处：插件资源（js/css等）存放位置处：插件的class存放位置处：插件定义文件存放位置处：插件JSP文件存放位置插件的xml、properties文件放在处,功能（菜单）权限,描述了插件的菜单的访问权限只针对二级菜单控制权限当没有二级菜单时，一级菜单不显示角色插件的功能权限采用系统的角色管理组件统一管理支持单位/部门角色系统启动时会把插件定义的角色写入角色管理组件通过单位管理的角色管理界面设置人与角色的关系（统一组件）通过插件定义文件声明新增角色支持自定义菜单访问的权限策略需要实现系统提供的权限接口在菜单定义中什么自定义的权限策略bean角色权限和自定义权限策略不冲突，求并集菜单访问权限可以使用系统角色,菜单1,菜单N,角色1,角色N,人员1,人员N,自定义权限,插件的安装和卸载,最低实现安装：代码：按照插件运行环境下的目录结构，做成ZIP包，用户解压缩后，直接拷贝即可SQL脚本：通过第三方工具执行卸载手工从WEB-INF/classes/conf/plugin下屏蔽掉插件定义文件弊端容错性差新增的插件角色不能够删除最高实现安装：通过exe程序直接将代码拷贝到指定位置，并执行SQL卸载：通过exe程序屏蔽掉插件定义文件，并把新增的插件角色删除（或置为不可用）,插件接口,插件定义插件定义Bean：com.seeyon.v3x.plugin.PluginDefintion插件一级菜单Bean：com.seeyon.v3x.plugin.PluginMainMenu插件二级菜单Bean：com.seeyon.v3x.plugin.PluginMenu插件菜单权限接口：com.seeyon.v3x.plugin.PluginMenuSecurity系统环境SystemEnviroment.getPlugins();列举所有插件SystemEnviroment.hasPlugin(pluginId);检查某个插件时候正常启动,需要改造的点,