Die Inhalte der Vorlesung wurden primär auf Basis der Vorlesung Software Engineering von Prof. Dr. Faustmann (FHW Berlin Fachbereich II) erstellt.

Transkript

1 Software Engineering Dokumentation von Softwarearchitekturen Die Inhalte der Vorlesung wurden primär auf Basis der Vorlesung Software Engineering von Prof. Dr. Faustmann (FHW Berlin Fachbereich II) erstellt Prof. Dr. Andreas Schmietendorf 1

2 Inhaltsübersicht Einführung UML-basierte Architekturdokumentation - Komponentendiagramme - Kompositionsstrukturdiagramme - Verteilungsdiagramme - Paketdiagramme Spezifikation von Fachkomponenten Prof. Dr. Andreas Schmietendorf 2

3 Einführung Prof. Dr. Andreas Schmietendorf 3

4 Motivation Architekturdokumentation: hilft anderen und nach einer gewissen Zeit auch uns selbst, eine SW- Architektur zu verstehen. Im eigenen oder auch anderen Projekten kann Wissen über den Architekturentwurf weitergegeben werden. Dokumentierte Architekturen können analysiert werden. Dokumentation von Architekturkomponenten: Unterstützt Komponentenmarktplätze Erlaubt die Wiederverwendung Gewährleistet die Umsetzbarkeit von funktionalen und nichtfunktionalen Anforderungen Prof. Dr. Andreas Schmietendorf 4

5 UML als Dokumentationsgrundlage Die UML 2.0 bietet einige Diagrammtypen, die eine gute Basis zur Beschreibung einer SW-Architektur bilden. - Komponentendiagramme modellieren die Organisation und Abhängigkeiten von Komponenten eines Systems. - Kompositionsstrukturdiagramme modellieren die internen Strukturen von Komponenten zusammen mit ihren gemeinsamen Interaktionspunkten. - Verteilungsdiagramme modellieren die Architektur verteilter Systeme zur Laufzeit. - Paketdiagramme organisieren und strukturieren Elemente in Paketen Prof. Dr. Andreas Schmietendorf 5

6 UML - Komponentendiagramm Prof. Dr. Andreas Schmietendorf 6

7 Anwendungsbereich Komponentendiagramme eignen sich besonders für die Spezifikation von Softwarearchitekturen. Sie werden meist parallel zu Verteilungsdiagrammen eingesetzt. Im Entwurf werden die Aufgaben des Gesamtsystems auf kleinere Subsysteme verteilt. Nachdem die einzelnen Komponenten mit ihren Aufgaben und der Kommunikation zwischen den Komponenten definiert wurden, kann die Entwicklungsarbeit aufgeteilt werden. Die Dokumentation von Softwarekomponenten und Schnittstellen kann in der Testphase als Grundlage von Integrationstests verwendet werden Prof. Dr. Andreas Schmietendorf 7

8 Notationselemente I Eine Komponente repräsentiert einen ersetzbaren modularen Bestandteil eines Systems, der sein Inneres kapselt. Eine Komponente kann aus wenigen Klassen bestehen, aber auch ein ganzes Softwaresystem sein. Quelle: Faustmann, G.: Vorlesung Software Engineering, FHW Berlin Fachbereich II) Prof. Dr. Andreas Schmietendorf 8

9 Notationselemente II Quelle: Faustmann, G.: Vorlesung Software Engineering, FHW Berlin Fachbereich II) Prof. Dr. Andreas Schmietendorf 9

10 Häufige Fehler Anfragen an eine Schnittstelle dürfen nur an eine kompatible Schnittstelle (gleicher Name!) weitergeleitet werden. Anfragen dürfen nur aus einer benötigten Schnittstelle weitergeleitet werden. Ebenso werden Anfrage üblicherweise in eine bereitgestellte Schnittstelle geleitet. Artefakte sollen einer Komponente zugeordnet werden, damit deutlich wird, welches Artefakt welche Komponente manifestiert. Schnittstellen sollten von einer Komponente realisiert werden. Artefakte können sich nicht gegenseitig manifestieren. Im Modell sollten keine zirkulären Abhängigkeiten über die <<use>>- Beziehung auftreten. Jede Komponente muss einen Namen besitzen Prof. Dr. Andreas Schmietendorf 10

