佳木斯湛栽影视文化发展公司

主頁 > 知識庫 > 基于ASP.NET MVC的ABP框架入門學(xué)習(xí)教程

基于ASP.NET MVC的ABP框架入門學(xué)習(xí)教程

熱門標簽:呼叫中心 智能手機 蘋果 硅谷的囚徒呼叫中心 電子圍欄 解決方案 地方門戶網(wǎng)站 服務(wù)器配置

為什么使用ABP
我們近幾年陸續(xù)開發(fā)了一些Web應(yīng)用和桌面應(yīng)用,需求或簡單或復(fù)雜,實現(xiàn)或優(yōu)雅或丑陋。一個基本的事實是:我們只是積累了一些經(jīng)驗或提高了對,NET的熟悉程度。
隨著軟件開發(fā)經(jīng)驗的不斷增加,我們發(fā)現(xiàn)其實很多工作都是重復(fù)機械的,而且隨著軟件復(fù)雜度的不斷提升,以往依靠經(jīng)驗來完成一些簡單的增刪改查的做法已經(jīng)行不通了。特別是用戶的要求越來越高,希望添加的功能越來多,目前這種開發(fā)模式,已經(jīng)捉襟見肘。我很難想象如何在現(xiàn)有的模式下進行多系統(tǒng)的持續(xù)集成并添加一些新的特性。
開發(fā)一個系統(tǒng)時,我們不可避免的會使用各種框架。數(shù)據(jù)持久層實現(xiàn)、日志、ASP.NET MVC、IOC以及自動映射等。一個高質(zhì)量的軟件系統(tǒng)往往還有全局容錯,消息隊列等組件。
把上述這些組件組合到一起的時候,其復(fù)雜度會急劇上升。一般個人和小團隊的技術(shù)水平,很難設(shè)計出一個均衡協(xié)調(diào)的框架。對于傳統(tǒng)的所謂三層架構(gòu),我也是很持懷疑態(tài)度的。(月薪15k的程序員搞的三層架構(gòu),我也仔細讀過,也是問題多多,并不能解釋為什么要使用三層)。
其實,我們無非是希望在編程的時候,把大部分的注意力全部集中到業(yè)務(wù)實現(xiàn)上。不要過多的考慮基礎(chǔ)的軟件結(jié)構(gòu)上的種種問題。應(yīng)該有一個框框或者一種范式來提供基本的服務(wù),如日志、容錯和AOP,DI等。
稍微正規(guī)一點的公司經(jīng)過多年沉淀都形成了自己的內(nèi)部軟件框架,他們在開發(fā)軟件的時候并不是從一片空白開始的。而是從一個非常牢固的基礎(chǔ)平臺上開始構(gòu)建的。這樣大大提高了開發(fā)速度,而且一種架構(gòu)往往也決定了分工協(xié)作的模式。我們目前之所以無法分工協(xié)作,根本原因也是缺少一套成熟穩(wěn)定的基礎(chǔ)開發(fā)架構(gòu)和工作流程。
目前.NET上有不少開源框架。比如Apworks和ABP。其中Apworks是中國人寫的一套開源框架。它是一個全功能的,不僅可以寫分布式應(yīng)用,也可以寫桌面應(yīng)用。ABP的全稱是Asp.net boilerplate project(asp.net樣板工程)。是github上非常活躍的一個開源項目。它并沒有使用任何新的技術(shù),只是由兩名架構(gòu)師將asp.net開發(fā)中常用的一些工具整合到了一起,并且部分實現(xiàn)了DDD的概念。是一個開箱即用的框架,可以作為asp.net分布式應(yīng)用的一個良好起點。
使用框架當然有代價,你必須受到框架強API的侵入,抑或要使用他的方言。而且這個框架想要吃透,也要付出很大的學(xué)習(xí)成本。但是好處也是顯而易見的。業(yè)界頂尖的架構(gòu)師已經(jīng)為你搭建好了一套基礎(chǔ)架構(gòu),很好的回應(yīng)了關(guān)于一個軟件系統(tǒng)應(yīng)該如何設(shè)計,如何規(guī)劃的問題,并且提供了一套最佳實踐和范例。
學(xué)習(xí)雖然要付出成本,但是經(jīng)過漫長的跋涉,我們從一無所知已經(jīng)站到了工業(yè)級開發(fā)的門檻上。基于這個框架,我們可以很好的來劃分任務(wù),進行單元測試等。大大降低了軟件出現(xiàn)BUG的幾率。

