Dispositions refactoring Garde

Question

Quelles sont les approches les gens prennent (le cas échéant) dans la gestion de l'explosion de la clause de garde dans vos classes ? Par exemple:

public void SomeMethod<T>(string var1, IEnumerable<T> items, int count)
{
    if (string.IsNullOrEmpty(var1))
    {
        throw new ArgumentNullException("var1");
    }

    if (items == null)
    {
        throw new ArgumentNullException("items");
    }

    if (count < 1)
    {
        throw new ArgumentOutOfRangeException("count");
    }

    ... etc ....
}

Dans le projet que je travaille actuellement il y a beaucoup de classes qui ont un ensemble similaire de clauses de garde sur les méthodes publiques.

Je suis au courant du code .NET 4.0 contrats mais ce n'est pas une option pour notre équipe en ce moment.

Answer 1

Beaucoup de projets que j'ai vu utiliser une classe Guard statique.

public static class Guard {
    public static void ArgumentIsNotNull(object value, string argument) {
        if (value == null)
            throw new ArgumentNullException(argument);
    }
}

Il rend le code beaucoup plus propre, à mon avis.

Guard.ArgumentIsNotNull(arg1, "arg1");

Answer 2

Si vous ne voulez pas aller dans le code la route des contrats, une façon de simplifier est de supprimer les accolades:

public void SomeMethod<T>(string var1, IEnumerable<T> items, int count)
{
    if (string.IsNullOrEmpty(var1))
        throw new ArgumentNullException("var1");

    if (items == null)
        throw new ArgumentNullException("items");

    if (count < 1)
        throw new ArgumentOutOfRangeException("count");

    ... etc ....
}

En dehors de cela, il y a quelques façons que vous pouvez simuler les contrats de code, si votre objection est que .Net 4.0 n'est pas encore prime time:

http://geekswithblogs.net/Podwysocki/archive/2008 /01/22/118770.aspx

Answer 3

Vous pourriez envisager refactoring Introduire un Null objet .

Answer 4

Pendant ce temps, il y a un excellent article à ce sujet ici: http://haacked.com/archive/2013/01/05/mitigate-the-billion-dollar-mistake-with-aspects.aspx/

Je considérerais utiliser NullGuard.Fody que je suis excité au sujet des capacités Fodys pour réduire le code boilerplate

Answer 5

Une approche pour réduire (pas éliminer complètement) le nombre de clauses de garde est de comprendre la cause de leur existence. Très souvent, il se que nous gardons contre les valeurs qui sont valables pour le type de l'argument, mais pas valable pour la méthode qui les accepte. En d'autres termes, la méthode est définie sur un sous-ensemble du domaine défini par le type d'argument.

Solution à cette catégorie de cas est d'essayer de définir un sous-type (par exemple une interface plus restrictive) et d'accepter ce type comme argument. Vous trouverez un exemple d'illustration dans cet article: Pourquoi nous avons besoin de clauses de la Garde?

Bien sûr, cette technique ne concerne pas tous les cas. Tous les types de référence permettent au moins des références nulles. Par conséquent, la plupart de nos méthodes seront définies sur une partie du domaine, ce qui exige une clause de protection contre nul.

Mais du côté positif, cette technique permet d'accroître la notoriété des méthodes qui reçoivent des arguments plus généraux que souhaité. Plomberie ce trou contribue à améliorer le design en général.