Merge pull request #95 from makevook/issue/94

refactor: spring modulith 도입 및 패키지 리팩토링

api/build.gradle

@@ -4,6 +4,10 @@ plugins {
     id 'io.spring.dependency-management' version '1.1.5'
 }
 
+ext {
+    springModulithVersion = "1.2.1"
+}
+
 group = 'vook.server'
 version = '0.0.1-SNAPSHOT'
 
@@ -33,6 +37,11 @@ dependencies {
         exclude group: 'com.vaadin.external.google', module: 'android-json'
     }
 
+    // spring modulith
+    implementation 'org.springframework.modulith:spring-modulith-starter-core'
+    implementation 'org.springframework.modulith:spring-modulith-starter-jpa'
+    testImplementation 'org.springframework.modulith:spring-modulith-starter-test'
+
     // lombok
     compileOnly 'org.projectlombok:lombok'
     annotationProcessor 'org.projectlombok:lombok'
@@ -50,8 +59,8 @@ dependencies {
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-api:2.5.0'
 
     // QueryDsl
-    implementation "com.querydsl:querydsl-jpa:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
-    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
+    implementation "com.querydsl:querydsl-jpa:5.0.0:jakarta"
+    annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
     annotationProcessor "jakarta.persistence:jakarta.persistence-api"
     annotationProcessor "jakarta.annotation:jakarta.annotation-api"
 
@@ -66,6 +75,12 @@ bootJar {
     archiveFileName = "${project.name}.jar"
 }
 
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.modulith:spring-modulith-bom:$springModulithVersion"
+    }
+}
+
 tasks.named('test') {
     useJUnitPlatform()
 }

api/src/main/java/vook/server/api/ApiApplication.java

@@ -2,7 +2,9 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.modulith.Modulithic;
 
