Structurizr Java

The structurizr-component library is a tool for discovering components within a Java codebase. It uses a combination of Apache Commons BCEL and JavaParser to scan code and identify components based on a pluggable and customizable set of matching and filtering rules.

This functionality can be used in two ways:

1. Programmatically via the Java library: Integrate the library directly into your Java application or build process.
2. Via Structurizr DSL: Use the !components keyword within a Structurizr DSL workspace to trigger component discovery.

The structurizr-annotation library provides custom Java annotations designed to facilitate the extraction of software architecture models from source code. These annotations serve two primary purposes:

1. Explicit Component Extraction: Using annotations like @Component to define how specific code elements should be mapped to architectural components.
2. Model Supplementation: Using annotations like @Property or @Tag to add metadata and additional information to the software architecture model.

Key characteristics:

• Zero Dependencies: The library does not introduce any external dependencies to your project.
• Runtime Retention: All annotations use a RUNTIME retention policy, ensuring they are available in the compiled bytecode for reflection-based extraction tools.

The structurizr-export library allows you to export models and views from a Structurizr workspace into various diagramming and visualization formats. Supported formats include:

• PlantUML and C4-PlantUML
• Mermaid
• DOT
• WebSequenceDiagrams
• Ilograph

You can find examples of these exported formats on the Structurizr DSL demo page.

The structurizr-export package provides two distinct PlantUML exporters for converting Structurizr models into PlantUML format:

1. StructurizrPlantUMLExporter: A general-purpose exporter for PlantUML.
2. C4PlantUMLExporter: An exporter specifically designed for C4 model diagrams in PlantUML.

For detailed instructions on how to use these exporters and integrate them into your workflow, refer to the official Structurizr export documentation at https://docs.structurizr.com/export.

The library supports importing the following types of content into a Structurizr workspace:

• Diagrams: Supports PlantUML, Mermaid, and Kroki formats.
• Documentation: Supports supplementary Markdown and AsciiDoc files.
• Architecture Decision Records (ADRs): Imports ADRs to provide context to the architecture.
• Images: Imports images to be used within diagrams or documentation.

The structurizr-autolayout library is available on Maven Central. You must have the Graphviz tool installed on your system for the layout engine to function, as the library wraps the Graphviz dot command.

<!-- Add the dependency to your Maven pom.xml -->
<dependency>
    <groupId>com.structurizr</groupId>
    <artifactId>structurizr-autolayout</artifactId>
    <version>VERSION</version>
</dependency>

The structurizr-client library is available on Maven Central. You can use it to interact with the Structurizr Cloud service or an on-premises installation via their Workspace and Admin APIs.

<!-- Add the following dependency to your Maven pom.xml -->
<dependency>
    <groupId>com.structurizr</groupId>
    <artifactId>structurizr-client</artifactId>
    <version>5.0.3</version>
</dependency>

Use the WebSequenceDiagramsExporter class to convert Structurizr dynamic views into diagram definitions compatible with websequencediagrams.com. You can export either an entire workspace's worth of dynamic views or a specific single dynamic view.

// Export all dynamic views in a workspace
Workspace workspace = ...
WebSequenceDiagramsExporter exporter = new WebSequenceDiagramsExporter();
Collection<Diagram> diagrams = exporter.export(workspace);

// OR export a single dynamic view
DynamicView view = ...
WebSequenceDiagramsExporter exporter = new WebSequenceDiagramsExporter();
Diagram diagram = exporter.export(view);