# shootpointer/shootpointer_be architecture

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

- Interactive diagram: https://gitdiagram.com/shootpointer/shootpointer_be
- Repository: https://github.com/shootpointer/shootpointer_be

## Overview

##### Project Type & Purpose
- Monolithic Spring Boot REST API backend
- Domains: Community, Highlight, Member (with Kakao OAuth)
- Cross-cutting concerns: security (JWT), logging (AOP), error handling, API docs (Swagger)
- Persistence via JPA repositories and an external relational database (spun up via Docker Compose)

##### Main Components
A. Clients / External Consumers
– Web/Mobile frontend
– Third-party OAuth (Kakao)
B. API Gateway & Security Layer
– `JwtAuthenticationFilter` (Spring Security filter)
– `SecurityConfig`
C. Presentation Layer (Controllers)
– `/community`, `/highlight`, `/member` controllers
– `KakaoController` for OAuth login
D. Service Layer
– Domain services (e.g., `CommunityService`, `HighlightService`, `MemberService`, `KakaoService`, `RefreshTokenService`)
– Business logic, DTO mapping
E. Repository Layer
– Spring Data JPA repositories under each domain
– CRUD operations on entities
F. Domain Model
– Entities for Community, Highlight, Member, MsgEntity, BaseEntity, BaseTimeEntity
G. Global Infrastructure
– Exception handling: `GlobalExceptionHandler`, `CustomException`
– AOP logging: `CustomLogAspect`, `CustomLog` annotation
– Utility classes: `JwtUtil`, `EncryptConverter`
– Configuration: `SwaggerConfig`, application settings
H. Database & External Services
– Relational database (MySQL/Postgres) defined in `docker-compose.yml`
– Redis or other caches if present (not shown in file tree)
– Kakao OAuth API

##### Component Relationships & Data Flow
1. Client → HTTP Request → Security Filter (JWT authentication)
2. If authenticated, → Controller
3. Controller → calls Service → applies business rules
4. Service → Repository → SQL → Database
5. Repository → returns Entities → Service → maps to DTO → Controller → Response
6. Errors bubble → GlobalExceptionHandler → standard `ApiResponse` with error codes
7. Swagger UI exposes endpoints via `SwaggerConfig`
8. AOP Logging wraps controllers/services annotated with `@CustomLog`

##### Architectural Patterns & Design Principles
- Layered (Presentation, Service, Repository)
- Domain-Driven package structure (each domain in its own package with controller/dto/entity/repository/service subpackages)
- Cross-cutting via AOP and centralized exception handling
- Security as a separate concern implemented via filters and config
- Configuration-driven (YAML, Docker Compose)
- Testing structure mirrors production code by domain and function

