Ist es besser, null oder eine leere Sammlung zurückzugeben?

Question

Das ist eine Art eine allgemeine Frage (aber ich bin mit C#), was ist der beste Weg (Best Practice), geben Sie null oder leere Sammlung für eine Methode, die eine Sammlung als Rückgabetyp hat?

Answer 1

Leere Sammlung. Immer.

Das nervt:

if(myInstance.CollectionProperty != null)
{
  foreach(var item in myInstance.CollectionProperty)
    /* arrgh */
}

Es gilt als bewährte Praxis, NIEMALS eine null wenn eine Sammlung oder Aufzählung zurückgegeben wird. IMMER eine leere Aufzählung/Auflistung zurückgeben. Dies verhindert den oben erwähnten Unsinn und verhindert, dass Ihr Auto von Kollegen und Benutzern Ihrer Klassen mit Eiern beworfen wird.

Wenn es um Eigenschaften geht, setzen Sie Ihre Eigenschaft immer nur einmal und vergessen Sie sie.

public List<Foo> Foos {public get; private set;}

public Bar() { Foos = new List<Foo>(); }

In .NET 4.6.1 können Sie dies sehr stark einschränken:

public List<Foo> Foos { get; } = new List<Foo>();

Wenn es um Methoden geht, die Aufzählungen zurückgeben, können Sie einfach eine leere Aufzählung anstelle von null ...

public IEnumerable<Foo> GetMyFoos()
{
  return InnerGetFoos() ?? Enumerable.Empty<Foo>();
}

使用方法 Enumerable.Empty<T>() kann als effizienter angesehen werden als die Rückgabe einer neuen leeren Sammlung oder eines Arrays.

Answer 2

Von der Rahmengestaltungsrichtlinien 2. Auflage (S. 256):

Geben Sie KEINE Nullwerte von Sammlungseigenschaften oder von Methoden die Sammlungen zurückgeben. Geben Sie eine leere Sammlung oder ein leeres Array zurück.

Hier ist ein weiterer interessanter Artikel über die Vorteile der Nichtrückgabe von Nullen (ich habe versucht, etwas in Brad Abrams Blog zu finden, und er hat auf den Artikel verwiesen).

Bearbeiten - Da Eric Lippert nun auf die ursprüngliche Frage geantwortet hat, möchte ich auch Link zu seinem ausgezeichneten Artikel .

Answer 3

Abhängig von Ihrem Vertrag und Ihr konkreter Fall . Im Allgemeinen ist es am besten, leere Sammlungen zurückzugeben , aber manchmal ( selten ):

• null könnte etwas Spezifischeres bedeuten;
• Ihr API (Vertrag) könnte Sie zur Rückgabe zwingen null .

Einige konkrete Beispiele:

• eine UI-Komponente (aus einer Bibliothek außerhalb Ihrer Kontrolle), könnte eine leere Tabelle darstellen, wenn eine leere Auflistung übergeben wird, oder überhaupt keine Tabelle, wenn null übergeben wird.
• in einem Object-to-XML (JSON/whatever), wobei null würde bedeuten, dass das Element fehlt, während eine leere Sammlung eine redundante (und möglicherweise falsche) <collection />
• Sie verwenden oder implementieren eine API, die ausdrücklich festlegt, dass null zurückgegeben/übergeben werden soll.

Answer 4

Es gibt noch einen weiteren Punkt, der noch nicht erwähnt wurde. Betrachten Sie den folgenden Code:

    public static IEnumerable<string> GetFavoriteEmoSongs()
    {
        yield break;
    }

Die C#-Sprache gibt beim Aufruf dieser Methode einen leeren Enumerator zurück. Um mit dem Sprachdesign (und damit den Erwartungen der Programmierer) übereinzustimmen, sollte daher eine leere Sammlung zurückgegeben werden.

Answer 5

Leere ist viel verbraucherfreundlicher.

Es gibt eine klare Methode, um eine leere Aufzählung zu erstellen:

Enumerable.Empty<Element>()