從模板創(chuàng)建空的web應(yīng)用程序

ABP的官方網(wǎng)站:http://www.aspnetboilerplate.com
ABP在Github上的開源項目:https://github.com/aspnetboilerplate
ABP提供了一個啟動模板用于新建的項目(盡管你能手動地創(chuàng)建項目并且從nuget獲得ABP包,模板的方式更容易)。
轉(zhuǎn)到www.aspnetboilerplate.com/Templates從模板創(chuàng)建你的應(yīng)用程序。
你可以選擇SPA(AngularJs或DurandalJs)或者選擇MPA(經(jīng)典的多頁面應(yīng)用程序)項目??梢赃x擇Entity Framework或NHibernate作為ORM框架。
這里我們選擇AngularJs和Entity Framework,填入項目名稱“SimpleTaskSystem”,點擊“CREATE MY PROJECT”按鈕可以下載一個zip壓縮包,解壓后得到VS2013的解決方案,使用的.NET版本是 4.5.1。

每個項目里引用了Abp組件和其他第三方組件,需要從Nuget下載。

黃色感嘆號圖標,表示這個組件在本地文件夾中不存在,需要從Nuget上還原。操作如下:

要讓項目運行起來,還得創(chuàng)建一個數(shù)據(jù)庫。這個模板假設(shè)你正在使用SQL2008或者更新的版本。當然也可以很方便地換成其他的關(guān)系型數(shù)據(jù)庫。
打開Web.Config文件可以查看和配置鏈接字符串:

復(fù)制代碼 代碼如下:

add name="Default" connectionString="Server=localhost; Database=SimpleTaskSystemDb; Trusted_Connection=True;" />

(在后面用到EF的Code first數(shù)據(jù)遷移時,會自動在SQL Server數(shù)據(jù)庫中創(chuàng)建一個名為SimpleTaskSystemDb的數(shù)據(jù)庫。)
就這樣,項目已經(jīng)準備好運行了!打開VS2013并且按F5:
下面將逐步實現(xiàn)這個簡單的任務(wù)系統(tǒng)程序

創(chuàng)建實體
把實體類寫在Core項目中,因為實體是領(lǐng)域?qū)拥囊徊糠帧?br /> 一個簡單的應(yīng)用場景:創(chuàng)建一些任務(wù)(tasks)并分配給人。 我們需要Task和Person這兩個實體。
Task實體有幾個屬性:描述(Description)、創(chuàng)建時間(CreationTime)、任務(wù)狀態(tài)(State),還有可選的導(dǎo)航屬性(AssignedPerson)來引用Person。

public class Task : Entitylong>
{
  [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類繼承自Entitylong>,所以它有一個long類型的Id。Person類有一個int類型的Id,因為int類型是Entity基類Id的默認類型,沒有特別指定類型時,實體的Id就是int類型。

創(chuàng)建DbContext
使用EntityFramework需要先定義DbContext類,ABP的模板已經(jīng)創(chuàng)建了DbContext文件,我們只需要把Task和Person類添加到IDbSet,請看代碼:

public class SimpleTaskSystemDbContext : AbpDbContext
{
  public virtual IDbSetTask> Tasks { get; set; }

  public virtual IDbSetPerson> People { get; set; }

  public SimpleTaskSystemDbContext()
    : base("Default")
  {

  }

  public SimpleTaskSystemDbContext(string nameOrConnectionString)
    : base(nameOrConnectionString)
  {
      
  }
}

通過Database Migrations創(chuàng)建數(shù)據(jù)庫表
我們使用EntityFramework的Code First模式創(chuàng)建數(shù)據(jù)庫架構(gòu)。ABP模板生成的項目已經(jīng)默認開啟了數(shù)據(jù)遷移功能,我們修改SimpleTaskSystem.EntityFramework項目下Migrations文件夾下的Configuration.cs文件:

internal sealed class Configuration :

DbMigrationsConfigurationSimpleTaskSystem.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底部的“程序包管理器控制臺”窗口中,選擇默認項目并執(zhí)行命令“Add-Migration InitialCreate”

會在Migrations文件夾下生成一個xxxx-InitialCreate.cs文件,內(nèi)容如下:

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");
  }
}

