ABP框架的体系结构及模块系统分析

陈浩

摘要：ABP是“ASP.NET Boilerplate Project 即ASP.NET样板项目”的简称。ASP.NET Boilerplate是一个用最佳实践和流行技术开发现代WEB应用程序的新起点，它旨在成为一个通用的WEB应用程序框架和项目模板。ASP.NET Boilerplate 基于DDD领域驱动设计的经典分层架构思想，实现了众多DDD的概念。该文针对此问题讨论了ABP的设计过程。

关键词：ABP；ASP.NET；领域驱动设计

中图分类号：TP393 文献标识码：A 文章编号：1009-3044（2016）32-0045-02

1 ABP框架模式概述

ABP框架是基于ASP.NET的Web开发框架，不过它遵循一种名为DDD（领域驱动设计）的设计模式原则，下面就ABP框架的体系结构及模块系统做以分析。

为了减少复杂性和提高代码的可重用性，采用分层架构是一种被广泛接受的技术。

为了实现分层的体系结构，ABP遵循DDD（领域驱动设计）的原则，将分为四个层次：

展现层（Presentation）：提供一个用户界面，实现用户交互操作。

应用层（Application）：进行展现层与领域层之间的协调，协调业务对象来执行特定的应用程序的任务。它不包含业务逻辑。

领域层（Domain）：包括业务对象和业务规则，这是应用程序的核心层。

基础设施层（Infrastructure）：提供通用技术来支持更高的层。例如基础设施层的仓储（Repository）可通过ORM来实现数据库交互。

2 ABP体系结构分析

一个简单的解决方案，大致包含5个项目，每一层可以用一个或多个程序集来实现，具体分析如下：

1）领域层（Domain）

领域层就是业务层，是一个项目的核心，所有业务规则都应该在领域层实现。

2）实体（Entity）

实体代表业务领域的数据和操作，在实践中，通过用来映射成数据库表。

3）仓储（Repository）

仓储用来操作数据库进行数据存取。仓储接口在领域层定义，而仓储的实现类应该写在基础设施层。

4）领域服务（Domain service）

当处理的业务规则跨越两个（及以上）实体时，应该写在领域服务方法里面。

5）领域事件（Domain Event）

在领域层某些特定情况发生时可以触发领域事件，并且在相应地方捕获并处理它们。

6）工作单元（Unit of Work）

工作单元是一种设计模式，用于维护一个由已经被修改（如增加、删除和更新等）的业务对象组成的列表。它负责协调这些业务对象的持久化工作及并发问题。

3应用层（Application）设计

应用层提供一些应用服务（Application Services）方法供展现层调用。一个应用服务方法接收一个DTO（数据传输对象）作为输入参数，使用这个输入参数执行特定的领域层操作，并根据需要可返回另一个DTO。在展现层到领域层之间，不应该接收或返回实体（Entity）对象，应该进行DTO映射。一个应用服务方法通常被认为是一个工作单元（Unit of Work）。用户输入参数的验证工作也应该在应用层实现。ABP提供了一个基础架构使得很容易地实现输入参数有效性验证。通过使用AutoMapper这样的工具来进行实体与DTO之间的映射。

4基础设施层（Infrastructure）设计

当在领域层中为定义了仓储接口，应该在基础设施层中实现这些接口。可以使用ORM工具，例如EntityFramework或NHibernate。ABP的基类已经提供了对这两种ORM工具的支持。数据库迁移也被用于这一层。

5 WEB与展现层（Web & Presentation）设计

Web层使用ASP.NET MVC和Web API来实现。可分别用于多页面应用程序（MPA）和单页面应用程序（SPA）。

在SPA中，所有资源被一次加载到客户端浏览器中（或者先只加载核心资源，其他资源懒加载），然后通过AJAX调用服务端WebApi接口获取数据，再根据数据生成HTML代码。不会整个页面刷新。现在已经有很多SPA的JS框架，例如：AngularJs、DurandalJs、BackboneJs、EmberJs。 ABP可以使用任何類似的前端框架，但是ABP提供了一些帮助类，让我们更方便地使用AngularJs和DurandalJs。

在经典的多页面应用（MPA）中，客户端向服务器端发出请求，服务器端代码（ASP.NET MVC控制器）从数据库获得数据，并且使用Razor视图生成HTML。这些被生成后的HTML页面被发送回客户端显示。每显示一个新的页面都会整页刷新。

