{"id":51,"date":"2020-12-28T19:20:15","date_gmt":"2020-12-28T18:20:15","guid":{"rendered":"http:\/\/192.168.178.38\/?p=51"},"modified":"2020-12-28T19:20:15","modified_gmt":"2020-12-28T18:20:15","slug":"antipattern","status":"publish","type":"post","link":"https:\/\/lpl-mind.de\/en\/antipattern\/","title":{"rendered":"Antipattern"},"content":{"rendered":"

\"\"
\nHeute einmal mit einem Antipattern, zum Thema tostring Methode. Viele kennen es und in vielen Programmiersprachen wird es unterst\u00fctzt, die “.ToString()” Methode. Geliebt und oft und genutzt, doch es gibt einige Probleme bei der Nutzung der ToString() Methode. Die folgenden Beispiele sind in C# geschrieben, sind allerdings 1 zu 1 anwendbar in jeder weiteren Programmiersprache. Ich werde zun\u00e4chst einige Beispiele auflisten, die zeigen sollen wie die ToString() Methode nicht genutzt werden sollte.
\nBeispiel 1: ToString als Konverter<\/strong><\/p>\n

1
2
3
4
5
6
7
8
<\/div><\/td>
class<\/span> Person {<\/span>
\n   public<\/span> string<\/span> Name {<\/span> get<\/span>;<\/span> set<\/span>;<\/span> }<\/span>
\n   public<\/span> int<\/span> Age {<\/span> get<\/span>;<\/span> set<\/span>;<\/span> }<\/span>
\n   public<\/span> override<\/span> string<\/span> ToString(<\/span>)<\/span>
\n   {<\/span>
\n      return<\/span> JsonConvert.<\/span>SerializeObject<\/span>(<\/span>this<\/span>)<\/span>;<\/span>
\n   }<\/span>
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

In diesem Beispiel, wird die ToString() Methode als Json Serializer genutzt. Im weiterem verlauf wurde dieses Json persistiert. Und bei Bedarf wieder Deserialisiert (JsonConvert.DeserializeObject(jsonstring);). Auf dem erstem Blick spricht da auch nicht viel dagegen, sofern das gesamtes Dev Team nach dieser Konvention arbeiten m\u00f6chte. Allerdings zeigt die Realit\u00e4t dass diese Verwendung zu Problemen f\u00fchren wird. Sobald eine neue Klasse erstellt wird und der Entwickler nicht die ToString() Methode laut Konvention richtig f\u00fcllt. In diesem Falle w\u00fcrde die default ToString Methode greifen, welche den Klassen Namen und die Version ausgibt. Bei der Deserialisierung kommt es dann zum b\u00f6sen Erwachen. Die Daten k\u00f6nnen nicht rekonstruiert werden.
\nF\u00fcr diesen Fall sollte immer das passende Converter geschrieben werden, sofern eine automatische Konvertierung nicht m\u00f6glich ist. Siehe “Newtonsoft.Json.JsonConverter”
\nBeispiel 2: ToString als GUI Ausgabe<\/strong><\/p>\n

1
2
3
4
5
6
7
8
9
10
11
<\/div><\/td>
class<\/span> Person {<\/span>
\n   public<\/span> string<\/span> Name {<\/span> get<\/span>;<\/span> set<\/span>;<\/span> }<\/span>
\n   public<\/span> int<\/span> Age {<\/span> get<\/span>;<\/span> set<\/span>;<\/span> }<\/span>
\n   public<\/span> override<\/span> string<\/span> ToString(<\/span>)<\/span>
\n   {<\/span>
\n      return<\/span> "Person: "<\/span> +<\/span> Name +<\/span> " ist "<\/span> +<\/span> Age+<\/span> " Jahre alt."<\/span>;<\/span>
\n   }<\/span>
\n}<\/span>
\n....<\/span>
\ncurrentPersonLabel<\/span>.<\/span>Text<\/span> =<\/span> person;<\/span>
\n....<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

Im diesem Beispiel wird die ToString Methode als GUI Hilfsklasse missbraucht. Hier wurde der zu anzeigende Text direkt in die ToString Methode geschrieben. Davon abgesehen das keine Ressourcen genutzt wurden, wird f\u00fcr einen einzigen GUI fall der Text statisch vorgegeben. Sobald die Person noch in weiteren GUI Elementen vorkommen soll, wird es schwierig. Zus\u00e4tzlich ist nicht jedem Entwickler klar, dass eine \u00c4nderung des Textes in der ToString Methode eine Auswirkung auf GUI Element haben wird.
\nAuch hier ganz klar, sollte die ToString Methode nicht verwendet werden. Ein direkt Zugriff auf die Variablen wird wahrscheinlich schon ausreichen.
\nBeispiel 3: ToString zum Vergleichen<\/strong><\/p>\n

1
2
3
4
5
6
7
8
9
10
11
12
<\/div><\/td>
class<\/span> Person {<\/span>
\n   public<\/span> string<\/span> Name {<\/span> get<\/span>;<\/span> set<\/span>;<\/span> }<\/span>
\n   public<\/span> int<\/span> Age {<\/span> get<\/span>;<\/span> set<\/span>;<\/span> }<\/span>
\n   public<\/span> override<\/span> string<\/span> ToString(<\/span>)<\/span>
\n   {<\/span>
\n      return<\/span> "Person: "<\/span> +<\/span> Name +<\/span> " "<\/span> +<\/span> Age;<\/span>
\n   }<\/span>
\n
\n}<\/span>
\n....<\/span>
\nif<\/span> (<\/span>person1.<\/span>ToString<\/span>(<\/span>)<\/span>==<\/span>person2.<\/span>ToString<\/span>(<\/span>)<\/span>)<\/span>
\n....<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

Im dem letztem Beispiel wird die ToString Methode zum Vergleichen genutzt. Auch hier w\u00fcrde es zun\u00e4chst funktionieren. Allerdings m\u00fcsste die ToString Methode immer gepflegt werden. Sobald ein Property hinzukommt muss dies auch in der ToString Methode aufgelistet werden, ansonsten ist der Vergleich nicht korrekt. Der richtige Weg w\u00e4re hier das \u00fcberschreiben der compare Methode.<\/p>\n

1
<\/div><\/td>
 public<\/span> virtual<\/span> bool<\/span> Equals (<\/span>object<\/span> obj)<\/span>;<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

In Zuge dessen habe ich mich auf der Suche gemacht und einige Definitionen rausgesucht.
\nF\u00fcr Java findet man auf “https:\/\/www.javatpoint.com\/understanding-toString()-method” folgende Beschreibung:<\/p>\n

If you want to represent any object as a string, toString() method comes into existence.
\nThe toString() method returns the string representation of the object.
\nIf you print any object, java compiler internally invokes the toString() method on the object. So overriding the toString() method, returns the desired output, it can be the state of an object etc. depends on your implementation.<\/p><\/blockquote>\n

Nat\u00fcrlich kann dies von einem oder dem andrem missverstanden werden. Speziell die \u00e4u\u00dferung “If you want to represent any object as a string” verleitet wohl den ein oder anderen, diese Methode f\u00fcr alles M\u00f6gliche zu verwenden. Besser w\u00e4re es gewesen die Aussage “If you print any object, java compiler internally invokes” hervorzuheben.
\n\u00c4hnliches gilt f\u00fcr Microsoft (c#) “https:\/\/docs.microsoft.com\/en-us\/dotnet\/api\/system.object.tostring?view=netframework-4.8”<\/p>\n

Object.ToString is the major formatting method in the .NET Framework. It converts an object to its string representation so that it is suitable for display. (For information about formatting support in the .NET Framework, see Formatting Types.) Default implementations of the Object.ToString method return the fully qualified name of the object\\’s type.<\/p><\/blockquote>\n","protected":false},"excerpt":{"rendered":"

Heute einmal mit einem Antipattern, zum Thema tostring Methode. Viele kennen es und in vielen Programmiersprachen wird es unterst\u00fctzt, die “.ToString()” Methode. Geliebt und oft und genutzt, doch es gibt einige Probleme bei der Nutzung der ToString() Methode. Die folgenden Beispiele sind in C# geschrieben, sind allerdings 1 zu 1 […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-51","post","type-post","status-publish","format-standard","hentry","category-allgemein"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/posts\/51"}],"collection":[{"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/comments?post=51"}],"version-history":[{"count":5,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/posts\/51\/revisions"}],"predecessor-version":[{"id":57,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/posts\/51\/revisions\/57"}],"wp:attachment":[{"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/media?parent=51"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/categories?post=51"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/tags?post=51"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}