# kiin21/booking architecture

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

- Interactive diagram: https://gitdiagram.com/kiin21/booking
- Repository: https://github.com/kiin21/booking

## Overview

##### Project type and purpose
- This is a backend-only RESTful API application (no UI) built with Spring Boot.
- Its primary purpose is to manage homestay listings, handle bookings (including availability and pricing), process payments via VNPay, and maintain user profiles.
- It follows domain-driven design (DDD) and layered architecture.

##### File structure
- Top-level build files: `build.gradle`, Gradle wrapper, Docker compose under `docker/`, SQL scripts under `sql/`.
- Source code under `src/main/java/org/example/booking`:
- `rest/` – Spring MVC controllers handling HTTP endpoints.
- `app/` – DTOs, constants, request/response utilities, and a `ResponseFactory`.
- `domain/` – Four subdomains (`booking`, `homestay`, `payment`, `user`), each with `entity`, `dto`, `repository`, `service`, plus `mapper` packages under booking.
- `infrastructure/` – Shared utilities and constants (e.g., date helpers).
- Resources: `application.yml` for configuration.
- Tests under `src/test/`.
- The presence of repositories (Spring Data JPA), entities, DTOs, mappers (MapStruct), and services shows a classic layered, DDD-style architecture.

##### README for additional insights
- Confirms PostgreSQL with PostGIS for geospatial queries.
- VNPay integration for payments.
- Bean Validation, Lombok, Hypersistence Utils for performance.
- Factory pattern for service instantiation.
- Standardized API responses with `ResponseDTO`.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% API Layer
    subgraph "API Layer"
        direction TB
        BC["BookingController"]:::api
        HC["HomestayController"]:::api
        PC["PaymentController"]:::api
        PrC["ProfileController"]:::api
    end

    %% Application Layer
    subgraph "Application Layer"
        direction TB
        DTOs["DTOs"]:::app
        RF["ResponseFactory"]:::app
        RU["RequestUtil"]:::app
        EU["EncodingUtil"]:::app
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB

        subgraph "Booking Subdomain"
            direction TB
            BS["BookingService"]:::domain
            AS["AvailabilityService"]:::domain
            PS["PricingService"]:::domain
            DS["DiscountService"]:::domain
            BF["BookingFactory"]:::domain
            BR["BookingRepository"]:::domain
            HAR["HomestayAvailabilityRepository"]:::domain
            BE["Booking Entities"]:::domain
            BM["BookingMapper"]:::domain
            BReq["BookingRequest/Response DTOs"]:::domain
            BP["BookingPrice DTO"]:::domain
        end

        subgraph "Homestay Subdomain"
            direction TB
            HS["HomestayService"]:::domain
            HR["HomestayRepository"]:::domain
            HE["Homestay Entities"]:::domain
            HD["HomestayDTOs"]:::domain
            HSR["HomestaySearchRequest DTO"]:::domain
        end

        subgraph "Payment Subdomain"
            direction TB
            PayInt["PaymentService"]:::domain
            VPS["VNPayService"]:::domain
            CH["IpnHandler"]:::domain
            VIP["VNPayIpnHandler"]:::domain
            CS["CryptoService"]:::domain
            IPReq["InitPaymentRequest/Response DTOs"]:::domain
            CONST["VNPay Constants"]:::domain
        end

        subgraph "User Subdomain"
            direction TB
            PrS["ProfileService"]:::domain
            PrR["ProfileRepository"]:::domain
            UE["User/Profile Entities"]:::domain
        end
    end

    %% Infrastructure Layer
    subgraph "Infrastructure Layer"
        direction TB
        DU["DateUtil"]:::infra
        DC["DateConst"]:::infra
    end

    %% Persistence
    subgraph "Persistence"
        direction TB
        PG[(PostgreSQL + PostGIS)]:::db
        SQL["SQL Scripts"]:::db
    end

    %% External Services
    subgraph "External"
        direction TB
        VNPAY[(VNPay Gateway)]:::external
    end

    %% Connections
    BC -->|uses| DTOs
    HC -->|uses| DTOs
    PC -->|uses| DTOs
    PrC -->|uses| DTOs

    BC -->|calls| RF
    HC -->|calls| RF
    PC -->|calls| RF
    PrC -->|calls| RF

    RF -->|invokes| BS
    RF -->|invokes| HS
    RF -->|invokes| VPS
    RF -->|invokes| PrS

    BS -->|uses| AS
    BS -->|uses| PS
    BS -->|uses| DS
    BS -->|resolved by| BF

    BS -->|calls| BR
    AS -->|calls| HAR
    HS -->|calls| HR
    PrS -->|calls| PrR

    BR -->|CRUD| PG
    HAR -->|CRUD| PG
    HR -->|CRUD| PG
    PrR -->|CRUD| PG

    VPS -->|HTTP init| VNPAY
    VNPAY -->|IPN callback| VIP
    VIP -->|calls| CS
    VIP -->|calls| PR
    VIP -->|calls| PR
    VIP -->|calls| BR

    %% Utilities connections
    DU ---|util| BS
    DU ---|util| HS
    DC ---|const| PS

    %% SQL scripts
    SQL -->|setup| PG

    %% Click Events
    click BC "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/rest/BookingController.java"
    click HC "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/rest/HomestayController.java"
    click PC "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/rest/PaymentController.java"
    click PrC "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/rest/ProfileController.java"
    click DTOs "https://github.com/kiin21/booking/tree/master/src/main/java/org/example/booking/app/dto"
    click RF "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/app/service/ResponseFactory.java"
    click RU "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/app/util/RequestUtil.java"
    click EU "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/app/util/EncodingUtil.java"
    click BS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/service/BookingService.java"
    click AS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/service/AvailabilityService.java"
    click PS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/service/PricingService.java"
    click BF "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/service/BookingFactory.java"
    click DS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/service/DiscountService.java"
    click BR "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/repository/BookingRepository.java"
    click HAR "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/repository/HomestayAvailabilityRepository.java"
    click BE "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/entity/Booking.java"
    click BM "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/mapper/BookingMapper.java"
    click BReq "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/dto/request/BookingRequest.java"
    click BP "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/booking/dto/BookingPrice.java"
    click HS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/homestay/service/HomestayService.java"
    click HR "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/homestay/repository/HomestayRepository.java"
    click HE "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/homestay/entity/Homestay.java"
    click HD "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/homestay/dto/HomestayDTO.java"
    click HSR "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/homestay/dto/request/HomestaySearchRequest.java"
    click PayInt "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/payment/service/PaymentService.java"
    click VPS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/payment/service/impl/VNPayService.java"
    click CH "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/payment/service/IpnHandler.java"
    click VIP "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/payment/service/impl/VNPayIpnHandler.java"
    click CS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/payment/service/CryptoService.java"
    click IPReq "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/payment/dto/request/InitPaymentRequest.java"
    click CONST "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/payment/constant/VNPayParams.java"
    click PrS "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/user/service/ProfileService.java"
    click PrR "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/user/repository/ProfileRepository.java"
    click UE "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/domain/user/entity/User.java"
    click DU "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/infrastructure/util/DateUtil.java"
    click DC "https://github.com/kiin21/booking/blob/master/src/main/java/org/example/booking/infrastructure/constant/DateConst.java"
    click SQL "https://github.com/kiin21/booking/blob/master/sql/schema.sql"

    %% Styles
    classDef api fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef app fill:#FFD580,stroke:#333,stroke-width:1px
    classDef domain fill:#90EE90,stroke:#333,stroke-width:1px
    classDef infra fill:#FFFF99,stroke:#333,stroke-width:1px
    classDef db fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef external fill:#DDA0DD,stroke:#333,stroke-width:1px
```
