# caolib/book_management_system architecture

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

- Interactive diagram: https://gitdiagram.com/caolib/book_management_system
- Repository: https://github.com/caolib/book_management_system

## Overview

##### Project Type & Purpose
- This is a **full-stack, front/backend-separated** application.
- The provided repo is the **backend** service, written in **Java17 + Spring Boot 3.0.9**, exposing RESTful APIs for book lending operations.
- It relies on **MySQL** for persistent storage and **Redis** for token management (JWT expiration).

##### Top-Level Architecture
- In the backend, model a **layered** (MVC) architecture:
a. **Web Layer**
b. **Service Layer**
c. **Persistence Layer**
- Two infrastructure components: **MySQL Database** and **Redis Cache**.

##### Main Components & Their Groupings
a. Web Layer ( Controllers + Interceptors + Exception Handler )
- Controllers: `AdminController`, `LoginController`, `BookController`, `BorrowController`, `ReaderController`, etc.
- Custom Annotation: `@MyController` (for any special controller logic).
- Interceptors: `JwtTokenInterceptor` (JWT auth), `LoggingInterceptor` (request logging).
- GlobalExceptionHandler: handles all uncaught exceptions and maps to HTTP responses.
- Configuration: `WebMvcConfig` (registers interceptors).

b. Service Layer
- Interfaces: `AdminService`, `BookService`, `BorrowService`, `ReaderService`.
- Implementations: `AdminServiceImpl`, `BookServiceImpl`, etc.
- Contains business logic, transaction management, calls DAOs (mappers).

c. Persistence Layer (MyBatis-Plus)
- Mappers: `AdminMapper`, `BookMapper`, `BorrowMapper`, `ReaderMapper`.
- XML mappings in `src/main/resources/mapper/*.xml` for custom SQL.
- Entities/DTOs/VOs: under `domain/entity`, `domain/dto`, `domain/vo`.

d. Infrastructure
- MySQL: persistent storage for books, readers, borrows, admins.
- Redis: token blacklist/expiry store for JWTs.
- Config classes: `MybatisConfig`, `RedisConfig`.
- Utility classes: `JwtUtils`, `MyUtils`, `ThreadLocalUtil`, `Advice`.

##### Data Flows & Interactions
1. Frontend → (HTTP/JSON) → Spring Boot controllers
2. Controller → (calls) → Service Layer
3. Service → (invokes) → MyBatis Mapper → MySQL (via JDBC)
4. Service or Interceptor → (reads/writes) → Redis for token operations
5. Exceptions bubble up → GlobalExceptionHandler converts to HTTP error response

##### Architectural Patterns & Design Principles
- **Layered Architecture (Separation of Concerns)**
- **RESTful API** style in Controllers
- **Interceptor Chain** for cross-cutting concerns (auth, logging)
- **Configuration Classes** for externalizing infra setup
- **Exception Handling** centralized
- **DTO/VO** pattern for request/response payloads

