# youseries/ureport architecture

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

- Interactive diagram: https://gitdiagram.com/youseries/ureport
- Repository: https://github.com/youseries/ureport

## Overview

##### Project Type and Purpose
- UReport2 is a multi‐module Java project providing a pure‐Java report engine (ureport2-core), a web-based designer console (ureport2-console), a font registration library (ureport2-font), and a JavaScript client (ureport2-js).
- Its purpose is to let developers embed a high-performance, Spring-based report engine into any J2EE/Maven project, design reports in the browser, and export them to PDF/Excel/HTML/Word.

##### High-Level Components
A. Frontend (ureport2-js)
- Hosts the browser-based designer UI, preview UI, dialogs, tree views, form builder, etc.
- Bundled via Webpack; served as static assets by the console webapp.
- Communicates over HTTP(S) (AJAX/REST) with the backend servlet endpoints.

B. Backend Console (ureport2-console)
- A Java web application (Servlet) running in any servlet container (Tomcat, Jetty).
- Spring Web MVC + custom servlet actions (e.g., DesignerServletAction, RenderPageServletAction, ExportPdfServletAction).
- Manages user sessions, temporary caches (HttpSessionReportCache, TempObjectCache), and serves static resources.
- Delegates report parsing, building, and exporting to ureport2-core.

