系统操作日志表单形式构建

1.概述

     所谓操作日志，就是某人对指定模块的指定对象进行操作的记录，在某种情况下，可能会有显示本次操作对哪些数据字段进行啦了动，或者是操作前后该模型的数据比对情况。针对于这类需求，想要查看某条操作记录具体改动项信息的时候，对于前端来讲，他不需要知道这个对象的具体类型及各个字段的意义的汉字描述，他们只需要循环遍历，将所有的数据拼到一个div容器里即可。后台该如何去设计才能做到最简化的操作那？第一种情况可以用枚举的形式，来标记每种模型的类型，在每次记录日志的时候，可以将当前枚举也记录进去（数据库/nosql），这样的话，在查看每种记录变动的详情时，就可以根据每种类型封装不同的拼接数据的策略，最终以统一的格式返回给前端。但是，这种操作起来并不是很理想，没实现一种模块的操作都要实现对应的表单项拼接策略，显然以后维护起来并不是十分的完美。那么，能不能通过反射的形式来根绝具体的模型名称动态的获取模型类型，并根据具体的类型和json数据来形成对象，从而完成表单项的构建那？？答案是：可以的（c#中可以根据Type type = Type.GetType(FullTypeName);类实现）。下面我们就先实现一下获取当前操作模型具体操作操作记录。

2.需求分析及实现

    1.前端需要展示成这样:

       2.后台代码设置

     

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

namespace ConsoleApp1.OpearorLog.Entity
{
    public class ColumnRenark : Attribute
    {
        /// <summary>
        /// 字段名称
        /// </summary>
        public string ColumnName { get; set; }
        /// <summary>
        /// 字段类型
        /// </summary>
        public ColumnType ColumnType { get; set; }


        public ColumnRenark() { }
    }
    public enum ColumnType
    {
        [Description("基础类型（int/string...）")]
        Basic = 0,
        [Description("类类型")]
        Class = 1,
        [Description("字典类型")]
        Dic = 2,
        [Description("列表类型")]
        Lst = 3,


    }
}

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

namespace ConsoleApp1.OpearorLog.Entity
{
    /// <summary>
    ///行记录
    /// </summary>
    public class RowRecord
    {
        /// <summary>
        /// 字段语义
        /// </summary>
        public string Key { get; set; }
        /// <summary>
        /// 字段对应值
        /// </summary>
        public string Value { get; set; }
        /// <summary>
        /// 所属层级
        /// </summary>
        public int Lev { get; set; }
        /// <summary>
        /// 包含的子项
        /// </summary>
        public List<List<RowRecord>> Child { get; set; }

        public RowRecord()
        {
            Child = new List<List<RowRecord>>();
        }

    }
}

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleApp1
{
  public  class OperatorLogContext
    {
        #region attr
        private List<RowRecord> RowRecords { get; set; }
        private object Obj { get; set; }
        public string FullTypeName { get; set; }
        public string JsonStr { get; set; }
        #endregion

        public OperatorLogContext(string fullTypeName,string jsonStr)
        {
            FullTypeName = fullTypeName;
            JsonStr = jsonStr;
            RowRecords = new List<RowRecord>();
            Type type = Type.GetType(FullTypeName);
            Obj = JsonConvert.DeserializeObject(JsonStr,type);
        }
        public OperatorLogContext()
        {
            Type type = Type.GetType(FullTypeName);
            Obj = JsonConvert.DeserializeObject(JsonStr, type);
        }
        /// <summary>
        /// 构建表单项
        /// </summary>
        /// <returns></returns>
        public List<RowRecord> BuildForm()
        {
            return Build(Obj);
        }
        #region private
        private List<RowRecord> Build(object obj, RowRecord parentRow = null, List<RowRecord> childRow = null, int lev = 0)
        {
            //1.当前类型
            Type currentType = obj.GetType();
            //2.获取当下模型的所有属性字段
            var props = currentType.GetProperties();
            foreach (var prop in props)
            {
                RowRecord rowRecord = new RowRecord();
                rowRecord.Lev = lev;   //设置当前树形级别
                //3.获取当下属性字段下的所有自定义属性
                var attr = prop.CustomAttributes.FirstOrDefault(o => o.AttributeType == typeof(ColumnRenark));
                if (attr == null)
                {
                    continue;
                }
                else
                {
                    foreach (var named in attr.NamedArguments)
                    {
                        if (named.MemberName == "ColumnName")
                        {
                            rowRecord.Key = named.TypedValue.Value.ToString();
                        }
                        else if (named.MemberName == "ColumnType")
                        {
                            ColumnType columnType = (ColumnType)Enum.Parse(typeof(ColumnType), named.TypedValue.Value.ToString());
                            switch (columnType)
                            {
                                case ColumnType.Basic:
                                    rowRecord.Value = prop.GetValue(obj).ToString();
                                    break;
                                case ColumnType.Class:
                                    Build(prop.GetValue(obj), rowRecord, new List<RowRecord>());
                                    break;
                                case ColumnType.Lst:
                                    var currentLst = (IEnumerable<object>)prop.GetValue(obj);

                                    foreach (var opt in currentLst)
                                    {

                                        Build(opt, rowRecord, new List<RowRecord>());
                                    }
                                    break;
                            }
                        }
                    }
                }

                if (parentRow != null)
                {
                    rowRecord.Lev = parentRow.Lev + 1;
                    childRow.Add(rowRecord);
                }
                else
                {
                    RowRecords.Add(rowRecord);
                }
            }
            if (childRow != null)
            {
                parentRow.Child.Add(childRow);
            }
            return RowRecords;
        }
        #endregion

    }
}

