MagicObject v0.0.2 将 MO.OriginObject 和 MO.Object 属性设为 public。完善并通过单元测试

Author: JeffreySu

src/Senparc.CO2NET.MagicObject.Tests/MoTests.cs

@@ -3,6 +3,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq.Expressions;
+using System.Xml.Linq;
 
 namespace Senparc.CO2NET.MagicObject.Tests
 {
@@ -28,11 +29,50 @@ public void Setup()
         [TestMethod]
         public void Set_SingleProperty_ChangesTracked()
         {
+            var dt = SystemTime.Now;
+
             _mo.Set(p => p.Name, "Bob");
 
+            var dt0 = SystemTime.Now;
+
             var result = _mo.Get(p => p.Name);
+
+            var dt1 = SystemTime.Now;
+
+            Console.WriteLine("Set 单次耗时(ms)：" + (dt0 - dt).TotalMilliseconds);
+            Console.WriteLine("Get 单次耗时(ms)：" + (dt1 - dt0).TotalMilliseconds);
+
+            var dt2 = SystemTime.Now;
+
+            for (var i = 0; i < 1000; i++)
+            {
+                _mo.Set(p => p.Name, "Bob" + i);
+                var resultX = _mo.Get(p => p.Name);
+            }
+            Console.WriteLine("1000 次 Set+Get 耗时(ms)：" + (SystemTime.DiffTotalMS(dt2)));
+
+            _mo.Set(p => p.Name, "Bob");
+
+            var dtS3 = SystemTime.Now;
+            Person person = new Person { Name = "Alice", Age = 30 };
+            person.Name = "Bob";
+            var result2 = person.Name;
+            var dtE3 = SystemTime.Now;
+            Console.WriteLine("原始方法 单次 Get+Set 耗时(ms)：" + (dtE3 - dtS3).TotalMilliseconds);
+
+
+            var dt4 = DateTime.Now;
+            for (var i = 0; i < 1000; i++)
+            {
+                person.Name = "Bob" + i;
+                var resultX = person.Name;
+            }
+            Console.WriteLine("1000 次 原始方法 耗时(ms)：" + SystemTime.DiffTotalMS(dt4));
+
+
             Assert.AreEqual("Alice", result.OldValue);
             Assert.AreEqual("Bob", result.NewValue);
+            Assert.AreEqual("Bob", _person.Name);
             Assert.IsTrue(result.IsChanged);
         }
 
@@ -63,9 +103,13 @@ public void GetChanges_AfterSettingProperties_ReturnsChanges()
         [TestMethod]
         public void Reset_ResetsObjectStateAndClearsChanges()
         {
+            Assert.AreSame(_mo.Object, _person);
+
             _mo.Set(p => p.Name, "Bob");
             _mo.Reset();
 
+            Assert.AreNotSame(_mo.Object, _person);
+
             var result = _mo.Get(p => p.Name);
             Assert.AreEqual("Alice", result.NewValue);
             Assert.IsFalse(result.IsChanged);
@@ -122,7 +166,7 @@ public void TakeSnapshot_RestoreSnapshot()
             _mo.TakeSnapshot();
 
             Assert.IsTrue(_mo.Get(z => z.Age).HasShapshot);
-            Assert.AreEqual( 30,_mo.Get(z => z.Age).SnapshotValue);
+            Assert.AreEqual(30, _mo.Get(z => z.Age).SnapshotValue);
 
             _mo.Set(p => p.Name, "Dave");
             var resultBeforeRestore = _mo.Get(p => p.Name);
@@ -140,6 +184,10 @@ public void TakeSnapshot_RestoreSnapshot()
             Assert.AreEqual("Charlie", resultAfterRestore.NewValue);
             Assert.IsTrue(resultAfterRestore.IsChanged);
             Assert.IsFalse(_mo.HasChanges());
+
+            //适用对象覆盖
+
+            //TODO
         }
 
         [TestMethod]
@@ -151,11 +199,15 @@ public void TestRevertChanges()
             _mo.Set(x => x.Name, "I'm Jeffrey");
             Assert.IsTrue(_mo.HasChanges());
             Assert.AreEqual("I'm Jeffrey", _mo.Get(z => z.Name).NewValue);
+            Assert.AreEqual("I'm Jeffrey", _person.Name);
 
             _mo.RevertChanges();
 
             // Assert  
+            Assert.AreSame(_mo.Object, _person);
+
             Assert.AreEqual("Alice", _mo.Get(z => z.Name).NewValue);
+            Assert.AreEqual("Alice", _person.Name);
             Assert.IsFalse(_mo.HasChanges());
         }
     }

src/Senparc.CO2NET.MagicObject.Tests/PropertyChangeResultTests.cs

@@ -0,0 +1,35 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Senparc.CO2NET.MagicObject;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Senparc.CO2NET.MagicObject.Tests
+{
+    [TestClass()]
+    public class PropertyChangeResultTests
+    {
+        private Person _person;
+        private MO<Person> _mo;
+
+        [TestInitialize]
+        public void Setup()
+        {
+            _person = new Person { Name = "Alice", Age = 30 };
+            _mo = new MO<Person>(_person);
+        }
+
+        [TestMethod()]
+        public void ToStringTest()
+        {
+            Assert.AreEqual("Alice", _mo.Get(z => z.Name).ToString());
+
+            _mo.Set(z => z.Name, "Bob");
+
+            Assert.AreEqual("Bob", _mo.Get(z => z.Name).NewValue);
+            Assert.AreEqual("Alice -> Bob", _mo.Get(z => z.Name).ToString());
+        }
+    }
+}

src/Senparc.CO2NET.MagicObject/MO.cs

