# xtoon/xtoon-boot-ddd architecture

> Architecture diagram of the GitHub repository xtoon/xtoon-boot-ddd, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/xtoon/xtoon-boot-ddd
- Repository: https://github.com/xtoon/xtoon-boot-ddd

## Overview

##### Project type and purpose
- xtoon-boot is a Java/Spring Boot monolith scaffolding for SaaS platforms, built on Domain-Driven Design (DDD) and Hexagonal (Ports & Adapters) architecture.
- It provides turnkey modules—login/registration, user/role/menu/tenant management, logs, multi-tenancy—so teams can focus on business logic rather than boilerplate.

##### File structure
- Top-level modules:
- db (SQL scripts)
- xtoon-common (cross-cutting domain classes, utilities, configuration)
- xtoon-api (REST controllers, web layer, Swagger UI)
- xtoon-sys (system-management subdomain)
- xtoon-org (organization-management subdomain)
- Each subdomain module (xtoon-sys, xtoon-org) follows the DDD layering:
- application (DTOs, commands, services, assemblers)
- domain (entities, value objects, specifications, domain services, external interfaces)
- infrastructure (persistence adapters, external service implementations)
- xtoon-api depends on xtoon-common and both subdomains; xtoon-common holds shared code (MyBatis config, Redis config, utility classes).

##### README for architectural guidance
- Embraces Hexagonal (Ports & Adapters): core logic is isolated from frameworks and infrastructure.
- Four layers: Presentation/API, Application, Domain, Infrastructure.
- Uses Spring Boot for wiring, Apache Shiro for security, MyBatis-Plus + Alibaba Druid for persistence, Redis for caching, Swagger for API docs.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    Client["Clients (Web UI/Postman)"]:::client

    %% API Layer
    subgraph "API Layer" 
        direction TB
        Controller["REST Controllers (xtoon-api)"]:::api
        Swagger["Swagger3Config"]:::api
        ShiroRealm["OAuth2Realm"]:::security
        ShiroFilter["OAuth2Filter"]:::security
    end

    %% Common Layer
    subgraph "Shared/Common Layer" 
        direction TB
        CommonUtil["Common Utilities"]:::common
        CommonDomain["Domain Base Classes & Specs"]:::common
        RedisConfig["RedisConfig"]:::common
        RedisUtils["RedisUtils"]:::common
        AliSms["AliSmsUtils"]:::common
    end

    %% Application Layer
    subgraph "Application Layer"
        direction TB
        subgraph "xtoon-sys Application"
            SysAppPort["Sys Application Services (Ports)"]:::app
            SysAppImpl["Sys Application Impls"]:::app
        end
        subgraph "xtoon-org Application"
            OrgAppPort["Org Application Services (Ports)"]:::app
            OrgAppImpl["Org Application Impls"]:::app
        end
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        SysDomainModel["Sys Domain Model"]:::domain
        SysDomainService["Sys Domain Services & Specs"]:::domain
        OrgDomainModel["Org Domain Model"]:::domain
    end

    %% Infrastructure Layer
    subgraph "Infrastructure Layer"
        direction TB
        subgraph "Persistence Adapters (xtoon-sys)"
            SysConverters["Converters"]:::infra
            SysMappers["MyBatis Mappers"]:::infra
            SysRepos["Repository Implementations"]:::infra
        end
        TokenGen["TokenGeneratorExternalServiceImpl"]:::infra
    end

    %% External Systems & DB
    Database[(Database\nMySQL)]:::db
    Redis[(Redis Cache)]:::external
    SMS[(SMS Gateway)]:::external

    %% Main Application
    XtoonApp["XtoonBootApplication"]:::app

    %% Connections
    Client -->|HTTP| Controller
    Controller -->|calls| SysAppPort
    Controller -->|calls| OrgAppPort
    Controller -->|uses| Swagger
    Controller -->|filters via| ShiroFilter
    ShiroFilter -->|authenticates via| ShiroRealm
    SysAppPort -->|invokes| SysAppImpl
    OrgAppPort -->|invokes| OrgAppImpl
    SysAppImpl -->|uses| SysDomainModel
    SysAppImpl -->|uses| SysDomainService
    OrgAppImpl -->|uses| OrgDomainModel
    SysDomainService -->|uses repo| SysRepos
    SysRepos -->|maps via| SysConverters
    SysRepos -->|executes| SysMappers
    SysRepos -->|writes to| Database
    SysConverters -->|converts| SysDomainModel
    TokenGen -->|implements port| SysAppImpl
    RedisUtils -->|caches| SysAppImpl
    RedisUtils -->|connects to| Redis
    AliSms -->|sends via| SMS

    %% Common usage
    Controller -->|imports| CommonUtil
    SysAppImpl -->|imports| CommonDomain
    OrgAppImpl -->|imports| CommonDomain

    %% Entry point
    XtoonApp -->|bootstraps| Controller
    XtoonApp -->|bootstraps| SysAppImpl
    XtoonApp -->|bootstraps| OrgAppImpl

    %% Click Events
    click Controller "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-api/src/main/java/com/xtoon/boot/web"
    click Swagger "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-api/src/main/java/com/xtoon/boot/web/util/swagger/Swagger3Config.java"
    click ShiroRealm "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-api/src/main/java/com/xtoon/boot/web/util/shiro/OAuth2Realm.java"
    click ShiroFilter "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-api/src/main/java/com/xtoon/boot/web/util/shiro/OAuth2Filter.java"
    click CommonUtil "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-common/src/main/java/com/xtoon/boot/common/util"
    click CommonDomain "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-common/src/main/java/com/xtoon/boot/common/domain"
    click RedisConfig "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-common/src/main/java/com/xtoon/boot/common/util/redis/RedisConfig.java"
    click RedisUtils "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-common/src/main/java/com/xtoon/boot/common/util/redis/RedisUtils.java"
    click AliSms "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-common/src/main/java/com/xtoon/boot/common/util/message/AliSmsUtils.java"
    click SysAppPort "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/application"
    click SysAppImpl "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/application/impl"
    click SysDomainModel "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/domain/model"
    click SysDomainService "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/domain/service"
    click SysDomainService "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/domain/specification"
    click SysConverters "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/infrastructure/persistence/converter"
    click SysMappers "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/infrastructure/persistence/mapper"
    click SysRepos "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/infrastructure/persistence/repository"
    click TokenGen "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-sys/src/main/java/com/xtoon/boot/sys/infrastructure/external/impl/TokenGeneratorExternalServiceImpl.java"
    click OrgAppPort "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-org/src/main/java/com/xtoon/boot/org/application"
    click OrgAppImpl "https://github.com/xtoon/xtoon-boot-ddd/tree/develop/xtoon-org/src/main/java/com/xtoon/boot/org/application/impl"
    click XtoonApp "https://github.com/xtoon/xtoon-boot-ddd/blob/develop/xtoon-api/src/main/java/com/xtoon/boot/XtoonBootApplication.java"

    %% Styles
    classDef client fill:#f9f,stroke:#333,stroke-width:1px
    classDef api fill:#bbf,stroke:#333,stroke-width:1px
    classDef security fill:#fdd,stroke:#333,stroke-width:1px
    classDef common fill:#dfd,stroke:#333,stroke-width:1px
    classDef app fill:#ffd,stroke:#333,stroke-width:1px
    classDef domain fill:#fcc,stroke:#333,stroke-width:1px
    classDef infra fill:#ccf,stroke:#333,stroke-width:1px
    classDef db fill:#cfc,stroke:#333,stroke-width:1px
    classDef external fill:#fcf,stroke:#333,stroke-width:1px
```