然后繼續(xù)在“程序包管理器控制臺”執(zhí)行“Update-Database”,會自動在數(shù)據(jù)庫創(chuàng)建相應(yīng)的數(shù)據(jù)表:
PM> Update-Database

數(shù)據(jù)庫顯示如下:

(以后修改了實體,可以再次執(zhí)行Add-Migration和Update-Database,就能很輕松的讓數(shù)據(jù)庫結(jié)構(gòu)與實體類的同步)

定義倉儲接口
通過倉儲模式,可以更好把業(yè)務(wù)代碼與數(shù)據(jù)庫操作代碼更好的分離,可以針對不同的數(shù)據(jù)庫有不同的實現(xiàn)類,而業(yè)務(wù)代碼不需要修改。
定義倉儲接口的代碼寫到Core項目中,因為倉儲接口是領(lǐng)域?qū)拥囊徊糠帧?br /> 我們先定義Task的倉儲接口:

public interface ITaskRepository : IRepositoryTask, long>
{
  ListTask> GetAllWithPeople(int? assignedPersonId, TaskState? state);
}

它繼承自ABP框架中的IRepository泛型接口。
在IRepository中已經(jīng)定義了常用的增刪改查方法:

所以ITaskRepository默認就有了上面那些方法??梢栽偌由纤氂械姆椒℅etAllWithPeople(...)。

不需要為Person類創(chuàng)建一個倉儲類,因為默認的方法已經(jīng)夠用了。ABP提供了一種注入通用倉儲的方式,將在后面“創(chuàng)建應(yīng)用服務(wù)”一節(jié)的TaskAppService類中看到。

實現(xiàn)倉儲類
我們將在EntityFramework項目中實現(xiàn)上面定義的ITaskRepository倉儲接口。

通過模板建立的項目已經(jīng)定義了一個倉儲基類:SimpleTaskSystemRepositoryBase(這是一種比較好的實踐,因為以后可以在這個基類中添加通用的方法)。

