DDD：關於模型的合法性，Entity.IsValid()合理嗎？

背景

見過很多框架（包括我自己的）都會在實體的定義中包含一個IsValid()方法，用來判斷實體的合法性，是否應該這樣設計呢？本文就這個問題介紹一點想法，希望大家多批評。

實體能否處於“非法”狀態？

實體是否應該包含IsValid()方法的深層次問題是：“實體能否處於非法狀態？”。我們來定義一些術語，接下來我就引用這些術語：

• A模式：實體允許處於非法狀態，但是實體要包含一個IsValid()方法進行校驗。
• B模式：實體不允許處於非法狀態，業務邏輯必須保證這一點。

關於A模式我不想多說了，A模式本身沒有問題的，今天重點說說如何實現B模式。

如何實現B模式？

最好的說明就是寫一個例子，下面是我們例子的需求：

• xxx屬性不能為空。
• xxx屬性必須唯一。

這個例子非常簡單，也具有代表性，可以進一步抽象為：

• xxx屬性不能為空，聚合自身的驗證。
• xxx屬性必須唯一，跨聚合驗證。

讓我們一個一個來。

xxx屬性不能為空，聚合自身的驗證。

聚合本身應該負責自己狀態的完整性，反射可能會繞過這些驗證，使用類似AutoMapper的工具需要注意（我已經處理了）。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Happy.Domain;
using Happy.Domain.Tree;
using Happy.Example.Events.TestGrids;

using Happy.Infrastructure;

namespace Happy.Example.Domain.TestGrids
{
    public partial class TestGrid : AggregateRoot<Guid>
    {
        public System.Int64? BigIntField { get; set; }
        public System.Boolean? BitField { get; set; }
        public System.DateTime? DateField { get; set; }
        public System.DateTime? DateTimeField { get; set; }
        public System.Decimal? DecimalField { get; set; }
        public System.Double? FloatField { get; set; }
        public System.Int32? IntField { get; set; }
        public System.Decimal? MoneyField { get; set; }
        public System.Decimal? NumericField { get; set; }
        public System.String NVarcharField { get; private set; }
        public System.Single? RealField { get; set; }
        public System.TimeSpan? TimeField { get; set; }
        public System.Byte[] TimestampField { get; set; }

        public void SetNVarcharField(string value)
        {
            value.MustNotNullAndNotWhiteSpace(value);

            this.NVarcharField = value;
        }

        internal void PublishCreatedEvent()
        {
            this.PublishEvent(new TestGridCreatedEvent());
        }
    }
}

xxx屬性必須唯一，跨聚合驗證。

倉儲負責判斷唯一性，應用服務負責驗證，注意：是先驗證，然后修改的實體。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Happy.Command;
using Happy.Application;
using Happy.Example.Domain.TestGrids;
using Happy.Example.Commands.TestGrids;

namespace Happy.Example.Application.TestGrids
{
    public class TestGridCommandHandler : ApplicationService,
        ICommandHandler<CreateTestGridComamnd>,
        ICommandHandler<UpdateTestGridComamnd>,
        ICommandHandler<DeleteTestGridComamnd>
    {
        public void Handle(CreateTestGridComamnd command)
        {
            var testGridService = this.Service<TestGridService>();

            testGridService.CheckNVarcharFieldUnique(command.NVarcharField);
            var testGrid = command.CreateTestGrid();

            testGridService.Create(testGrid);
            command.Result = testGrid.Id;
        }

        public void Handle(UpdateTestGridComamnd command)
        {
            var testGridService = this.Service<TestGridService>();

            var testGrid = testGridService.LoadAndDetach(command.Id);
            if (testGrid.NVarcharField != command.NVarcharField)
            {
                testGridService.CheckNVarcharFieldUnique(command.NVarcharField);
            }
            command.UpdateTestGrid(testGrid);

            testGridService.Update(testGrid);
        }

        public void Handle(DeleteTestGridComamnd command)
        {
            this.Service<TestGridService>().Delete(command.Id);
        }
    }
}

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using AutoMapper;

using Happy.Infrastructure;
using Happy.Infrastructure.AutoMapper;
using Happy.Command;
using Happy.Example.Domain.TestGrids;

namespace Happy.Example.Commands.TestGrids
{
    public class UpdateTestGridComamnd : ICommand, IHasIdProperty<Guid>
    {
        public Guid Id { get; set; }
        public System.Int64? BigIntField { get; set; }
        public System.Boolean? BitField { get; set; }
        public System.DateTime? DateField { get; set; }
        public System.DateTime? DateTimeField { get; set; }
        public System.Decimal? DecimalField { get; set; }
        public System.Double? FloatField { get; set; }
        public System.Int32? IntField { get; set; }
        public System.Decimal? MoneyField { get; set; }
        public System.Decimal? NumericField { get; set; }
        public System.String NVarcharField { get; set; }
        public System.Single? RealField { get; set; }
        public System.TimeSpan? TimeField { get; set; }
        public System.Byte[] TimestampField { get; set; }
        public byte[] OptimisticKey { get; set; }

        internal void UpdateTestGrid(TestGrid testGrid)
        {
            Mapper.Map(this, testGrid);
            testGrid.SetNVarcharField(this.NVarcharField);
        }

        static UpdateTestGridComamnd()
        {
            var map = Mapper.CreateMap<UpdateTestGridComamnd, TestGrid>();
            map.ForMember(x => x.Id, m => m.Ignore());
            map.IgnoreNotPublicSetter();
        }
    }
}

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Happy.Example.Domain.TestGrids;

namespace Happy.Example.Application.TestGrids
{
    public partial class TestGridService
    {
        protected override void AfterCreate(TestGrid aggregate)
        {
            base.AfterCreate(aggregate);

            aggregate.PublishCreatedEvent();
        }

        internal void CheckNVarcharFieldUnique(string value)
        {
            if (!this.Repository.IsNVarcharFieldExist(value))
            {
                throw new InvalidOperationException("NVarcharField必須唯一");
            }
        }
    }
}

備注

一些好的資源：

• http://msdn.microsoft.com/en-us/library/ff664356(v=pandp.50).aspx
• http://gorodinski.com/blog/2012/05/19/validation-in-domain-driven-design-ddd/
• http://lostechies.com/jimmybogard/2009/02/15/validation-in-a-ddd-world/
• http://abdullin.com/journal/2009/1/29/ddd-and-rule-driven-ui-validation-in-net.html
• http://www.iteye.com/topic/413815
• http://devlicio.us/blogs/billy_mccafferty/archive/2009/02/17/a-response-to-validation-in-a-ddd-world.aspx