Merge pull request #249 from HoeSeong123/feat/template_refactor_chorong

제약 조건 추가 및 리팩토링
woowacourse-teams · Aug 2, 2024 · d851e92 · d851e92
2 parents e0a45e3 + c6b77e7
commit d851e92
Show file tree

Hide file tree

Showing 24 changed files with 327 additions and 71 deletions.
diff --git a/backend/src/main/java/codezap/category/controller/CategoryController.java b/backend/src/main/java/codezap/category/controller/CategoryController.java
@@ -21,7 +21,7 @@
 
 @RestController
 @RequestMapping("/categories")
-public class CategoryController implements SpringDocCategoryController{
+public class CategoryController implements SpringDocCategoryController {
 
     private final CategoryService categoryService;
 
@@ -41,8 +41,10 @@ public ResponseEntity<FindAllCategoriesResponse> getCategories() {
     }
 
     @PutMapping("/{id}")
-    public ResponseEntity<Void> updateCategory(@PathVariable Long id,
-            @Valid @RequestBody UpdateCategoryRequest updateCategoryRequest) {
+    public ResponseEntity<Void> updateCategory(
+            @PathVariable Long id,
+            @Valid @RequestBody UpdateCategoryRequest updateCategoryRequest
+    ) {
         categoryService.update(id, updateCategoryRequest);
         return ResponseEntity.ok().build();
     }

diff --git a/backend/src/main/java/codezap/category/dto/request/CreateCategoryRequest.java b/backend/src/main/java/codezap/category/dto/request/CreateCategoryRequest.java
@@ -3,12 +3,14 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
 
+import codezap.global.validation.ValidationGroups.NotNullGroup;
+import codezap.global.validation.ValidationGroups.SizeCheckGroup;
 import io.swagger.v3.oas.annotations.media.Schema;
 
 public record CreateCategoryRequest(
         @Schema(description = "카테고리 이름", example = "Spring")
-        @NotNull(message = "카테고리 이름이 null 입니다.")
-        @Size(max = 255, message = "카테고리 이름은 최대 255자까지 입력 가능합니다.")
+        @NotNull(message = "카테고리 이름이 null 입니다.", groups = NotNullGroup.class)
+        @Size(max = 255, message = "카테고리 이름은 최대 255자까지 입력 가능합니다.", groups = SizeCheckGroup.class)
         String name
 ) {
 }
diff --git a/backend/src/main/java/codezap/category/dto/request/UpdateCategoryRequest.java b/backend/src/main/java/codezap/category/dto/request/UpdateCategoryRequest.java
@@ -3,12 +3,14 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
 
+import codezap.global.validation.ValidationGroups.NotNullGroup;
+import codezap.global.validation.ValidationGroups.SizeCheckGroup;
 import io.swagger.v3.oas.annotations.media.Schema;
 
 public record UpdateCategoryRequest(
         @Schema(description = "카테고리 이름", example = "Spring")
-        @NotNull(message = "카테고리 이름이 null 입니다.")
-        @Size(max = 255, message = "카테고리 이름은 최대 255자까지 입력 가능합니다.")
+        @NotNull(message = "카테고리 이름이 null 입니다.", groups = NotNullGroup.class)
+        @Size(max = 255, message = "카테고리 이름은 최대 255자까지 입력 가능합니다.", groups = SizeCheckGroup.class)
         String name
 ) {
 }
diff --git a/backend/src/main/java/codezap/category/service/CategoryService.java b/backend/src/main/java/codezap/category/service/CategoryService.java
@@ -46,6 +46,9 @@ public void deleteById(Long id) {
         if (templateRepository.existsByCategoryId(id)) {
             throw new CodeZapException(HttpStatus.BAD_REQUEST, "템플릿이 존재하는 카테고리는 삭제할 수 없습니다.");
         }
+        if (id == 1) {
+            throw new CodeZapException(HttpStatus.BAD_REQUEST, "1번 카테고리는 삭제할 수 없습니다.");
+        }
         categoryRepository.deleteById(id);
     }
 

diff --git a/backend/src/main/java/codezap/global/cors/WebCorsConfiguration.java b/backend/src/main/java/codezap/global/cors/WebCorsConfiguration.java
@@ -10,6 +10,7 @@ public class WebCorsConfiguration implements WebMvcConfigurer {
     public void addCorsMappings(CorsRegistry registry) {
         registry.addMapping("/**")
                 .allowedOrigins("*")
-                .allowedMethods("*");
+                .allowedMethods("*")
+                .exposedHeaders("*");
     }
 }
diff --git a/backend/src/main/java/codezap/global/validation/ValidationGroups.java b/backend/src/main/java/codezap/global/validation/ValidationGroups.java
@@ -0,0 +1,7 @@
+package codezap.global.validation;
+
+public class ValidationGroups {
+    public interface NotNullGroup {}
+    public interface ByteLengthGroup {}
+    public interface SizeCheckGroup {}
+}
diff --git a/backend/src/main/java/codezap/global/validation/ValidationSequence.java b/backend/src/main/java/codezap/global/validation/ValidationSequence.java
@@ -0,0 +1,11 @@
+package codezap.global.validation;
+
+import jakarta.validation.GroupSequence;
+
+import codezap.global.validation.ValidationGroups.ByteLengthGroup;
+import codezap.global.validation.ValidationGroups.NotNullGroup;
+import codezap.global.validation.ValidationGroups.SizeCheckGroup;
+
+@GroupSequence({NotNullGroup.class, SizeCheckGroup.class, ByteLengthGroup.class})
+public interface ValidationSequence {
+}
diff --git a/backend/src/main/java/codezap/template/controller/SpringDocTemplateController.java b/backend/src/main/java/codezap/template/controller/SpringDocTemplateController.java
@@ -21,7 +21,7 @@ public interface SpringDocTemplateController {
 
     @Operation(summary = "템플릿 생성", description = """
             새로운 템플릿을 생성합니다. \n
-            템플릿의 제목, 썸네일 스니펫의 순서, 스니펫 목록이 필요합니다. \n
+            템플릿의 제목, 썸네일 스니펫의 순서, 스니펫 목록, 카테고리 ID, 태그 목록이 필요합니다. \n
             스니펫 목록은 파일 이름, 소스 코드, 해당 스니펫의 순서가 필요합니다. \n
             * 썸네일 스니펫은 1로 고정입니다. (2024.07.15 기준) \n
             * 모든 스니펫 순서는 1부터 시작합니다. \n
@@ -31,7 +31,7 @@ public interface SpringDocTemplateController {
             @Header(name = "생성된 템플릿의 API 경로", example = "/templates/1")})
     @ApiErrorResponse(status = HttpStatus.BAD_REQUEST, instance = "/templates/1", errorCases = {
             @ErrorCase(description = "모든 필드 중 null인 값이 있는 경우", exampleMessage = "템플릿 이름 null 입니다."),
-            @ErrorCase(description = "제목 또는 스니펫 파일명이 255자를 초과한 경우", exampleMessage = "제목은 최대 255자까지 입력 가능합니다."),
+            @ErrorCase(description = "제목 또는 스니펫 파일 또는 태그 이름이 255자를 초과한 경우", exampleMessage = "제목은 최대 255자까지 입력 가능합니다."),
             @ErrorCase(description = "썸네일 스니펫의 순서가 1이 아닌 경우", exampleMessage = "썸네일 스니펫의 순서가 잘못되었습니다."),
             @ErrorCase(description = "스니펫 순서가 잘못된 경우", exampleMessage = "스니펫 순서가 잘못되었습니다."),
             @ErrorCase(description = "스니펫 내용 65,535 byte를 초과한 경우", exampleMessage = "파일 내용은 최대 65,535 byte까지 입력 가능합니다.")

diff --git a/backend/src/main/java/codezap/template/controller/TemplateController.java b/backend/src/main/java/codezap/template/controller/TemplateController.java
@@ -2,9 +2,8 @@
 
 import java.net.URI;
 
-import jakarta.validation.Valid;
-
 import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -13,6 +12,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+import codezap.global.validation.ValidationSequence;
 import codezap.template.dto.request.CreateTemplateRequest;
 import codezap.template.dto.request.UpdateTemplateRequest;
 import codezap.template.dto.response.FindAllTemplatesResponse;
@@ -30,7 +30,7 @@ public TemplateController(TemplateService templateService) {
     }
 
     @PostMapping
-    public ResponseEntity<Void> create(@Valid @RequestBody CreateTemplateRequest createTemplateRequest) {
+    public ResponseEntity<Void> create(@Validated(ValidationSequence.class) @RequestBody CreateTemplateRequest createTemplateRequest) {
         return ResponseEntity.created(URI.create("/templates/" + templateService.create(createTemplateRequest)))
                 .build();
     }
@@ -48,7 +48,7 @@ public ResponseEntity<FindTemplateByIdResponse> getTemplateById(@PathVariable Lo
     @PostMapping("/{id}")
     public ResponseEntity<Void> updateTemplate(
             @PathVariable Long id,
-            @Valid @RequestBody UpdateTemplateRequest updateTemplateRequest
+            @Validated(ValidationSequence.class) @RequestBody UpdateTemplateRequest updateTemplateRequest
     ) {
         templateService.update(id, updateTemplateRequest);
         return ResponseEntity.ok().build();

diff --git a/backend/src/main/java/codezap/template/domain/Template.java b/backend/src/main/java/codezap/template/domain/Template.java
@@ -30,13 +30,15 @@ public class Template extends BaseTimeEntity {
     @ManyToOne(optional = false)
     private Category category;
 
-    public Template(String title, Category category) {
+    public Template(String title, String description, Category category) {
         this.title = title;
+        this.description = description;
         this.category = category;
     }
 
-    public void updateTitle(String title, Category category) {
+    public void updateTemplate(String title, String description, Category category) {
         this.title = title;
+        this.description = description;
         this.category = category;
     }
 }
diff --git a/backend/src/main/java/codezap/template/dto/request/CreateSnippetRequest.java b/backend/src/main/java/codezap/template/dto/request/CreateSnippetRequest.java
@@ -4,17 +4,20 @@
 import jakarta.validation.constraints.Size;
 
 import codezap.global.validation.ByteLength;
+import codezap.global.validation.ValidationGroups.ByteLengthGroup;
+import codezap.global.validation.ValidationGroups.NotNullGroup;
+import codezap.global.validation.ValidationGroups.SizeCheckGroup;
 import io.swagger.v3.oas.annotations.media.Schema;
 
 public record CreateSnippetRequest(
         @Schema(description = "파일 이름", example = "Main.java")
-        @NotNull(message = "파일 이름이 null 입니다.")
-        @Size(max = 255, message = "파일 이름은 최대 255자까지 입력 가능합니다.")
+        @NotNull(message = "파일 이름이 null 입니다.", groups = NotNullGroup.class)
+        @Size(max = 255, message = "파일 이름은 최대 255자까지 입력 가능합니다.", groups = SizeCheckGroup.class)
         String filename,
 
         @Schema(description = "소스 코드", example = "public class Main { // ...")
-        @NotNull(message = "파일 내용이 null 입니다.")
-        @ByteLength(max = 65_535, message = "파일 내용은 최대 65,535 Byte까지 입력 가능합니다.")
+        @NotNull(message = "파일 내용이 null 입니다.", groups = NotNullGroup.class)
+        @ByteLength(max = 65_535, message = "파일 내용은 최대 65,535 Byte까지 입력 가능합니다.", groups = ByteLengthGroup.class)
         String content,
 
         @Schema(description = "스니펫 순서", example = "1")

diff --git a/backend/src/main/java/codezap/template/dto/request/CreateTemplateRequest.java b/backend/src/main/java/codezap/template/dto/request/CreateTemplateRequest.java
@@ -6,22 +6,35 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
 
+import codezap.global.validation.ByteLength;
+import codezap.global.validation.ValidationGroups.ByteLengthGroup;
+import codezap.global.validation.ValidationGroups.NotNullGroup;
+import codezap.global.validation.ValidationGroups.SizeCheckGroup;
 import codezap.template.dto.request.validation.ValidatedSnippetsOrdinalRequest;
 import io.swagger.v3.oas.annotations.media.Schema;
 
 public record CreateTemplateRequest(
         @Schema(description = "템플릿 이름", example = "스프링 로그인 구현")
-        @NotNull(message = "템플릿 이름이 null 입니다.")
-        @Size(max = 255, message = "템플릿 이름은 최대 255자까지 입력 가능합니다.")
+        @NotNull(message = "템플릿 이름이 null 입니다.", groups = NotNullGroup.class)
+        @Size(max = 255, message = "템플릿 이름은 최대 255자까지 입력 가능합니다.", groups = SizeCheckGroup.class)
         String title,
 
+        @Schema(description = "템플릿 설명", example = "JWT를 사용하여 로그인 기능을 구현함")
+        @NotNull(message = "템플릿 설명이 null 입니다.", groups = NotNullGroup.class)
+        @ByteLength(max = 65_535, message = "템플릿 설명은 최대 65,535 Byte까지 입력 가능합니다.", groups = ByteLengthGroup.class)
+        String description,
+
         @Schema(description = "템플릿의 스니펫 내역")
-        @NotNull(message = "스니펫 리스트가 null 입니다.")
+        @NotNull(message = "스니펫 리스트가 null 입니다.", groups = NotNullGroup.class)
         @Valid
         List<CreateSnippetRequest> snippets,
 
+        @Schema(description = "카테고리 ID", example = "1")
+        @NotNull(message = "카테고리 id가 null 입니다.")
         Long categoryId,
 
+        @Schema(description = "태그 리스트")
+        @NotNull(message = "태그 리스트가 null 입니다.")
         List<String> tags
 ) implements ValidatedSnippetsOrdinalRequest {
     @Override

diff --git a/backend/src/main/java/codezap/template/dto/request/UpdateSnippetRequest.java b/backend/src/main/java/codezap/template/dto/request/UpdateSnippetRequest.java
@@ -4,6 +4,9 @@
 import jakarta.validation.constraints.Size;
 
 import codezap.global.validation.ByteLength;
+import codezap.global.validation.ValidationGroups.ByteLengthGroup;
+import codezap.global.validation.ValidationGroups.NotNullGroup;
+import codezap.global.validation.ValidationGroups.SizeCheckGroup;
 import io.swagger.v3.oas.annotations.media.Schema;
 
 public record UpdateSnippetRequest(
@@ -12,13 +15,13 @@ public record UpdateSnippetRequest(
         Long id,
 
         @Schema(description = "파일 이름", example = "Main.java")
-        @NotNull(message = "파일 이름이 null 입니다.")
-        @Size(max = 255, message = "파일 이름은 최대 255자까지 입력 가능합니다.")
+        @NotNull(message = "파일 이름이 null 입니다.", groups = NotNullGroup.class)
+        @Size(max = 255, message = "파일 이름은 최대 255자까지 입력 가능합니다.", groups = SizeCheckGroup.class)
         String filename,
 
         @Schema(description = "소스 코드", example = "public class Main { // ...")
-        @NotNull(message = "파일 내용이 null 입니다.")
-        @ByteLength(max = 65_535, message = "파일 내용은 최대 65,535 Byte까지 입력 가능합니다.")
+        @NotNull(message = "파일 내용이 null 입니다.", groups = NotNullGroup.class)
+        @ByteLength(max = 65_535, message = "파일 내용은 최대 65,535 Byte까지 입력 가능합니다.", groups = ByteLengthGroup.class)
         String content,
 
         @Schema(description = "스니펫 순서", example = "1")

diff --git a/backend/src/main/java/codezap/template/dto/request/UpdateTemplateRequest.java b/backend/src/main/java/codezap/template/dto/request/UpdateTemplateRequest.java
@@ -3,30 +3,48 @@
 import java.util.List;
 import java.util.stream.Stream;
 
+import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
 
+import codezap.global.validation.ByteLength;
+import codezap.global.validation.ValidationGroups.ByteLengthGroup;
+import codezap.global.validation.ValidationGroups.NotNullGroup;
+import codezap.global.validation.ValidationGroups.SizeCheckGroup;
 import codezap.template.dto.request.validation.ValidatedSnippetsOrdinalRequest;
 import io.swagger.v3.oas.annotations.media.Schema;
 
 public record UpdateTemplateRequest(
         @Schema(description = "템플릿 이름", example = "스프링 로그인 구현")
-        @NotNull(message = "템플릿 이름이 null 입니다.")
+        @NotNull(message = "템플릿 이름이 null 입니다.", groups = NotNullGroup.class)
+        @Size(max = 255, message = "템플릿 이름은 최대 255자까지 입력 가능합니다.", groups = SizeCheckGroup.class)
         String title,
 
+        @Schema(description = "템플릿 설명", example = "JWT를 사용하여 로그인 기능을 구현함")
+        @NotNull(message = "템플릿 설명이 null 입니다.", groups = NotNullGroup.class)
+        @ByteLength(max = 65_535, message = "템플릿 설명은 최대 65,535 Byte까지 입력 가능합니다.", groups = ByteLengthGroup.class)
+        String description,
+
         @Schema(description = "새로 추가한 스니펫 내역")
-        @NotNull(message = "createSnippets 리스트가 null 입니다.")
+        @NotNull(message = "createSnippets 리스트가 null 입니다.", groups = NotNullGroup.class)
+        @Valid
         List<CreateSnippetRequest> createSnippets,
 
         @Schema(description = "삭제, 생성 스니펫을 제외한 모든 스니펫 내역")
-        @NotNull(message = "updateSnippets 리스트가 null 입니다.")
+        @NotNull(message = "updateSnippets 리스트가 null 입니다.", groups = NotNullGroup.class)
+        @Valid
         List<UpdateSnippetRequest> updateSnippets,
 
         @Schema(description = "삭제한 스니펫 식별자")
         @NotNull(message = "deleteSnippetIds 리스트가 null 입니다.")
         List<Long> deleteSnippetIds,
 
+        @Schema(description = "카테고리 ID", example = "1")
+        @NotNull(message = "카테고리 id가 null 입니다.")
         Long categoryId,
 
+        @Schema(description = "태그 리스트")
+        @NotNull(message = "태그 리스트가 null 입니다.")
         List<String> tags
 ) implements ValidatedSnippetsOrdinalRequest {
     @Override

diff --git a/backend/src/main/java/codezap/template/dto/response/FindAllSnippetByTemplateResponse.java b/backend/src/main/java/codezap/template/dto/response/FindAllSnippetByTemplateResponse.java
@@ -6,10 +6,13 @@
 public record FindAllSnippetByTemplateResponse(
         @Schema(description = "파일 식별자", example = "0")
         Long id,
+
         @Schema(description = "파일 이름", example = "Main.java")
         String filename,
+
         @Schema(description = "소스 코드", example = "public class Main { // ...")
         String content,
+
         @Schema(description = "스니펫의 순서", example = "1")
         int ordinal
 ) {

diff --git a/backend/src/main/java/codezap/template/dto/response/FindTagByIdResponse.java b/backend/src/main/java/codezap/template/dto/response/FindTagByIdResponse.java
@@ -1,9 +1,13 @@
 package codezap.template.dto.response;
 
 import codezap.template.domain.Tag;
+import io.swagger.v3.oas.annotations.media.Schema;
 
 public record FindTagByIdResponse(
+        @Schema(description = "태그 식별자", example = "1")
         Long id,
+
+        @Schema(description = "태그 이름", example = "스프링")
         String name
 ) {
     public static FindTagByIdResponse from(Tag tag) {

diff --git a/backend/src/main/java/codezap/template/dto/response/FindTemplateByIdResponse.java b/backend/src/main/java/codezap/template/dto/response/FindTemplateByIdResponse.java
@@ -16,11 +16,16 @@ public record FindTemplateByIdResponse(
         @Schema(description = "템플릿 이름", example = "스프링 로그인 구현")
         String title,
 
+        @Schema(description = "템플릿 설명", example = "JWT를 사용하여 로그인 기능을 구현함")
+        String description,
+
         @Schema(description = "스니펫 목록")
         List<FindAllSnippetByTemplateResponse> snippets,
 
+        @Schema(description = "카테고리 정보")
         FindCategoryByIdResponse category,
 
+        @Schema(description = "태그 목록")
         List<FindTagByIdResponse> tags,
 
         @Schema(description = "템플릿 수정 시간", example = "2024-11-11 12:00", type = "string")
@@ -30,6 +35,7 @@ public static FindTemplateByIdResponse of(Template template, List<Snippet> snipp
         return new FindTemplateByIdResponse(
                 template.getId(),
                 template.getTitle(),
+                template.getDescription(),
                 mapToFindAllSnippetByTemplateResponse(snippets),
                 FindCategoryByIdResponse.from(template.getCategory()),
                 mapToFindTagByTemplateResponse(tags),

diff --git a/backend/src/main/java/codezap/template/dto/response/FindThumbnailSnippetResponse.java b/backend/src/main/java/codezap/template/dto/response/FindThumbnailSnippetResponse.java
@@ -6,6 +6,7 @@
 public record FindThumbnailSnippetResponse(
         @Schema(description = "파일 이름", example = "Main.java")
         String filename,
+
         @Schema(description = "목록 조회 시 보여질 코드", example = "public class Main { // ...")
         String thumbnailContent
 ) {