11 Übung 12-1 Versetzen Sie sich in die Lage eines produzierenden Betriebs. Da der Betrieb weitestgehend auftragsbezogen arbeitet und so seine Lagerhaltung minimiert, hat die Auftragsverwaltung eine zentrale Funktion. Nach Auftragseingang wird durch die Lagerverwaltung geprüft, ob sich die angefragte Ware bereits im Lager befindet. Falls nicht, wird durch die Auftragsverwaltung der Produktionsplanung der Auftrag erteilt, einen Produktionsplan aufzustellen. Dieser Plan besteht aus Arbeitsschritten, die mit verschiedenen Vor- und Zwischenprodukten in Verbindung stehen. Der Produktionsplan wird von der Produktverwaltung verwaltet. Wesentlich ist die Verfügbarkeit der Vor- und Zwischenprodukte. Dazu wird der Lagerbestandsverwaltung der Auftrag gegeben, für deren Verfügbarkeit zu sorgen und diese ggfs. zu reservieren. Sind Produkte nicht verfügbar, ist es Aufgabe der Bestellverwaltung, die nötigen Produkte bei den Lieferanten zu bestellen. Die Dokumentenverwaltung erzeugt dann ein Bestelldokument. Ist die Verfügbarkeit der Ware durch Bestand oder Lieferzusagen gesichert, initiiert die Auftragsverwaltung die Erstellung der Auftragsbestätigung an den Kunden durch die Dokumentenverwaltung. Erstellen Sie ein Komponentendiagramm! Prof. Dr. Andreas Schmietendorf 11

12 UML - Kompositionsstrukturdiagramm Prof. Dr. Andreas Schmietendorf 12

13 Anwendungsbereich Interne Strukturen von Komponenten und deren Interaktionspunkte zu weiteren Komponenten des Systems werden definiert. Kompositionsstrukturdiagramme zeigen die innere Architektur von Komponenten, wie ihre einzelnen Bestandteile gemeinsam die gewünschten Aufgaben verrichten und werden auch als Architekturdiagramme bezeichnet. Diese Diagramme werden in den frühen Phasen der Softwareentwicklung erstellt. Im weiteren Verlauf der Entwicklung werden sie präzisiert und verfeinert. Weiterhin empfiehlt die UML ihren Einsatz bei der Definition von Lösungsmustern für wiederkehrende Problemstellungen Prof. Dr. Andreas Schmietendorf 13

14 Notationselemente Quelle: Faustmann, G.: Vorlesung Software Engineering, FHW Berlin Fachbereich II) Prof. Dr. Andreas Schmietendorf 14

15 Häufige Fehler In einer Kollaboration müssen Rollenbezeichnungen enthalten sein. An einer Kollaborationsanwendung dürfen nur Rollen teilnehmen, die in der zugehörigen Kollaboration definiert wurden. Die Rollenzuordnung in einer Kollaborationsanwendung muss spezifiziert werden. Die Definition der Struktur einer Klasse macht wenig Sinn, wenn diese Klasse nirgendwo anders verwendet wird. Der Name eines Konnektors und der Name eines Ports sind optional, sollten jedoch angegeben werden Prof. Dr. Andreas Schmietendorf 15

16 UML - Verteilungsdiagramm Prof. Dr. Andreas Schmietendorf 16

17 Anwendungsbereich Verteilungsdiagramme spezifizieren die physische Hardware- und Softwareumgebung und die Verteilung der Komponenten in dieser Umgebung. Verteilungsdiagramme werden meist parallel zu Komponentendiagrammen eingesetzt. Verteilungsdiagramme werden überwiegend in der Entwurfsphase erstellt. Auf ihrer Basis werden Entscheidungen über eventuell anzuschaffende Hardware- und Softwarekomponenten und deren Kommunikationswege getroffen. Bereits während der Implementierung des Softwaresystems kann so seine Laufzeitumgebung aufgebaut, installiert und getestet werden Prof. Dr. Andreas Schmietendorf 17

18 Notationselemente Quelle: Faustmann, G.: Vorlesung Software Engineering, FHW Berlin Fachbereich II) Prof. Dr. Andreas Schmietendorf 18

