52 votes

HVS avatar

ReSharper - Affectation nulle possible lors de l'utilisation de Microsoft.Contracts

Demandé el 30 de Mai, 2009
Quand la question a-t-elle été
7869 affichage
Nombre de visites la question a
5 Réponses
Nombre de réponses aux questions
Résolu
Situation réelle de la question

Est-il un moyen d'indiquer à ReSharper qu'une référence null n'a pas lieu en raison de la Conception par Contrat Requiert la vérification? Par exemple, le code suivant va augmenter l'avertissement (Possible 'null' assignment to entity marked with 'NotNull' attribute) dans ReSharper sur les lignes 7 et 8:

private Dictionary<string, string> _Lookup = new Dictionary<string, string>();

public void Foo(string s)
{
    Contract.Requires(!String.IsNullOrEmpty(s));

    if (_Lookup.ContainsKey(s))
        _Lookup.Remove(s);
}

Ce qui est vraiment bizarre c'est que si vous supprimez l' Contract.Requires(...) de la ligne, la ReSharper message disparaît.

Mise à jour

J'ai trouvé la solution grâce à ExternalAnnotations qui a également été mentionné par Mike ci-dessous. Voici un exemple de comment le faire pour une fonction dans Microsoft.Les contrats:

  • Créez un répertoire appelé Microsoft.Contracts sous l' ExternalAnnotations ReSharper répertoire.
  • Ensuite, Créez un fichier appelé Microsoft.Contracts.xml et remplir comme suit:

<assembly name="Microsoft.Contracts">
    <member name="M:System.Diagnostics.Contracts.Contract.Requires(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
</assembly>

  • Redémarrez Visual Studio, et le message disparaît!
Demandé el 30 de Mai, 2009 par HVS

Réponses

Trop de publicités?

43voto

Porges avatar
Porges Points 17745

Remarque : à partir de l'actuel EAP R # 8.0, cette fonctionnalité est incluse.

Voici la solution pour la version actuelle (c.-à-d. .NET 4.0) de contrats de code:

Dans ...\ExternalAnnotations\mscorlib\Contracts.xml , ajoutez ce qui suit: 

 <assembly name="mscorlib">
    <member name="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean, System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Assume(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Assume(System.Boolean, System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires``1(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires(System.Boolean,System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires``1(System.Boolean,System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Invariant(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Invariant(System.Boolean,System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
</assembly>
Répondu el 7 de Novembre, 2009 par Porges (17745 Points )

19voto

StriplingWarrior avatar
StriplingWarrior Points 56276

Je tiens à ajouter que pour des gens qui écrivent leurs propres méthodes d'assertion et de ce fait, vous pouvez inclure ces attributs sans un fichier XML externe. Dans Visual Studio, aller à l' ReSharper > Options > Code Annotations et cliquez sur l' Copy default implementation to clipboard bouton. Puis créer un nouveau fichier (n'importe où vous voulez dans votre solution) et le coller dans le code à partir du presse-papiers. Maintenant, vous pouvez créer des méthodes comme ceci:

public class Require
{
    [AssertionMethod]
    public static void That(
        [AssertionCondition(AssertionConditionType.IS_TRUE)] 
        bool requiredCondition,
        string message = null)
    {
        ...
    }
...
}

Maintenant, tout appel à l' Require.That(a != null) indiquent à ReSharper que vous ne pouvez pas obtenir au-delà de cette ligne si a a la valeur null. Contrairement à la ExternalAnnotations technique, cela fonctionne pour toute personne utilisant vos méthodes, sans aucun travail supplémentaire de leur part.

Mise à jour

Resharper a changé leur contrat d'annotation modèle à partir de la version 7. Voici ce que la méthode ci-dessus ressemblerait à maintenant:

public class Require
{
    [ContractAnnotation("requiredCondition:false => halt")]
    public static void That(
        bool requiredCondition,
        string message = null)
    {
        ...
    }
...
}
Répondu el 11 de Juin, 2010 par StriplingWarrior (56276 Points )

5voto

Mike Two avatar
Mike Two Points 16706

Je pense que vous pouvez, mais il n'est pas trivial. Jetez un oeil à Resharper aide en ligne pour le code d'annotation

Ils annoté de la BCL les classes et les NUnit cadre (et plus) pour améliorer Resharpers code des capacités d'inspection.

Par exemple, avec la NUnit affirme annoté avec une AssertionMethodAttribute. Cela dit Resharpers code de l'inspection que si vous avez passé une Assertion.IsNotNull(foo); puis foo ne doit pas être null et qu'il ne produira pas la possibilité "d' 'null' affectation..." avertissement plus.

Vous pourriez produire un fichier xml en annotant les Contrats.Nécessite méthode pour indiquer que c'est comme un faire Valoir.

Répondu el 30 de Mai, 2009 par Mike Two (16706 Points )

4voto

R. Martinho Fernandes avatar
R. Martinho Fernandes Points 96873

La raison pour laquelle le message disparaît lorsque vous retirez l'affirmation est que la R# travaille dans un scénario "optimiste" mode par défaut. Il suppose que tout est non-null jusqu'à ce que vous faites quelque chose qui indique qu'il peut effectivement être null. C'est ce qui arrive lorsque vous ajoutez l'appel à String.IsNullOrEmpty. Vous êtes indiquant qu' s pourrait être null. Il n'est tout simplement pas au courant que l' Contract.Requires méthode d'arrêt d'exécution si c'est le cas, mais que vous avez résolu avec l'annotation.

Dans la R# 5.0, vous pouvez changer de mode pessimiste que suppose le pire à chaque coin de rue.

Répondu el 17 de Décembre, 2009 par R. Martinho Fernandes (96873 Points )

3voto

Rory MacLeod avatar
Rory MacLeod Points 4574

J'ai pris le XML de Porges et ajouté des annotations aux méthodes Assert et Assume. Je vais wiki cette réponse au cas où d'autres personnes voudraient ajouter plus de méthodes. 

 <assembly name="mscorlib">
    <member name="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Assert(System.Boolean, System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Assume(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Assume(System.Boolean, System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires``1(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires(System.Boolean,System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Requires``1(System.Boolean,System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Invariant(System.Boolean)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
    <member name="M:System.Diagnostics.Contracts.Contract.Invariant(System.Boolean,System.String)">
        <attribute ctor="M:JetBrains.Annotations.AssertionMethodAttribute.#ctor"/>
        <parameter name="condition">
            <attribute ctor="M:JetBrains.Annotations.AssertionConditionAttribute.#ctor(JetBrains.Annotations.AssertionConditionType)">
                <argument>0</argument>
            </attribute>
        </parameter>
    </member>
</assembly>
Répondu el 25 de Août, 2010 par Rory MacLeod (4574 Points )

Questions en vedette

Top Tags

Dans notre réseau

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

Yandex
X