用例演示 - 創(chuàng)建實(shí)體

本節(jié)將演示一些示例用例并討論可選場景。

創(chuàng)建實(shí)體

從實(shí)體/聚合根類創(chuàng)建對象是實(shí)體生命周期的第一步。聚合/聚合根規(guī)則和最佳實(shí)踐部分 建議為Entity類創(chuàng)建一個(gè)主構(gòu)造函數(shù)，以保證創(chuàng)建一個(gè)有效的實(shí)體。因此，無論何時(shí)我們需要?jiǎng)?chuàng)建實(shí)體的實(shí)例，我們都應(yīng)該使用那個(gè)構(gòu)造函數(shù)

參見下面的問題聚合根類:

public class Issue : AggregateRoot<Guid>
{
    public Guid RepositoryId { get; private set; }
    public string Title { get; private set; }
    public string Text { get; set; }
    public Guid? AssignedUserId { get; private set; }
    
    public Issue(
        Guid id, 
        Guid repositoryId,
        string title,
        string text = null
    ) : base(id)
    {
        RepositoryId = repositoryId;
        Title = Check.NotNullOrWhiteSpace(title, nameof(title));
        Text = text; // 允許空值
    }

    private Issue() { //為ORM保留的空構(gòu)造函數(shù) }

    public void SetTitle(string title)
    {
        Title = Check.NotNullOrWhiteSpace(title, nameof(title));
    }
}

• 該類保證通過其構(gòu)造函數(shù)創(chuàng)建有效的實(shí)體。

• 如果你需要更改標(biāo)題，你需要使用 SetTitle 方法保證標(biāo)題在一個(gè)有效狀態(tài)

• 如果您想將這個(gè)問題分配給用戶，您需要使用 IssueManager (它在分配之前實(shí)現(xiàn)了一些業(yè)務(wù)規(guī)則, 請參閱我之前關(guān)于 領(lǐng)域服務(wù) 的文章)。

• Text 屬性有一個(gè)公共setter，因?yàn)樗步邮躰ull值，并且這個(gè)示例沒有任何驗(yàn)證規(guī)則。它在構(gòu)造函數(shù)中也是可選的

讓我們看看用于創(chuàng)建問題的Application Service方法:

public class IssueAppService : ApplicationService, IIssueAppService
{
    //省略了Repository和DomainService的依賴注入

    [Authorize]
    public async Task<IssueDto> CreateAsync(IssueCreationDto input)
    {
        //創(chuàng)建一個(gè)有效的問題實(shí)體
        var issue = new Issue(
            GuidGenerator.Create(),
            input.RepositoryId,
            input.Title,
            input.Text
        );

        //如果傳入了被分配人,則把該問題法分配給這個(gè)用戶
        if(input.AssignedUserId.HasValue)
        {
            var user = await _userRepository.GetAsync(input.AssignedUserId.Value);
            await _issueManager.AssignToAsync(issue, user);
        }

        // 把問題實(shí)體保存到數(shù)據(jù)庫
        await _issueRepository.InsertAsync(issue);

        //返回表示這個(gè)新的問題的DTO
        return ObjectMapper.Map<Issue, IssueDto>(issue);
    }
}

CreateAsync 方法:

• 使用 Issue 構(gòu)造函數(shù)創(chuàng)建有效的問題。它使用 IGuidGenerator 服務(wù)傳遞Id。這里不使用自動(dòng)對象映射
• 如果客戶端希望在對象創(chuàng)建時(shí)將這個(gè)問題分配給用戶，它會(huì)使用IssueManager 來完成，允許 IssueManager 在分配之前執(zhí)行必要的檢查。
• 保存實(shí)體到數(shù)據(jù)庫
• 最后使用 IObjectMapper 返回一個(gè) IssueDto ，該 IssueDto 是通過映射從新的 Issue 實(shí)體自動(dòng)創(chuàng)建的

使用領(lǐng)域規(guī)則創(chuàng)建實(shí)體

上述示例, Issue 沒有關(guān)于實(shí)體創(chuàng)建的業(yè)務(wù)規(guī)則，除了在構(gòu)造函數(shù)中進(jìn)行一些形式的驗(yàn)證。但是，在某些情況下，實(shí)體創(chuàng)建應(yīng)該檢查一些額外的業(yè)務(wù)規(guī)則

例如，假設(shè)您不希望在完全相同的標(biāo)題已經(jīng)存在問題的情況下創(chuàng)建問題。在哪里實(shí)現(xiàn)這個(gè)規(guī)則? 在 Application Service 中實(shí)現(xiàn)此規(guī)則是不合適的，因?yàn)樗且粋€(gè)應(yīng)該始終檢查的 核心業(yè)務(wù)(領(lǐng)域)規(guī)則

該規(guī)則應(yīng)該在 領(lǐng)域服務(wù) (在本例中是 IssueManager )中實(shí)現(xiàn)。因此，我們需要強(qiáng)制應(yīng)用層總是使用 IssueManager 來創(chuàng)建一個(gè)新的 Issue

首先，我們可以將 Issue 構(gòu)造函數(shù)設(shè)置為 internal ，而不是 public:

public class Issue : AggregateRoot<Guid>
{
    internal Issue(
        Guid id, 
        Guid repositoryId,
        string title,
        string text = null
    ) : base(id)
    {
        //...
    }
}

這阻止了應(yīng)用服務(wù)直接使用構(gòu)造函數(shù)，所以它們將使用 IssueManager 。然后我們可以在 IssueManager 中添加一個(gè) CreateAsync 方法:

public class IssueManager : DomainService
{
    //省略了依賴注入

    public async Task<IssueDto> CreateAsync(
        Guid repositoryId,
        string title,
        string text = null
    )
    {
        //如果存在相同標(biāo)題的問題,直接拋錯(cuò)
        if(await _issueRepository.AnyAsync(i => i.Title == title))
        {
            throw new BusinessException("IssueTracking:IssueWithSameTitleExists");
        }

        //創(chuàng)建一個(gè)有效的問題實(shí)體
        return new Issue(
            GuidGenerator.Create(),
            repositoryId,
            title,
            text
        );
    }
}

• CreateAsync 方法檢查相同標(biāo)題是否已經(jīng)存在問題，并在這種情況下拋出業(yè)務(wù)異常
• 如果沒有重復(fù)，則創(chuàng)建并返回一個(gè)新的Issue

為了使用上述方法，IssueAppService 被修改如下:

public class IssueAppService : ApplicationService, IIssueAppService
{
    //省略了依賴注入

    public async Task<IssueDto> CreateAsync(IssueCreationDto input)
    {
        //★修改為通過領(lǐng)域服務(wù)創(chuàng)建有效的問題實(shí)體, 而不是直接new
        var issue = await _issueManager.CreateAsync(
            GuidGenerator.Create(),
            input.RepositoryId,
            input.Title,
            input.Text
        );

        //如果傳入了被分配人,則把該問題法分配給這個(gè)用戶
        if(input.AssignedUserId.HasValue)
        {
            var user = await _userRepository.GetAsync(input.AssignedUserId.Value);
            await _issueManager.AssignToAsync(issue, user);
        }

        // 把問題實(shí)體保存到數(shù)據(jù)庫
        await _issueRepository.InsertAsync(issue);

        //返回表示這個(gè)新的問題的DTO
        return ObjectMapper.Map<Issue, IssueDto>(issue);
    }
}

討論:為什么問題沒有在 IssueManager 中保存到數(shù)據(jù)庫?

你可能會(huì)問 “為什么 IssueManager 不把問題保存到數(shù)據(jù)庫中?” 我們認(rèn)為這是應(yīng)用服務(wù)的責(zé)任

因?yàn)椋诒４鎲栴}對象之前，應(yīng)用程序服務(wù)可能需要對其進(jìn)行額外的更改/操作。如果領(lǐng)域服務(wù)保存它，則保存操作將重復(fù)

• 兩次數(shù)據(jù)庫往返會(huì)導(dǎo)致性能損失
• 需要顯式的數(shù)據(jù)庫事務(wù)來包含這兩個(gè)操作
• 如果由于業(yè)務(wù)規(guī)則的原因，其他操作取消了實(shí)體創(chuàng)建，則應(yīng)該在數(shù)據(jù)庫中回滾事務(wù)

當(dāng)你檢查 IssueAppService 時(shí)，你會(huì)看到在 IssueManager.CreateAsync 中不保存 Issue 到數(shù)據(jù)庫的好處。否則，我們將需要執(zhí)行一次插入(在 IssueManager 中)和一次更新(在分配問題之后)

討論:為什么不在應(yīng)用程序服務(wù)中實(shí)現(xiàn)重復(fù)標(biāo)題檢查?

我們可以簡單地說 “因?yàn)樗且粋€(gè)核心領(lǐng)域邏輯，應(yīng)該在領(lǐng)域?qū)又袑?shí)現(xiàn)”。然而，這帶來了一個(gè)新的問題: “您如何判斷它是核心領(lǐng)域邏輯，而不是應(yīng)用程序邏輯?” (稍后我們將詳細(xì)討論其中的差異)

對于這個(gè)例子，一個(gè)簡單的問題可以幫助我們做出決定: “如果我們有另一種方法(用例)來創(chuàng)建一個(gè)問題，我們是否仍然應(yīng)用相同的規(guī)則?” 你可能會(huì)想 “為什么我們有第二種制造問題的方式?” 然而，在現(xiàn)實(shí)生活中，你有:

• 應(yīng)用程序的最終用戶可能會(huì)在應(yīng)用程序的標(biāo)準(zhǔn)UI中創(chuàng)建問題(比如在github的網(wǎng)頁端創(chuàng)建問題)
• 您可能有第二個(gè)后臺(tái)應(yīng)用程序，由您自己的員工使用，您可能希望提供一種創(chuàng)建問題的方法(在本例中可能使用不同的授權(quán)規(guī)則)
• 您可能有一個(gè)對第三方客戶端開放的HTTP API，他們會(huì)創(chuàng)建問題。
• 您可能有一個(gè) background worker service，如果它檢測到一些故障，它會(huì)做一些事情并創(chuàng)建問題。這樣，它將在沒有任何用戶交互的情況下(可能沒有任何標(biāo)準(zhǔn)的授權(quán)檢查)創(chuàng)建問題。
• 您甚至可以在UI上設(shè)置一個(gè)按鈕，將某些內(nèi)容 (例如，討論) 轉(zhuǎn)換為問題

綜上所述，不同的應(yīng)用程序始終遵循這樣的規(guī)則:新問題的標(biāo)題不能與任何現(xiàn)有問題的標(biāo)題相同!他們與應(yīng)用層無關(guān)! 這就是為什么該邏輯是核心領(lǐng)域邏輯，應(yīng)該位于領(lǐng)域?qū)又校粦?yīng)該在應(yīng)用程序服務(wù)中實(shí)現(xiàn)為重復(fù)的代碼。