TmaxCloud SuperPX 형상관리 Spring Project

개요

• TmaxCloud SuperPX 형상관리 스프링 백엔드 프로젝트
• Single Datasource 사용

Versions

• Java8
• SpringBoot 2.6.3
  • JPA
  • WEB
  • Security
  • WebFlux
  • TEST
• Gradle 7.4
• QueryDSL 1.0.10
• Lombok 1.18.22
• SpringDoc OpenAPI 1.6.6
  • Swagger 3
• ModelMapper 2.3.8
• JWT 3.18.1
  • JJWT 0.9.1
• SLF4J 1.7.35
• LogBack 1.2.10

Directory Architecture

패키지 구조
src.main.java.package
  ├── data                                                // 데이터 관련 코드
  │   │
  │   └── primary                                         // 첫번째 데이터 소스에 종속되는 코드
  │       ├── model                           
  │       │   ├── entity                                  // 테이블 엔티티
  │       │   └── enums                                   // 테이블 관련된 enum
  │       ├── repository                                  // 테이블 엔티티 종속 기본 repository 코드 작성
  │       └── PrimaryQuerydslRepositorySupport.java       // 첫번째 데이터 소스를 위한 QuerydslRepositorySupport
  │    
  ├── domain                                              // api 도메인
  │   │
  │   ├── commit                                          // 도메인 단위로 폴더 구분
  │   │   ├── controller                                  // 컨트롤러 코드 작성
  │   │   ├── dto                                         // DTO
  │   │   └── service                                     // 서비스 코드 작성
  │   │
  │   ├── project                                         // 상동.
  │   │   ├── controller
  │   │   ├── dto
  │   │   └── service
  │   │ 
  │   └── reference                                       // 상동.
  │       ├── controller
  │       ├── dto
  │       └── service
  │
  └── global                                              // 프로젝트 전체에 해당하는 코드를 포함
      │
      ├── config                                          // 설정
      │   ├── ApplicationCommonConfig.java                // 프로젝트 공통 설정(ex. modelMapper)
      │   ├── DataSourcePrimaryConfig.java                // 첫번째 데이터 소스에 대한 설정      
      │   ├── QueryDslConfig.java                         // queryDSL 설정     
      │   ├── SecurityConfig.java                         // 보안 관련 설정(비밀번호 암호화, 웹 기본 보안 등)
      │   ├── ServletContextConfig.java                   // WebMVC Context 관련 설정 
      │   ├── SwaggerConfig.java                          // Swagger 관련 설정
      │   └── WebClientConfig.java                        // WebClient 설정
      │
      ├── error                                           // 오류 처리
      │   ├── exception                                   
      │   │   ├── BusinessException.java                  // custom exception class
      │   │   └── ErrorCode.java                          // 프로젝트에서 정의하는 오류 코드 리스트
      │   └── GlobalExceptionHandler.java                 // 오류 발생 시 핸들링을 위한 클래스
      │
      ├── interceptor                                     
      │   └── ApiInterceptor.java                         // 기본 interceptor, 
      │                                                   // pre에 jwt 핸들링, after에 api request/response에 대한 처리를 포함함
      ├── response                                     
      │   ├── DataResponse.java                           // 정상 처리 시 데이터를 포함한 Default Response 형태에 대한 정의
      │   └── ErrorResponse.java                          // 오류 발생 시 응답 형태에 대한 정의 
      │
      └── utils
          ├── CustomServletWrappingFilter.java            // API Request, Response를 처리하기 위한 모듈
          ├── InitialApplicationRunner.java               // Application Runner
          ├── JwtTokenProvider.java                       // JWT 관련 모듈
          └── QueryDslUtil.java                           // QueryDSL 관련 모듈

...

그 외 프로젝트 구조
          
├ libs
│ └── tibero6-jdbc.jar                                    // 티베로 드라이버
├ logs                                                    // 로그 저장 경로, info.log / error.log 로 구분하려 rolling save
│
├ src.main.resources
│ ├── ...
│ ├── application.yml                                     // 프로젝트 설정
│ └── logback-spring.xml                                  // Logback 설정
│
├ ...
├ build.gradle
└ ...