猎艳神雕行,西南之窗,小彩泉
abp是“asp.net boilerplate project (asp.net样板项目)”的简称。
asp.net boilerplate是一个用最佳实践和流行技术开发现代web应用程序的新起点，它旨在成为一个通用的web应用程序框架和项目模板。
abp的官方网站：
abp在github上的开源项目：
abp 的由来
“dry——避免重复代码”是一个优秀的开发者在开发软件时所具备的最重要的思想之一。我们在开发企业web应用程序时都有一些类似的需求，例如：都需要登录页面、用户/角色管理、权限验证、数据有效性验证、多语言/本地化等等。一个高品质的大型软件都会运用一些最佳实践，例如分层体系结构、领域驱动设计、依赖注入等。我们也可能会采用orm、数据库迁移（database migrations）、日志记录（logging）等工具。
从零开始创建一个企业应用程序是一件繁琐的事，因为需要重复做很多常见的基础工作。许多公司都在开发自己的应用程序框架来重用于不同的项目，然后在框架的基础上开发一些新的功能。但并不是每个公司都有这样的实力。假如我们可以分享的更多，也许可以避免每个公司或每个项目的重复编写类似的代码。作者之所以把项目命名为“asp.net boilerplate”，就是希望它能成为开发一般企业web应用的新起点，直接把abp作为项目模板。
abp是什么？
abp是为新的现代web应用程序使用最佳实践和使用最流行工具的一个起点。可作为一般用途的应用程序的基础框架或项目模板。它的功能包括：
服务器端：
客户端：
除abp框架项目以外，还开发了名叫“zero”的模块，实现了以下功能：
abp不是什么？
abp提供了一个应用程序开发模型用于最佳实践。它拥有基础类、接口和工具使我们容易建立起可维护的大规模的应用程序。
然而：
它不是rad工具之一，rad工具的目的是无需编码创建应用程序。相反，abp提供了一种编码的最佳实践。
它不是一个代码生成工具。在运行时虽然它有一些特性构建动态代码，但它不能生成代码。
它不是一个一体化的框架。相反，它使用流行的工具/库来完成特定的任务（例如用ef做orm，用log4net做日志记录，使得castle windsor作为赖注入容器， angularjs 用于spa 框架）。
就我使用了abp几个月的经验来看，虽然abp不是rad，但是用它开发项目绝对比传统三层架构要快很多。
虽然abp不是代码生成工具，但因为有了它，使我们项目的代码更简洁规范，这有利于使用代码生成工具。
我自己使用vs2013的scaffolder+t4开发的代码生成器，可根据领域对象的uml类图自动生成全部前后端代码和数据库，简单的curd模块几乎不需要编写代码，有复杂业务逻辑的模块主要补充领域层代码即可。这样就能把时间多花在领域模型的设计上，减少写代码的时间。
下面通过原作者的“简单任务系统”例子，演示如何运用abp开发项目
从模板创建空的web应用程序
abp提供了一个启动模板用于新建的项目（尽管你能手动地创建项目并且从nuget获得abp包，模板的方式更容易）。
转到从模板创建你的应用程序。
你可以选择spa（angularjs或durandaljs）或者选择mpa（经典的多页面应用程序）项目。可以选择entity framework或nhibernate作为orm框架。
这里我们选择angularjs和entity framework，填入项目名称“simpletasksystem”，点击“create my project”按钮可以下载一个zip压缩包，解压后得到vs2013的解决方案，使用的.net版本是 4.5.1。
每个项目里引用了abp组件和其他第三方组件，需要从nuget下载。
黄色感叹号图标，表示这个组件在本地文件夹中不存在，需要从nuget上还原。操作如下：
要让项目运行起来，还得创建一个数据库。这个模板假设你正在使用sql2008或者更新的版本。当然也可以很方便地换成其他的关系型数据库。
打开web.config文件可以查看和配置链接字符串：
<add name="default" connectionstring="server=localhost; database=simpletasksystemdb; trusted_connection=true;" />
（在后面用到ef的code first数据迁移时，会自动在sql server数据库中创建一个名为simpletasksystemdb的数据库。）
就这样，项目已经准备好运行了！打开vs2013并且按f5：
下面将逐步实现这个简单的任务系统程序
创建实体
把实体类写在core项目中，因为实体是领域层的一部分。
一个简单的应用场景：创建一些任务(tasks)并分配给人。 我们需要task和person这两个实体。
task实体有几个属性：描述（description）、创建时间（creationtime）、任务状态（state），还有可选的导航属性(assignedperson)来引用person。
我要评论
public class task : entity<long>
{
[foreignkey("assignedpersonid")]
public virtual person assignedperson { get; set; }
public virtual int? assignedpersonid { get; set; }
public virtual string description { get; set; }
public virtual datetime creationtime { get; set; }
public virtual taskstate state { get; set; }
public task()
{
creationtime = datetime.now;
state = taskstate.active;
}
}
person实体更简单，只定义了一个name属性：
public class person : entity
{
public virtual string name { get; set; }
}
在abp框架中，有一个entity基类，它有一个id属性。因为task类继承自entity<long>，所以它有一个long类型的id。person类有一个int类型的id，因为int类型是entity基类id的默认类型，没有特别指定类型时，实体的id就是int类型。
创建dbcontext
使用entityframework需要先定义dbcontext类，abp的模板已经创建了dbcontext文件，我们只需要把task和person类添加到idbset，请看代码：
public class simpletasksystemdbcontext : abpdbcontext
{
public virtual idbset<task> tasks { get; set; }
public virtual idbset<person> people { get; set; }
public simpletasksystemdbcontext()
: base("default")
{
}
public simpletasksystemdbcontext(string nameorconnectionstring)
: base(nameorconnectionstring)
{
}
}
通过database migrations创建数据库表
我们使用entityframework的code first模式创建数据库架构。abp模板生成的项目已经默认开启了数据迁移功能，我们修改simpletasksystem.entityframework项目下migrations文件夹下的configuration.cs文件：
internal sealed class configuration : dbmigrationsconfiguration<simpletasksystem.entityframework.simpletasksystemdbcontext>
{
public configuration()
{
automaticmigrationsenabled = false;
}
protected override void seed(simpletasksystem.entityframework.simpletasksystemdbcontext context)
{
context.people.addorupdate(
p => p.name,
new person {name = "isaac asimov"},
new person {name = "thomas more"},
new person {name = "george orwell"},
new person {name = "douglas adams"}
);
}
}
在vs2013底部的“程序包管理器控制台”窗口中，选择默认项目并执行命令“add-migration initialcreate”
会在migrations文件夹下生成一个xxxx-initialcreate.cs文件，内容如下：
public partial class initialcreate : dbmigration
{
public override void up()
{
createtable(
"dbo.stspeople",
c => new
{
id = c.int(nullable: false, identity: true),
name = c.string(),
})
.primarykey(t => t.id);
createtable(
"dbo.ststasks",
c => new
{
id = c.long(nullable: false, identity: true),
assignedpersonid = c.int(),
description = c.string(),
creationtime = c.datetime(nullable: false),
state = c.byte(nullable: false),
})
.primarykey(t => t.id)
.foreignkey("dbo.stspeople", t => t.assignedpersonid)
.index(t => t.assignedpersonid);
}
public override void down()
{
dropforeignkey("dbo.ststasks", "assignedpersonid", "dbo.stspeople");
dropindex("dbo.ststasks", new[] { "assignedpersonid" });
droptable("dbo.ststasks");
droptable("dbo.stspeople");
}
}
然后继续在“程序包管理器控制台”执行“update-database”，会自动在数据库创建相应的数据表：
pm> update-database
数据库显示如下：
（以后修改了实体，可以再次执行add-migration和update-database，就能很轻松的让数据库结构与实体类的同步）
定义仓储接口
通过仓储模式，可以更好把业务代码与数据库操作代码更好的分离，可以针对不同的数据库有不同的实现类，而业务代码不需要修改。
定义仓储接口的代码写到core项目中，因为仓储接口是领域层的一部分。
我们先定义task的仓储接口：
public interface itaskrepository : irepository<task, long>
{
它继承自abp框架中的irepository泛型接口。
在irepository中已经定义了常用的增删改查方法：
所以itaskrepository默认就有了上面那些方法。可以再加上它独有的方法getallwithpeople(...)。
不需要为person类创建一个仓储类，因为默认的方法已经够用了。abp提供了一种注入通用仓储的方式，将在后面“创建应用服务”一节的taskappservice类中看到。
实现仓储类
我们将在entityframework项目中实现上面定义的itaskrepository仓储接口。
通过模板建立的项目已经定义了一个仓储基类：simpletasksystemrepositorybase（这是一种比较好的实践，因为以后可以在这个基类中添加通用的方法）。
public class taskrepository : simpletasksystemrepositorybase<task, long>, itaskrepository
{
public list<task> getallwithpeople(int? assignedpersonid, taskstate? state)
{
//在仓储方法中，不用处理数据库连接、dbcontext和数据事务，abp框架会自动处理。
var query = getall(); //getall() 返回一个 iqueryable<t>接口类型
//添加一些where条件
if (assignedpersonid.hasvalue)
{
query = query.where(task => task.assignedperson.id == assignedpersonid.value);
}
if (state.hasvalue)
{
query = query.where(task => task.state == state);
}
return query
.orderbydescending(task => task.creationtime)
.include(task => task.assignedperson)
.tolist();
}
}
taskrepository继承自simpletasksystemrepositorybase并且实现了上面定义的itaskrepository接口。
创建应用服务（application services）
在application项目中定义应用服务。首先定义task的应用服务层的接口：
public interface itaskappservice : iapplicationservice
{
gettasksoutput gettasks(gettasksinput input);
void updatetask(updatetaskinput input);
void createtask(createtaskinput input);
}
itaskappservice继承自iapplicationservice，abp自动为这个类提供一些功能特性（比如依赖注入和参数有效性验证）。
然后，我们写taskappservice类来实现itaskappservice接口：
public class taskappservice : applicationservice, itaskappservice
{
private readonly itaskrepository _taskrepository;
private readonly irepository<person> _personrepository;
/// <summary>
/// 构造函数自动注入我们所需要的类或接口
/// </summary>
public taskappservice(itaskrepository taskrepository, irepository<person> personrepository)
{
_taskrepository = taskrepository;
_personrepository = personrepository;
}
public gettasksoutput gettasks(gettasksinput input)
{
//调用task仓储的特定方法getallwithpeople
var tasks = _taskrepository.getallwithpeople(input.assignedpersonid, input.state);
//用automapper自动将list<task>转换成list<taskdto>
return new gettasksoutput
{
tasks = mapper.map<list<taskdto>>(tasks)
};
}
public void updatetask(updatetaskinput input)
{
//可以直接logger,它在applicationservice基类中定义的
logger.info("updating a task for input: " + input);
//通过仓储基类的通用方法get，获取指定id的task实体对象
var task = _taskrepository.get(input.taskid);
//修改task实体的属性值
if (input.state.hasvalue)
{
task.state = input.state.value;
}
if (input.assignedpersonid.hasvalue)
{
task.assignedperson = _personrepository.load(input.assignedpersonid.value);
}
//我们都不需要调用update方法
//因为应用服务层的方法默认开启了工作单元模式（unit of work）
//abp框架会工作单元完成时自动保存对实体的所有更改，除非有异常抛出。有异常时会自动回滚，因为工作单元默认开启数据库事务。
}
public void createtask(createtaskinput input)
{
logger.info("creating a task for input: " + input);
//通过输入参数，创建一个新的task实体
var task = new task { description = input.description };
if (input.assignedpersonid.hasvalue)
{
task.assignedpersonid = input.assignedpersonid.value;
}
//调用仓储基类的insert方法把实体保存到数据库中
_taskrepository.insert(task);
}
}
taskappservice使用仓储进行数据库操作，它通往构造函数注入仓储对象的引用。
数据验证
如果应用服务(application service)方法的参数对象实现了iinputdto或ivalidate接口，abp会自动进行参数有效性验证。
createtask方法有一个createtaskinput参数，定义如下：
public class createtaskinput : iinputdto
{
public int? assignedpersonid { get; set; }
[required]
public string description { get; set; }
}
description属性通过注解指定它是必填项。也可以使用其他 data annotation 特性。
如果你想使用自定义验证，你可以实现icustomvalidate 接口：
public class updatetaskinput : iinputdto, icustomvalidate
{
[range(1, long.maxvalue)]
public long taskid { get; set; }
public int? assignedpersonid { get; set; }
public taskstate? state { get; set; }
public void addvalidationerrors(list<validationresult> results)
{
if (assignedpersonid == null && state == null)
{
results.add(new validationresult("assignedpersonid和state不能同时为空!", new[] { "assignedpersonid", "state" }));
}
}
}
你可以在addvalidationerrors方法中写自定义验证的代码。
创建web api服务
abp可以非常轻松地把application service的public方法发布成web api接口，可以供客户端通过ajax调用。
dynamicapicontrollerbuilder .forall<iapplicationservice>(assembly.getassembly(typeof (simpletasksystemapplicationmodule)), "tasksystem") .build();
simpletasksystemapplicationmodule这个程序集中所有继承了iapplicationservice接口的类，都会自动创建相应的apicontroller，其中的公开方法，就会转换成webapi接口方法。
可以通过http://xxx/api/services/tasksystem/task/gettasks这样的路由地址进行调用。
通过上面的案例，大致介绍了领域层、基础设施层、应用服务层的用法。
现在，可以在asp.net mvc的controller的action方法中直接调用application service的方法了。
如果用spa单页编程，可以直接在客户端通过ajax调用相应的application service的方法了(通过创建了动态web api)。
总结
以上所述是小编给大家介绍的abp(现代asp.net样板开发框架)系列之二、abp入门教程详解，希望对大家有所帮助
如对本文有疑问，请在下面进行留言讨论，广大热心网友会与你互动！！ 点击进行留言回复
asp.net搭建博客，使用BlogEngine.NET+MySql搭建博客
网友评论