文檔目錄
本節內容:
應用服務把領域邏輯暴露給展現層。一個應用服務被展現層使用一個DTO(數據傳輸對象)參數所調用,使用領域對象執行一些特殊業務邏輯並返回一個DTO給展現層。因此,展現層是完全獨立於領域層,在一個理想的分層應用裡,展現層從不直接使用領域對象。
IApplicationService 接口
在ABP裡,一個應用服務應當實現IApplicationService接口,為每個應用服務創建一個接口是好的做法,所以我們先為一個應用服務創建一個接口,如下所示:
public interface IPersonAppService : IApplicationService { void CreatePerson(CreatePersonInput input); }
IPersonAppService只有一個方法,它被展現層用來創建一個新的person,CreatePersonInput是一個DTO對象,如下所示:
public class CreatePersonInput { [Required] public string Name { get; set; } public string EmailAddress { get; set; } }
然後我們可以實現IPersonAppService:
public class PersonAppService : IPersonAppService { private readonly IRepository<Person> _personRepository; public PersonAppService(IRepository<Person> 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); } }
這裡有幾個關鍵點:
ApplicationService 類
一個應用服務應當實現IApplicationService接口,如上所示,也可隨意的繼承於ApplicationService基類,因為它內部實現了IApplicationService,同時ApplicationService有些基本的功能,使得日志、本地化等更容易。建議為你的應用服務創建一個特殊的繼承於ApplicationService類的基類,從而可以為所有應用服務添加一些通用的功能,一個應用服務示例如下:
public class TaskAppService : ApplicationService, ITaskAppService { public TaskAppService() { LocalizationSourceName = "SimpleTaskSystem"; } public void CreateTask(CreateTaskInput input) { //Write some logs (Logger is defined in ApplicationService class) Logger.Info("Creating a new task with description: " + input.Description); //Get a localized text (L is a shortcut for LocalizationHelper.GetString(...), defined in ApplicationService class) var text = L("SampleLocalizableTextKey"); //TODO: Add new task to database... } }
你有一個在構造器裡定義了LocalizationSourceName的基類,這樣,你就不用為所有的服務類重復定義了,這個主題的更多信息請查看日志和本地化文檔。
CrudAppService 和 AsyncCrueAppService 類
如果你需要為一個特定的實體創建一個包含Create、Update、Delete、GetAll方法的應用服務,可以從CrudAppService(或AsyncCrudAppService,創建異步方法)繼承,CrudAppService基類是一個以相關Entity和DTO類型為參數的泛型,並可通過重寫功能進行你需要的定制。
簡單的CRUD應用服務示例
假設你有一個Task實體,定義如下:
public class Task : Entity, IHasCreationTime { public string Title { get; set; } public string Description { get; set; } public DateTime CreationTime { get; set; } public TaskState State { get; set; } public Person AssignedPerson { get; set; } public Guid? AssignedPersonId { get; set; } public Task() { CreationTime = Clock.Now; State = TaskState.Open; } }
我們為該實體創建一個DTO:
[AutoMap(typeof(Task))] public class TaskDto : EntityDto, IHasCreationTime { public string Title { get; set; } public string Description { get; set; } public DateTime CreationTime { get; set; } public TaskState State { get; set; } public Guid? AssignedPersonId { get; set; } public string AssignedPersonName { get; set; } }
AutoMap特性創建實體與DTO之間的映射配置,現在,我們可以創建一個應用服務,如:
public class TaskAppService : AsyncCrudAppService<Task, TaskDto> { public TaskAppService(IRepository<Task> repository) : base(repository) { } }
我們注入倉儲並把它傳給基類(如果要使用同步的方法,我們可以從CrudAppService繼承)。這就是所有代碼!TaskAppService現在就已經有了簡單的CRUD方法,如果你想為這個應用服務創建一個接口,可以像下面這樣:
public interface ITaskAppService : IAsyncCrudAppService<TaskDto> { }
注意:IAsyncCrudAppService沒有以實體(Task)作為泛型參數,因為實體與實現相關,不應該包含在公開的接口裡,接下來,我們就可以為TaskAppService類實現ITaskAppService接口:
public class TaskAppService : AsyncCrudAppService<Task, TaskDto>, ITaskAppService { public TaskAppService(IRepository<Task> repository) : base(repository) { } }
定制CRUD應用服務
獲取列表
Crud應用服務的GetAll方法默認以PagedAndSortedResultRequestInput為參數,該參數提供可選的排序和分頁參數,但你可能想為GetAll方法添加另一個參數,例如:你想添加一些自定義過濾,這種情況,你可以為GetAll方法創建一個DTO,如:
public class GetAllTasksInput : PagedAndSortedResultRequestInput { public TaskState? State { get; set; } }
我們從PagedAndSortedResultRequestInput繼承(不是必須,但可以直接從基類得到paging和sorting參數),並添加一個可空的State屬性,用來過濾task。現在我們應該修改TaskAppService,使它接受自定義過濾:
public class TaskAppService : AsyncCrudAppService<Task, TaskDto, int, GetAllTasksInput> { public TaskAppService(IRepository<Task> repository) : base(repository) { } protected override IQueryable<Task> CreateFilteredQuery(GetAllTasksInput input) { return base.CreateFilteredQuery(input) .WhereIf(input.State.HasValue, t => t.State == input.State.Value); } }
首先,我們添加GetAllTasksInputAsyncCrudAppService第4個泛型參數(第三個是實體主鍵的類型),然後重寫CreateFilteredQuery方法實現自定義過濾,該方法是AsyncCrudAppService類的一個擴展點(WhereIf是ABP的一個擴展方法,用來簡化條件過濾,但實質上我們所做的是簡單過濾一個IQueryable)。
注意:如果你已創建應用服務接口,那麼你就需要為接口添加相同的泛型參數。
創建和更新
注意:我們為獲取、創建和更新Task使用相同的DTO(TaskDto),在現實應用裡,這可能不太好,所以我們想定制創建和更新的DTO,讓我們從創建一個CreateTaskInput類開始:
[AutoMapTo(typeof(Task))] public class CreateTaskInput { [Required] [MaxLength(Task.MaxTitleLength)] public string Title { get; set; } [MaxLength(Task.MaxDescriptionLength)] public string Description { get; set; } public Guid? AssignedPersonId { get; set; } }
接著創建一個UpdateTaskInput DTO:
[AutoMapTo(typeof(Task))] public class UpdateTaskInput : CreateTaskInput, IEntityDto { public int Id { get; set; } public TaskState State { get; set; } }
我們為Update操作從CreateTaskInput上繼承所有屬性(但你也可以不這麼做),此處必須實現實現IEntity(或不同於int類型的主鍵的IEntity<PrimaryKey>),因為我們需要知道哪一個實體需要更新,最後,我添加了一個額外的屬性State,它不包含在CreateTaskInput裡。
接下來,我們可以使用這些DTO類作為AsyncCrudAppService類的泛型接口,如下所示:
public class TaskAppService : AsyncCrudAppService<Task, TaskDto, int, GetAllTasksInput, CreateTaskInput, UpdateTaskInput> { public TaskAppService(IRepository<Task> repository) : base(repository) { } protected override IQueryable<Task> CreateFilteredQuery(GetAllTasksInput input) { return base.CreateFilteredQuery(input) .WhereIf(input.State.HasValue, t => t.State == input.State.Value); } }
不需要修改其它的代碼。
其它
如果你想定制Get和Delete方法的input的DTO,AsyncCrudAppService可以接受更多的泛型參數。同樣,所有的基類方法都是virtual,所以你可以重寫它們進行行為定制。
工作單元
在ABP裡一個應用服務方法就是一個工作單元,因此,任何一個應用服務方法都是事務性的,並自動在方法結束時保存修改到數據庫。
更多信息查看工作單元文檔。
一個應用服務的生命周期
所有應用服務實體都是Transient(短暫的),也就說:它們都是暫存於每次使用裡。更多信息查看依賴注入文檔。