<<ABP框架>> 應用服務

来源:http://www.cnblogs.com/kid1412/archive/2016/10/27/6003490.html
-Advertisement-
Play Games

文檔目錄 本節內容： IApplicationService 介面 ApplicationService 類 CrudAppService 和 AsyncCrudAppService 類 簡單的CRUD應用服務示例 定製CRUD應用服務 獲取列表 創建和更新 其它 工作單元 一個應用服務生命周期 簡 ...


文檔目錄

 

本節內容：

 

應用服務把領域邏輯暴露給展現層。一個應用服務被展現層使用一個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);
    }
}

這裡有幾個關鍵點：

  • PersonAppService使用IRepository<Person>執行資料庫操作，它使用構造器註入模式，這裡我們使用依賴註入。
  • PersonAppService實現IApplicationService（因為IPersonAppService擴展了IApplicationService），它自動被ABP註入到依賴註入系統，然後被其它類註入並使用。這裡命名約定很重要，查看依賴註入文檔獲取更多信息。
  • CreatePerson方法取得CreatePersonInput，它是一個輸入的DTO並被ABP自動驗證，更多細節查看DTO和驗證文檔。

 

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（短暫的），也就說：它們都是暫存於每次使用里。更多信息查看依賴註入文檔。

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Emit學習(2) - IL
    學習Emit必不可少的, 會使用到IL中間代碼. 初見IL代碼, 讓我有一種彙編的感覺, 讓我想起了, 大學時, 學習8051的彙編語言. 多的就不扯了, 直接進入正題, OpCodes指令集是不是有一種讓人望而卻步的感覺, 那麼多, 具體我沒有數過, 但是肯定是比8051的指令多不少, 應該有20 ...
  • mvc過濾器學習(1)
    mvc 過濾器結構圖 AuthorizeAttribute AuthorizeAttribute是IAuthorizationFilter的預設實現,添加了Authorize特性的Action將對用戶進行驗證授權,只有通過了用戶才可以進入這個Action. AuthorizeAttribute提供了 ...
  • WinFrom窗體始終置頂
    調用WindowsAPI使窗體始終保持置頂效果，不被其他窗體遮蓋： 使用方式：在需要置頂的窗體的Load方法裡面加上 ...
  • 將文本文件的內容存儲在DataSet中的方法總結
    項目中比較多的會對文件進行操作，例如文件的上傳下載，文件的壓縮和解壓等IO操作。在.NET項目中較多的會使用DataSet，DataTable進行數據的緩存。 項目中對文本文件的操作比較簡單，但是如果需要將文本文件的內容寫入系統的緩存中，操作起來，會稍微的繁瑣一些。現在總結一個較為通用的方法，將文本 ...
  • Linq詳細語法
    閑言碎語 近期比較忙，但還是想寫點什麼，就分享一些基礎的知識給大家看吧，希望能幫助一些linq新手，如果有其它疑問，可以加我QQ，進行交流探討，謝謝。 開門見山 讀這篇文章之前，我先說下，每一種搜索結果集，我都以三種方式變現出來，為啦更好的理解，希望不要嫌我啰嗦。 1.簡單的linq語法 2.帶wh ...
  • 一些踩過的坑
    1）關於特性過濾器 這個我們經常用到，一般用在捕捉異常還有許可權控制等方面，這個用著比較方便，但是這個確隱藏著一個坑，就是呢，特性過濾器會在被第一次訪問的時候創建一次，僅僅會被創建一次，然後就被aspnet緩存下來，之後就是取緩存了。 所以說如果我們要定義特性類的話，必須要註意一點就是裡面不能包含狀態 ...
  • WPF自定義RoutedEvent事件代碼段
    今天在寫東西的時候，發現常用的代碼段里沒有RoutedEvent的，因此，寫了一個代碼段，方便以後使用，順便記錄一下，如何做代碼段。 1、在項目中新建一個XML文件，將擴展名修改為snippet。 2、打開文件，然後右鍵--插入代碼段--snippet 3、出現預設的代碼段實例，修改不同的位置 4、 ...
  • [開源ORM] SqliteSugar 3.x .net Core版本成功上線
    SqliteSqlSugar 3.X API 作為支持.NET CORE 為數不多的ORM之一，除了具有優越的性能外，還擁有強大的功能，不只是滿足你的增,刪,查和改。實質上擁有更多你想像不到的功能,當你需要實現某個功能時會發現有這個功能太棒了。 因為每個版本的貼子API都基本一致，所以我也說一些別的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類