public class TaskRepository : SimpleTaskSystemRepositoryBaseTask, long>, ITaskRepository
{
  public ListTask> GetAllWithPeople(int? assignedPersonId, TaskState? state)
  {
    //在倉儲方法中,不用處理數(shù)據(jù)庫連接、DbContext和數(shù)據(jù)事務(wù),ABP框架會自動處理。
      
    var query = GetAll(); //GetAll() 返回一個 IQueryableT>接口類型
      
    //添加一些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并且實現(xiàn)了上面定義的ITaskRepository接口。

 
創(chuàng)建應(yīng)用服務(wù)(Application Services)
在Application項目中定義應(yīng)用服務(wù)。首先定義Task的應(yīng)用服務(wù)層的接口:

public interface ITaskAppService : IApplicationService
{
  GetTasksOutput GetTasks(GetTasksInput input);
  void UpdateTask(UpdateTaskInput input);
  void CreateTask(CreateTaskInput input);
}

ITaskAppService繼承自IApplicationService,ABP自動為這個類提供一些功能特性(比如依賴注入和參數(shù)有效性驗證)。

然后,我們寫TaskAppService類來實現(xiàn)ITaskAppService接口:

public class TaskAppService : ApplicationService, ITaskAppService
{
  private readonly ITaskRepository _taskRepository;
  private readonly IRepositoryPerson> _personRepository;
    
  /// summary>
  /// 構(gòu)造函數(shù)自動注入我們所需要的類或接口
  /// /summary>
  public TaskAppService(ITaskRepository taskRepository, IRepositoryPerson> personRepository)
  {
    _taskRepository = taskRepository;
    _personRepository = personRepository;
  }
    
  public GetTasksOutput GetTasks(GetTasksInput input)
  {
    //調(diào)用Task倉儲的特定方法GetAllWithPeople
    var tasks = _taskRepository.GetAllWithPeople(input.AssignedPersonId, input.State);

    //用AutoMapper自動將ListTask>轉(zhuǎn)換成ListTaskDto>
    return new GetTasksOutput
        {
          Tasks = Mapper.MapListTaskDto>>(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);
    }

    //我們都不需要調(diào)用Update方法
    //因為應(yīng)用服務(wù)層的方法默認開啟了工作單元模式(Unit of Work)
    //ABP框架會工作單元完成時自動保存對實體的所有更改,除非有異常拋出。有異常時會自動回滾,因為工作單元默認開啟數(shù)據(jù)庫事務(wù)。
  }

  public void CreateTask(CreateTaskInput input)
  {
    Logger.Info("Creating a task for input: " + input);

    //通過輸入?yún)?shù),創(chuàng)建一個新的Task實體
    var task = new Task { Description = input.Description };

    if (input.AssignedPersonId.HasValue)
    {
      task.AssignedPersonId = input.AssignedPersonId.Value;
    }

    //調(diào)用倉儲基類的Insert方法把實體保存到數(shù)據(jù)庫中
    _taskRepository.Insert(task);
  }
}

TaskAppService使用倉儲進行數(shù)據(jù)庫操作,它通往構(gòu)造函數(shù)注入倉儲對象的引用。

數(shù)據(jù)驗證

如果應(yīng)用服務(wù)(Application Service)方法的參數(shù)對象實現(xiàn)了IInputDto或IValidate接口,ABP會自動進行參數(shù)有效性驗證。

CreateTask方法有一個CreateTaskInput參數(shù),定義如下:

public class CreateTaskInput : IInputDto
{
  public int? AssignedPersonId { get; set; }

  [Required]
  public string Description { get; set; }
}

Description屬性通過注解指定它是必填項。也可以使用其他 Data Annotation 特性。

如果你想使用自定義驗證,你可以實現(xiàn)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(ListValidationResult> results)
  {
    if (AssignedPersonId == null  State == null)
    {
      results.Add(new ValidationResult("AssignedPersonId和State不能同時為空!", new[] { "AssignedPersonId", "State" }));
    }
  }
}

你可以在AddValidationErrors方法中寫自定義驗證的代碼。

創(chuàng)建Web Api服務(wù)
ABP可以非常輕松地把Application Service的public方法發(fā)布成Web Api接口,可以供客戶端通過ajax調(diào)用。

DynamicApiControllerBuilder
  .ForAllIApplicationService>(Assembly.GetAssembly(typeof (SimpleTaskSystemApplicationModule)), "tasksystem")
  .Build();

SimpleTaskSystemApplicationModule這個程序集中所有繼承了IApplicationService接口的類,都會自動創(chuàng)建相應(yīng)的ApiController,其中的公開方法,就會轉(zhuǎn)換成WebApi接口方法。

可以通過http://xxx/api/services/tasksystem/Task/GetTasks這樣的路由地址進行調(diào)用。

通過上面的案例,大致介紹了領(lǐng)域?qū)?、基礎(chǔ)設(shè)施層、應(yīng)用服務(wù)層的用法。

現(xiàn)在,可以在ASP.NET MVC的Controller的Action方法中直接調(diào)用Application Service的方法了。

如果用SPA單頁編程,可以直接在客戶端通過ajax調(diào)用相應(yīng)的Application Service的方法了(通過創(chuàng)建了動態(tài)Web Api)。

您可能感興趣的文章:
  • BootStrap table表格插件自適應(yīng)固定表頭(超好用)
  • 值得分享的輕量級Bootstrap Table表格插件
  • ABP入門系列應(yīng)用BootstrapTable表格插件

標簽:房產(chǎn) 德宏 玉林 泰安 呂梁 喀什 佳木斯

巨人網(wǎng)絡(luò)通訊聲明:本文標題《基于ASP.NET MVC的ABP框架入門學(xué)習(xí)教程》,本文關(guān)鍵詞  ;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 收縮
    • 微信客服
    • 微信二維碼
    • 電話咨詢

    • 400-1100-266
    新和县| 江油市| 临沂市| 宾川县| 盐源县| 周宁县| 孙吴县| 康乐县| 吉首市| 曲沃县| 社会| 株洲市| 娱乐| 朝阳市| 嵩明县| 辛集市| 阳信县| 开远市| 舒城县| 邵东县| 吉首市| 张家界市| 乐安县| 徐汇区| 新巴尔虎右旗| 赣州市| 星子县| 分宜县| 金溪县| 庄河市| 格尔木市| 靖远县| 湄潭县| 龙井市| 灵寿县| 上杭县| 尖扎县| 梁平县| 泾川县| 阳曲县| 海城市|