+@Modulithic(systemName = "Vook API")
 @SpringBootApplication
 public class ApiApplication {
 

api/src/main/java/vook/server/api/config/SecurityConfig.java

@@ -15,10 +15,10 @@
 import org.springframework.security.oauth2.client.web.OAuth2AuthorizationRequestResolver;
 import org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter;
 import org.springframework.security.web.SecurityFilterChain;
-import vook.server.api.web.auth.app.TokenService;
-import vook.server.api.web.auth.jwt.JWTFilter;
-import vook.server.api.web.auth.oauth2.LoginSuccessHandler;
-import vook.server.api.web.auth.oauth2.VookOAuth2UserService;
+import vook.server.api.web.common.auth.app.TokenService;
+import vook.server.api.web.common.auth.jwt.JWTFilter;
+import vook.server.api.web.common.auth.oauth2.LoginSuccessHandler;
+import vook.server.api.web.common.auth.oauth2.VookOAuth2UserService;
 
 @Configuration
 @EnableWebSecurity

api/src/main/java/vook/server/api/config/SwaggerConfig.java

@@ -4,8 +4,8 @@
 import org.springdoc.core.customizers.GlobalOperationCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import vook.server.api.web.swagger.GlobalOpenApiCustomizerImpl;
-import vook.server.api.web.swagger.GlobalOperationCustomizerImpl;
+import vook.server.api.web.common.swagger.GlobalOpenApiCustomizerImpl;
+import vook.server.api.web.common.swagger.GlobalOperationCustomizerImpl;
 
 @Configuration
 public class SwaggerConfig {

api/src/main/java/vook/server/api/config/package-info.java

@@ -0,0 +1,6 @@
+@ApplicationModule(
+        type = ApplicationModule.Type.OPEN
+)
+package vook.server.api.config;
+
+import org.springframework.modulith.ApplicationModule;

api/src/main/java/vook/server/api/devhelper/app/InitService.java

@@ -3,14 +3,14 @@
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
-import vook.server.api.app.contexts.demo.domain.DemoTerm;
-import vook.server.api.app.contexts.demo.domain.DemoTermRepository;
-import vook.server.api.app.contexts.demo.domain.DemoTermSynonymRepository;
-import vook.server.api.app.contexts.user.domain.SocialUserRepository;
-import vook.server.api.app.contexts.user.domain.UserInfoRepository;
-import vook.server.api.app.contexts.user.domain.UserRepository;
-import vook.server.api.app.contexts.vocabulary.domain.VocabularyRepository;
-import vook.server.api.app.infra.search.demo.MeilisearchDemoTermSearchService;
+import vook.server.api.domain.demo.model.DemoTerm;
+import vook.server.api.domain.demo.model.DemoTermRepository;
+import vook.server.api.domain.demo.model.DemoTermSynonymRepository;
+import vook.server.api.domain.user.model.SocialUserRepository;
+import vook.server.api.domain.user.model.UserInfoRepository;
+import vook.server.api.domain.user.model.UserRepository;
+import vook.server.api.domain.vocabulary.model.VocabularyRepository;
+import vook.server.api.infra.search.demo.MeilisearchDemoTermSearchService;
 
 import java.util.List;
 

api/src/main/java/vook/server/api/devhelper/app/TestTermsLoader.java

@@ -3,8 +3,8 @@
 import lombok.RequiredArgsConstructor;
 import org.springframework.core.io.ResourceLoader;
 import org.springframework.stereotype.Component;
-import vook.server.api.app.contexts.demo.domain.DemoTerm;
 import vook.server.api.devhelper.helper.CsvReader;
+import vook.server.api.domain.demo.model.DemoTerm;
 
 import java.io.IOException;
 import java.io.InputStream;

api/src/main/java/vook/server/api/devhelper/init/LocalInit.java

@@ -5,8 +5,8 @@
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
-import vook.server.api.app.contexts.demo.domain.DemoTermRepository;
 import vook.server.api.devhelper.app.InitService;
+import vook.server.api.domain.demo.model.DemoTermRepository;
 
 @Slf4j
 @Profile("local")

api/src/main/java/vook/server/api/devhelper/web/routes/init/InitApi.java

@@ -2,7 +2,7 @@
 
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
-import vook.server.api.web.common.CommonApiResponse;
+import vook.server.api.web.common.response.CommonApiResponse;
 
 @Tag(name = "init", description = "초기화 API")
 public interface InitApi {

api/src/main/java/vook/server/api/devhelper/web/routes/init/InitController.java

@@ -6,7 +6,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 import vook.server.api.devhelper.app.InitService;
-import vook.server.api.web.common.CommonApiResponse;
+import vook.server.api.web.common.response.CommonApiResponse;
 
 @Profile({"local", "dev", "stag"})
 @RestController

api/src/main/java/vook/server/api/domain/common/exception/DomainException.java

@@ -0,0 +1,6 @@
+package vook.server.api.domain.common.exception;
+
+import vook.server.api.globalcommon.exception.AppException;
+
+public class DomainException extends AppException {
+}

api/src/main/java/vook/server/api/app/common/exception/ExceptionAdvisor.java → api/src/main/java/vook/server/api/domain/common/exception/ExceptionAdvisor.java

@@ -1,16 +1,17 @@
-package vook.server.api.app.common.exception;
+package vook.server.api.domain.common.exception;
 
 import jakarta.validation.ConstraintViolationException;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.springframework.stereotype.Component;
+import vook.server.api.globalcommon.exception.ParameterValidateException;
 
 @Aspect
 @Component
 public class ExceptionAdvisor {
-    // vook.server.api.app 패키지 이하의 모든 메서드에 대해 실행
-    @Around("execution(* vook.server.api.app..*.*(..))")
+    // vook.server.api.domain 패키지 이하의 모든 메서드에 대해 실행
+    @Around("execution(* vook.server.api.domain..*.*(..))")
     public Object convertException(ProceedingJoinPoint joinPoint) throws Throwable {
         try {
             return joinPoint.proceed();

api/src/main/java/vook/server/api/app/common/entity/BaseEntity.java → api/src/main/java/vook/server/api/domain/common/model/BaseEntity.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.common.entity;
+package vook.server.api.domain.common.model;
 
 import jakarta.persistence.Column;
 import jakarta.persistence.EntityListeners;

api/src/main/java/vook/server/api/domain/common/package-info.java

@@ -0,0 +1,7 @@
+@ApplicationModule(
+        type = ApplicationModule.Type.OPEN,
+        displayName = "Domain Common"
+)
+package vook.server.api.domain.common;
+
+import org.springframework.modulith.ApplicationModule;

api/src/main/java/vook/server/api/app/contexts/demo/domain/DemoTerm.java → api/src/main/java/vook/server/api/domain/demo/model/DemoTerm.java

@@ -1,8 +1,8 @@
-package vook.server.api.app.contexts.demo.domain;
+package vook.server.api.domain.demo.model;
 
 import jakarta.persistence.*;
 import lombok.Getter;
-import vook.server.api.app.common.entity.BaseEntity;
+import vook.server.api.domain.common.model.BaseEntity;
 
 import java.util.ArrayList;
 import java.util.List;

api/src/main/java/vook/server/api/app/contexts/demo/domain/DemoTermRepository.java → api/src/main/java/vook/server/api/domain/demo/model/DemoTermRepository.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.demo.domain;
+package vook.server.api.domain.demo.model;
 
 import org.springframework.data.jpa.repository.JpaRepository;
 

api/src/main/java/vook/server/api/app/contexts/demo/domain/DemoTermSynonym.java → api/src/main/java/vook/server/api/domain/demo/model/DemoTermSynonym.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.demo.domain;
+package vook.server.api.domain.demo.model;
 
 import jakarta.persistence.*;
 import lombok.Getter;

api/src/main/java/vook/server/api/app/contexts/demo/domain/DemoTermSynonymRepository.java → api/src/main/java/vook/server/api/domain/demo/model/DemoTermSynonymRepository.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.demo.domain;
+package vook.server.api.domain.demo.model;
 
 import org.springframework.data.jpa.repository.JpaRepository;
 

api/src/main/java/vook/server/api/domain/demo/package-info.java

@@ -0,0 +1,9 @@
+@ApplicationModule(
+        type = ApplicationModule.Type.OPEN,
+        allowedDependencies = {
+                "common"
+        }
+)
+package vook.server.api.domain.demo;
+
+import org.springframework.modulith.ApplicationModule;

api/src/main/java/vook/server/api/app/contexts/demo/application/DemoService.java → api/src/main/java/vook/server/api/domain/demo/service/DemoService.java

@@ -1,9 +1,9 @@
-package vook.server.api.app.contexts.demo.application;
+package vook.server.api.domain.demo.service;
 
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
-import vook.server.api.app.contexts.demo.application.data.DemoTermSearchParams;
-import vook.server.api.app.contexts.demo.application.data.DemoTermSearchResult;
+import vook.server.api.domain.demo.service.data.DemoTermSearchParams;
+import vook.server.api.domain.demo.service.data.DemoTermSearchResult;
 
 @Service
 @RequiredArgsConstructor

api/src/main/java/vook/server/api/domain/demo/service/DemoTermSearchService.java

@@ -0,0 +1,8 @@
+package vook.server.api.domain.demo.service;
+
+import vook.server.api.domain.demo.service.data.DemoTermSearchParams;
+import vook.server.api.domain.demo.service.data.DemoTermSearchResult;
+
+public interface DemoTermSearchService {
+    DemoTermSearchResult search(DemoTermSearchParams params);
+}

api/src/main/java/vook/server/api/app/contexts/demo/application/data/DemoTermSearchParams.java → api/src/main/java/vook/server/api/domain/demo/service/data/DemoTermSearchParams.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.demo.application.data;
+package vook.server.api.domain.demo.service.data;
 
 import com.meilisearch.sdk.SearchRequest;
 import lombok.Builder;

api/src/main/java/vook/server/api/app/contexts/demo/application/data/DemoTermSearchResult.java → api/src/main/java/vook/server/api/domain/demo/service/data/DemoTermSearchResult.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.demo.application.data;
+package vook.server.api.domain.demo.service.data;
 
 import com.meilisearch.sdk.model.Searchable;
 import lombok.Getter;

api/src/main/java/vook/server/api/domain/term/exception/TermLimitExceededException.java

@@ -0,0 +1,6 @@
+package vook.server.api.domain.term.exception;
+
+import vook.server.api.domain.common.exception.DomainException;
+
+public class TermLimitExceededException extends DomainException {
+}

api/src/main/java/vook/server/api/app/contexts/term/domain/Term.java → api/src/main/java/vook/server/api/domain/term/model/Term.java

@@ -1,8 +1,8 @@
-package vook.server.api.app.contexts.term.domain;
+package vook.server.api.domain.term.model;
 
 import jakarta.persistence.*;
 import lombok.Getter;
-import vook.server.api.app.common.entity.BaseEntity;
+import vook.server.api.domain.common.model.BaseEntity;
 
 import java.util.ArrayList;
 import java.util.List;

api/src/main/java/vook/server/api/app/contexts/term/domain/TermRepository.java → api/src/main/java/vook/server/api/domain/term/model/TermRepository.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.term.domain;
+package vook.server.api.domain.term.model;
 
 import org.springframework.data.jpa.repository.JpaRepository;
 

api/src/main/java/vook/server/api/app/contexts/term/domain/TermSynonym.java → api/src/main/java/vook/server/api/domain/term/model/TermSynonym.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.term.domain;
+package vook.server.api.domain.term.model;
 
 import jakarta.persistence.*;
 import lombok.Getter;

api/src/main/java/vook/server/api/app/contexts/term/domain/VocabularyId.java → api/src/main/java/vook/server/api/domain/term/model/VocabularyId.java

@@ -1,4 +1,4 @@
-package vook.server.api.app.contexts.term.domain;
+package vook.server.api.domain.term.model;
 
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;