Пример ковариантности и контравариантности в реальном мире - PullRequest
139 голосов
/ 18 апреля 2010

У меня небольшие проблемы с пониманием того, как я буду использовать ковариацию и контравариантность в реальном мире.

Пока что единственными примерами, которые я видел, был тот же самый старый пример массива.

object[] objectArray = new string[] { "string 1", "string 2" };

Было бы неплохо увидеть пример, который позволил бы мне использовать его во время разработки, если бы я мог видеть, что он используется в другом месте.

Ответы [ 8 ]

124 голосов
/ 18 апреля 2010
// Contravariance
interface IGobbler<in T> {
    void gobble(T t);
}

// Since a QuadrupedGobbler can gobble any four-footed
// creature, it is OK to treat it as a donkey gobbler.
IGobbler<Donkey> dg = new QuadrupedGobbler();
dg.gobble(MyDonkey());

// Covariance
interface ISpewer<out T> {
    T spew();
}

// A MouseSpewer obviously spews rodents (all mice are
// rodents), so we can treat it as a rodent spewer.
ISpewer<Rodent> rs = new MouseSpewer();
Rodent r = rs.spew();

Для полноты ...

// Invariance
interface IHat<T> {
    void hide(T t);
    T pull();
}

// A RabbitHat…
IHat<Rabbit> rHat = RabbitHat();

// …cannot be treated covariantly as a mammal hat…
IHat<Mammal> mHat = rHat;      // Compiler error
// …because…
mHat.hide(new Dolphin());      // Hide a dolphin in a rabbit hat??

// It also cannot be treated contravariantly as a cottontail hat…
IHat<CottonTail> cHat = rHat;  // Compiler error
// …because…
rHat.hide(new MarshRabbit());
cHat.pull();                   // Pull a marsh rabbit out of a cottontail hat??
109 голосов
/ 09 марта 2016

Вот то, что я собрал, чтобы помочь мне понять разницу

public interface ICovariant<out T> { }
public interface IContravariant<in T> { }

public class Covariant<T> : ICovariant<T> { }
public class Contravariant<T> : IContravariant<T> { }

public class Fruit { }
public class Apple : Fruit { }

public class TheInsAndOuts
{
    public void Covariance()
    {
        ICovariant<Fruit> fruit = new Covariant<Fruit>();
        ICovariant<Apple> apple = new Covariant<Apple>();

        Covariant(fruit);
        Covariant(apple); //apple is being upcasted to fruit, without the out keyword this will not compile
    }

    public void Contravariance()
    {
        IContravariant<Fruit> fruit = new Contravariant<Fruit>();
        IContravariant<Apple> apple = new Contravariant<Apple>();

        Contravariant(fruit); //fruit is being downcasted to apple, without the in keyword this will not compile
        Contravariant(apple);
    }

    public void Covariant(ICovariant<Fruit> fruit) { }

    public void Contravariant(IContravariant<Apple> apple) { }
}

tldr

ICovariant<Fruit> apple = new Covariant<Apple>(); //because it's covariant
IContravariant<Apple> fruit = new Contravariant<Fruit>(); //because it's contravariant
99 голосов
/ 18 апреля 2010

Допустим, у вас есть класс Person и класс, который происходит от него, Учитель. У вас есть некоторые операции, которые принимают IEnumerable<Person> в качестве аргумента. В вашем школьном классе у вас есть метод, который возвращает IEnumerable<Teacher>. Ковариантность позволяет вам напрямую использовать этот результат для методов, которые принимают IEnumerable<Person>, заменяя более производный тип на менее производный (более общий) тип. Контравариантность, напротив, позволяет вам использовать более общий тип, где указывается более производный тип.

См. Также Ковариация и Контравариантность в родовых объектах на MSDN .

Классы :

public class Person 
{
     public string Name { get; set; }
} 

public class Teacher : Person { } 

public class MailingList
{
    public void Add(IEnumerable<out Person> people) { ... }
}

public class School
{
    public IEnumerable<Teacher> GetTeachers() { ... }
}

public class PersonNameComparer : IComparer<Person>
{
    public int Compare(Person a, Person b) 
    { 
        if (a == null) return b == null ? 0 : -1;
        return b == null ? 1 : Compare(a,b);
    }

    private int Compare(string a, string b)
    {
        if (a == null) return b == null ? 0 : -1;
        return b == null ? 1 : a.CompareTo(b);
    }
}

Использование

var teachers = school.GetTeachers();
var mailingList = new MailingList();

// Add() is covariant, we can use a more derived type
mailingList.Add(teachers);

// the Set<T> constructor uses a contravariant interface, IComparer<T>,
// we can use a more generic type than required.
// See https://msdn.microsoft.com/en-us/library/8ehhxeaf.aspx for declaration syntax
var teacherSet = new SortedSet<Teachers>(teachers, new PersonNameComparer());
53 голосов
/ 24 февраля 2013

Ключевые слова in и out управляют правилами приведения компилятора для интерфейсов и делегатов с общими параметрами:

interface IInvariant<T> {
    // This interface can not be implicitly cast AT ALL
    // Used for non-readonly collections
    IList<T> GetList { get; }
    // Used when T is used as both argument *and* return type
    T Method(T argument);
}//interface

interface ICovariant<out T> {
    // This interface can be implicitly cast to LESS DERIVED (upcasting)
    // Used for readonly collections
    IEnumerable<T> GetList { get; }
    // Used when T is used as return type
    T Method();
}//interface

interface IContravariant<in T> {
    // This interface can be implicitly cast to MORE DERIVED (downcasting)
    // Usually means T is used as argument
    void Method(T argument);
}//interface

class Casting {

    IInvariant<Animal> invariantAnimal;
    ICovariant<Animal> covariantAnimal;
    IContravariant<Animal> contravariantAnimal;

    IInvariant<Fish> invariantFish;
    ICovariant<Fish> covariantFish;
    IContravariant<Fish> contravariantFish;

    public void Go() {

        // NOT ALLOWED invariants do *not* allow implicit casting:
        invariantAnimal = invariantFish; 
        invariantFish = invariantAnimal; // NOT ALLOWED

        // ALLOWED covariants *allow* implicit upcasting:
        covariantAnimal = covariantFish; 
        // NOT ALLOWED covariants do *not* allow implicit downcasting:
        covariantFish = covariantAnimal; 

        // NOT ALLOWED contravariants do *not* allow implicit upcasting:
        contravariantAnimal = contravariantFish; 
        // ALLOWED contravariants *allow* implicit downcasting
        contravariantFish = contravariantAnimal; 

    }//method

}//class

// .NET Framework Examples:
public interface IList<T> : ICollection<T>, IEnumerable<T>, IEnumerable { }
public interface IEnumerable<out T> : IEnumerable { }


class Delegates {

    // When T is used as both "in" (argument) and "out" (return value)
    delegate T Invariant<T>(T argument);

    // When T is used as "out" (return value) only
    delegate T Covariant<out T>();

    // When T is used as "in" (argument) only
    delegate void Contravariant<in T>(T argument);

    // Confusing
    delegate T CovariantBoth<out T>(T argument);

    // Confusing
    delegate T ContravariantBoth<in T>(T argument);

    // From .NET Framework:
    public delegate void Action<in T>(T obj);
    public delegate TResult Func<in T, out TResult>(T arg);

}//class
32 голосов
/ 18 апреля 2010
class A {}
class B : A {}

public void SomeFunction()
{
    var someListOfB = new List<B>();
    someListOfB.Add(new B());
    someListOfB.Add(new B());
    someListOfB.Add(new B());
    SomeFunctionThatTakesA(someListOfB);
}

public void SomeFunctionThatTakesA(IEnumerable<A> input)
{
    // Before C# 4, you couldn't pass in List<B>:
    // cannot convert from
    // 'System.Collections.Generic.List<ConsoleApplication1.B>' to
    // 'System.Collections.Generic.IEnumerable<ConsoleApplication1.A>'
}

По сути, когда у вас есть функция, которая принимает Enumerable одного типа, вы не можете передать Enumerable производного типа без явного приведения его.

Просто чтобы предупредить вас о ловушке:

var ListOfB = new List<B>();
if(ListOfB is IEnumerable<A>)
{
    // In C# 4, this branch will
    // execute...
    Console.Write("It is A");
}
else if (ListOfB is IEnumerable<B>)
{
    // ...but in C# 3 and earlier,
    // this one will execute instead.
    Console.Write("It is B");
}

В любом случае это ужасный код, но он существует, и изменяющееся поведение в C # 4 может привести к тонким и трудным поискам ошибок, если вы используете такую ​​конструкцию.

31 голосов
/ 08 марта 2017

Вот простой пример использования иерархии наследования.

Учитывая простую иерархию классов:

enter image description here

И в коде:

public abstract class LifeForm  { }
public abstract class Animal : LifeForm { }
public class Giraffe : Animal { }
public class Zebra : Animal { }

Инвариантность (то есть параметры общего типа * не *, украшенные in или out ключевыми словами)

По-видимому, такой метод

public static void PrintLifeForms(IList<LifeForm> lifeForms)
{
    foreach (var lifeForm in lifeForms)
    {
        Console.WriteLine(lifeForm.GetType().ToString());
    }
}

... должен принять гетерогенную коллекцию: (что он делает)

var myAnimals = new List<LifeForm>
{
    new Giraffe(),
    new Zebra()
};
PrintLifeForms(myAnimals); // Giraffe, Zebra

Однако передать коллекцию более производного типа не удается!

var myGiraffes = new List<Giraffe>
{
    new Giraffe(), // "Jerry"
    new Giraffe() // "Melman"
};
PrintLifeForms(myGiraffes); // Compile Error!

cannot convert from 'System.Collections.Generic.List<Giraffe>' to 'System.Collections.Generic.IList<LifeForm>'

Почему? Поскольку универсальный параметр IList<LifeForm> не является ковариантным - IList<T> является инвариантом, поэтому IList<LifeForm> принимает только коллекции (которые реализуют IList), где параметризованный тип T должен быть LifeForm.

