Ist es notwendig, in jedem Klassendiagramm Logging und Audit hinzuzufügen

Question

Ich werde eine neue Anwendung für das Design von Klassendiagrammen starten ... In meiner Anwendung plane ich Log4j für Logging und Audit4j für Audit zu implementieren. Jetzt habe ich einen Zweifel, ist es notwendig, Logging-und Audit-Funktionalität in UML (Klassendiagramm) hinzufügen, weil jede Klasse beide verwendet und es ist standardmäßig verständlich. Wenn ich sie hinzufüge, sieht meine UML so ungeschickt und unklar aus.

Ist es ratsam, Protokollierung und Audit von UML zu entfernen. Wird es irgendwelche Nachteile beim Bau verursachen ...

Vielen Dank im Voraus ...

Answer 1

Klassendiagramme und andere UML-Diagramme den Zweck der Klärung der Zusammenhänge und Wechselwirkungen zwischen den Modulen und Klassen dienen. Wie Sie bereits erwähnt haben, wird das Hinzufügen unnötiger Details, die quer über die Module/Klassen hinweg reichen, Ihre Diagramme überladen und keinen Wert hinzufügen.

Als Entwickler von Klassendiagrammen würde ich die Logger/Audits nicht sehen wollen. Sie können die Details zu diesen übergreifenden Funktionen in Ihren anderen Spezifikationen/Dokumentationen hinzufügen.

Answer 2

UML dreht sich nicht um Diagramme, sondern um Modelle. Ihre Diagramme helfen dem Menschen, das Modell zu verstehen. Sie erstellen mehr als ein Diagramm, um einen bestimmten Aspekt hervorzuheben. Wenn Sie versuchen, eine dreidimensionale Skulptur mit 2-dimensionalen Fotos zu dokumentieren, müssen Sie auch mehr als ein Foto machen. Einige dieser Fotos enthalten doppelte (redundante) Informationen. Sie können sie bei Bedarf zuschneiden. Aber manchmal brauchen Sie das für den Kontext.

Zusammenfassend: Machen Sie so viele Diagramme wie nötig. Focus in einigen. Machen Sie ein globaleres Bild in anderen. Es ist eine Kunst für sich, gute Bilder zu bekommen.