这篇文章主要介绍了C# 开发日志本地化工具的步骤，帮助大家更好的理解和学习使用c#，感兴趣的朋友可以了解下
程序员讨厌写文档, 讨厌写注释, 而我还讨厌写日志, 输出一个 "Id=5, 姓名=王大锤, 性别=男, 生日=2020年1月1日" 总归会用到字符串的填充
var log = $"Id={person.Id}, 姓名={person.Name}, 性别={(person.Sex == SexType.Man ? "男性" : "女性")}, 生日={person.Birthday}";Json序列化工具多好啊, 可是输出的是
{"id": 5,"name":"葫芦娃", "sex":"Man", "birthday":"2020-1-1 00:00:00"}业务部门的人就是看不懂, 毕竟不是人人都有良好的英语基础, 同时我也经常猜不到有人用 DRLS 表示 "当日流水".
其实如果只要稍微把 json 里面的key 用中文替代, 业务部门还是能大概读得懂大部分意思的.
所以我开发了一个工具 LocalizationTools, 协助生成中文日志.
新建一个 Console, 引入 nuget 包: LocalizationTools, 然后定义示例类
////// 人类 /// public class Person { ////// Id /// public int Id { get; set; } ////// 名字 /// public string Name { get; set; } ////// 出生日期, 出生日期最好不要超过当前时间 /// [DisplayName("出生日期")] public DateTime Birthday { get; set; } ////// 性别 /// public SexType Sex { get; set; } ////// 是否活着 /// public bool IsAlive { get; set; } } ////// 性别 /// public enum SexType { ////// 男性 /// Man = 0, ////// 女性 /// Woman = 2, ////// 人妖 /// Ladyman = 3, }
记得在生成界面勾上 XML文档文件
使用代码
static void Main(string[] args) { var p1 = new Person { Id = 1, Name = "王大锤", Birthday = DateTime.Parse("2020-01-01"), Sex = SexType.Man, }; LocalizationTools.KeyValueSeparator = "="; var str = LocalizationTools.ToString(p1); Console.WriteLine(str); }相信这样的输出, 大部分人也应该能够看懂了
{"Id"=1,"名字"="王大锤","出生日期"="2020/1/1 0:00:00","性别"="男性","是否活着"=false}LocalizationTools.ToString() 方法会将 属性名称 替换成注释里的 Summary 信息, 枚举值也同样会进行这样的替换
如果字段很少, 刚才的输出还没什么问题, 如果字段非常多, 读着就眼花缭乱了, 所以我建议还是这行删除
LocalizationTools.KeyValueSeparator = "=";
这样输出的内容是
{"Id":1,"名字":"王大锤","出生日期":"2020/1/1 0:00:00","性别":"男性","是否活着":false}使用Json工具格式化一下
{ "Id": 1, "名字": "王大锤", "出生日期": "2020/1/1 0:00:00", "性别": "男性", "是否活着": false }这样即使包含了子对象的对象, 也非常清晰明了了.
这里面的不足是: "是否活着" 这个属性输出的是 true/false, 布尔值在不同的场景可以表示: 是/否、对/错、启用/关闭....... 业务人员可不想自己猜, 解决办法有两个
1. 在ToString()前, 我知道IsAlive是false, 应该用 "否" 来替换
var str = LocalizationTools.ToString(p1, new { IsAlive = "否" }); // 输出 {"Id":1,"名字":"王大锤","出生日期":"2020/1/1 0:00:00","性别":"男性","是否活着":"否"}2. 给 IsAlive 属性加上 ToStringReplacePairAttribute, 来替换某些特定的值
[ToStringReplacePair(true, "是", false, "否")] public bool IsAlive { get; set; }LocalizationTools 替换 属性名称 的顺序是 1. DisplayNameAttribute 2. 注释里的summary, 因为有些人喜欢在 summary 中加入其他说明信息, 输出到日志里不好看;
由于 DisplayNameAttribute 不能作用于 enum枚举值, 所以我专门定义了 EnumAliasAttribute, 它的优先级也比 注释里的summary 高
这里特别强调一下, LocalizationTools.ToString() 不是一个Json 序列化工具, 为了使用随处可见的 Json格式化工具, 而将输出调整得像Json, 所以这个工具从来就没有考虑到反序列化功能, 也没有去解决循环引用的问题, 也没有考虑到要符合Json 的标准, 仅仅是一个方便输出中文日志的工具, 也没有追求高性能.
LocalizationTools.ToString() 特别适用于面向数据表的编程, 因为表字段一般都是简单的类型, 输出的日志更为直观.
按理说应该为这个工具提供扩展方法, 但是我有强迫症, 许多类库给 object 加上了各种扩展方法, 让我很不爽, 所以我没有在类库中主动加入扩展方法, 大家可以在自己的项目里加入以下代码, 以提供扩展方法
namespace Localization { using System.Collections.Generic; public static class LocalizationToolsExtend { public static string ToLocalizationString(this object obj, params string[] ignorePropertyNames) { return LocalizationTools.ToString(obj, ignorePropertyNames); } public static string ToLocalizationString(this object obj, T customPropertyValues, params string[] ignorePropertyNames) where T : class { return LocalizationTools.ToString(obj, customPropertyValues, ignorePropertyNames); } public static string ToLocalizationString(this object obj, Dictionary customPropertyValues, params string[] ignorePropertyNames) { return LocalizationTools.ToString(obj, customPropertyValues, ignorePropertyNames); } public static string ToLocalizationStringInclude(this object obj, IEnumerable includePropertyNames) { return LocalizationTools.ToStringInclude(obj, includePropertyNames); } public static string ToLocalizationStringInclude(this object obj, IEnumerable includePropertyNames, T customPropertyValues) where T : class { return LocalizationTools.ToStringInclude(obj, includePropertyNames, customPropertyValues); } public static string ToLocalizationStringInclude(this object obj, IEnumerable includePropertyNames, Dictionary customPropertyValues) { return LocalizationTools.ToStringInclude(obj, includePropertyNames, customPropertyValues); } } } 新增实体的日志解决了, 接下来又有另一个问题, 如何保存实体变化的日志?
最简单的办法就是把 实体类 修改前的json 和 修改后的json 都保存起来, 让业务人员自己去痛苦寻找的变化, 呵呵呵, 只要是个人, 都会抱怨.
让程序员一个字段一个字段的比较, 然后生成日志, 开玩笑! 我干不来这样枯燥的活
nuget 上有 JsonDiffPatch 这样的工具生成 JSON patch, 但输出的结果就不是为人类准备的, 所以我又继续写了 Compare 方法
static void Main(string[] args) { var p1 = new Person { Id = 1, Name = "王大锤", Birthday = DateTime.Parse("2020-01-01"), Sex = SexType.Man, }; var p2 = new Person { Id = 1, Name = "王小锤", Birthday = DateTime.Parse("2021-01-01"), Sex = SexType.Man, }; var compareResult = LocalizationTools.Compare(p1, p2); Console.WriteLine(compareResult.GetDifferenceMsg()); } // 输出: {"名字":{"从":"王大锤","变成":"王小锤"},"出生日期":{"从":"2020/1/1 0:00:00","变成":"2021/1/1 0:00:00"}}Json格式化一下
{ "名字": { "从": "王大锤", "变成": "王小锤" }, "出生日期": { "从": "2020/1/1 0:00:00", "变成": "2021/1/1 0:00:00" } }当然你可以对 CompareResult 进行进一步处理, 使用 UpdateDifferentProperty 修改里面的比较结果, 最后再得出比较结果.
以上就是C# 开发日志本地化工具的详细内容，更多请关注0133技术站其它相关文章！
