解析ABP框架中的數(shù)據(jù)傳輸對象與應(yīng)用服務(wù)

數(shù)據(jù)傳輸對象（DTOs）
數(shù)據(jù)傳輸對象(Data Transfer Objects)用于應(yīng)用層和展現(xiàn)層的數(shù)據(jù)傳輸。

展現(xiàn)層傳入數(shù)據(jù)傳輸對象(DTO)調(diào)用一個(gè)應(yīng)用服務(wù)方法，接著應(yīng)用服務(wù)通過領(lǐng)域?qū)ο髨?zhí)行一些特定的業(yè)務(wù)邏輯并且返回DTO給展現(xiàn)層。這樣展現(xiàn)層和領(lǐng)域?qū)颖煌耆蛛x開了。在具有良好分層的應(yīng)用程序中，展現(xiàn)層不會直接使用領(lǐng)域?qū)ο?倉庫，實(shí)體)。

1.數(shù)據(jù)傳輸對象的作用：
為每個(gè)應(yīng)用服務(wù)方法創(chuàng)建DTO看起來是一項(xiàng)乏味耗時(shí)的工作。但如果你正確使用它們，這將會解救你的項(xiàng)目。為啥呢？

（1）抽象領(lǐng)域?qū)?(Abstraction of domain layer)

在展現(xiàn)層中數(shù)據(jù)傳輸對象對領(lǐng)域?qū)ο筮M(jìn)行了有效的抽象。這樣你的層(layers)將被恰當(dāng)?shù)母綦x開來。甚至當(dāng)你想要完全替換展現(xiàn)層時(shí)，你還可以繼續(xù)使用已經(jīng)存在的應(yīng)用層和領(lǐng)域?qū)印７粗?，你可以重寫領(lǐng)域?qū)?，修改?shù)據(jù)庫結(jié)構(gòu)，實(shí)體和ORM框架，但并不需要對展現(xiàn)層做任何修改，只要你的應(yīng)用層沒有發(fā)生改變。

（2）數(shù)據(jù)隱藏 (Data hiding)

想象一下，你有一個(gè)User實(shí)體擁有屬性Id, Name, EmailAddress和Password。如果UserAppService的GetAllUsers()方法的返回值類型為List。這樣任何人都可以查看所有人的密碼，即使你沒有將它打印在屏幕上。這不僅僅是安全問題，這還跟數(shù)據(jù)隱藏有關(guān)。應(yīng)用服務(wù)應(yīng)只返回展現(xiàn)層所需要的，不多不少剛剛好。

（3）序列化 惰性加載 (Serialization lazy load problems)

當(dāng)你將數(shù)據(jù)(對象)返回給展現(xiàn)層時(shí)，數(shù)據(jù)有可能會被序列化。舉個(gè)例子，在一個(gè)返回Json的MVC的Action中，你的對象需要被序列化成JSON并發(fā)送給客戶端。直接返回實(shí)體給展現(xiàn)層將有可能會出現(xiàn)麻煩。

在真實(shí)的項(xiàng)目中，實(shí)體會引用其他實(shí)體。User實(shí)體會引用Role實(shí)體。所以，當(dāng)你序列化User時(shí)，Role也將被序列化。而且Role還擁有一個(gè)List并且Permission還引用了PermissionGroup等等….你能想象這些對象都將被序列化嗎？這有很有可能使整個(gè)數(shù)據(jù)庫數(shù)據(jù)意外的被序列化。那么該如何解決呢？將屬性標(biāo)記為不可序列化？不行，因?yàn)槟悴恢缹傩院螘r(shí)該被序列化何時(shí)不該序列化。所以在這種情況下，返回一個(gè)可安全序列化，特別定制的數(shù)據(jù)傳輸對象是不錯(cuò)的選擇哦。

幾乎所有的ORM框架都支持惰性加載。只有當(dāng)你需要加載實(shí)體時(shí)它才會被加載。比如User類型引用Role類型。當(dāng)你從數(shù)據(jù)庫獲取User時(shí)，Role屬性并沒有被填充。當(dāng)你第一次讀取Role屬性時(shí)，才會從數(shù)據(jù)庫中加載Role。所以，當(dāng)你返回這樣一個(gè)實(shí)體給展現(xiàn)層時(shí)，很容易引起副作用（從數(shù)據(jù)庫中加載）。如果序列化工具讀取實(shí)體，它將會遞歸地讀取所有屬性，這樣你的整個(gè)數(shù)據(jù)庫都將會被讀取。

