Ist es in C# für einen Komponententest oder eine Codeanalyse möglich, festzustellen, ob ein Namespace in einer Klasse verwendet wird?

Question

Als Geschäftsregel verbieten wir die Verwendung eines spezifischen Namensraums innerhalb dieses anderen Namensraums.

Beispiel:

using X.A; //Allowed 
using X.B; //Not allowed 

namespace X.C 
{ 
    const string abc = X.A.MyClass.ABC; //Allowed 
    const string def = X.B.MyClass.DEF; //Not allowed, because we are using X.B 

    public void MyMethod() 
    { 
     string ghi = X.A.MyClass.GHI; //Allowed 
     string jkl = X.B.MyClass.JKL; //Not allowed because we are using X.B 
     string mno = "X.B.MyClass.MNO"; //Allowed, because we are not accessing X.B 
    } 
} 

Ist es möglich, dies mit einem Unit-Test zu steuern, über Code-Analyse, oder beides, so dass wir leichter diese Geschäftsregel durchsetzen können, anstatt sich auf Code-Review unter Berufung, die kann diese Art von Sache leicht verpassen? Angenommen, es ist möglich, wie würden Sie das machen?

Answer 1

Eine solche Regel ist mit dem Werkzeug NDepend that let's write code rule through C# LINQ queries und check such rules live in Visual Studio und in your Build Process möglich.

Konkret solche Regel könnte wie folgt aussehen:

warnif count > 0 from n in Namespaces where 
n.IsUsing ("NUnit.Core.Extensibility") && 
(n.Name == @"NUnit.Core.Builders") 
select new { n, n.NbLinesOfCode } 
// the namespace NUnit.Core.Builders 
// shouldn't use directly 
// the namespace NUnit.Core.Extensibility 
// because (TODO insert your reason) 

... und diese Regel bearbeitet und ausgeführt werden können/Live in Visual Studio erzwungen.

Eigentlich kann man einen solchen Code Regel mit einem einzigen Klick von der dependency graph oder aus dem dependency matrix erzeugen:

Eine solche Regel Regel kann auch in Komponententests geschrieben und durchgesetzt werden, da NDepend bietet und API.

Das könnte Sie auch interessieren: white books concerning structuring code through namespaces and assemblies.

Haftungsausschluss: Ich arbeite für NDepend.