feat: 공지 CRUD API 구현

src/main/java/com/listywave/common/exception/ErrorCode.java

@@ -44,6 +44,8 @@ public enum ErrorCode {
     DUPLICATE_NICKNAME_EXCEPTION(BAD_REQUEST, "중복된 닉네임입니다."),
     DUPLICATE_COLLABORATOR_EXCEPTION(BAD_REQUEST, "이미 동일한 콜라보레이터가 존재합니다"),
     DUPLICATE_FOLDER_NAME_EXCEPTION(BAD_REQUEST, "중복된 폴더명입니다."),
+    NULL_OR_BLANK_EXCEPTION(BAD_REQUEST, "값이 null이거나 공백일 수 없습니다."),
+    NOT_EXIST_CODE(BAD_REQUEST, "존재하지 않는 코드입니다."),
 
     // S3
     S3_DELETE_OBJECTS_EXCEPTION(INTERNAL_SERVER_ERROR, "S3의 이미지를 삭제 요청하는 과정에서 에러가 발생했습니다."),

src/main/java/com/listywave/notice/application/converter/ContentTypeConverter.java

@@ -0,0 +1,20 @@
+package com.listywave.notice.application.converter;
+
+
+import com.listywave.notice.application.domain.ContentType;
+import jakarta.persistence.AttributeConverter;
+import jakarta.persistence.Converter;
+
+@Converter(autoApply = true)
+public class ContentTypeConverter implements AttributeConverter<ContentType, String> {
+
+    @Override
+    public String convertToDatabaseColumn(ContentType contentType) {
+        return contentType.name().toLowerCase();
+    }
+
+    @Override
+    public ContentType convertToEntityAttribute(String s) {
+        return ContentType.valueOf(s.toUpperCase());
+    }
+}

src/main/java/com/listywave/notice/application/domain/ContentType.java

@@ -0,0 +1,17 @@
+package com.listywave.notice.application.domain;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public enum ContentType {
+
+    SUBTITLE,
+    BODY,
+    IMAGE,
+    BUTTON,
+    LINE,
+    NOTE,
+    ;
+}

src/main/java/com/listywave/notice/application/domain/Notice.java

@@ -0,0 +1,43 @@
+package com.listywave.notice.application.domain;
+
+import static jakarta.persistence.CascadeType.ALL;
+import static jakarta.persistence.FetchType.LAZY;
+import static lombok.AccessLevel.PROTECTED;
+
+import com.listywave.common.BaseEntity;
+import jakarta.persistence.Column;
+import jakarta.persistence.Embedded;
+import jakarta.persistence.Entity;
+import jakarta.persistence.OneToMany;
+import java.util.ArrayList;
+import java.util.List;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Entity
+@Getter
+@NoArgsConstructor(access = PROTECTED)
+public class Notice extends BaseEntity {
+
+    @Column(name = "code", nullable = false)
+    private NoticeType type;
+
+    @Embedded
+    private NoticeTitle title;
+
+    @Embedded
+    private NoticeDescription description;
+
+    @OneToMany(mappedBy = "notice", fetch = LAZY, cascade = ALL, orphanRemoval = true)
+    private final List<NoticeContent> contents = new ArrayList<>();
+
+    public Notice(NoticeType type, NoticeTitle title, NoticeDescription description) {
+        this.type = type;
+        this.title = title;
+        this.description = description;
+    }
+
+    public void addContents(List<NoticeContent> contents) {
+        this.contents.addAll(contents);
+    }
+}

src/main/java/com/listywave/notice/application/domain/NoticeContent.java

@@ -0,0 +1,61 @@
+package com.listywave.notice.application.domain;
+
+import static jakarta.persistence.GenerationType.IDENTITY;
+import static lombok.AccessLevel.PRIVATE;
+import static lombok.AccessLevel.PROTECTED;
+
+import jakarta.annotation.Nullable;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Entity
+@Getter
+@AllArgsConstructor(access = PRIVATE)
+@NoArgsConstructor(access = PROTECTED)
+public class NoticeContent {
+
+    @Id
+    @GeneratedValue(strategy = IDENTITY)
+    private Long id;
+
+    @ManyToOne
+    @JoinColumn(name = "notice_id", nullable = false)
+    private Notice notice;
+
+    @Column(name = "orders", nullable = false)
+    private int order;
+
+    @Column(nullable = false, length = 30)
+    private ContentType type;
+
+    @Column(nullable = true, length = 1000)
+    private String description;
+
+    @Column(nullable = true, length = 2048)
+    private String imageUrl;
+
+    @Column(nullable = true, length = 50)
+    private String buttonName;
+
+    @Column(nullable = true, length = 2048)
+    private String buttonLink;
+
+    public static NoticeContent create(
+            Notice notice,
+            int order,
+            ContentType type,
+            @Nullable String description,
+            @Nullable String imageUrl,
+            @Nullable String buttonName,
+            @Nullable String buttonLink
+    ) {
+        return new NoticeContent(null, notice, order, type, description, imageUrl, buttonName, buttonLink);
+    }
+}

src/main/java/com/listywave/notice/application/domain/NoticeDescription.java

@@ -0,0 +1,38 @@
+package com.listywave.notice.application.domain;
+
+import static com.listywave.common.exception.ErrorCode.LENGTH_EXCEEDED_EXCEPTION;
+import static com.listywave.common.exception.ErrorCode.NULL_OR_BLANK_EXCEPTION;
+import static lombok.AccessLevel.PROTECTED;
+
+import com.listywave.common.exception.CustomException;
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Embeddable
+@EqualsAndHashCode
+@NoArgsConstructor(access = PROTECTED, force = true)
+public class NoticeDescription {
+
+    private static final int MAX_LENGTH = 30;
+
+    @Column(name = "description", nullable = false, length = MAX_LENGTH)
+    private final String value;
+
+    public NoticeDescription(String value) {
+        validate(value);
+        this.value = value;
+    }
+
+    private void validate(String value) {
+        if (value == null || value.isBlank()) {
+            throw new CustomException(NULL_OR_BLANK_EXCEPTION, NULL_OR_BLANK_EXCEPTION.getDetail() + " 입력값: " + value);
+        }
+        if (value.length() > MAX_LENGTH) {
+            throw new CustomException(LENGTH_EXCEEDED_EXCEPTION, LENGTH_EXCEEDED_EXCEPTION.getDetail() + " 입력값의 길이: " + value.length());
+        }
+    }
+}

src/main/java/com/listywave/notice/application/domain/NoticeTitle.java

@@ -0,0 +1,38 @@
+package com.listywave.notice.application.domain;
+
+import static com.listywave.common.exception.ErrorCode.LENGTH_EXCEEDED_EXCEPTION;
+import static com.listywave.common.exception.ErrorCode.NULL_OR_BLANK_EXCEPTION;
+import static lombok.AccessLevel.PROTECTED;
+
+import com.listywave.common.exception.CustomException;
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Embeddable
+@EqualsAndHashCode
+@NoArgsConstructor(access = PROTECTED, force = true)
+public class NoticeTitle {
+
+    private static final int MAX_LENGTH = 30;
+
+    @Column(name = "title", nullable = false, length = MAX_LENGTH)
+    private final String value;
+
+    public NoticeTitle(String value) {
+        validate(value);
+        this.value = value;
+    }
+
+    private void validate(String value) {
+        if (value == null || value.isBlank()) {
+            throw new CustomException(NULL_OR_BLANK_EXCEPTION, NULL_OR_BLANK_EXCEPTION.getDetail() + " 입력값: " + value);
+        }
+        if (value.length() > MAX_LENGTH) {
+            throw new CustomException(LENGTH_EXCEEDED_EXCEPTION, LENGTH_EXCEEDED_EXCEPTION.getDetail() + " 입력값의 길이: " + value.length());
+        }
+    }
+}

src/test/java/com/listywave/notice/application/domain/NoticeDescriptionTest.java

@@ -0,0 +1,64 @@
+package com.listywave.notice.application.domain;
+
+import static com.listywave.common.exception.ErrorCode.LENGTH_EXCEEDED_EXCEPTION;
+import static com.listywave.common.exception.ErrorCode.NULL_OR_BLANK_EXCEPTION;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatNoException;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import com.listywave.common.exception.CustomException;
+import com.listywave.common.exception.ErrorCode;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullAndEmptySource;
+
+class NoticeDescriptionTest {
+
+    @Test
+    void 공지_제목의_최대_길이를_넘으면_예외를_발생한다() {
+        // given
+        String value = IntStream.range(0, 30)
+                .mapToObj(String::valueOf)
+                .collect(Collectors.joining(""));
+
+        // when
+        ErrorCode result = assertThrows(CustomException.class, () -> new NoticeDescription(value))
+                .getErrorCode();
+
+        // then
+        assertThat(result).isEqualTo(LENGTH_EXCEEDED_EXCEPTION);
+    }
+
+    @ParameterizedTest
+    @NullAndEmptySource
+    void 값이_null이거나_빈_값이면_예외를_발생한다(String value) {
+        // when
+        ErrorCode result = assertThrows(CustomException.class, () -> new NoticeDescription(value))
+                .getErrorCode();
+
+        // then
+        assertThat(result).isEqualTo(NULL_OR_BLANK_EXCEPTION);
+    }
+
+    @Test
+    void 공지_제목을_정상적으로_생성한다() {
+        // given
+        String value = "12345678911234567891123456789";
+
+        // expect
+        assertThatNoException().isThrownBy(() -> new NoticeDescription(value));
+    }
+
+    @Test
+    void 값이_같으면_같은_객체다() {
+        // given
+        NoticeDescription title1 = new NoticeDescription("123456789");
+        NoticeDescription title2 = new NoticeDescription("123456789");
+
+        // expect
+        assertThat(title1).isEqualTo(title2);
+        assertThat(title1).hasSameHashCodeAs(title2);
+    }
+}

src/test/java/com/listywave/notice/application/domain/NoticeTitleTest.java

@@ -0,0 +1,64 @@
+package com.listywave.notice.application.domain;
+
+import static com.listywave.common.exception.ErrorCode.LENGTH_EXCEEDED_EXCEPTION;
+import static com.listywave.common.exception.ErrorCode.NULL_OR_BLANK_EXCEPTION;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatNoException;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import com.listywave.common.exception.CustomException;
+import com.listywave.common.exception.ErrorCode;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.NullAndEmptySource;
+
+class NoticeTitleTest {
+
+    @Test
+    void 공지_제목의_최대_길이를_넘으면_예외를_발생한다() {
+        // given
+        String value = IntStream.range(0, 30)
+                .mapToObj(String::valueOf)
+                .collect(Collectors.joining(""));
+
+        // when
+        ErrorCode result = assertThrows(CustomException.class, () -> new NoticeTitle(value))
+                .getErrorCode();
+
+        // then
+        assertThat(result).isEqualTo(LENGTH_EXCEEDED_EXCEPTION);
+    }
+
+    @ParameterizedTest
+    @NullAndEmptySource
+    void 값이_null이거나_빈_값이면_예외를_발생한다(String value) {
+        // when
+        ErrorCode result = assertThrows(CustomException.class, () -> new NoticeTitle(value))
+                .getErrorCode();
+
+        // then
+        assertThat(result).isEqualTo(NULL_OR_BLANK_EXCEPTION);
+    }
+
+    @Test
+    void 공지_제목을_정상적으로_생성한다() {
+        // given
+        String value = "12345678911234567891123456789";
+
+        // expect
+        assertThatNoException().isThrownBy(() -> new NoticeTitle(value));
+    }
+
+    @Test
+    void 값이_같으면_같은_객체다() {
+        // given
+        NoticeTitle title1 = new NoticeTitle("123456789");
+        NoticeTitle title2 = new NoticeTitle("123456789");
+
+        // expect
+        assertThat(title1).isEqualTo(title2);
+        assertThat(title1).hasSameHashCodeAs(title2);
+    }
+}