在展現(xiàn)層中使用實(shí)體還會有更多的問題。最佳的方案就是展現(xiàn)層不應(yīng)該引用任何包含領(lǐng)域?qū)拥某绦蚣?/p>

2.DTO 約定 驗(yàn)證
ABP對數(shù)據(jù)傳輸對象提供了強(qiáng)大的支持。它提供了一些相關(guān)的(Conventional)類型 接口并對DTO命名和使用約定提供了建議。當(dāng)你像這里一樣使用DTO，ABP將會自動化一些任務(wù)使你更加輕松。

一個(gè)例子 (Example)

讓我們來看一個(gè)完整的例子。我們相要編寫一個(gè)應(yīng)用服務(wù)方法根據(jù)name來搜索people并返回people列表。Person實(shí)體代碼如下:

public class Person : Entity
{
  public virtual string Name { get; set; }
  public virtual string EmailAddress { get; set; }
  public virtual string Password { get; set; }
}

首先，我們定義一個(gè)應(yīng)用服務(wù)接口:

public interface IPersonAppService : IApplicationService
{
  SearchPeopleOutput SearchPeople(SearchPeopleInput input);
}

ABP建議命名input/ouput對象類似于MethodNameInput/MethodNameOutput，對于每個(gè)應(yīng)用服務(wù)方法都需要將Input和Output進(jìn)行分開定義。甚至你的方法只接收或者返回一個(gè)值，也最好創(chuàng)建相應(yīng)的DTO類型。這樣，你的代碼才會更具有擴(kuò)展性，你可以添加更多的屬性而不需要更改方法的簽名，這并不會破壞現(xiàn)有的客戶端應(yīng)用。

當(dāng)然，方法返回值有可能是void，之后你添加一個(gè)返回值并不會破壞現(xiàn)有的應(yīng)用。如果你的方法不需要任何參數(shù)，那么你不需要定義一個(gè)Input Dto。但是創(chuàng)建一個(gè)Input Dto可能是個(gè)更好的方案，因?yàn)樵摲椒ㄔ趯碛锌赡軙枰粋€(gè)參數(shù)。當(dāng)然是否創(chuàng)建這取決于你。 Input和Output DTO類型定義如下：

public class SearchPeopleInput : IInputDto
{
  [StringLength(40, MinimumLength = 1)]
  public string SearchedName { get; set; }
}

public class SearchPeopleOutput : IOutputDto
{
  public ListPersonDto> People { get; set; }
}

public class PersonDto : EntityDto
{
  public string Name { get; set; }
  public string EmailAddress { get; set; }
}

驗(yàn)證：作為約定，Input DTO實(shí)現(xiàn)IInputDto 接口，Output DTO實(shí)現(xiàn)IOutputDto接口。當(dāng)你聲明IInputDto參數(shù)時(shí), 在方法執(zhí)行前ABP將會自動對其進(jìn)行有效性驗(yàn)證。這類似于ASP.NET MVC驗(yàn)證機(jī)制，但是請注意應(yīng)用服務(wù)并不是一個(gè)控制器(Controller)。ABP對其進(jìn)行攔截并檢查輸入。查看DTO 驗(yàn)證(DTO Validation)文檔獲取更多信息。 EntityDto是一個(gè)簡單具有與實(shí)體相同的Id屬性的簡單類型。如果你的實(shí)體Id不為int型你可以使用它泛型版本。EntityDto也實(shí)現(xiàn)了IDto接口。你可以看到PersonDto并不包含Password屬性，因?yàn)檎宫F(xiàn)層并不需要它。

跟進(jìn)一步之前我們先實(shí)現(xiàn)IPersonAppService：

public class PersonAppService : IPersonAppService
{
  private readonly IPersonRepository _personRepository;

  public PersonAppService(IPersonRepository personRepository)
  {
    _personRepository = personRepository;
  }
  public SearchPeopleOutput SearchPeople(SearchPeopleInput input)
  {
    //獲取實(shí)體
    var peopleEntityList = _personRepository.GetAllList(person => person.Name.Contains(input.SearchedName));

    //轉(zhuǎn)換成DTO
    var peopleDtoList = peopleEntityList
      .Select(person => new PersonDto
                {
                  Id = person.Id,
                  Name = person.Name,
                  EmailAddress = person.EmailAddress
                }).ToList();

    return new SearchPeopleOutput { People = peopleDtoList };
  }
}

 
我們從數(shù)據(jù)庫獲取實(shí)體，將實(shí)體轉(zhuǎn)換成DTO并返回output。注意我們沒有手動檢測Input的數(shù)據(jù)有效性。ABP會自動驗(yàn)證它。ABP甚至?xí)z查Input是否為null，如果為null則會拋出異常。這避免了我們在每個(gè)方法中都手動檢查數(shù)據(jù)有效性。