@@ -1,14 +1,53 @@
-using System;
+#region Apache License Version 2.0
+/*----------------------------------------------------------------
+
+Copyright 2023 Suzhou Senparc Network Technology Co.,Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the
+License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See the License for the specific language governing permissions
+and limitations under the License.
+
+Detail: https://github.com/Senparc/Senparc.CO2NET/blob/master/LICENSE
+
+----------------------------------------------------------------*/
+#endregion Apache License Version 2.0
+
+/*----------------------------------------------------------------
+    Copyright (C) 2024 Senparc
+  
+    文件名：Enums.cs
+    文件功能描述：枚举配置文件
+    
+    
+    创建标识：MO - 20240730
+ 
+    修改标识：Senparc - 20240731
+    修改描述：v0.0.2 将 MO.OriginObject 和 MO.Object 属性设为 public
+
+----------------------------------------------------------------*/
+
+using System;
 using System.Collections.Generic;
 using System.Linq.Expressions;
 using System.Reflection;
 
 namespace Senparc.CO2NET.MagicObject
 {
+    /// <summary>
+    /// MagicObject 对象
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public class MO<T>
+        //where T:class
     {
-        private T OriginalObject { get; set; }
-        private T Object { get; set; }
+        public T OriginalObject { get; set; }
+        public T Object { get; set; }
         private Dictionary<string, PropertyChangeResult<object>> _changes;
         private T _snapshot;
 
@@ -21,6 +60,14 @@ public MO(T obj)
             _changes = new Dictionary<string, PropertyChangeResult<object>>();
         }
 
+        /// <summary>
+        /// 设置属性值
+        /// </summary>
+        /// <typeparam name="TValue"></typeparam>
+        /// <param name="expression">需要设置属性的对象</param>
+        /// <param name="value">值</param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentException"></exception>
         public MO<T> Set<TValue>(Expression<Func<T, TValue>> expression, TValue value)
         {
             MemberExpression memberExpression = null;
@@ -60,7 +107,13 @@ public MO<T> Set<TValue>(Expression<Func<T, TValue>> expression, TValue value)
             return this;
         }
 
-
+        /// <summary>
+        /// 获取属性值
+        /// </summary>
+        /// <typeparam name="TValue"></typeparam>
+        /// <param name="expression">需要获取的属性</param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentException"></exception>
         public PropertyChangeResult<TValue> Get<TValue>(Expression<Func<T, TValue>> expression)
         {
             if (expression.Body is MemberExpression memberExpression && memberExpression.Member is PropertyInfo propertyInfo)
@@ -87,22 +140,39 @@ public PropertyChangeResult<TValue> Get<TValue>(Expression<Func<T, TValue>> expr
             }
         }
 
+        /// <summary>
+        /// 获取所有的修改
+        /// </summary>
+        /// <returns></returns>
         public Dictionary<string, PropertyChangeResult<object>> GetChanges()
         {
             return _changes;
         }
 
+        /// <summary>
+        /// 使用旧对象的副本覆盖当前对象（注意将丢失对原有对象的引用，请慎重使用）
+        /// <para>如果不希望丢失对原有对象的引用，请使用 <see cref="RevertChanges"/> 方法</para>
+        /// </summary>
         public void Reset()
         {
             Object = Clone(OriginalObject);
             _changes.Clear();
         }
 
+        /// <summary>
+        /// 检查是否具有修改
+        /// </summary>
+        /// <returns></returns>
         public bool HasChanges()
         {
             return _changes.Count > 0;
         }
 
+        /// <summary>
+        /// 批量设置属性值
+        /// </summary>
+        /// <param name="properties"></param>
+        /// <exception cref="ArgumentException"></exception>
         public void SetProperties(Dictionary<Expression<Func<T, object>>, object> properties)
         {
             foreach (var property in properties)
@@ -123,40 +193,65 @@ public void SetProperties(Dictionary<Expression<Func<T, object>>, object> proper
         }
 
 
-
+        /// <summary>
+        /// 获取快照
+        /// </summary>
         public void TakeSnapshot()
         {
             _snapshot = Clone(Object);
         }
 
-        public void RestoreSnapshot()
+        /// <summary>
+        /// 将快照还原到对象
+        /// </summary>
+        /// <param name="keepObjectInstance">是否保持当前对象引用，如果为否，将使用 Clone 的旧对象</param>
+        public void RestoreSnapshot(bool keepObjectInstance = true)
         {
             if (_snapshot != null)
             {
-                Object = Clone(_snapshot);
+                if (keepObjectInstance)
+                {
+                    RevertProperties(Object, _snapshot);
+                }
+                else
+                {
+                    Object = Clone(_snapshot);
+                }
                 _changes.Clear();
             }
         }
 
+        /// <summary>
+        /// 克隆对象
+        /// </summary>
+        /// <param name="source"></param>
+        /// <returns></returns>
         private T Clone(T source)
         {
             var cloneMethod = source.GetType().GetMethod("MemberwiseClone", BindingFlags.Instance | BindingFlags.NonPublic);
             return (T)cloneMethod.Invoke(source, null);
         }
 
-        public void RevertChanges()
+        private void RevertProperties(T target,T originalObject)
         {
-            var properties = OriginalObject.GetType().GetProperties();
+            var properties = typeof(T).GetProperties();
             foreach (var property in properties)
             {
                 if (property.CanWrite)
                 {
-                    var originalValue = property.GetValue(OriginalObject);
+                    var originalValue = property.GetValue(originalObject);
                     property.SetValue(Object, originalValue);
                 }
             }
-            _changes.Clear();
         }
 
+        /// <summary>
+        /// 在当前引用对象基础上，还原所有修改（不会改变引用对象）
+        /// </summary>
+        public void RevertChanges()
+        {
+            RevertProperties(Object, OriginalObject);
+            _changes.Clear();
+        }
     }
 }