C. Core Engine (ureport2-core)
- Provides DSL parsing (ANTLR4 grammars), report definition model, builder layers (cell/aggregate/paging), expression evaluation (EL + custom functions), data binding, and export managers.
- Uses a layered architecture:
1. Parser (ReportParser, parser.impl)
2. Definition model (definition/*)
3. Builder/Compute (build/*, compute/*, paging/*)
4. Expression (expression/parse, expression/function)
5. Export (export/excel, export/pdf, export/html, export/word)
6. Caching (cache/*) and resource providers (provider/*)
- Configured via ureport-core-context.xml and ureport.properties; wired by Spring IoC.

D. Font Module (ureport2-font)
- Registers common fonts via Java classes (e.g. ArialFontRegister, YaheiFontRegister).
- Loaded as a bean in Spring context when exporting to formats that embed fonts (PDF, Word).

E. Parent POM (ureport2-parent)
- Defines dependency versions and module aggregation (multi-module Maven project).

##### External Dependencies & Integrations
- JDBC DataSources or SpringBean data sources (datasource/* in core).
- HTTP/HTTPS image providers for dynamic images.
- Spring Framework, Servlet API, ANTLR4, Jackson/Gson (for JSON), caching (in-memory), and optionally external file storage/classpath for report templates.

##### Relationships & Data Flow
1. User opens browser → downloads HTML/JS/CSS from ureport2-console.
2. Frontend Designer issues AJAX calls → console servlet endpoints (/ureport/*).
3. Console loads or saves report definition → passes to core DSL parser → builds in-memory ReportDefinition.
4. Core ReportBuilder fetches data via configured DataSource → computes cells, aggregates, paging.
5. Core ExportManager serializes the Report model → chosen format (PDF/Excel/HTML/Word).
6. Console streams the binary or HTML back to the browser → rendered or downloaded by user.

##### Important Architectural Patterns
- Layered architecture in core (Parser → Definition → Builder → Compute → Export).
- Spring IoC for wiring modules and pluggable providers.
- MVC-style servlet actions in console.
- Client-server separation: a thin JavaScript client vs. a heavyweight Java core.

## Diagram (Mermaid)

```mermaid
flowchart TD
    direction TB

    subgraph "Browser"
        direction TB
        Frontend["ureport2-js Designer UI"]:::frontend
    end

    subgraph "Console WebApp (Spring MVC)" 
        direction TB
        UReportServlet["UReportServlet"]:::console
        DesignerAction["DesignerServletAction"]:::console
        RenderAction["RenderPageServletAction"]:::console
        ExportPdf["ExportPdfServletAction"]:::console
        ExportExcel["ExportExcelServletAction"]:::console
        HtmlPreview["HtmlPreviewServletAction"]:::console
        ExportWord["ExportWordServletAction"]:::console
        HttpSessionCache["HttpSessionReportCache"]:::console
        TempObjectCache["TempObjectCache"]:::console
        StaticResources["Static Resources"]:::console
    end

    subgraph "Core Engine (Spring IoC)"
        direction TB
        Parser["Parser"]:::core
        Definition["Definition Model"]:::core
        BuilderCompute["Builder/Compute/Paging"]:::core
        Expression["Expression Evaluation"]:::core
        ExportManagers["Export Managers"]:::core
        CacheProviders["Cache & Providers"]:::core
    end

    FontModule["Font Module"]:::grey
    ParentPOM["Parent POM"]:::grey
    JDBCDB["JDBC Database"]:::grey
    ImgService["HTTP Image Service"]:::grey

    %% Data Flows
    Frontend -- "HTTP AJAX/REST" --> UReportServlet
    UReportServlet --> DesignerAction
    UReportServlet --> RenderAction
    UReportServlet --> ExportPdf
    UReportServlet --> ExportExcel
    UReportServlet --> HtmlPreview
    UReportServlet --> ExportWord
    DesignerAction -->|parsing| Parser
    RenderAction -->|build/report| BuilderCompute
    ExportPdf -->|generate PDF| ExportManagers
    ExportExcel -->|generate Excel| ExportManagers
    HtmlPreview -->|generate HTML| ExportManagers
    ExportWord -->|generate Word| ExportManagers
    BuilderCompute --> Definition
    BuilderCompute --> Expression
    Parser --> Definition
    Definition --> BuilderCompute
    Expression --> BuilderCompute
    ExportManagers -->|binary stream| UReportServlet
    UReportServlet --> Frontend
    BuilderCompute -->|JDBC calls| JDBCDB
    ExportManagers -->|HTTP| ImgService
    FontModule --> ExportManagers

    %% Click Events
    click Frontend "https://github.com/youseries/ureport/tree/master/ureport2-js/src/"
    click UReportServlet "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/UReportServlet.java"
    click DesignerAction "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/designer/DesignerServletAction.java"
    click RenderAction "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/RenderPageServletAction.java"
    click ExportPdf "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/export/ExportPdfServletAction.java"
    click ExportExcel "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/excel/ExportExcelServletAction.java"
    click HtmlPreview "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/html/HtmlPreviewServletAction.java"
    click ExportWord "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/word/ExportWordServletAction.java"
    click HttpSessionCache "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/cache/HttpSessionReportCache.java"
    click TempObjectCache "https://github.com/youseries/ureport/blob/master/ureport2-console/src/main/java/com/bstek/ureport/console/cache/TempObjectCache.java"
    click StaticResources "https://github.com/youseries/ureport/tree/master/ureport2-console/src/main/resources/ureport-asserts/"
    click Parser "https://github.com/youseries/ureport/blob/master/ureport2-core/src/main/java/com/bstek/ureport/parser/ReportParser.java"
    click Definition "https://github.com/youseries/ureport/tree/master/ureport2-core/src/main/java/com/bstek/ureport/definition/"
    click BuilderCompute "https://github.com/youseries/ureport/tree/master/ureport2-core/src/main/java/com/bstek/ureport/build/"
    click Expression "https://github.com/youseries/ureport/tree/master/ureport2-core/src/main/java/com/bstek/ureport/expression/parse/"
    click ExportManagers "https://github.com/youseries/ureport/tree/master/ureport2-core/src/main/java/com/bstek/ureport/export/"
    click CacheProviders "https://github.com/youseries/ureport/tree/master/ureport2-core/src/main/java/com/bstek/ureport/cache/"
    click FontModule "https://github.com/youseries/ureport/blob/master/ureport2-font/pom.xml"
    click ParentPOM "https://github.com/youseries/ureport/blob/master/ureport2-parent/pom.xml"

    %% Styles
    classDef frontend fill:#ccffcc,stroke:#006600,color:#000000
    classDef console fill:#cce5ff,stroke:#004085,color:#000000
    classDef core fill:#ffdd99,stroke:#e69500,color:#000000
    classDef grey fill:#eeeeee,stroke:#666666,color:#000000
```
