弱框架及插件式开发方案.docx

弱框架及插件式开发方案青岛XXXXX有限公司2011.04一、 弱框架插件式开发分析 弱框架的意思是说将框架弱化，只是提供一些常用的功能如登陆、用户管理、角色权限管理、功能项管理等。弱框架只是提供一个架构、一个服务，是插件开发依托、测试的平台，是所有功能模块的载体，在弱框架中可以很好的展示系统、展示插件功能。 中小型企业在上信息化建设项目的时候，可能已经使用其他的软件，已经形成原有软件登陆习惯。很多企业会想将软件进行集成，而不是多个分离的系统。多个系统从管理还是从应用方面都是比较繁琐的事。为了解决这种问题，可以将系统以插件的形式提供，系统与原有系统完美融合。二、 弱框架插件式开发目标（1）、将框架很好的分层，将一些层进行固化，只提供服务接口，供插件使用。（2）、将弱框架平台功能基本功能模块实现如登录、用户管理、部门管理、角色权限管理、功能项管理等模块。（3）、弱框架平台的界面设计美观、大方、简介。在对客户演示的时候，达到眼前一亮的感觉，让客户认识到其专业性。（4）、开发的插件功能、设计、使用方法明确。只有对业务进行透彻的分析，设计进行评价后来确定是否进行插件式开发。插件只做成熟的、共用的业务。三、 弱框架插件式开发设计弱框架插件式开发主要有两方面进行规划，其重中之重在于弱框架的设计、开发上。只有好的架构、好的依托才能使插件开发简洁实用。插件开发设计主要是如何定义接口、如何实现插件式开发方面进行设计考虑。1、 弱框架设计 框架分层方面：A、 数据层：（该部分对外接口是固定的，可增，不可减）主要是处理系统与数据库的交互。在这方面要确定下一步的应用数据库服务器，如SqlServer数据库等等，由于数据库语法存在差异，兼容多数据库类型的需要两套到三套的SQL语句，如果需要多套在建设的时候就做多套（该部分是重中之中，这块需要详细的设计）。B、 公共函数层 公共函数层是对常用公用函数、公用类封装层。公用函数层采用数据工厂，通过接口的形式对外提供服务。公用函数层现归纳一下几个方面：1、 XML操作类2、 字符加密解密类3、 文件处理类（文件转移、删除、重命名、上传、取文件名等）、4、 字符串处理类（判断非空、判断数字、字符串转换等）5、 日志记录类6、 异常处理类（暂定）7、 常用结构体（如星期、月份）8、 消息提示类（JS提示）C、 Session、Cookie用户信息层 用户信息等在程序开发中很多地方可以用到，为了使用方便、方便判断重写，需要将该部分进行封装，封装后用户可以根据设置来选择是Session、Cookie形式的存放方式。该层要考虑协同登录的问题，如客户在登录自己系统后，如何将Session信息或Cookie信息写入。该层可以配置注入的形式，来自定义Session或Cookie信息，为SessionCookie的扩展提供方便。D、 公用实体层该层是对模块中常用实体的包装，如用户信息、角色权限实体。E、 公用模块业务层 该层主要是对公用模块的业务处理层，主要是对人员选择页面、部门选择页面、角色权限页面，所有页面的公用部分。该部分的SQL语句是定制的。在与别的系统进行综合使用使用可以通过建立存储过程、视图的形式，将其他系统的用户、部门、角色权限应用直接映射到系统中。这样开发的其他模块就可以直接利用原有数据库的基本信息进行使用。对具有权限的页面，需要进行权限的控制，通过基类来进行判断或者提供权限控制的函数。权限控制函数用户可以自行设置，来进行客户系统融合时候进行判断是否具有权限。F、 系统实体层 该层主要是对弱框架中的系统模块用的实体进行处理，如部门的管理、人员的管理、角色管理、功能项管理、权限管理等模块。G、 系统业务层 该层是对弱框架中系统模块业务信息进行的实现，包括所有系统模块所有业务信息、数据库操作信息等。业务信息为基础平台功能，其专业性、可用性要强。在跟客户演示的时候，公用模块也是其中一亮点。H、 UI实现层 UI实现层是对整个框架的展示模块，其中包括登录、框架、系统模块的展现。其美观、大方、专业为亮点。其模块设计易用、操作方便。2、 插件开发设计插件式开发所应用的东西无非就是数据库操作、公用函数、SessionCookie、选择人员部门等公用模块。将这些动态库与插件一同提供给用户，就可以与用户原有系统进行紧密结合。插件式开发的原则是将通用的业务进行封装，所有公司有可能用到的业务进行整合，如新闻模块、通知公告模块、计划管理模块、知识库管理模块、客户管理模块、工作日志管理等，将其业务进行固化，然后设计其功能设计、页面设计。专业化、简单化为设计原则。插件式开发在开发前要对该插件是否要需要做插件式开发进行研讨、业务固化要进行验证、设计进行评价。最后确定其开发的必要性，在进行详细开发，每个插件开发都是必要的、可行的、专业的。开发完毕后进行详细测试。确保每个插件都是可用的、好用的。其出错率小于3个，不允许出现业务、逻辑错误。插件分层方面：引用框架中的公用函数层、数据库层、Session/Cookie层、公用模块层，为插件事开发进行服务。A、 插件业务层插件业务层是对插件业务的实现，是插件操作信息的完善。在插件业务实现中，其函数命名规则、变量、熟悉命名规范，方法逻辑说明详细，让其他接手人可用很清晰的了解其编程思路。函数的意义等。在插件开发中大数据量的查询最好通过自定义的分页存储过程来完成，尽可能的数据传输减少。插件开发的查询语句不允许使用 Select * 这种形式，用到哪些字段要写出哪些字段。B、 插件UI层 插件UI层是对业务实现为客户的展示层，是可用用与操作层。其美观行、专业性、统一性要在设计中就进行固化。将所有做的插件都是专业的、易用的。C、 插件实体层 插件层中所用到的实体，方便在UI层、业务层中进行操作。D、 插件对外接口层插件对外接口，也就是为其他插件、系统提供的服务，在接口定义中其命名清晰、说明详尽。E、 插件对外接口展现层 插件对外接口的展现，也就是在对外提供接口的时候，面向客户的展示页面，需要插件对接的时候，只需要将接口的东西引用进去即可。四、 功能设计思路展示1、 弱框架方面A、 登录页面用户身份验证、登录系统判断页面，该页面具有用户名、密码、验证码，登录成功后进行Session、Cookie的记录，并且具有历史的记录。登录中可以对用户登录次数进行控制，如输入密码几次后进行自动锁定，在过段时间自动解锁。用户可以设置忘记密码机制，通过密码找回功能，自动找回自己的密码。用户密码使用加密技术，保存的密码可以分为两个MD5加密、其他加密方式，当找回密码的时候应用可解密的密码进行密码找回，这样管理员也不可查到其用户的密码，让系统更加安全。B、 展示框架平台展示框架平台，也就是插件、公有模块展示的区域，是插件、功能的载体。展示平台通过左侧树形、右侧展示区的样式显示。展示平台可以做两到三个展示方式，展示方式在以后的应用中可以陆续增加。（多个展示页）展示区域是否需要用多Tab的机制，在弱框架设计中可以考虑这个问题，应用多Tab的机制可以让用户打开多个页面来操作，不用打开一个需关闭一个，方便用户操作，也是其他软件常用的思路。展示的功能项是以权限为基准来显示的，对没权限的功能项不做显示。展示的功能项处可以让用户设置、也可以通过自动计算的方式，让用户常用的自动列出。用户可以通过常用模块很快的进行办公，来提高用户的工作效率。C、 部门组织结构维护部门组织结构是对公司部门、组织结构进行管理的平台，部门组织结构是以树形的形式来展示，让客户可以很清晰的查看到部门之间的层次关系。部门组织结构具有唯一编号、名称、排序号、说明、负责人等常用信息。D、 人员维护 人员维护采用组织结构的分层模式进行，用于添加公司人员信息，每个用户具有唯一编号，姓名、性别、排序号等。可以通过部门组织进行方便过滤。其展示形式以左侧组织树，右侧为用户列表的形式进行。添加进去的用户如果已经登录使用的不可删除，可以通过标志位的形式来限制用户是否可用。E、 用户维护用户维护是对登录系统的用户进行维护，该部分是为了使系统用户与人员信息进行分开而设计。公司的人员可以不是用户，用户也可以不是公司员工，这样就能很好的扩展系统，使系统控制不太死板。F、 角色维护角色维护意思就是对用户进行分组管理，方便权限分配，方便人员选择而用。角色是将一些共性的用户放置在一起。在设计角色模块的时候，将角色分为管理角色、一般角色，具有管理角色的可以进行层级授权。例如：李四具有 合同管理员角色、材料一般角色，李四可以建立角色，并且对角色进行分配功能项时候，只可以分配合同管理员角色的权限，材料的权限不可分配。这样就能很好的控制权限逐级分解。建立的角色只有具有建立这个角色的人员才能进行对角色进行管理，分配。G、 功能项维护功能项维护是设置的功能树，是将本系统中所有的功能维护进框架平台中。通过网址的进行。功能项具有唯一编码，名称，排序号，说明，是否可用等属性。功能项可以维护其使用详细说明（扩展），用户可以通过功能项说明来查看其具体功能，如何操作，让没使用系统的用户也能很好的使用出来。功能项这块这块现在是对页面级别的授权，是否需要对按钮级别的授权在具体设计中在进行考虑。H、 分配权限维护 分配权限就是对角色设置对应的功能项、人员对应的角色。分配权限的方式只能通过角色、功能项的方式进行。不能直接将一功能项分配个用户。这样是为了规范化。 一个用户可以具有多种角色。I、 对外公用模块开发 对外公用模块部分也就是 人员选择、用户选择、部门选择、角色人员选择、角色选择等，为插件开发提供数据选择的支持。2、 插件方面插件的设计是对插件的业务细化，本方案不包括插件具有哪些具功能，只是对如何来进行插件开发进行思路的剖析，如何才能使插件的移植性更好，更方便。其如何设计、如何展示、如何做是对具体插件的业务功能设计所需考虑的。五、 插件式开发规范1、 插件开发前都需要进行研讨该业务插件是否可以进行开发。2、 插件业务进行固化、研讨，将想通的东西进行固化。3、 确定插件开发后进行详细的数据库设计、页面设计、操作设计，最后进行评价，评价后进入开发阶段。4、 每个插件开发都具有自己的类、命名空间，在定义命名空间的时候进行固化，不允许与以前开发的重复，其实际意义也可以从名字中很明白的识别。5、 插件开发设计中会用到图片、Css、JS，这块是独立的，与框架彻底分开。每个插件都是一个独立的系统。其存放有一定的规范，如：新闻News开发，图片放入Images/News下面Css放入 CSS/News下面 依次类推。其展示功能都在页面都放入Module/News 下。六、 插件的使用 插件的使用分3种情况：1、 框架和插件一块使用不用做任何修改即可使用。2、 客户原有系统也是.net framework2.0的，将插件与客户系统进行融合将插件中