ndolls框架使用说明-基于dotnet的数据库操作框架.docVIP

NDolls框架使用说明 框架说明 1.1 设计理念 传统的信息系统开发过程中，针对数据库的操作繁琐且容易出错，并可能存在各方面的安全隐患问题。三层架构虽然一定程度上实现了对数据库操作的封装，但在使用过程中对数据库结构的依赖程度过高，一旦数据库结构发生变化，三层的内容都需要不同程度的发生调整，且对不同表之间的关联关系的支持不足。 针对以上问题，提出了NDolls框架，对底层数据库操作的封装。最大程度上减少了对数据库结构的依赖，只需维护对应的实体类即可；并提供多表之间关联关系的级联操作（事务处理）及实体对象的验证配置化等功能。 1.2 框架组成 本次涉及两部分NDolls.Core及NDolls.Data。其中NDolls.Core作为基础功能支持类库，封装了各种公共方法，供NDolls.Data及未来不断扩展的各种框架组件使用；NDolls.Data则是本次重点，提供了支持数据库操作的各种基本操作。 使用准备 支持DotNet Framework4.0及以上版本； 使用时在项目中添加NDoll.Core.dll及NDoll.Data.dll引用即可。 实体类配置 3.1 数据库连接配置 在主项目的配置文件(Window对应App.config、网站对应Web.config)的appSettings节中维护ConnctionString即可。如下图所示： 3.2 实体类配置 NDolls数据框架中，最为核心的就是实体类，通过对实体类的配置可以实现一系列复杂的数据库操作。 使用NDolls框架的实体类都要继承自NDolls.Data.Entity.EntityBase实体基类。如下图所示： 对实体类的配置主要由NDolls.Data.Attribute程序集中Entity特性、DataField特性、Association特性及Validate特性实现。 Entity特性用于映射实体类对应的数据库表及其主键信息。如下图所示： DataField特性用于配置实体类中属性与数据库的对应关系，其中包括与数据库对应的字段名及字段类型等。如下图所示： Association特性主要负责管理实体类的关联关系，并通过配置实现各种级联操作。 【关联关系包括普通关联关系(1对1)、聚合关系(1对N)、组合关系(1对N)。】 【CascadeType枚举类型设置了各种级联操作的类型，包括级联添加、级联修改、级联查询等。】 普通关联关系（1对1）示例，如下图所示： 聚合及组合关系（1对N）示例，如下图所示： Validate特性设置了对数据库进行修改或添加操作时需要验证的属性字段及验证规则等。 【其中验证规则可使用内置验证规则（见附录一），也可自定义正则表达式的验证规则。】 A：内置规则验证示例，如下图所示： B：自定义验证规则示例，如下图所示： 使用示例 具体应用功能需添加一下命名空间的引用，如下图所示： 定义Repository功能容器，通过容器即可完成数据库的各种基本操作。Repository的创建可有两种方式实现，通过RepositoryFactory获得对象或直接实例化对象，其中通过RepositoryFactory方式具有容器缓存功能，具有更好的效率。示例如下图所示： 【CreateRepository方法的参数可由用户随意定制，用来作为缓存的名称使用，下次再次调用时会直接获取缓存对象，提高效率；建议与调用的类名一致。】 4.1 查询操作 4.1.1 按主键查询对象 通过将主键值作为参数传入，查询该主键对应的对象。主键的配置在Model实体类中配置。 4.1.2 按自定义条件查询对象集合 每一个查询条件对应一个ConditionItem实例对象，若有多个条件，则需生成由多个ConditionItem对象组成的List集合；查询时可以通过ConditionItem中的SearchType设置该条件查询匹配方式（精确查询、模糊查询、不等于查询）。示例如下所示： 4.1.3 按实体类内容查询对象集合 此时的查询会将实体类中不为null的属性作为查询条件查询，进行精确匹配后，得出查询结果。 4.2 新增操作 首先，构造主实体对象；其次，若主对象有关联对象则一并构造好赋值给主对象；最后，调用容器的Add方法完成添加操作。 4.3 修改操作 修改操作首先构造好对应的实体对象，然后调用容器的Update操作即可。 4.4 删除操作 按照主键删除。 4.5 验证操作 对构造好的实体对象进行验证，若验证发现问题，Validate方法会返回对应的错误信息，否则返回空字符串。 附录一、内置验证规则 Ndolls V1.0 数据框架使用说明 第1页/共7页