C# 实现一个基于值相等性比较的字典

Intro

今天在项目里遇到一个需求,大概是这样的我要比较两个 JSON 字符串是不是相等,JSON 字符串其实是一个 Dictionary 但是顺序可能不同,和上一篇 record 使用场景 中的第一个需求类似,前面我们介绍过使用 record 可以比较方便的解决,但是我们的项目是 .netcoreapp3.1 的,不能使用 record,如何比较方便的比较呢?我们能否自己实现一个类似于 record 的类型,基于值去比较呢?于是就有了本文的探索

StringValueDictioanry

实现了一个基于值进行比较的字典,实现代码如下,实现的比较简单,涉及到一些简单的知识点,平时不怎么用已经忘了怎么写了,通过写下面的代码又学习了一下

先来看测试代码吧,测试代码如下:

[Fact]
public void EqualsTest()
{
    var abc = new { Id = 1, Name = "Tom" };
    var dic1 = StringValueDictionary.FromObject(abc);
    var dic2 = StringValueDictionary.FromObject(new Dictionary()
    {
        {"Name", "Tom" },
        {"Id", 1},
    });

    Assert.True(dic1 == dic2);
    Assert.Equal(dic1, dic2);
}

[Fact]
public void DistinctTest()
{
    var abc = new { Id = 1, Name = "Tom" };
    var dic1 = StringValueDictionary.FromObject(abc);
    var dic2 = StringValueDictionary.FromObject(new Dictionary()
    {
        {"Id", 1},
        {"Name", "Tom" },
    });
    var set = new HashSet();
    set.Add(dic1);
    set.Add(dic2);

    Assert.Single(set);
}

[Fact]
public void CloneTest()
{
    var dic1 = StringValueDictionary.FromObject(new Dictionary()
    {
        {"Id", 1},
        {"Name", "Tom" }
    });
    var dic2 = dic1.Clone();
    Assert.False(ReferenceEquals(dic1, dic2));
    Assert.True(dic1 == dic2);
}

[Fact]
public void ImplicitConvertTest()
{
    var abc = new { Id = 1, Name = "Tom" };
    var stringValueDictionary = StringValueDictionary.FromObject(abc);
    Dictionary dictionary = stringValueDictionary;
    Assert.Equal(stringValueDictionary.Count, dictionary.Count);

    var dic2 = StringValueDictionary.FromObject(dictionary);

    Assert.Equal(dic2, stringValueDictionary);
    Assert.True(dic2 == stringValueDictionary);
} 

从上面的代码可能大概能看出一些实现,重写了默认的 EqualsGetHashCode,并重载了“==” 运算符,并且实现了一个从 StringValueDictionaryDictionary 的隐式转换,来看下面的实现代码:

public sealed class StringValueDictionary : IEquatable
{
    private readonly Dictionary _dictionary = new();

    private StringValueDictionary(IDictionary dictionary)
    {
        foreach (var pair in dictionary)
        {
            _dictionary[pair.Key] = pair.Value;
        }
    }

    private StringValueDictionary(StringValueDictionary dictionary)
    {
        foreach (var key in dictionary.Keys)
        {
            _dictionary[key] = dictionary[key];
        }
    }

    public static StringValueDictionary FromObject(object obj)
    {
        if (obj is null) throw new ArgumentNullException(nameof(obj));
        if (obj is IDictionary dictionary)
        {
            return new StringValueDictionary(dictionary);
        }
        if (obj is IDictionary dictionary2)
        {
            return new StringValueDictionary(dictionary2.ToDictionary(p => p.Key, p => p.Value?.ToString()));
        }
        if (obj is StringValueDictionary dictionary3)
        {
            return new StringValueDictionary(dictionary3);
        }
        return new StringValueDictionary(obj.GetType().GetProperties()
            .ToDictionary(p => p.Name, p => p.GetValue(obj)?.ToString()));
    }

    public static StringValueDictionary FromJson(string json)
    {
        Guard.NotNull(json, nameof(json));
        var dic = json.JsonToObject>()
            .ToDictionary(x => x.Key, x => x.Value?.ToString());
        return new StringValueDictionary(dic);
    }

    public StringValueDictionary Clone() => new(this);

    public int Count => _dictionary.Count;

    public bool ContainsKey(string key) => _dictionary.ContainsKey(key) ? _dictionary.ContainsKey(key) : throw new ArgumentOutOfRangeException(nameof(key));

    public string? this[string key] => _dictionary[key];

    public Dictionary.KeyCollection Keys => _dictionary.Keys!;

    public bool Equals(StringValueDictionary? other)
    {
        if (other is null) return false;
        if (other.Count != Count) return false;
        foreach (var key in _dictionary.Keys)
        {
            if (!other.ContainsKey(key))
            {
                return false;
            }
            if (_dictionary[key] != other[key])
            {
                return false;
            }
        }
        return true;
    }

    public override bool Equals(object obj)
    {
        return Equals(obj as StringValueDictionary);
    }

    public override int GetHashCode()
    {
        var stringBuilder = new StringBuilder();
        foreach (var pair in _dictionary)
        {
            stringBuilder.Append($"{pair.Key}={pair.Value}_");
        }
        return stringBuilder.ToString().GetHashCode();
    }

