ABP.IO WEB應用程式框架新手教學 No.07 開發教學第 6 部分作者：領域層

2021-07-23

2493
0
ABP
2021-07-26

使用一些 DDD 最佳實踐來實作 Author 的領域層

Web 應用程序開發教程 - 第 6 部分：作者：領域層

關於本教程

在本系列教程中，您將構建一個名為Acme.BookStore. 此應用程序用於管理書籍及其作者的列表。它是使用以下技術開發的：

Entity Framework Core作為 ORM 提供者。
Angular作為 UI 框架。

本教程分為以下幾個部分；

下載源代碼

本教程根據您的UI和數據庫首選項有多個版本。我們準備了幾個要下載的源代碼組合：

介紹

在前面的部分中，我們已經使用 ABP 基礎架構輕鬆構建了一些服務；

使用CrudAppService基類，而不是為標準的創建、讀取、更新和刪除操作手動開發應用程序服務。
使用通用存儲庫來完全自動化數據庫層。

對於“作者”部分；

我們將手動完成一些操作，以展示您在需要時如何進行操作。
我們將實施一些領域驅動設計 (DDD) 最佳實踐。

開發將逐層進行，以一次集中在單個層上。在實際項目中，您將按功能（垂直）開發應用程序功能，如前幾部分所述。通過這種方式，您將體驗兩種方法。

作者實體

Authors在Acme.BookStore.Domain項目中創建一個文件夾（命名空間）並在其中添加一個Author類：

using System;
using JetBrains.Annotations;
using Volo.Abp;
using Volo.Abp.Domain.Entities.Auditing;

namespace Acme.BookStore.Authors
{
    public class Author : FullAuditedAggregateRoot<Guid>
    {
        public string Name { get; private set; }
        public DateTime BirthDate { get; set; }
        public string ShortBio { get; set; }

        private Author()
        {
            /* This constructor is for deserialization / ORM purpose */
        }

        internal Author(
            Guid id,
            [NotNull] string name,
            DateTime birthDate,
            [CanBeNull] string shortBio = null)
            : base(id)
        {
            SetName(name);
            BirthDate = birthDate;
            ShortBio = shortBio;
        }

        internal Author ChangeName([NotNull] string name)
        {
            SetName(name);
            return this;
        }

        private void SetName([NotNull] string name)
        {
            Name = Check.NotNullOrWhiteSpace(
                name, 
                nameof(name), 
                maxLength: AuthorConsts.MaxNameLength
            );
        }
    }
}

繼承自FullAuditedAggregateRoot<Guid>which 使實體軟刪除（這意味著當您刪除它時，它不會在數據庫中刪除，而只是標記為已刪除）具有所有審計屬性。
private set因為Name屬性限制從這個類中設置這個屬性。有兩種設置名稱的方法（在這兩種情況下，我們都驗證名稱）：
- 在構造函數中，同時創建一個新作者。
- ChangeName稍後使用該方法更新名稱。
的constructor和ChangeName方法是internal迫使僅在域層使用這些方法，使用AuthorManager將在後面說明。
Checkclass 是一個 ABP 框架實用程序類，可幫助您檢查方法參數（它會引發ArgumentException無效情況）。

AuthorConsts是一個簡單的類，位於項目的Authors命名空間（文件夾）下Acme.BookStore.Domain.Shared：

namespace Acme.BookStore.Authors
{
    public static class AuthorConsts
    {
        public const int MaxNameLength = 64;
    }
}

在Acme.BookStore.Domain.Shared項目內部創建了這個類，因為我們稍後將在數據傳輸對象(DTO)上重用它。

AuthorManager：領域服務

Author構造函數和ChangeName方法是internal，因此它們只能在領域層中使用。

在 Acme.BookStore.Domain 專案的Authors文件夾（命名空間）中創建一個類 AuthorManager：

using System;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Volo.Abp;
using Volo.Abp.Domain.Services;

namespace Acme.BookStore.Authors
{
    public class AuthorManager : DomainService
    {
        private readonly IAuthorRepository _authorRepository;