SPA和MPA涉及到完全不同的体系结构，也有不同的应用场景。一个管理后台适合用SPA，博客就更适合用MPA，因为它更利于被搜索引擎抓取。

SignalR是一种从服务器到客户端发送推送通知的完美工具。它能给用户提供丰富的实时的体验。

已经有很多客户端的Javascript框架或库，JQuery是其中最流行的，并且它有成千上万免费的插件。使用Bootstrap可以让我们更轻松地完成写Html和CSS的工作。

ABP也实现了根据Web API接口自动创建Javascript的代码函数，来简化JS对Web Api的调用。还有把服务器端的菜单、语言、设置等生成到JS端。（但是在我自己的项目中，我是把这些自动生成功能关闭的，因为必要性不是很大，而这些又会比较影响性能）。

ABP会自动处理服务器端返回的异常，并以友好的界面提示用户。

6 ABP模块系统设计过程

ABP框架提供了创建和组装模块的基础，一个模块能够依赖于另一个模块。在通常情况下，一个程序集就可以看成是一个模块。在ABP框架中，一个模块通过一个类来定义，而这个类要继承自AbpModule。

Assembly程序集：Assembly是一个包含来程序的名称，版本号，自我描述，文件关联关系和文件位置等信息的一个集合。自己设计类库生成的dll就可以看做是一个程序集，这个程序集可以包括很多类，类又包括很多方法等。

.net可以通过反射获取一个程序集中的类以及方法。

例如开发一个可以在多个不同应用中被调用MybolgApplication模块，代码如下：

public class MyBlogApplicationModule ： AbpModule //定义

{

public override void Initialize（） //初始化

{

IocManager.RegisterAssemblyByConvention（Assembly.GetExecutingAssembly（））；

//这行代码的写法基本上是不变的。它的作用是把当前程序集的特定类或接口注册到依赖注入容器中。

}

}

ABP框架会扫描所有的程序集，并且发现AbpModule类中所有已经导入的所有类，如果已经创建了包含多个程序集的应用，对于ABP是为每一个程序集创建一个Module（模块）。

生命期事件

在一个应用中，abp框架调用了Module模块的一些指定的方法来进行启动和关闭模块的操作。可以重载这些方法来完成任务。

ABP框架通过依赖关系的顺序来调用这些方法，假如：模块A依赖于模块B，那么模块B要在模块A之前初始化，模块启动的方法顺序如下：

PreInitialize-B

PreInitialize-A

Initialize-B

Initialize-A

PostInitialize-B

PostInitialize-A

下面是具体方法的说明：

1）PreInitialize

预初始化：当应用启动后，第一次会调用这个方法。在依赖注入注册之前，可以在这个方法中指定自己的特别代码。例如：假如创建了一个传统的登记类，那么要先注册这个类（使用IocManager对登记类进行注册），可以注册事件到IOC容器。

2）Initialize

初始化：在这个方法中一般是来进行依赖注入的注册，一般通过IocManager.RegisterAssemblyByConvention這个方法来实现。如果要实现自定义的依赖注入，那么需要使用依赖注入的相关文档。

3）PostInitialize

提交初始化：最后一个方法，这个方法用来解析依赖关系。

4）Shutdown

关闭：当应用关闭以后，这个方法被调用。

7总结

目前.NET上有不少开源框架。比如Apworks和ABP。其中Apworks是中国人写的一套开源框架。它是一个全功能的，不仅可以写分布式应用，也可以写桌面应用。ABP的全称是Asp.Net boilerplate project（asp.net样板工程）。是github上非常活跃的一个开源项目。它并没有使用任何新的技术，只是由两名架构师将asp.net开发中常用的一些工具整合到了一起，并且部分实现了DDD的概念。是一个开箱即用的框架，作为asp.net分布式应用的一个良好起点。

参考文献：

[1] 仰燕兰.ASP.NET AJAX框架研究及其在Web开发中的应用[J].计算机应用与软件， 201l（6）：195-198.

[2] 肖洋.基于ASP.NET的MVC框架的应用开发模式研究[J].电子技术与软件工程， 2016（2）：63-63.

[3] 王素芳.基于多层架构的ASP.NET 4 MVC框架研究[J].电脑与电信， 2015（10）：64-66.

[4] 高欣.ASP.NET页面间传输数据的几种方法研究[J].软件导刊，， 2012， 11（11）：43-45.