Backend Convention

1. Overall Code Convention

• IntelliJ Java Google Style을 준수합니다.
  • Preferences - Editor - Code Style - Java - Scheme Import - Google Style IDE
  • Tab and Indents에서 Indent 및 Tab Size를 4로 변경합니다.
• New Line 자동 추가 및 Import 최적화 설정을 참고해주세요.
  • POSIX 표준 준수를 위해 코드 파일 끝에 New Line을 추가합니다.
  • 사용하지 않는 Import 구문은 삭제합니다.

2. Test Code Convention

• 7 Popular Unit Test Naming Conventions을 준수합니다.
  • MethodName_StateUnderTest_ExpectedBehavior 방식을 사용합니다.
• Test Method의 @DisplayName은 동사형으로 작성하되, 너무 길어지지 않도록 주의합니다.
• 신규 기능을 구현하는 경우 아래 항목에서 해당되는 테스트들을 모두 작성해야 합니다.
  • Unit Test
    • @DataJpaTest 및 외부 API Mock Test 포함
  • Slice Test (Service)
  • Slice Test (Controller)
  • Integration Test (Service - Repository)
  • Acceptance Test

3. Web Layered Architecture

• Presentation - Application - Domain - Infrastructure의 웹 계층을 준수합니다.

4. Tech Stack

4.1. Language

• Java 11

4.2. Framework

• Spring Boot
• Spring Data JPA

4.3. Documentation

• Spring REST Docs
• SonarQube

4.4. Logging

• Logback
• AWS CloudWatch

4.5. Test

• JUnit (feat. AssertJ)

4.6. Database

• MariaDB (Prod, Dev, Local)
• H2 (Test)

4.7. Build

• Jenkins

4.8. Deployment

• AWS EC2
• AWS S3
• AWS CloudFront
• Nginx (Reverse Proxy)
• TLS
• Docker

4.9. ETC

• OAuth2 & JWT
• Sub-Module

4.10. 추후 도입 예정

• QueryDSL
• Multi-Module
• Web Socket