Если реализация метода PrintLifeForms была вредоносной (но имеет такую ​​же сигнатуру метода), причина, по которой компилятор предотвращает передачу List<Giraffe>, становится очевидной:

 public static void PrintLifeForms(IList<LifeForm> lifeForms)
 {
     lifeForms.Add(new Zebra());
 }

Поскольку IList допускает добавление или удаление элементов, любой подкласс LifeForm может быть таким образом добавлен к параметру lifeForms, что приведет к нарушению типа любой коллекции производных типов, передаваемых методу. (Здесь злонамеренный метод попытается добавить Zebra к var myGiraffes). К счастью, компилятор защищает нас от этой опасности.

Ковариация (универсальный с параметризованным типом, украшенным out)

Ковариация широко используется с неизменяемыми коллекциями (т. Е. Новые элементы не могут быть добавлены или удалены из коллекции)

Решение приведенного выше примера состоит в том, чтобы обеспечить использование ковариантного универсального типа коллекции, например, IEnumerable (определяется как IEnumerable<out T>). IEnumerable не имеет методов для изменения коллекции, и в результате ковариации out любая коллекция с подтипом LifeForm теперь может быть передана методу:

public static void PrintLifeForms(IEnumerable<LifeForm> lifeForms)
{
    foreach (var lifeForm in lifeForms)
    {
        Console.WriteLine(lifeForm.GetType().ToString());
    }
}

PrintLifeForms теперь можно вызывать с Zebras, Giraffes и любым IEnumerable<> любого подкласса LifeForm

Contravariance (универсальный с параметризованным типом, украшенным in)

Контравариантность часто используется, когда функции передаются в качестве параметров.

Вот пример функции, которая принимает Action<Zebra> в качестве параметра и вызывает его на известном экземпляре Zebra:

public void PerformZebraAction(Action<Zebra> zebraAction)
{
    var zebra = new Zebra();
    zebraAction(zebra);
}

Как и ожидалось, это прекрасно работает:

var myAction = new Action<Zebra>(z => Console.WriteLine("I'm a zebra"));
PerformZebraAction(myAction); // I'm a zebra

Интуитивно, это не удастся:

var myAction = new Action<Giraffe>(g => Console.WriteLine("I'm a giraffe"));
PerformZebraAction(myAction); 

cannot convert from 'System.Action<Giraffe>' to 'System.Action<Zebra>'

Однако, это успешно

var myAction = new Action<Animal>(a => Console.WriteLine("I'm an animal"));
PerformZebraAction(myAction); // I'm an animal

и даже это также успешно:

var myAction = new Action<object>(a => Console.WriteLine("I'm an amoeba"));
PerformZebraAction(myAction); // I'm an amoeba

Почему? Поскольку Action определяется как Action<in T>, то есть это contravariant, что означает, что для Action<Zebra> myAction, что myAction может быть не более "Action<Zebra>, но менее производные суперклассы Zebra также приемлемый.

Хотя поначалу это может быть не интуитивно понятно (например, как можно передать Action<object> в качестве параметра, требующего Action<Zebra>?), Если вы распакуете шаги, вы заметите, что вызываемая функция (PerformZebraAction) сам отвечает за передачу данных (в данном случае Zebra экземпляр) в функцию - данные не поступают из вызывающего кода.

Из-за перевернутого подхода использования функций более высокого порядка таким образом, к моменту вызова Action это более производный экземпляр Zebra, который вызывается для функции zebraAction (передаваемой как параметр ), хотя сама функция использует менее производный тип.

4 голосов
/ 08 октября 2014

С MSDN

В следующем примере кода показана поддержка ковариации и контравариантности. для групп методов

static object GetObject() { return null; }
static void SetObject(object obj) { }

static string GetString() { return ""; }
static void SetString(string str) { }

static void Test()
{
    // Covariance. A delegate specifies a return type as object, 
    // but you can assign a method that returns a string.
    Func<object> del = GetString;

    // Contravariance. A delegate specifies a parameter type as string, 
    // but you can assign a method that takes an object.
    Action<string> del2 = SetObject;
}
2 голосов
/ 05 октября 2017

Делегат конвертера помогает мне визуализировать обе концепции, работающие вместе:

delegate TOutput Converter<in TInput, out TOutput>(TInput input);

TOutput представляет ковариацию , где метод возвращает более конкретный тип .

TInput представляет контравариантность , где передается метод менее определенный тип .

public class Dog { public string Name { get; set; } }
public class Poodle : Dog { public void DoBackflip(){ System.Console.WriteLine("2nd smartest breed - woof!"); } }

public static Poodle ConvertDogToPoodle(Dog dog)
{
    return new Poodle() { Name = dog.Name };
}

List<Dog> dogs = new List<Dog>() { new Dog { Name = "Truffles" }, new Dog { Name = "Fuzzball" } };
List<Poodle> poodles = dogs.ConvertAll(new Converter<Dog, Poodle>(ConvertDogToPoodle));
poodles[0].DoBackflip();
...