abp(net core)+easyui+efcore倉儲系統目錄
abp(net core)+easyui+efcore倉儲系統——ABP總體介紹(一)
abp(net core)+easyui+efcore倉儲系統——解決方案介紹(二)
abp(net core)+easyui+efcore倉儲系統——領域層建立實體(三)
abp(net core)+easyui+efcore倉儲系統——定義倉儲並實現 (四)
在上一篇文章中學習了ABP的倉儲(Repository)功能,Repository對資料庫進行增刪改查操作。在這一篇文章中我們主要了解應用服務層。
一、解釋下應用服務層
應用服務用於將領域(業務)邏輯暴露給展現層。展現層通過傳入DTO(資料傳輸物件)引數來呼叫應用服務,而應用服務通過領域物件來執行相應的業務邏輯並且將DTO返回給展現層。因此,展現層和領域層將被完全隔離開來。
以下幾點,在建立應用服務時需要注意:
- 在ABP中,一個應用服務需要實現IApplicationService介面,最好的實踐是針對每個應用服務都建立相應繼承自IApplicationService的介面。(通過繼承該介面,ABP會自動幫助依賴注入)
- ABP為IApplicationService提供了預設的實現ApplicationService,該基類提供了方便的日誌記錄和本地化功能。實現應用服務的時候繼承自ApplicationService並實現定義的介面即可。
- ABP中,一個應用服務方法預設是一個工作單元(Unit of Work)。ABP針對UOW模式自動進行資料庫的連線及事務管理,且會自動儲存資料修改。
二、定義應用服務介面需要用到的DTO
1. 在Visual Studio 2017的“解決方案資源管理器”中,右鍵單擊“ABP.TPLMS.Application”專案。 選擇“新增” > “新建資料夾”。
2.將資料夾命名為“Modules”。
3. 右鍵單擊“Modules”資料夾,選擇“新增” > “新建資料夾”。將資料夾重新命名為“Dto”。如下圖。
4. 右鍵單擊“Dto”資料夾,然後選擇“新增” > “類”。 將類命名為 ModuleDto,然後選擇“新增”。程式碼如下。
using Abp.Application.Services.Dto; using Abp.AutoMapper; using ABP.TPLMS.Entitys; using System; using System.Collections.Generic; using System.Text; namespace ABP.TPLMS.Modules.Dto { [AutoMapFrom(typeof(Module))] public class ModuleDto:EntityDto<long> { public string DisplayName { get; set; } public string Name { get; set; } public string Url { get; set; } public string HotKey { get; set; } public int ParentId { get; set; } public bool RequiresAuthentication { get; set; } public bool IsAutoExpand { get; set; } public string IconName { get; set; } public int Status { get; set; } public string ParentName { get; set; } public string RequiredPermissionName { get; set; } public int SortNo { get; set; } } }
- 為了在頁面上展示模組資訊,Module
Dto
被用來將模組資料傳遞到基礎設施層。 - Module
Dto
繼承自EntityDto<long>
.跟在領域層定義的Module類一樣具有一些相同屬性。 [AutoMapFrom(typeof(Module))]
用來建立從Module類到ModuleDto
的對映.使用這種方法。你可以將Module物件自動轉換成ModuleDto
物件(而不是手動複製所有的屬性)。
5. 右鍵單擊“Dto”資料夾,然後選擇“新增” > “類”。 將類命名為 CreateUpdateModuleDto ,然後選擇“新增”。程式碼如下。
using Abp.Application.Services.Dto; using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.Text; namespace ABP.TPLMS.Modules.Dto { public class CreateUpdateModuleDto : EntityDto<long> { public const int MaxLength = 255; [Required] [StringLength(MaxLength)] public string DisplayName { get; set; } [Required] [StringLength(MaxLength)] public string Name { get; set; } [Required] [StringLength(MaxLength)] public string Url { get; set; } [StringLength(MaxLength)] public string HotKey { get; set; } public int ParentId { get; set; } public bool RequiresAuthentication { get; set; } public bool IsAutoExpand { get; set; } [StringLength(MaxLength)] public string IconName { get; set; } public int Status { get; set; } [Required] [StringLength(MaxLength)] public string ParentName { get; set; } [StringLength(MaxLength)] public string RequiredPermissionName { get; set; } public int SortNo { get; set; } } }
- 這個DTO類在建立和更新模組資訊的時候被使用,用來從頁面獲取模組資訊。
- 類中的屬性定義了資料註解(如[Required])用來定義有效性驗證。ABP會自動校驗DTO的資料有效性。
6. 為什麼需要通過dto進行資料傳輸?
一般來說,使用DTO進行資料傳輸具有以下好處。
- 資料隱藏
- 序列化和延遲載入問題
- ABP對DTO提供了約定類以支援驗證
- 引數或返回值改變,通過Dto方便擴充套件
- DTO類被用來在 基礎設施層 和 應用層 傳遞資料.
7.Dto規範 (靈活應用)
- ABP建議命名輸入/輸出引數為:MethodNameInput和MethodNameOutput
- 併為每個應用服務方法定義單獨的輸入和輸出DTO(如果為每個方法的輸入輸出都定義一個dto,那將有一個龐大的dto類需要定義維護。一般通過定義一個公用的dto進行共用)
- 即使你的方法只接受/返回一個引數,也最好是建立一個DTO類
- 一般會在對應實體的應用服務資料夾下新建Dtos資料夾來管理Dto類。
定義完DTO,是不是腦袋有個疑問,我在用DTO在展現層與應用服務層進行資料傳輸,但最終這些DTO都需要轉換為實體才能與資料庫直接打交道啊。如果每個dto都要自己手動去轉換成對應實體,這個工作量也是不可小覷啊。
聰明如你,你肯定會想肯定有什麼方法來減少這個工作量。
三、使用AutoMapper自動對映DTO與實體
1.簡要介紹AutoMapper
開始之前,如果對AutoMapper不是很瞭解,建議看下這篇文章AutoMapper小結。
AutoMapper的使用步驟,簡單總結下:
- 建立對映規則(Mapper.CreateMap<source, destination>();)
- 型別對映轉換(Mapper.Map<source,destination>(sourceModel))
在Abp中有兩種方式建立對映規則:
- 特性資料註解方式:
- AutoMapFrom、AutoMapTo 特性建立單向對映
- AutoMap 特性建立雙向對映
- 程式碼建立對映規則:
- Mapper.CreateMap<source, destination>();
2.為Module實體相關的Dto定義對映規則
ModuleDto、CreateUpdateModuleDto中的屬性名與Module實體的屬性命名一致,且只需要從Dto對映到實體,不需要反向對映。所以通過AutoMapTo建立單向對映即可。
[AutoMapTo(typeof(Module))] //定義單向對映 public class ModuleDto:EntityDto<long> { ... } [AutoMapTo(typeof(Module))] //定義單向對映 public class CreateUpdateModuleDto : EntityDto<long> { ... }
四、定義IModuleAppService介面
1. 右鍵單擊“Dto”資料夾,然後選擇“新增” > “新建項”,在彈出對話方塊中選擇“介面”。為應用服務定義一個名為 IModuleAppService
的介面。程式碼如下。
using Abp.Application.Services; using Abp.Application.Services.Dto; using ABP.TPLMS.Modules.Dto; using System; using System.Collections.Generic; using System.Text; using System.Threading.Tasks; namespace ABP.TPLMS.Modules { public interface IModuleAppService : IApplicationService { Task CreateAsync(CreateUpdateModuleDto input); Task UpdateAsync(CreateUpdateModuleDto input); Task<ListResultDto<ModuleDto>> GetAllAsync(); Task DeleteAsync(int Id); void Delete(int Id); } }
從上面的程式碼中我們仔細看一下方法的引數及返回值,大家可能會發現並未直接使用Module實體物件。這是為什麼呢?因為展現層與應用服務層是通過Data Transfer Object(DTO)進行資料傳輸。
五、實現IModuleAppService
對於具體的業務來講,只是簡單的增刪該查,實現起來就很簡單了。程式碼如下:
using Abp.Application.Services; using Abp.Application.Services.Dto; using Abp.Domain.Repositories; using ABP.TPLMS.Entitys; using ABP.TPLMS.Modules.Dto; using AutoMapper; using System; using System.Collections.Generic; using System.Text; using System.Threading.Tasks; namespace ABP.TPLMS.Modules { public class ModuleAppService : ApplicationService, IModuleAppService { private readonly IRepository<Module> _moduleRepository; public ModuleAppService(IRepository<Module> moduleRepository) { _moduleRepository = moduleRepository; } public Task CreateAsync(CreateUpdateModuleDto input) { var module = Mapper.Map<Module>(input); return _moduleRepository.InsertAsync(module); } public Task UpdateAsync(CreateUpdateModuleDto input) { var module = Mapper.Map<Module>(input); return _moduleRepository.UpdateAsync(module); } public async Task<ListResultDto<ModuleDto>> GetAllAsync() { var books = await _moduleRepository.GetAllListAsync(); return new ListResultDto<ModuleDto>(ObjectMapper.Map<List<ModuleDto>>(books)); } public async Task DeleteAsync(int Id) { await _moduleRepository.DeleteAsync(Id); } public void Delete(int Id) { _moduleRepository.Delete(Id); } } }