using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Reflection;
using System.Text;

namespace ConsoleApp1
{
    class Program
    {
        static void Main(string[] args)
        {
            User user = new User();
            user.Age = 20;
            user.Name = "lsh";
            user.Book = new Book()
            {
                Name = "c#从入门指南",
                Desc = "书籍描述"
            };
            user.Hobby = new List<Hobby>() {
                new Hobby() { Name = "读书", Rate = "89%" },
                new Hobby() { Name = "旅游", Rate = "33%" }
            };
            string json = JsonConvert.SerializeObject(user);
            var lst = new OperatorLogContext("ConsoleApp1.User", json).BuildForm();
            Console.ReadKey();
        }
    }
    public class User
    {
        [ColumnRenark(ColumnName = "姓名", ColumnType = ColumnType.Basic)]
        public string Name { get; set; }
        [ColumnRenark(ColumnName = "年龄", ColumnType = ColumnType.Basic)]
        public int Age { get; set; }
        [ColumnRenark(ColumnName = "书籍", ColumnType = ColumnType.Class)]
        public Book Book { get; set; }
        [ColumnRenark(ColumnName = "爱好", ColumnType = ColumnType.Lst)]
        public List<Hobby> Hobby { get; set; }

    }
    public class Hobby
    {
        [ColumnRenark(ColumnName = "爱好名", ColumnType = ColumnType.Basic)]
        public string Name { get; set; }
        [ColumnRenark(ColumnName = "比率", ColumnType = ColumnType.Basic)]
        public string Rate { get; set; }
    }
    /// <summary>
    /// 行元素
    /// </summary>
    public class RowRecord
    {
        public string Key { get; set; }
        public string Value { get; set; }
        public int Lev { get; set; }
        public List<List<RowRecord>> Child { get; set; }

        public RowRecord()
        {
            Child = new List<List<RowRecord>>();
        }
    }
    public class Book
    {
        [ColumnRenark(ColumnName = "书名", ColumnType = ColumnType.Basic)]
        public string Name { get; set; }
        [ColumnRenark(ColumnName = "书描述", ColumnType = ColumnType.Basic)]
        public string Desc { get; set; }
    }
    /// <summary>
    /// 字段标记属性
    /// </summary>
    public class ColumnRenark : Attribute
    {
        /// <summary>
        /// 字段名称
        /// </summary>
        public string ColumnName { get; set; }
        /// <summary>
        /// 字段类型
        /// </summary>
        public ColumnType ColumnType { get; set; }


        public ColumnRenark() { }
    }

    public enum ColumnType
    {
        [Description("基础类型（int/string...）")]
        Basic = 0,
        [Description("类类型")]
        Class = 1,
        [Description("字典类型")]
        Dic = 2,
        [Description("列表类型")]
        Lst = 3,


    }
}

3.测试结果