19 Häufige Fehler Ein Artefakt kann keine Ausführungsumgebung für einen Knoten darstellen (falsche deploy-richtung). Für jede Einsatzspezifikation ist die Abhängigkeit zu einem Artefakt zu modellieren. Mehrere Knoten eines Typs brauchen nicht modelliert zu werden. Es sollten besser Multiplizitäten an den Kommunikationspfaden verwendet werden. Bei der Modellierung von Knoten sollten Stereotypen verwendet werden. Es können auch eigene Stereotypen eingesetzt werden! Auch Kommunikationspfade sind mit Stereotypen zu versehen Prof. Dr. Andreas Schmietendorf 19

20 Übung 12-2 Es soll ein Verteilungsdiagramm für ein System mit den folgenden Komponenten erstellt werden: - Datenbank-Server für Kundendaten (DBS1), - Datenbankserver für Lagerdaten (DBS2) - Anwendungs-Server für den Vertrieb -mit entsprechender Software mit Client-Schnittstelle (APS) - Client unter Windows für Abfrage von Kundendaten (CL1) - Client unter Linux (CL2) mit Management-Support-System (MSS) Welche Abhängigkeiten bestehen? Prof. Dr. Andreas Schmietendorf 20

21 UML - Paketdiagramm Prof. Dr. Andreas Schmietendorf 21

22 Anwendungsbereich Paketdiagramme werden in den frühen Phasen der Softwareentwicklung verwendet, um das Modell horizontal und vertikal zu strukturieren. Unter horizontaler Strukturierung wird die Möglichkeit verstanden, UML-Elemente, die logisch zusammengehören, in Paketen zusammen zu fassen und damit das Modell zu modularisieren. Die vertikale Strukturierung dagegen erlaubt eine hierarchische Modellierung des Systems mit Unterpaketen. Pakete auf tieferen Ebenen nähern sich dann den Projektdetails Prof. Dr. Andreas Schmietendorf 22

23 Notationselemente Quelle: Faustmann, G.: Vorlesung Software Engineering, FHW Berlin Fachbereich II) Prof. Dr. Andreas Schmietendorf 23

24 Häufige Fehler Paketname fehlt. - Pakete müssen mit eindeutigen Namen versehen werden. Bezeichnung der Beziehung fehlt. - Die Art der modellierten Beziehung ist zu definieren (import, access, merge). Zirkuläre <<merge>>-beziehungen. - Zwei Pakete dürfen sich nicht gegenseitig mergen. Ungültige <<merge>>-beziehung. - Die <<merge>>-beziehung darf nur zwischen Paketen modelliert werden. Falsche Hierarchie. - Klassen können weitere Klassen, jedoch keine Pakete enthalten. Paketen können jedoch sowohl Klassen als auch Unterpakete enthalten Prof. Dr. Andreas Schmietendorf 24

25 Spezifikation von Fachkomponenten Prof. Dr. Andreas Schmietendorf 25

26 Spezifikation von FK Fachkomponente Auftragsbearbeitung Service-Adapter (Client) Dienstgeber LiefereKundenDaten Service-Adapter (Server) Kundenverwaltung Dienstnehmer LiefereKundenDaten Schnittstelle Ein Kunde ist eine Person, die uns bekannt ist... LiefereKundenDaten ( In: ID :String Out: Name :String Adresse:String... ) LiefereKundenDaten ( In: ID :Long Out: Name :String VorName :String Straße :String Nummer :Integer... ) Ein Kunde ist eine Person, die schon einmal etwas bei uns erworben hat... Signaturen passen nicht Entwickler Konzepte passen nicht Entwickler Prof. Dr. Andreas Schmietendorf 26

27 Spezifikation von FK Formale Notationen - Syntax und Semantik der Notation sind eindeutig und widerspruchsfrei - Unterstützen entwickler- und unternehmensübergreifende intersubjektive Nachvollziehbarkeit der Spezifikationsergebnisse Ergänzende Sekundärspezifikation - Grafisch Notation - Verbale Spezifikation - Aufbereitung der Spezifikation für spezielle Adressatenkreise Prof. Dr. Andreas Schmietendorf 27

28 Spezifikation von FK Durchgängige Spezifikation Quelle: Prof. Dr. Andreas Schmietendorf 28