Why Doesn't LINQ's Distinct Work with Custom Objects, and How Can I Fix It?

LINQ's Distinct() and Custom Objects: A Common Pitfall

LINQ's Distinct() method simplifies removing duplicates from collections. However, it behaves unexpectedly with custom objects, often failing to identify duplicates based on their properties.

The Problem: Reference vs. Value Equality

The issue lies in how Distinct() compares objects. It uses reference equality, meaning two objects are considered distinct unless they occupy the same memory location. This means that even if two custom objects have identical property values, Distinct() treats them as separate entities.

Illustrative Example: Duplicate Authors

Imagine a list of books, each with a list of authors. Even if two books list the same author (same first and last name), Distinct() won't remove the duplicate author entries because they are distinct object instances.

The Solution: Implementing IEquatable<T>

To resolve this, implement the IEquatable<T> interface in your custom object class (e.g., Author). This interface mandates the Equals() and GetHashCode() methods, allowing you to define how equality is determined for your objects. By overriding these methods, you can instruct Distinct() to compare based on property values rather than references.

Enhanced Author Class

Here's an improved Author class implementing IEquatable<Author>:

public class Author : IEquatable<Author>
{
    public string FirstName { get; set; }
    public string LastName { get; set; }

    public bool Equals(Author other)
    {
        if (other == null) return false;
        return FirstName == other.FirstName && LastName == other.LastName;
    }

    public override int GetHashCode()
    {
        return (FirstName?.GetHashCode() ?? 0) ^ (LastName?.GetHashCode() ?? 0);
    }
}

Resolution: Value-Based Comparison

By implementing IEquatable<Author>, the Equals() method now compares authors based on their FirstName and LastName. The GetHashCode() method ensures consistent hashing for objects with the same values. Now, Distinct() will correctly identify and remove duplicate authors based on their names.

Conclusion: Customized Equality for Distinct()

Implementing IEquatable<T> provides a crucial mechanism to control how your custom objects are compared for equality, allowing Distinct() to function correctly when dealing with value-based duplicates. This ensures that Distinct() operates as intended, removing duplicates based on the properties you define as significant.

The above is the detailed content of Why Doesn't LINQ's Distinct Work with Custom Objects, and How Can I Fix It?. For more information, please follow other related articles on the PHP Chinese website!