##### Detailed Steps
6. On top or side, illustrate cross-cutting modules: AOP Logging, Exception Handler, Swagger.

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Web/Mobile Client"]:::external
    Client --> JwtAuthFilter

    subgraph "Security Layer"
        JwtAuthFilter["JwtAuthenticationFilter\n(Spring Security Filter)"]:::crosscut
        SecurityConfig["SecurityConfig"]:::crosscut
    end
    JwtAuthFilter -->|"auth flow"| CommunityController
    JwtAuthFilter -->|"auth flow"| HighlightController
    JwtAuthFilter -->|"auth flow"| MemberController

    subgraph "Community Domain"
        CommunityController["CommunityController"]:::controller
        CommunityService["CommunityService"]:::service
        CommunityRepository["CommunityRepository"]:::repository
        CommunityController -->|"calls"| CommunityService
        CommunityService -->|"uses"| CommunityRepository
    end

    subgraph "Highlight Domain"
        HighlightController["HighlightController"]:::controller
        HighlightService["HighlightService"]:::service
        HighlightRepository["HighlightRepository"]:::repository
        HighlightController -->|"calls"| HighlightService
        HighlightService -->|"uses"| HighlightRepository
    end

    subgraph "Member Domain"
        MemberController["MemberController"]:::controller
        KakaoController["KakaoController"]:::controller
        MemberService["MemberService"]:::service
        KakaoService["KakaoService"]:::service
        RefreshTokenService["RefreshTokenService"]:::service
        MemberRepository["MemberRepository"]:::repository
        MemberController -->|"calls"| MemberService
        KakaoController -->|"calls"| KakaoService
        KakaoService -->|"calls API & updates"| MemberRepository
        RefreshTokenService -->|"uses"| MemberRepository
    end

    MemberController -->|"refresh token"| RefreshTokenService

    subgraph "External Services"
        KakaoAPI["Kakao OAuth API"]:::external
    end
    KakaoService -->|"OAuth call"| KakaoAPI

    subgraph "Database & Persistence"
        DB["Relational Database\n(MySQL/Postgres)"]:::database
    end
    CommunityRepository -->|"SQL"| DB
    HighlightRepository -->|"SQL"| DB
    MemberRepository -->|"SQL"| DB

    subgraph "Global Infrastructure"
        SwaggerConfig["SwaggerConfig"]:::crosscut
        GlobalExceptionHandler["GlobalExceptionHandler"]:::crosscut
        CustomLogAspect["CustomLogAspect"]:::crosscut
        CustomException["CustomException"]:::crosscut
        JwtUtil["JwtUtil"]:::crosscut
        EncryptConverter["EncryptConverter"]:::crosscut
        ApiResponse["ApiResponse DTO"]:::crosscut
    end

    CommunityController -->|"errors"| GlobalExceptionHandler
    HighlightController -->|"errors"| GlobalExceptionHandler
    MemberController -->|"errors"| GlobalExceptionHandler
    CustomLogAspect -->|"AOP wrap"| CommunityController
    CustomLogAspect -->|"AOP wrap"| HighlightController
    CustomLogAspect -->|"AOP wrap"| MemberController

    click JwtAuthFilter "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/util/jwt/JwtAuthenticationFilter.java"
    click SecurityConfig "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/config/SecurityConfig.java"
    click SwaggerConfig "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/config/SwaggerConfig.java"
    click CommunityController "https://github.com/shootpointer/shootpointer_be/tree/dev/src/main/java/com/midas/shootpointer/domain/community/controller"
    click HighlightController "https://github.com/shootpointer/shootpointer_be/tree/dev/src/main/java/com/midas/shootpointer/domain/highlight/controller"
    click MemberController "https://github.com/shootpointer/shootpointer_be/tree/dev/src/main/java/com/midas/shootpointer/domain/member/controller"
    click KakaoController "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/domain/member/controller/KakaoController.java"
    click CommunityService "https://github.com/shootpointer/shootpointer_be/tree/dev/src/main/java/com/midas/shootpointer/domain/community/service"
    click HighlightService "https://github.com/shootpointer/shootpointer_be/tree/dev/src/main/java/com/midas/shootpointer/domain/highlight/service"
    click MemberService "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/domain/member/service/MemberService.java"
    click KakaoService "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/domain/member/service/KakaoService.java"
    click RefreshTokenService "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/domain/member/service/RefreshTokenService.java"
    click CommunityRepository "https://github.com/shootpointer/shootpointer_be/tree/dev/src/main/java/com/midas/shootpointer/domain/community/repository"
    click HighlightRepository "https://github.com/shootpointer/shootpointer_be/tree/dev/src/main/java/com/midas/shootpointer/domain/highlight/repository"
    click MemberRepository "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/domain/member/repository/MemberRepository.java"
    click GlobalExceptionHandler "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/exception/GlobalExceptionHandler.java"
    click CustomException "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/exception/CustomException.java"
    click CustomLogAspect "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/aop/CustomLogAspect.java"
    click JwtUtil "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/util/jwt/JwtUtil.java"
    click EncryptConverter "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/util/encrypt/EncryptConverter.java"
    click ApiResponse "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/java/com/midas/shootpointer/global/dto/ApiResponse.java"
    click DB "https://github.com/shootpointer/shootpointer_be/blob/dev/src/main/resources/docker-compose.yml"

    classDef controller fill:#C3D9FF,stroke:#0366D6,color:#0366D6
    classDef service fill:#D1E7DD,stroke:#28A745,color:#28A745
    classDef repository fill:#F8D7DA,stroke:#DC3545,color:#DC3545
    classDef database fill:#FFF3CD,stroke:#FFC107,color:#856404
    classDef external fill:#E2E3E5,stroke:#6C757D,color:#495057
    classDef crosscut fill:#E0BBE4,stroke:#957DAD,color:#5D3A9B
```
