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

Schnittstellen zu fremden System werden explizit entworfen. Jede weitere Methode die angeboten wird ist genauestens auf dem Bed\u00fcrfnis des sp\u00e4teren Nutzers abgestimmt. Oftmals sind diese Schnittstellen gut definiert bzw. Ein Dritter ist in der Lage diese zu nutzen. Nun warum wird dieses Prinzip nicht auf jedes Modul, welches intern genutzt wird, angewendet? Auch hier gibt es einen sp\u00e4teren Anwender, bzw. Ein Kollege der dieses Modul verwenden soll.
\nIn dem folgenden Beispiel wird ein antipattern gezeigt. Dort ist ein kleiner Ausschnitt eines Settings Modul beschrieben. Dieses Modul soll ein Setting verwalten, das hei\u00dft in eine DB schreiben und lesen.<\/p>\n

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<\/div><\/td>
\/\/ folgende schritte werden benotigt um ein menu punkt hinzu zu f\u00fcgen<\/span>
\n\/\/ 1. F\u00fcge die enum hinzu<\/span>
\n\/\/ 2. F\u00fcge den typ hinzu<\/span>
\n\/\/ 3. Konverter bei komplexen typen<\/span>
\n\/\/ 4. Wenn der typ in der db nicht bekannt ist.<\/span>
\n\/\/ 5. Wenn der typ ver\u00e4ndert wurde und konvertiert werden muss<\/span>
\n\/\/ 6. Men\u00fc punkt f\u00fcr die settings festlegen<\/span>
\n\/\/ 7. Default werte festlegen<\/span>
\nclass<\/span> Settings{<\/span>
\n   \/\/ zu 1.   <\/span>
\n   enum<\/span> Typ{<\/span>            
\n      smtp-<\/span>url,
\n      smtp-<\/span>port,
\n      cachesize,
\n      temppath
\n   }<\/span>
\n   \/\/ zu 2.<\/span>
\n   Dictionary<<\/span>Typ, Type><\/span> typelist =<\/span> new<\/span><\/a> Dictionary<<\/span>Typ, Type><\/span>(<\/span>)<\/span>
\n   {<\/span>
\n      [<\/span>Typ.<\/span>smtp<\/span>-<\/span>url]<\/span> =<\/span> typeof<\/span><\/a>(<\/span>string<\/span>)<\/span>,
\n      [<\/span>Typ.<\/span>smtp<\/span>-<\/span>port]<\/span> =<\/span> typeof<\/span><\/a>(<\/span>int<\/span>)<\/span> ,
\n      [<\/span>Typ.<\/span>cachesize<\/span>]<\/span> =<\/span> typeof<\/span><\/a>(<\/span>int<\/span>)<\/span>
\n   }<\/span>;<\/span>
\n   \/\/ zu 7.<\/span>
\n   Dictionary<<\/span>Typ, object<\/span>><\/span> defaultvalues =<\/span> new<\/span><\/a> Dictionary<<\/span>Typ, object<\/span>><\/span>(<\/span>)<\/span>
\n   {<\/span>
\n      [<\/span>Typ.<\/span>smtp<\/span>-<\/span>url]<\/span> =<\/span> "localhost"<\/span>,
\n      [<\/span>Typ.<\/span>smtp<\/span>-<\/span>port]<\/span> =<\/span> 23<\/span> ,
\n      [<\/span>Typ.<\/span>cachesize<\/span>]<\/span> =<\/span> 100000<\/span>
\n   }<\/span>;<\/span>
\n   \/\/ zu 6.<\/span>
\n   Dictionary<<\/span>Typ, String<\/span>><\/span> menulist =<\/span> new<\/span><\/a> Dictionary<<\/span>Typ, String<\/span>><\/span>(<\/span>)<\/span>
\n   {<\/span>
\n      [<\/span>Typ.<\/span>smtp<\/span>-<\/span>url]<\/span> =<\/span> "E-mail"<\/span>,
\n      [<\/span>Typ.<\/span>smtp<\/span>-<\/span>port]<\/span> =<\/span>  "E-mail"<\/span>,
\n      [<\/span>Typ.<\/span>cachesize<\/span>]<\/span> =<\/span> "System"<\/span>
\n   }<\/span>;<\/span>
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

Zu erkennen ist das der Entwickler keine richtige Schnittstelle definiert hat, in der eine Setting hinzugef\u00fcgt werden kann. Stattdessen wurde ein Kommentar mit Anweisungen hinterlassen. Somit muss ein Entwickler genauestens diesen Anweisungen folgen, um eine Setting korrekt anzulegen. Beispielsweise muss er in einer enum eine neue Settingskey definieren und zu dieser den passenden objekttyp in einer dictionary eintragen.
\nDieses Vorgehen sorgt daf\u00fcr das der nachkommende Entwickler entsprechende mehr Zeit investieren muss, um eine Setting anzulegen. Au\u00dferdem ist die Fehlerwahrscheinlich bei diesem Vorgehen gr\u00f6\u00dfer, da es zu Missverst\u00e4ndnissen kommen kann. Ich lasse die Frage offen wie dieser Code refactored werden kann. Freue mich \u00fcber die Kommentare und m\u00f6glichen refactoring M\u00f6glichkeiten.<\/p>\n","protected":false},"excerpt":{"rendered":"

Schnittstellen zu fremden System werden explizit entworfen. Jede weitere Methode die angeboten wird ist genauestens auf dem Bed\u00fcrfnis des sp\u00e4teren Nutzers abgestimmt. Oftmals sind diese Schnittstellen gut definiert bzw. Ein Dritter ist in der Lage diese zu nutzen. Nun warum wird dieses Prinzip nicht auf jedes Modul, welches intern genutzt […]<\/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-58","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\/58"}],"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=58"}],"version-history":[{"count":2,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/posts\/58\/revisions"}],"predecessor-version":[{"id":60,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/posts\/58\/revisions\/60"}],"wp:attachment":[{"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/media?parent=58"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/categories?post=58"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lpl-mind.de\/en\/wp-json\/wp\/v2\/tags?post=58"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}