Java User Group Saxony Dec Oliver B. Fischer - E-Post Development GmbH Dirk Mahler - buschmais GbR

Transkript

1 by Java User Group Saxony Dec 2015 Oliver B. Fischer - E-Post Development GmbH Dirk Mahler - buschmais GbR

2 2

3 Eine strukturierte oder hierarchische Anordnung der Systemkomponenten sowie die Beschreibung Ihrer Beziehungen. Helmut Balzert 3

4 The fundamental organisation of a system embodied in its components, their relationships to each other, and the environment, and the principles guiding its design and evolution. IEEE

5 CMI: John Carter...from the plethora of definitions the vary concept of Software Architecture is fuzzy to the point of utter uselessness... A lot of folks mean: That peculiar consistency and homogenity of Design that would give arise to the ease of use and reuse, which is wished for by the developer who calls himself The Software Architect....[which] implodes immediatly on the appointment of a second Software Architect... 5

6 Software-Qualität Prozess Qualität Produkt-Qualität Wartbarkeit Brauchbarkeit Prüfbarkeit Änderbarkeit Portabilität Lesbarkeit Strukturiertheit Einfachheit 6

7 Durch Software Architektur wollen wir erhalten: Wartbare Software Verständliche Software Anpassbare bzw. Erweiterbare Software Effiziente Software 7

8 Software Architektur entsteht sobald sich zwei Personen über einen Aspekt eines Dings oder das Zusammenspiel zweier Dinge abstimmen. 8

9 Software Architektur entsteht sobald sich zwei Personen [über einen Aspekt eines Dings oder das Zusammenspiel zweier Dinge] abstimmen. 9

10 Software Architektur ist [auch] Kommunikation über Strukturen, Beziehungen und Prinzipien......um besser und leichter arbeiten zu können. 10

11 Software Architektur muß Verständnis schaffen, nicht nur für das Wie, sondern auch für das Warum! 11

12 Drei Rollen-Model Domainexperte Entwickler User 12

13 Einfachster Fall Domainexperte Entwickler User 13

14 Es wird schwieriger... Domainexperte Entwickler User 14

15 Es wird schwieriger... Domainexperte Entwickler User 15

16 Das Team wird größer Domainexperte Entwickler User 16

17 Es verteilt sich... Team in Berlin Team in München 17

18 Es verteilt sich geographisch und kulturell Ich spreche Deutsch... Я говорю по-русский I speak Englisch 18

19 Und dann auch zeitlich... 19

20 Veraltete Libraries... Neue Lösungsansätze Divergierende Makroarchitektur 20

21 1. Jedes System Jede Methode Auf jedem Server Hast Du mal Zeit? Ich habe da eine Idee.... Ja, so machen wir das! Ja, was willst Du denn? Laß mal hören

22 Regeln entstehen meist informell 1. Jedes System Jede Methode Auf jedem Server

23 Informelle Regeln haben Grenzen... Größe des Teams erschwert Kommunikation Entstehung von Inselwissen Fluktuation Charaktertypen 23

24 Überführung von informellen Regeln in formale Regeln. 24

25 Wir schreiben das auf! Im Wiki! Wo? Zitat Wiki, der Ort wo Informationen zum Sterben hingehen. 25

26 Dokumentation!= Kommunikation 26

27 Helfen Reviews? 27

28 Helfen Tools? 28

29 Mind The Gap! Architecture vs. Code 29

30 Open Source GPL v3 Current release: initiated: 03/2013 first stable release: 04/2015 Neo4j Community Edition embedded no installation necessary 30

31 The Idea Scan software structures Store in a database Execute queries Add higher level concepts Find constraint violations Find all Create Reports Database Provide feedback to developers within build process 31

32 Scan Plugins Command Line/ Maven Analyze Plugins Report Plugins 32

