How pp8817/chukchuk-haksa_server works
The 척척학사 Backend project is clearly designed as a Spring Boot-based back-end service that supports a student academic management system. Its purpose is to let students check, compare, and manage their academic records (such as credits, course records, graduation requirements) by connecting with the school portal and synchronizing academic data in real time. The ELK configuration files hint at built-in logging and monitoring support (using Elasticsearch, Logstash, and Kibana), which further refines the backend’s operational observability.
Main Components
• Application Server: Represent the Spring Boot application (entry point is ChukchukHaksaApplication.java) which handles all business logic.
• API Layer (Controllers): Several controllers reside in the “domain” packages such as AcademicRecordController, GraduationController, StudentController, UserController, etc. These controllers manage incoming REST API requests.
• Service Layer (Application & Domain Services): Each domain has its associated service classes (e.g., DashboardService, AcademicRecordService, GraduationService, StudentService, etc.) that encapsulate business logic.
• Persistence Layer (Repositories): The repository interfaces (e.g., StudentRepository, SemesterAcademicRecordRepository, etc.) implement data access for the various domain models.
• Domain Models: There is a rich set of domain objects (entities like Student, Course, Department, GraduationRequirement, etc.) that are the core of the business logic.
• Security Components: Contains security configuration (SecurityConfig, JwtAuthenticationFilter, CustomUserDetails, etc.) to manage authentication and authorization.
• Global Configurations & Exception Handling: Classes for configuration (OpenApiConfig, logging via logback.xml) and global exception handling.
• External Integrations & Infrastructure:
• The project integrates with external systems such as the school’s academic portal for real-time synchronization of academic data.
• ELK Stack Components (via elk-config folder): These are deployed using Docker (docker-compose.yml, multiple Dockerfiles for Elasticsearch, Kibana, and Logstash) to handle logging and monitoring.
• Swagger API docs via the swagger.json and swagger.yaml files provide interactive API documentation.
Relationships and Interactions
• The REST controllers receive requests from clients (e.g., front-end applications or external systems) and invoke methods in the Service layer.
• Service layers then orchestrate domain logic and call repository interfaces to persist or retrieve data from a relational database (database details, while not directly visible, are assumed to be managed in configuration files external to the provided tree).
• Security filters and configurations sit at the API entry points to secure and authorize incoming requests before they reach the business logic.
• Global configurations (including OpenAPI settings) help expose the API documentation for client developers.
• Simultaneously, the ELK stack containers process and display log data generated by the application to monitor operations and diagnose issues.
Architectural Patterns and Design Principles
• Layered Architecture: The project is structured into clear layers – controllers (presentation/API), services (business logic), repositories (persistence), and domain models – following the standard Spring Boot application design.
• Domain-Driven Design (DDD): The domain packages (academic, course, student, graduation, professor, user, etc.) indicate that business concerns are modularized based on domain concepts.
• Security & Exception Handling: Dedicated components for global exception handling and security ensure that cross-cutting concerns are isolated.
• Containerization for Monitoring and Logging: The ELK configuration uses Docker to containerize the logging components.
Detailing Essential Architectural Elements
• The underlying Gradle-based build and configuration management (you may note that the project is built with Gradle).
• The division between business functionalities (academic records, graduation, student, etc.) and cross-cutting concerns (security, logging, API documentation).
• The role of Dockerized services in the ELK stack to provide logging and monitoring support.