How jaero0725/bkc works
And List the Main Components
• Frontend / Client Side:
• Web resources residing in src/main/webapp – includes JSP pages, JavaScript, CSS, images, and other static assets.
• Distinct UI sections for delivery, guest, admin, subpages, and payment.
• Backend / Application Server:
• Spring Controllers: Organized by functions (admin, delivery, user, customer service, event, youtube, etc.). They handle incoming requests. Look into packages such as com.bkc.admin.*, com.bkc.delivery.*, com.bkc/user, etc.
• Service Layer: Business logic implementations (e.g., BannerService, OrderService, UserService). Ensure to denote the interfaces and concrete implementations.
• DAO Layer and MyBatis Mappers: Data access objects for different functional areas (admin boards, coupons, menus, orders, etc.). The mapper XML files (located in src/main/resources/mapper) indicate the queries and mappings with the database.
• Utility Components / Filters: e.g., TestFilter, DateUtils.
• Security Components: Spring Security configuration in WEB-INF/spring/appServlet/security-context.xml and custom security classes under com.bkc.user.security.
• Database:
• Relationship among tables (e.g., one-to-many relationships between orders and order details) as part of the overall system design.
• External Services and Integrations:
• Social Authentication (Kakao, Naver) integrations.
• Payment API integration (e.g., using I’mportA).
• SMS APIs from coolSMS.
• AWS S3 integration (seen in the AwsS3.java class).
• External front-end libraries (jQuery, bootstrap, chart libraries, chart.js, slick, etc.).
• Infrastructure/Build Tools:
• Maven (pom.xml) for dependency management.
• Git-Flow is used for branch management, indicating CI/CD and release management processes.
Architectural Patterns and Design Principles
• MVC Pattern: Clearly differentiate between Controllers (handling HTTP requests/responses), the Service layer (business logic), and the DAO/Repository layer (data access).
• Separation of Concerns: Indicate that each module (admin, delivery, customer service, etc.) is responsible for different business domains.
• Layered Architecture: Emphasize the clear stack from web resources to controllers, services, DAOs, and down to the database.
• Use of patterns like Dependency Injection (through Spring) and clear data mapping via MyBatis.
• Cohesive naming conventions, as many directories follow a “controller, dao, service, vo” structure.
Incorporate Technologies and Frameworks
• Use of Spring MVC (and Spring Security) handling web requests.
• Maven for build automation and dependency management.
• MyBatis for database mapping.
• JSP (within WEB-INF/views) for the view layer.
• Java utilities and filters that add cross-cutting features.
• External integrations like AWS S3, Kakao and Naver APIs, coolSMS, and third-party libraries used for charting and UI components.
Final Checklist
• Every major component is clearly labeled.
• Annotations for important patterns (MVC, layered architecture, integration points, and Git-Flow branch management).