irwansyahrir / structurizr-java

Structurizr for Java

Structurizr for Java

This GitHub repository is primarily a client library for Structurizr, a web-based publishing platform for software architecture models based upon the C4 model. It can also be used to create software architecture diagrams that can be rendered with tools such as PlantUML, Graphviz and WebSequenceDiagrams.

In essence, Structurizr for Java is an implementation of an executable architecture description language; a domain-specific language to describe software architecture, using code. The key benefit of using code to create a software architecture model is that you can use the static analysis and reflection features of Java to help you extract components from the codebase you are modelling. Integration of this tooling with your continuous integration/build process helps your software architecture diagrams stay up to date.

A quick example

As an example, the following Java code can be used to create a software architecture model and an associated view that describes a user using a software system.

public static void main(String[] args) throws Exception {
    Workspace workspace = new Workspace("Getting Started", "This is a model of my software system.");
    Model model = workspace.getModel();
    
    Person user = model.addPerson("User", "A user of my software system.");
    SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system.");
    user.uses(softwareSystem, "Uses");
    
    ViewSet views = workspace.getViews();
    SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram.");
    contextView.addAllSoftwareSystems();
    contextView.addAllPeople();
}

The view can then be exported to be visualised in a number of different ways; e.g. PlantUML, Structurizr and Graphviz:

Table of contents

• Introduction
  • Getting started
  • About Structurizr and how it compares to other tooling
  • Why use code?
  • Basic concepts (workspaces, models, views and documentation)
  • C4 model
  • Examples
  • Binaries
  • API Client
  • Usage patterns
• Model
  • Creating your model
• Views
  • Creating views
  • System Context diagram
  • Container diagram
  • Component diagram
  • Dynamic diagram
  • Deployment diagram
  • System Landscape diagram
  • Styling elements
  • Styling relationships
  • Filtered views
• Documentation
  • Documentation overview
  • Structurizr
  • arc42
  • Viewpoints and Perspectives
  • Automatic template
• Extracting software architecture information from code
  • Component finder
  • Structurizr annotations
  • Type matchers
  • Spring component finder strategies
  • Supplementing the model from source code
  • Components and supporting types
  • The Spring PetClinic example
• Exporting and visualising with other tools
  • PlantUML
  • Graphviz and DOT
  • WebSequenceDiagrams
• Other
  • Client-side encryption
  • Corporate branding
  • Building from source
• Related projects
  • cat-boot-structurizr: A way to apply dependency management to help modularise Structurizr code.
  • java-quickstart: A simple starting point for using Structurizr for Java
  • structurizr-groovy: An initial version of a Groovy wrapper around Structurizr for Java.
  • structurizr-dotnet: Structurizr for .NET