    public static bool operator ==(StringValueDictionary? current, StringValueDictionary? other)
    {
        return current?.Equals(other) == true;
    }

    public static bool operator !=(StringValueDictionary? current, StringValueDictionary? other)
    {
        return current?.Equals(other) != true;
    }

    public static implicit operator Dictionary(StringValueDictionary dictionary)
    {
        return dictionary._dictionary;
    }
} 

More

上述代码实现的有点粗糙,可能会有一些问题,仅供参考

以上代码基本实现了基于想要的值的相等性比较以及 Clone(复制、克隆)的目标

实现相等性比较的时候,EqualsGetHashCode 方法也要重写,如果没有重写 GetHashCode,编译器也会给出警告,如果没有重写 GetHashCode 在实际在 HashSet 或者 Dictionary 里可能会出现重复 key

重载运算符的时候需要一个静态方法,"==" 和 "!=" 是一对操作运算符,如果要实现两个都要实现,不能只实现其中一个

implicit 也算是一个特殊的运算符,巧妙的使用隐式转换可以大大简化代码的写法,StackExchange.Redis 中就使用了 implicit 来实现 RedisValue 和 string 等其他常用类型的隐式转换

References

  • https://github.com/WeihanLi/WeihanLi.Common/blob/dev/src/WeihanLi.Common/Models/StringValueDictionary.cs
  • https://github.com/WeihanLi/WeihanLi.Common/blob/dev/test/WeihanLi.Common.Test/ModelsTest/StringValueDictionaryTest.cs
标签:

C# 实现一个基于值相等性比较的字典的更多相关文章

  1. 计算机网络安全 —— C# 使用谷歌身份验证器(Google Authenticator)

    一、Google Authenticator 基本概念Google Authenticator是谷歌推出的一款动态口......

  2. C#编写 HTML生成PDF

    html中 <body> <div style="text-align:c......

  3. C# 获取当前总毫秒数的实例讲解

    在.Net下DateTime.Ticks获得的是个long型的时间整数,具体表示是至0001 年 1 月 1 日午夜......

  4. C# StreamReader类实现读取文件的方法

    在 C# 语言中 StreamReader 类用于从流中读取字符串。它继承自 TextReader 类。Stream......

  5. C# 中的动态类型

    翻译自 Camilo Reyes 2018年10月15日的文章 《Working with the Dynamic ......

  6. c# 操作word写入特殊字符的实例

    在word中插入特殊字符(word 2010):插入-符号-选择特殊符号,如图:c#操作 :首先要得到插入符号的字符......

  7. C#微信公众号推送消息接口消息排重

    用户在微信公众号发送文本,语音,图片等的普通消息时,微信服务器会向公众号配置的接收消息的地址转发用户消息,微信服务器......

  8. class Awhere T:new()是什么意思

    这是C#泛型类声明的语法class A 表示 A类接受某一种类型,泛型类型为T,需要运行时传入where表明了对类型......

  9. C# Twain协议调用扫描仪,设置多图像输出模式(Multi image output)

    Twain随着扫描仪、数码相机和其他图像采集设备的引入,用户热切地发现了将图像整合到他们的文档和其他工作中的价值。然......

  10. 如何在C#中使用MSMQ

    MSMQ (Microsoft消息队列)是Windows中默认可用的消息队列。作为跨计算机系统发送和接收消息的可靠方......

随机推荐

  1. Python基础(下篇)

    本篇文章主要内容:异常处理,函数,模块和包。 本篇文章主要内容:异常处理,函数,模块和包。 在开......

  2. 详解JavaScript中的链式调用

    链模式链模式是一种链式调用的方式,准确来说不属于通常定义的设计模式范畴,但链式调用是一种非常有用的代码构建技巧。描述......

  3. Perl 使用 Mail::POP3Client 发送邮件

    use Mail::POP3Client;$mail = new Mail::POP3Client("us......

  4. 【Android初级】使用Gallery实现照片拖动的特效(附源码)

    今天要分享一个非常简单的功能:使用Android原生控件Gallery实现照片拖动的特效实现思路如下:在布局文件中定......

  5. Python连接Oracle

    python 3.4.3cx_Oracle#!/usr/bin/env pythonimport timesta......

  6. Perl 从 HTML 网页中解析出链接

    use LWP::Simple;use HTML::LinkExtor;$html = get("http......

  7. vue使用vue-quill-editor富文本编辑器且将图片上传到服务器的功能

    一、准备工作下载vue-quill-editornpm install vue-quill-editor --sav......

  8. sqlserver 日期与字符串之间的转换

    字符转换为日期时,Style的使用--1. Style=101时,表示日期字符串为:mm/dd/yyyy格式SELE......

  9. Python 学习笔记(1)

    Mac下载安装Pythonmac 系统自带有python 。但就最新的mac系统而言,它自带的python版本为2.......

  10. Python基础篇

    一、准备工作1、安装Python(注意选择一个稳定的版本,方便学习和使用)Python官网:https://www.......