但是你很可能不喜歡手動將Person實(shí)體轉(zhuǎn)換成PersonDto。這真的是個(gè)乏味的工作。Peson實(shí)體包含大量屬性時(shí)更是如此。

3.DTO和實(shí)體間的自動映射
還好這里有些工具可以讓映射（轉(zhuǎn)換）變得十分簡單。AutoMapper就是其中之一。你可以通過nuget把它添加到你的項(xiàng)目中。讓我們使用AutoMapper來重寫SearchPeople方法:

public SearchPeopleOutput SearchPeople(SearchPeopleInput input)
{
  var peopleEntityList = _personRepository.GetAllList(person => person.Name.Contains(input.SearchedName));
  return new SearchPeopleOutput { People = Mapper.MapListPersonDto>>(peopleEntityList) };
}

這就是全部代碼。你可以在實(shí)體和DTO中添加更多的屬性，但是轉(zhuǎn)換代碼依然保持不變。在這之前你只需要做一件事：映射

Mapper.CreateMapPerson, PersonDto>();

AutoMapper創(chuàng)建了映射的代碼。這樣，動態(tài)映射就不會成為性能問題。真是快速又方便。AutoMapper根據(jù)Person實(shí)體創(chuàng)建了PersonDto,并根據(jù)命名約定來給PersonDto的屬性賦值。命名約定是可配置的并且很靈活。你也可以自定義映射和使用更多特性，查看AutoMapper的文檔獲取更多信息。

4.使用特性(attributes)和擴(kuò)展方法來映射 (Mapping using attributes and extension methods)

ABP提供了幾種attributes和擴(kuò)展方法來定義映射。使用它你需要通過nuget將Abp.AutoMapper添加到你的項(xiàng)目中。使用AutoMap特性(attribute)可以有兩種方式進(jìn)行映射，一種是使用AutoMapFrom和AutoMapTo。另一種是使用MapTo擴(kuò)展方法。定義映射的例子如下：

 
[AutoMap(typeof(MyClass2))] //定義映射（這樣有兩種方式進(jìn)行映射）
public class MyClass1
{
  public string TestProp { get; set; }
}

public class MyClass2
{
  public string TestProp { get; set; }
}
 

接著你可以通過MapTo擴(kuò)展方法來進(jìn)行映射：

var obj1 = new MyClass1 { TestProp = "Test value" };
var obj2 = obj1.MapToMyClass2>(); //創(chuàng)建了新的MyClass2對象，并將obj1.TestProp的值賦值給新的MyClass2對象的TestProp屬性。
上面的代碼根據(jù)MyClass1創(chuàng)建了新的MyClass2對象。你也可以映射已存在的對象，如下所示：
var obj1 = new MyClass1 { TestProp = "Test value" };
var obj2 = new MyClass2();
obj1.MapTo(obj2); //根據(jù)obj1設(shè)置obj2的屬性

5.輔助接口和類型
ABP還提供了一些輔助接口，定義了常用的標(biāo)準(zhǔn)化屬性。

ILimitedResultRequest定義了MaxResultCount屬性。所以你可以在你的Input DTO上實(shí)現(xiàn)該接口來限制結(jié)果集數(shù)量。

IPagedResultRequest擴(kuò)展了ILimitedResultRequest，它添加了SkipCount屬性。所以我們在SearchPeopleInput實(shí)現(xiàn)該接口用來分頁: 

public class SearchPeopleInput : IInputDto, IPagedResultRequest
{
  [StringLength(40, MinimumLength = 1)]
  public string SearchedName { get; set; }

  public int MaxResultCount { get; set; }
  public int SkipCount { get; set; }
}

對于分頁請求，你可以將實(shí)現(xiàn)IHasTotalCount的Output DTO作為返回結(jié)果。標(biāo)準(zhǔn)化屬性幫助我們創(chuàng)建可復(fù)用的代碼和規(guī)范?？稍贏bp.Application.Services.Dto命名空間下查看其他的接口和類型。

