HowTo: Objekte rekursiv durchlaufen - ein ObjectDumper fürs Logging mittels Reflection

Im letzten HowTo ging es um das Logging mit Log4Net.  Für eine gute Fehleranalyse braucht man möglichst viele Details über die Parameter die in eine Methode eingegangen sind. Das manuelle rausloggen ist sehr mühsam. Mittels reflection kann man sich viel Arbeit ersparen: Ein ObjectDumper welcher Objekte rekursiv durchläuft und die Eigenschaften ausloggt ist die Lösung :)

Reflection
Über Reflection kann man so ziemlich alle Details eines Objekts bzw. einer Klasse erfahren ohne genau zu wissen von welchem Typ diese ist. In dem Wikipedia Artikel ist das recht gut beschrieben.

Logging + Reflection
Einzelne Properties rauszuloggen ist recht mühsam und im Log ist es manchmal auch recht praktisch mehr als nur das Property X zu sehen, sondern alle Details des Objektes zu erfahren.
Mit ein wenig Rekursion und Reflection kann man sich da sehr viel Arbeit ersparen.

In einem größeren Projekt wurde der "ObjectDumper" erfolgreich eingesetzt. Im Internet findet man einige Varianten davon, ich selbst hatte mich auch schon mal damit beschäftigt.
Diese Version stammt von Daniel Brückner, welchen ich hier auch nochmal danken möchte, dass ich den Source Code veröffentlichen darf :)

Aufbau des "ObjectDumpers":

Im Logger Interface findet das "logging" statt:

        #region Logger interface

        private static void LogMessage(String message)
        {
            ILog logger = LogManager.GetLogger(typeof (ObjectDumper));
            logger.Debug(message);
        }

        #endregion

In der "message" steht das Property + der Value drin. Ich nutze in diesem "Interface" einfach Log4Net zum Loggen. Den restlichen Code könnt ihr euch im Detail später anschauen.

Anwendung

            Person newPerson = new Person();
            newPerson.Age = 123;
            newPerson.Id = Guid.NewGuid();
            newPerson.Name = "hasdhaskjdh";
            ObjectDumper.DumpObject(newPerson, "newPerson", true);

Es werden 3 Parameter übergeben:

• Das Objekt ansich
• Der Name des Objektes
• Und ob bereits "ausgeloggte" Elemente nochmal rausgeloggt werden, wenn diese angenommen im Objektbaum 2 mal vorkommen.

Die Methoden sind auch entsprechend mit Kommentaren ausgestattet:

Spezial Features
Einige Sachen sollte man allerdings vermeiden zu loggen, z.B. Passwörter. Dafür gibt es eine String Array wo Propertynamen eingetragen werden können, welche nicht geloggt werden:

        private static readonly String[] PasswordMemberNameParts = { "PASSWORD", "PWD" };

Wenn man eine ganze Klasse nicht loggen möchte (z.B. die generierten Properties vom Entity Framework etc.) kann auch dieses Attribut nehmen:

    [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
    public class DoNotDumpAttribute : Attribute { }

Anwendungsfall
Angewendet kann der ObjectDumper an vielen stellen. Als ASP.NET MVC Entwickler könnte es interessant sein z.B. die Request & ViewData Daten über ein ActionFilter zu loggen. Dies ist aber nur ein Beispiel :)

Feedback
Wer gute Ideen hat bzw. Fehler in dem Code findet kann gern an dieser Stelle Feedback geben :)

[ Download Source Code ]