- [ ] Controllers, Interceptors, Exception Handler inside Web Layer
- [ ] Services grouped in Service Layer
- [ ] Mappers & Entities in Persistence Layer
- [ ] Config classes, Utilities as side modules

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Frontend
    Frontend["Frontend (Vue3 + Vite)"]:::external
    Frontend -->|"HTTP/JSON\n/api/*"| WebLayer

    %% Web Layer
    subgraph "Web Layer"
        direction TB
        Controllers["Controllers"]:::web
        subgraph "Controller Classes"
            direction TB
            AdminController["AdminController"]:::web
            AdminLoginController["AdminLoginController"]:::web
            BookController["BookController"]:::web
            BorrowController["BorrowController"]:::web
            CommonController["CommonController"]:::web
            LoginController["LoginController"]:::web
            ReaderController["ReaderController"]:::web
        end
        Annotation["@MyController"]:::web
        Interceptors["Interceptors"]:::web
        subgraph "Interceptor Classes"
            direction TB
            JwtTokenInterceptor["JwtTokenInterceptor"]:::web
            LoggingInterceptor["LoggingInterceptor"]:::web
        end
        ExceptionHandler["GlobalExceptionHandler"]:::web
        WebMvcConfig["WebMvcConfig"]:::config
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        Services["Service Interfaces"]:::service
        subgraph "Interfaces"
            AdminService["AdminService"]:::service
            BookService["BookService"]:::service
            BorrowService["BorrowService"]:::service
            ReaderService["ReaderService"]:::service
        end
        Implementations["Service Impl"]:::service
        subgraph "Implementations"
            AdminServiceImpl["AdminServiceImpl"]:::service
            BookServiceImpl["BookServiceImpl"]:::service
            BorrowServiceImpl["BorrowServiceImpl"]:::service
            ReaderServiceImpl["ReaderServiceImpl"]:::service
        end
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        direction TB
        Mappers["MyBatis Mappers"]:::persistence
        subgraph "Mapper Interfaces"
            AdminMapper["AdminMapper"]:::persistence
            BookMapper["BookMapper"]:::persistence
            BorrowMapper["BorrowMapper"]:::persistence
            ReaderMapper["ReaderMapper"]:::persistence
        end
        XML["XML Mappings"]:::persistence
        subgraph "Mapper XML Files"
            BorrowMapperXML["BorrowMapper.xml"]:::persistence
            ReaderMapperXML["ReaderMapper.xml"]:::persistence
        end
        Domain["Domain Models"]:::persistence
        subgraph "Entities/DTO/VO"
            Entities["Entity Classes"]:::persistence
            DTOs["DTO Classes"]:::persistence
            VOs["VO Classes"]:::persistence
        end
    end

    %% Infrastructure
    subgraph "Infrastructure"
        direction TB
        Database["MySQL Database"]:::database
        Cache["Redis Cache"]:::cache
        Configs["Config Classes"]:::config
        subgraph "Infra Config"
            MybatisConfig["MybatisConfig"]:::config
            RedisConfig["RedisConfig"]:::config
        end
        Utils["Utility Classes"]:::util
        subgraph "Utils"
            JwtUtils["JwtUtils"]:::util
            MyUtils["MyUtils"]:::util
            ThreadLocalUtil["ThreadLocalUtil"]:::util
            Advice["Advice"]:::util
        end
    end

    %% Entry Point
    Entry["BookApplication"]:::config

    %% Connections
    WebLayer -->|"calls"| ServiceLayer
    ServiceLayer -->|"invokes"| PersistenceLayer
    PersistenceLayer -->|"JDBC"| Database
    ServiceLayer <-->|"read/write"| Cache
    WebMvcConfig -.->|"configures"| JwtTokenInterceptor
    WebMvcConfig -.->|"configures"| LoggingInterceptor
    WebLayer -->|"exceptions"| ExceptionHandler
    Entry -->|starts| WebLayer
    Entry -->|starts| ServiceLayer

    %% Click Events
    click AdminController "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/controller/AdminController.java"
    click AdminLoginController "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/controller/AdminLoginController.java"
    click BookController "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/controller/BookController.java"
    click BorrowController "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/controller/BorrowController.java"
    click CommonController "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/controller/CommonController.java"
    click LoginController "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/controller/LoginController.java"
    click ReaderController "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/controller/ReaderController.java"
    click Annotation "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/annotation/MyController.java"
    click JwtTokenInterceptor "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/interceptor/JwtTokenInterceptor.java"
    click LoggingInterceptor "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/interceptor/LoggingInterceptor.java"
    click ExceptionHandler "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/handle/GlobalExceptionHandler.java"
    click WebMvcConfig "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/config/WebMvcConfig.java"
    click AdminService "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/AdminService.java"
    click BookService "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/BookService.java"
    click BorrowService "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/BorrowService.java"
    click ReaderService "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/ReaderService.java"
    click AdminServiceImpl "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/Impl/AdminServiceImpl.java"
    click BookServiceImpl "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/Impl/BookServiceImpl.java"
    click BorrowServiceImpl "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/Impl/BorrowServiceImpl.java"
    click ReaderServiceImpl "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/service/Impl/ReaderServiceImpl.java"
    click AdminMapper "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/mapper/AdminMapper.java"
    click BookMapper "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/mapper/BookMapper.java"
    click BorrowMapper "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/mapper/BorrowMapper.java"
    click ReaderMapper "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/mapper/ReaderMapper.java"
    click BorrowMapperXML "https://github.com/caolib/book_management_system/blob/master/src/main/resources/mapper/BorrowMapper.xml"
    click ReaderMapperXML "https://github.com/caolib/book_management_system/blob/master/src/main/resources/mapper/ReaderMapper.xml"
    click MybatisConfig "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/config/MybatisConfig.java"
    click RedisConfig "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/config/RedisConfig.java"
    click JwtUtils "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/util/JwtUtils.java"
    click MyUtils "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/util/MyUtils.java"
    click ThreadLocalUtil "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/util/ThreadLocalUtil.java"
    click Advice "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/util/Advice.java"
    click Entry "https://github.com/caolib/book_management_system/blob/master/src/main/java/com/clb/BookApplication.java"

    %% Styles
    classDef web fill:#e2f7e1,stroke:#2e7d32,stroke-width:1px
    classDef service fill:#e3f2fd,stroke:#1565c0,stroke-width:1px
    classDef persistence fill:#fff3e0,stroke:#ef6c00,stroke-width:1px
    classDef database fill:#eceff1,stroke:#607d8b,stroke-width:1px
    classDef cache fill:#ffebee,stroke:#c62828,stroke-width:1px
    classDef config fill:#f3e5f5,stroke:#6a1b9a,stroke-width:1px
    classDef util fill:#e0f7fa,stroke:#006064,stroke-width:1px
    classDef external fill:#f9fbe7,stroke:#827717,stroke-width:1px
```