        public AuthorManager(IAuthorRepository authorRepository)
        {
            _authorRepository = authorRepository;
        }

        public async Task<Author> CreateAsync(
            [NotNull] string name,
            DateTime birthDate,
            [CanBeNull] string shortBio = null)
        {
            Check.NotNullOrWhiteSpace(name, nameof(name));

            var existingAuthor = await _authorRepository.FindByNameAsync(name);
            if (existingAuthor != null)
            {
                throw new AuthorAlreadyExistsException(name);
            }

            return new Author(
                GuidGenerator.Create(),
                name,
                birthDate,
                shortBio
            );
        }

        public async Task ChangeNameAsync(
            [NotNull] Author author,
            [NotNull] string newName)
        {
            Check.NotNull(author, nameof(author));
            Check.NotNullOrWhiteSpace(newName, nameof(newName));

            var existingAuthor = await _authorRepository.FindByNameAsync(newName);
            if (existingAuthor != null && existingAuthor.Id != author.Id)
            {
                throw new AuthorAlreadyExistsException(newName);
            }

            author.ChangeName(newName);
        }
    }
}

AuthorManager強制以受控方式創建作者和更改作者姓名。應用層（後面會介紹）會用到這些方法。

DDD 提示：除非確實需要並執行一些核心業務規則，否則不要引入域服務方法。
對於這種情況，我們需要此服務能夠強制唯一名稱約束。

兩種方法都會檢查是否已經存在具有給定名稱的作者並拋出一個特殊的業務異常，AuthorAlreadyExistsException在Acme.BookStore.Domain項目（Authors文件夾中）中定義，如下所示：

using Volo.Abp;

namespace Acme.BookStore.Authors
{
    public class AuthorAlreadyExistsException : BusinessException
    {
        public AuthorAlreadyExistsException(string name)
            : base(BookStoreDomainErrorCodes.AuthorAlreadyExists)
        {
            WithData("name", name);
        }
    }
}

BusinessException是一種特殊的異常類型。在需要時拋出域相關的異常是一個很好的做法。它由 ABP 框架自動處理，並且可以輕鬆本地化。

WithData(...)方法用於向異常對象提供附加數據，這些數據稍後將用於本地化消息或用於其他目的。

BookStoreDomainErrorCodes在Acme.BookStore.Domain.Shared項目中打開，修改如下圖：

namespace Acme.BookStore
{
    public static class BookStoreDomainErrorCodes
    {
        public const string AuthorAlreadyExists = "BookStore:00001";
    }
}

這是一個唯一的字符串，代表您的應用程序拋出的錯誤代碼，可由客戶端應用程序處理。對於用戶，您可能希望對其進行本地化。

打開項目Localization/BookStore/en.json內部Acme.BookStore.Domain.Shared並添加以下條目：

"BookStore:00001": "There is already an author with the same name: {name}"

無論何時拋出AuthorAlreadyExistsException，最終用戶都會在 UI 上看到一條很好的錯誤消息。

IAuthorRepository

// 這個自訂倉儲的所定義的方法其實直接使用內建的通用倉儲就可以完成，這邊只是為了示範自訂倉儲該如何一步步實現，如果用不到沒必要多此一舉。

AuthorManager注入IAuthorRepository，所以我們需要定義它。在 Acme.BookStore.Domain 項目的Authors文件夾（命名空間）中創建這個新接口：

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Volo.Abp.Domain.Repositories;

namespace Acme.BookStore.Authors
{
    public interface IAuthorRepository : IRepository<Author, Guid>
    {
        Task<Author> FindByNameAsync(string name);

        Task<List<Author>> GetListAsync(
            int skipCount,
            int maxResultCount,
            string sorting,
            string filter = null
        );
    }
}

IAuthorRepository擴展了標準IRepository<Author, Guid>接口，因此所有標準存儲庫方法也可用於IAuthorRepository.
FindByNameAsync用於AuthorManager按姓名查詢作者。
GetListAsync 將在應用程序層中用於獲取列出、排序和過濾的作者列表以顯示在 UI 上。