33 Available scanner plugins ZIP JAR, WAR, EAR GZ Liquibase *.class *.properties *.yaml MANIFEST.MF /META-INF/services/* web.xml application.xml beans.xml CheckStyle JaCoCo FindBugs Git pom.xml surefire-reports.xml *.xsd Plugin API is public M2 Repository RDBMS Schema 33

34 Mind The Gap! Architecture vs. Code 34

35 All we need is Nodes Labels Properties Relationships Type EXTENDS fqn:org.springframework.samples. petclinic.model.owner Modeling is just Taking a pen Drawing the structures on a whiteboard (i.e. the database) We don t need Foreign keys Tables and schemas Deep knowledge in graph theory 35

36 Project Maven name:petclinic CREATES Artifact Package Package Package CONTAINS CONTAINS CONTAINS name:samples name:org name:springframework CONTAINS name:petclinic Package CONTAINS name:model Package

37 Type Annotation fqn:javax.persistence.mappedsuperclass OF_TYPE name:model Package fqn:javax.persistence.entity Type OF_TYPE Annotation ANNOTATED_BY CONTAINS fqn:org.springframework. samples.petclinic. model.person name:person Type Method Class name:getaddress() ANNOTATED_BY EXTENDS RETURNS DECLARES fqn:java.lang.string Type READS Type Class OF_TYPE DECLARES fqn:org.springframework. samples.petclinic. model.owner name:owner name:address Field

38 Explore an application using queries Which class extends from another class? EXTENDS Type Type Let s convert this to ASCII art () as nodes -[]-> as directed relationships Class 38

39 Explore an application using queries Which class extends from another class? EXTENDS Type Type Let s convert this to ASCII art () as nodes -[]-> as directed relationships Class ()-[]->() 39

40 Explore an application using queries Which class extends from another class? C1 EXTENDS C2 Type Type Let s convert this to ASCII art () as nodes -[]-> as directed relationships Class (c1)-[]->(c2) 40

41 Explore an application using queries Which class extends from another class? C1 EXTENDS C2 Type Type Let s convert this to ASCII art () as nodes -[]-> as directed relationships Class (c1)-[:extends]->(c2) 41

42 Explore an application using queries Which class extends from another class? C1 EXTENDS C2 Type Type Let s convert this to ASCII art () as nodes -[]-> as directed relationships Class (c1:class)-[:extends]->(c2:type) 42

43 Explore an application using queries Which class extends from another class? C1 EXTENDS C2 Type Type Class Pattern matching is the core principle of Cypher MATCH (c1:class)-[:extends]->(c2:type) RETURN c1.fqn, c2.fqn 43

44 Mind The Gap! Architecture vs. Code 44

45 Mind The Gap! Architecture vs. Code 45

46 Analyze Execution of rules Defined in AsciiDoc or XML documents Concepts Enrich data model Constraints Detect violations Group Allow different execution profiles 46

47 Group Includes Constraint Requires Requires Concept Concept Requires Concept 47

48 Concept == JPA Entities [[jpa2:entity]].labels all types annotated with Jpa and Entity. [source,cypher,role=concept] ---- MATCH (t:type)-[:annotated_by]->()-[:of_type]->(a:type) WHERE a.fqn ="javax.persistence.entity" SET t:jpa:entity RETURN t AS Entity

49 Concept Type Annotation fqn:javax.persistence.entity OF_TYPE ANNOTATED_BY Type Class Jpa Entity fqn:org.springframework. samples.petclinic. model.owner name:owner 49

50 Constraint [[model:jpaentityinmodelpackage]].all JPA entities must be located in packages named "model". [source,cypher,role=constraint,requiresconcepts="jpa2:entity"] ---- MATCH (package:package)-[:contains]->(entity:jpa:entity) WHERE package.name <> "model" RETURN entity AS EntityInWrongPackage

51 Group [[default]] [role=group,includesconstraints="model:jpaentityinmodelpackage"] == Naming Rules The following naming rules apply: - <<model:jpaentityinmodelpackage>> 51

52 AsciiDoc Wiki syntax Rendering to DocBook HTML PDF Executable specification Coding rules Design & Architecture 52

53 Mind The Gap! Architecture vs. Code 53

54 Holistic view on code structure and system architecture Exploration of existing structures Validation of rules Executable architecture and design specification Rules using terms from architecture & design language 54

55 by Mail: Web: jqassistant.org