Lind.DDD.Domain領域模型介紹 - lori－IT工程師數位筆記本

文章出處

Lind.DDD.Domain位于Lind.DDD核心項目中，它主要面向領域實體而設計，由一個IEntity的標識接口，EntityBase基類和Ｎ個Entity實體類組成，其中IEntity主要用來標識，在倉儲操作時，用它來表明操作的實體范圍和約束；EntityBase定義了幾個公用的屬性，為了避免代碼的重復，特意將狀態，插入時間和更新時間定義到了EntityBase里，而為何不將主鍵定義進來呢，主要考慮到主鍵的類型是為確實的，還有就是不同類型的主鍵可能需要實現不同的特性，如MongoDB的主鍵可能是BsonID或者需要為它添加BsonId這個特性，所以將主鍵從EntityBase中拿出來，誰需要就去實現它，也是符合面向對象的原則的．

下面我們來看一下Lind.DDD.Domain設計實體的代碼

一　IEntity實體標識接口，所有poco實體都繼承它

　　 /// <summary>
    /// 實體類標示接口
    /// </summary>
    public interface IEntity
    {

    }

二　EntityBase實體基類，具體實體基類要繼承它，共享它的屬性

    /// <summary>
    /// 領域模型，實體模型基類，它可能有多種持久化方式，如DB,File,Redis,Mongodb,XML等
    /// Lind.DDD框架的領域模型與數據庫實體合二為一
    /// </summary>
    [PropertyChangedAttribute]
    public abstract class EntityBase :
        // ContextBoundObject,//屬性變化跟蹤，這個可以在具體的實體上添加，需要記錄它的set變化，就添加這個特性
        IEntity,
        INotifyPropertyChanged
    {
        #region Contructors
        /// <summary>
        /// 實體初始化
        /// </summary>
        public EntityBase()
            : this(Status.Normal, DateTime.Now, DateTime.Now)
        { }
        /// <summary>
        /// 帶參數的初始化
        /// </summary>
        /// <param name="status">狀態</param>
        /// <param name="updateDateTime">更新日期</param>
        /// <param name="createDateTime">插入日期</param>
        public EntityBase(Status status, DateTime updateDateTime, DateTime createDateTime)
        {
            this.DataStatus = Status.Normal;
            this.DataUpdateDateTime = DateTime.Now;
            this.DataCreateDateTime = DateTime.Now;
            this.PropertyChanged += EntityBase_PropertyChanged;
        }
        #endregion

        #region Properties
        /// <summary>
        /// 建立時間
        /// </summary>
        [XmlIgnore, DataMember(Order = 3), XmlElement(Order = 3), DisplayName("建立時間"), Required]
        public DateTime DataCreateDateTime { get; set; }
        /// <summary>
        /// 更新時間
        /// </summary>
        [XmlIgnore, DataMember(Order = 2), XmlElement(Order = 2), DisplayName("更新時間"), Required]
        public DateTime DataUpdateDateTime { get; set; }
        /// <summary>
        /// 實體狀態
        /// </summary>
        [XmlIgnore, DataMember(Order = 1), XmlElement(Order = 1), DisplayName("狀態"), Required]
        public Status DataStatus { get; set; }
        #endregion

        #region Methods
        /// <summary>
        /// 拿到實體驗證的結果列表
        /// 結果為null或者Enumerable.Count()==0表達驗證成功
        /// </summary>
        /// <returns></returns>
        public IEnumerable<RuleViolation> GetRuleViolations()
        {
            var properties = this.GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance).ToArray();

            foreach (var i in properties)
            {
                var attr = i.GetCustomAttributes();
                foreach (var a in attr)
                {
                    var val = (a as ValidationAttribute);
                    if (val != null)
                        if (!val.IsValid(i.GetValue(this)))
                        {
                            yield return new RuleViolation(val.ErrorMessage, i.Name);
                        }
                }
            }

        }
        #endregion

        #region PropertyChangedEventHandler Events
        /// <summary>
        /// 屬性值變更事件，外部可以直接訂閱它
        /// </summary>
        public event PropertyChangedEventHandler PropertyChanged;
        /// <summary>
        /// 事件實例
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void EntityBase_PropertyChanged(object sender, PropertyChangedEventArgs e)
        {
            Console.WriteLine("基類EntityBase屬性:{0},值:{1}", e.PropertyName, sender.GetType().GetProperty(e.PropertyName).GetValue(sender));
        }
        /// <summary>
        /// 觸發事件,寫在每個屬性的set塊中CallerMemberName特性表示當前塊的屬性名
        /// </summary>
        /// <param name="propertyName"></param>
        protected void OnPropertyChanged([CallerMemberName] string propertyName = null)
        {
            if (PropertyChanged != null)
                PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
        }

        #endregion

    }

三　主鍵為整形的實體基類Entity，它繼承了EntityBase，實現了自己的主鍵，所以主鍵為整形的實體，都要繼承它

　　 /// <summary>
    /// 主鍵為int類型的實體基類
    /// </summary>
    public abstract class Entity : EntityBase
    {
        /// <summary>
        /// 標識列
        /// </summary>
        [DisplayName("編號"), Column("ID"), Required]
        public int Id { get; set; }
    }

四　主鍵為string類型的實體基類為NoSqlEntity，起初為了實現Mongodb表的ObjectID主鍵而設計的，其它的數據庫如果表的主鍵為字符串，也可以直接繼承它

　　/// <summary>
    /// mongodb,xml,redis實體基類
    /// 主鍵類型為string
    /// </summary>
    public abstract class NoSqlEntity : EntityBase
    {
        public NoSqlEntity()
        {
            this.Id = ObjectId.GenerateNewId().ToString();
        }
        /// <summary>
        /// 標識列
        /// </summary>
        [BsonId]
        [BsonRepresentation(BsonType.ObjectId)]
        [DataMember(Order = 0), XmlElement(Order = 0), DisplayName("編號"), Column("ID"), Required]
        public string Id { get; set; }

        /// <summary>
        /// 返回mongodb實體的鍵值對
        /// </summary>
        public IEnumerable<KeyValuePair<string, object>> GetProperyiesDictionary()
        {
            var properties = this.GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance)
                   .Where(i => i.Name != "Id")
                   .ToArray();

            foreach (var i in properties)
                yield return new KeyValuePair<string, object>(i.Name, i.GetValue(this));

        }
    }