Architektur und Code im Einklang [DeveloperCamp 2017]

Architektur und Code
im Einklang
Umsetzung von Architekturkonzepten
und Designvorgaben mit jQAssistant und
AsciiDoc direkt im Quellcode automatisiert
überprüfen
@feststelltaste feststelltaste.de talk@markusharrer.de
Markus Harrer

“If you think good architecture is
expensive, try bad architecture.”
Brian Foote

“If you think good architecture is
expensive, try undocumented and
non-validated architecture.”
Markus Harrer

jQAssistant Funktionsweise
• Scanne Softwarestrukturen
• Speichere diese in eine Datenbank
• Führe Abfragen aus
• Untersuche Zusammenhänge
• Ergänze Konzepte
• Validiere Regelverletzungen
• Generiere Berichte

jQAssistant Kernideen: Concepts
• Gescannte Elemente werden Konzepten
(„concepts“) zugeordnet, z. B.
• Maven Project = Modul
• Java Package = Schicht
• Mit @Entity annotierte Klasse = JPA-Entity

jQAssistant Kernideen: Constraints
• Regeln werden auf Basis der Konzepte textuell
formuliert, z. B.
„Alle JPA-Entitäten müssen sich in der
Persistenz-Schicht befinden“
• Abweichungen von den Regeln („constraints“)
werden geprüft, z. B.
„Gib mir alle JPA-Entities, die sich nicht in der
Persistenzschicht befinden.“

jQAssistant Kernideen: Groups
• Alles wird in einer gemeinsamen
Dokumentation festgehalten, über Gruppen
(„groups“) strukturiert und beim Build
ausgeführt.
Ausschnitt:

Technische Umsetzung: Alles Plugins
Command
Line/
Maven
Scan
Analyze
Report
Plugins
Plugins
Plugins

Scanner
*.class
RDBMS Schema
Git
JaCoCo
FindBugsCheckStyle
JAR, WAR, EAR
ZIP
application.xml
web.xml
MANIFEST.M
F
beans.xml
pom.xml
surefire-reports.xml
GZ
*.properties
*.xsd
M2 Repository
*.yaml
*.xml

Graphentheorie
mit Neo4j und Cypher

Graph im Detail
Knoten
Mögliche Arten
Java-Klasse
Messpunkt
Datei
Repository
URL
...

Graph im Detail
Kanten
Typ einer Beziehung
DECLARES
EXTENDS
IMPLEMENTS
ANNOTATED_BY
DEPENDS_ON
...

Ein Graph
File Class TypeFile
key value
name “entity“
file “Entity.java”
fqn “jpa.thing.Entity”
key value
weight 3key value
name “Pet”
file “Pet.java”
fqn “foo.bar.Pet”
Labels
Properties

Graph im Detail
Labels
Markierung eines Knotens
:Class
:Type
:Java
:File
...
File

Graph im Detail
Properties
Eigenschaften eines Knotens
fqn
name
visibility
abstract
static
final
...
key value
name “Pet”
file “Pet.java”
fqn “foo.bar.Pet”

Sprint PetClinic: Verwaltung für Tierpraxis

Beispiel-Graph: Sprint PetClinic
visibility: public
name: Pet
fqn: org.springframework.samples.petclinic.model.Pet
…
Class:Type:Java:File

Kann ich abfragen!

Cypher
Abfrage von Knoten
()-[]->()

Cypher
Abfrage von Knoten
(p)-[]->(e)

Cypher
Abfrage von Knoten
(p:Class)-[]->(e:Type)

Cypher
Abfrage von Knoten
(p:Class {name:"Pet"})-[]->(e:Type {name:"Entity"})

Cypher
Abfrage von Knoten
MATCH
(p:Class {name:"Pet"})-[]->(e:Type {name:"Entity"})
RETURN p, e

Cypher
Abfrage von Knoten
MATCH
WHERE
p.name = "Pet" AND
e.name = "Entity"
RETURN p, e

Explorative Analysen in Neo4j
Demo 1
MATCH
WHERE
p.name = "Pet" AND
e.name = "Entity"
RETURN p, e

Dokumentieren
mit AsciiDoc und Cypher

AsciiDoc
Markup Language
• Rendert zu
• DocBook
• HTML
• PDF
mit Cypher: ausführbare Spezifikation!
• Programmiervorgaben
• Design und Architektur

Definition eines Concepts
== JPA Entities
[[jpa2:Entity]]
.Labels all types annotated with @javax.persistence.Entity
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
----

Definition eines Constraints
[[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
----

Definition einer Group
[[default]]
[role=group,includesConstraints=
"model:JpaEntityInModelPackage"]
== Naming Rules
The following naming rules apply:
- <<model:JpaEntityInModelPackage>>

Ergebnisbericht
Z. B. als Maven Site Report

Selbstvalidierende Architekturdokumentation
Demo 2
Spring PetClinic

• jQAssistant bietet schnelle und flexible Sichten
auf eine Vielzahl von Softwarestrukturen
• Zusammenhänge können explorativ über die
Graphdatenbank Neo4j erkundet werden
• Definition von Spielregeln über Concepts und
Constraints in Cypher / AsciiDoc
Automatisierte Überprüfung von
• Architekturkonzepten und
• Designvorgaben
• direkt im Code
Zusammenfassung

Links
• jQAssistant
• http://jqassistant.org
• Ausführliches Video
• https://www.youtube.com/watch?v=kQr2c7yWbEA
• Spring PetClinic Beispielprojekt
• Repo: http://github.com/buschmais/spring-petclinic
• Output: https://buschmais.github.io/spring-petclinic/
• Meine Erfahrungen soweit
• https://www.feststelltaste.de/my-experiences-with-
jqassistant-so-far/

Credits
Einige Beispiele wurden aus Dirk Mahlers
Vortrag “jQAssistant - Verify Your Design And
Architecture” übernommen
• https://jqassistant.org/wp-content/uploads/2016/06/
jQAssistant-Verify-Your-Design-And-Architecture.pdf
Bilder
• https://de.wikipedia.org/wiki/Datei:Yin_yang.svg
• https://commons.wikimedia.org/wiki/File:Achitecture_time.jpg
• https://commons.wikimedia.org/wiki/File:Adelaide_Street_aba
ndoned_house.jpg

Architektur und Code im Einklang [DeveloperCamp 2017]

Weitere ähnliche Inhalte

Empfohlen

Architektur und Code im Einklang [DeveloperCamp 2017]