[FEAT] Gallery 관련 API 구현 완료 (#10)

src/docs/asciidoc/gallery.adoc

@@ -0,0 +1,28 @@
+== 갤러리 API
+:source-highlighter: highlightjs
+
+---
+=== 갤러리 게시글 생성 (POST /galleries)
+====
+operation::gallery-controller-test/create-gallery[snippets="http-request,request-fields,http-response,response-fields"]
+====
+
+=== 갤러리 게시글 목록 조회 (GET /galleries)
+====
+operation::gallery-controller-test/get-galleries[snippets="http-request,query-parameters,http-response,response-fields"]
+====
+
+=== 갤러리 게시글 조회 (GET /galleries/{galleryId})
+====
+operation::gallery-controller-test/get-gallery[snippets="http-request,path-parameters,http-response,response-fields"]
+====
+
+=== 갤러리 게시글 삭제 (DELETE /galleries/{galleryId})
+====
+operation::gallery-controller-test/delete-gallery[snippets="http-request,path-parameters"]
+====
+
+=== 갤러리 게시글 수정 (PUT /galleries/{galleryId})
+====
+operation::gallery-controller-test/update-gallery[snippets="http-request,path-parameters,request-fields,http-response,response-fields"]
+====

src/docs/asciidoc/index.adoc

@@ -14,3 +14,4 @@ include::talk.adoc[]
 include::notice.adoc[]
 include::eventNotice.adoc[]
 include::eventPeriod.adoc[]
+include::gallery.adoc[]

src/main/java/com/scg/stop/domain/file/domain/File.java

@@ -4,7 +4,7 @@
 import static jakarta.persistence.GenerationType.IDENTITY;
 import static lombok.AccessLevel.PROTECTED;
 
-import com.scg.stop.domain.gallery.domain.Gallery;
+import com.scg.stop.gallery.domain.Gallery;
 import com.scg.stop.notice.domain.Notice;
 import com.scg.stop.event.domain.EventNotice;
 import com.scg.stop.global.domain.BaseTimeEntity;
@@ -54,4 +54,8 @@ public void setNotice(Notice notice) {
     public void setEventNotice(EventNotice eventNotice) {
         this.eventNotice = eventNotice;
     }
+
+    public void setGallery(Gallery gallery) {
+        this.gallery = gallery;
+    }
 }

src/main/java/com/scg/stop/gallery/controller/GalleryController.java

@@ -0,0 +1,67 @@
+package com.scg.stop.gallery.controller;
+
+import com.scg.stop.auth.annotation.AuthUser;
+import com.scg.stop.gallery.dto.request.GalleryRequest;
+import com.scg.stop.gallery.dto.response.GalleryResponse;
+import com.scg.stop.gallery.service.GalleryService;
+import com.scg.stop.user.domain.AccessType;
+import com.scg.stop.user.domain.User;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.web.PageableDefault;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/galleries")
+public class GalleryController {
+
+    private final GalleryService galleryService;
+
+    @PostMapping
+    public ResponseEntity<GalleryResponse> createGallery(
+            @RequestBody @Valid GalleryRequest galleryRequest,
+            @AuthUser(accessType = {AccessType.ADMIN}) User user
+    ) {
+        GalleryResponse galleryResponse = galleryService.createGallery(galleryRequest);
+        return ResponseEntity.status(HttpStatus.CREATED).body(galleryResponse);
+    }
+
+    @GetMapping
+    public ResponseEntity<Page<GalleryResponse>> getGalleries(
+            @RequestParam(value = "year", required = false) Integer year,
+            @RequestParam(value = "month", required = false) Integer month,
+            @PageableDefault(page = 0, size = 10) Pageable pageable) {
+        Page<GalleryResponse> galleries = galleryService.getGalleries(year, month, pageable);
+        return ResponseEntity.ok(galleries);
+    }
+
+    @GetMapping("/{galleryId}")
+    public ResponseEntity<GalleryResponse> getGallery(@PathVariable("galleryId") Long galleryId) {
+        GalleryResponse galleryResponse = galleryService.getGallery(galleryId);
+        return ResponseEntity.ok(galleryResponse);
+    }
+
+    @PutMapping("/{galleryId}")
+    public ResponseEntity<GalleryResponse> updateGallery(
+            @PathVariable("galleryId") Long galleryId,
+            @RequestBody @Valid GalleryRequest galleryRequest,
+            @AuthUser(accessType = {AccessType.ADMIN}) User user
+    ) {
+        GalleryResponse galleryResponse = galleryService.updateGallery(galleryId, galleryRequest);
+        return ResponseEntity.ok(galleryResponse);
+    }
+
+    @DeleteMapping("/{galleryId}")
+    public ResponseEntity<Void> deleteGallery(
+            @PathVariable("galleryId") Long galleryId,
+            @AuthUser(accessType = {AccessType.ADMIN}) User user
+    ) {
+        galleryService.deleteGallery(galleryId);
+        return ResponseEntity.noContent().build();
+    }
+}

src/main/java/com/scg/stop/gallery/domain/Gallery.java

@@ -0,0 +1,64 @@
+package com.scg.stop.gallery.domain;
+
+import static jakarta.persistence.FetchType.LAZY;
+import static jakarta.persistence.GenerationType.IDENTITY;
+import static lombok.AccessLevel.PROTECTED;
+
+import com.scg.stop.domain.file.domain.File;
+import com.scg.stop.global.domain.BaseTimeEntity;
+import jakarta.persistence.*;
+
+import java.util.ArrayList;
+import java.util.List;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Entity
+@Getter
+@NoArgsConstructor(access = PROTECTED)
+public class Gallery extends BaseTimeEntity {
+
+    @Id
+    @GeneratedValue(strategy = IDENTITY)
+    private Long id;
+
+    @Column(nullable = false)
+    private String title;
+
+    @Column(nullable = false)
+    private Integer year;
+
+    @Column(nullable = false)
+    private Integer month;
+
+    @Column(nullable = false)
+    private Integer hitCount = 0;
+
+    @OneToMany(fetch = LAZY, mappedBy = "gallery", cascade = CascadeType.ALL, orphanRemoval = true)
+    private List<File> files = new ArrayList<>();
+
+    private Gallery(String title, Integer year, Integer month, List<File> files) {
+        this.title = title;
+        this.year = year;
+        this.month = month;
+        this.files = files;
+        files.forEach(file -> file.setGallery(this));
+    }
+
+    public static Gallery of(String title, Integer year, Integer month, List<File> files) {
+        return new Gallery(title, year, month, files);
+    }
+
+    public void update(String title, Integer year, Integer month, List<File> files) {
+        this.title = title;
+        this.year = year;
+        this.month = month;
+        this.files.clear();
+        this.files.addAll(files);
+        files.forEach(file -> file.setGallery(this));
+    }
+
+    public void increaseHitCount() {
+        this.hitCount += 1;
+    }
+}

src/main/java/com/scg/stop/gallery/dto/request/GalleryRequest.java

@@ -0,0 +1,31 @@
+package com.scg.stop.gallery.dto.request;
+
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+import java.util.List;
+
+import static lombok.AccessLevel.PRIVATE;
+
+@Getter
+@NoArgsConstructor(access = PRIVATE)
+@AllArgsConstructor
+public class GalleryRequest {
+
+    @NotBlank(message = "제목을 입력해주세요.")
+    private String title;
+
+    @NotNull(message = "연도를 입력해주세요.")
+    private Integer year;
+
+    @NotNull(message = "월을 입력해주세요.")
+    private Integer month;
+
+    @Size(min = 1, message = "1개 이상의 파일을 첨부해야 합니다.")
+    @NotNull(message = "파일을 첨부해주세요.")
+    private List<Long> fileIds;
+}

src/main/java/com/scg/stop/gallery/dto/response/GalleryResponse.java

@@ -0,0 +1,48 @@
+package com.scg.stop.gallery.dto.response;
+
+import static lombok.AccessLevel.PRIVATE;
+
+import com.scg.stop.domain.file.dto.response.FileResponse;
+import com.scg.stop.gallery.domain.Gallery;
+import java.time.LocalDateTime;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@NoArgsConstructor(access = PRIVATE)
+@AllArgsConstructor
+public class GalleryResponse {
+
+    private Long id;
+    private String title;
+    private int year;
+    private int month;
+    private int hitCount;
+    private LocalDateTime createdAt;
+    private LocalDateTime updatedAt;
+    private List<FileResponse> files;
+
+    public static GalleryResponse of(Gallery gallery, List<FileResponse> fileResponses) {
+        return new GalleryResponse(
+                gallery.getId(),
+                gallery.getTitle(),
+                gallery.getYear(),
+                gallery.getMonth(),
+                gallery.getHitCount(),
+                gallery.getCreatedAt(),
+                gallery.getUpdatedAt(),
+                fileResponses
+        );
+    }
+
+    public static GalleryResponse from(Gallery gallery) {
+        List<FileResponse> fileResponses = gallery.getFiles().stream()
+                .map(FileResponse::from)
+                .collect(Collectors.toList());
+        return GalleryResponse.of(gallery, fileResponses);
+    }
+}

src/main/java/com/scg/stop/gallery/repository/GalleryRepository.java

@@ -0,0 +1,22 @@
+package com.scg.stop.gallery.repository;
+
+import com.scg.stop.gallery.domain.Gallery;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface GalleryRepository extends JpaRepository<Gallery, Long> {
+
+    @Query("SELECT g FROM Gallery g " +
+            "WHERE (:year IS NULL OR g.year = :year) " +
+            "AND (:month IS NULL OR g.month = :month)")
+    Page<Gallery> findGalleries(
+            @Param("year") Integer year,
+            @Param("month") Integer month,
+            Pageable pageable
+    );
+}