Lind.DDD.Domain领域模型介绍

Posted 2020-10-14

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));

        }
    }

在NoSqlEntity抽象类里，我们看到了共有方法GetProperyiesDictionary()，它主要功能是将表中所有属性和它的值以键值对的方式返回一个枚举集合，我们有时在仓储类中可以直接使用这个方法，向Mongodb集成了对这种类型的支持，可以方便的实现对表

的添加与更新！

Lind.DDD.Domain实体模型除了定义实体外，还提供了实体属性的变更跟踪功能，即当一个属性值发生变化时(set 方法被触发时）我们可以跟踪到它，并进行相应的操作，一般地，我们会在使用者层，添加一种事件，使用者只要订阅了这种事件，就可以实现对

跟踪实体的操作，如把变更保存到文件，或者直接入库等等！

更多的介绍，