應(yīng)用服務(wù)
應(yīng)用服務(wù)用于將領(lǐng)域(業(yè)務(wù))邏輯暴露給展現(xiàn)層。展現(xiàn)層通過傳入DTO(數(shù)據(jù)傳輸對象)參數(shù)來調(diào)用應(yīng)用服務(wù)，而應(yīng)用服務(wù)通過領(lǐng)域?qū)ο髞韴?zhí)行相應(yīng)的業(yè)務(wù)邏輯并且將DTO返回給展現(xiàn)層。因此，展現(xiàn)層和領(lǐng)域?qū)訉⒈煌耆綦x開來。在一個(gè)理想的層級項(xiàng)目中，展現(xiàn)層應(yīng)該從不直接訪問領(lǐng)域?qū)ο蟆?/p>

1.IApplicationService接口
在ABP中，一個(gè)應(yīng)用服務(wù)需要實(shí)現(xiàn)IApplicationService接口。最好的實(shí)踐是針對每個(gè)應(yīng)用服務(wù)都創(chuàng)建相應(yīng)的接口。所以，我們首先定義一個(gè)應(yīng)用服務(wù)接口，如下所示：

public interface IPersonAppService : IApplicationService
{
  void CreatePerson(CreatePersonInput input);
}

IPersonAppService只有一個(gè)方法，它將被展現(xiàn)層調(diào)用來創(chuàng)建一個(gè)新的Person。CreatePersonInput是一個(gè)DTO對象，如下所示：

public class CreatePersonInput : IInputDto
{
  [Required]
  public string Name { get; set; }

  public string EmailAddress { get; set; }
}

public class PersonAppService : IPersonAppService
{
  private readonly IRepositoryPerson> _personRepository;
  public PersonAppService(IRepositoryPerson> personRepository)
  {
    _personRepository = personRepository;
  }

  public void CreatePerson(CreatePersonInput input)
  {
    var person = _personRepository.FirstOrDefault(p => p.EmailAddress == input.EmailAddress);
    if (person != null)
    {
      throw new UserFriendlyException("There is already a person with given email address");
    }

    person = new Person { Name = input.Name, EmailAddress = input.EmailAddress };
    _personRepository.Insert(person);
  }
}

 
以下是幾個(gè)重要提示：

• PersonAppService通過IRepository來執(zhí)行數(shù)據(jù)庫操作。它通過構(gòu)造器注入模式來生成。我們在這里使用了依賴注入。
• PersonAppService實(shí)現(xiàn)了IApplicationService（通過IPersonAppService繼承IApplicationService）。ABP會自動地把它注冊到依賴注入系統(tǒng)中，并可以注入到別的類型中使用。
• CreatePerson方法需要一個(gè)CreatePersonInput類型的參數(shù)。這是一個(gè)作為輸入的DTO，它將被ABP自動驗(yàn)證其數(shù)據(jù)有效性?？梢圆榭碊TO和數(shù)據(jù)有效性驗(yàn)證(Validation)文檔獲取相關(guān)細(xì)節(jié)。

2.應(yīng)用服務(wù)類型

應(yīng)用服務(wù)(Application Services)需要實(shí)現(xiàn)IApplicationService接口。當(dāng)然，你可以選擇將你的應(yīng)用服務(wù)(Application Services)繼承自ApplicationService基類，這樣你的應(yīng)用服務(wù)也就自然而然的實(shí)現(xiàn)IApplicationService接口了。ApplicationService基類提供了方便的日志記錄和本地化功能。在此建議你針對你的應(yīng)用程序創(chuàng)建一個(gè)應(yīng)用服務(wù)基類繼承自ApplicationService類型。這樣你就可以添加一些公共的功能來提供給你的所有應(yīng)用服務(wù)使用。一個(gè)應(yīng)用服務(wù)示例如下所示：

public class TaskAppService : ApplicationService, ITaskAppService
{
  public TaskAppService()
  {
    LocalizationSourceName = "SimpleTaskSystem";
  }

  public void CreateTask(CreateTaskInput input)
  {
    //記錄日志，Logger定義在ApplicationService中
    Logger.Info("Creating a new task with description: " + input.Description);

    //獲取本地化文本(L是LocalizationHelper.GetString(...)的簡便版本, 定義在 ApplicationService類型)
    var text = L("SampleLocalizableTextKey");

    //TODO: Add new task to database...
  }
}

 本例中我們在構(gòu)造函數(shù)中定義了LocalizationSourceName，但你可以在基類中定義它，這樣你就不需要在每個(gè)具體的應(yīng)用服務(wù)中定義它。查看日志記錄(logging)和本地化(localization)文檔可以獲取更多的相關(guān)信息。