알림 읽기 기능 구현

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmCommandController.java

@@ -1,15 +1,14 @@
 package com.votogether.domain.alarm.controller;
 
-import com.votogether.domain.alarm.dto.ReportActionAlarmResponse;
-import com.votogether.domain.alarm.dto.ReportActionResponse;
-import com.votogether.domain.alarm.service.AlarmService;
+import com.votogether.domain.alarm.service.AlarmCommandService;
 import com.votogether.domain.member.entity.Member;
 import com.votogether.global.jwt.Auth;
-import jakarta.validation.constraints.PositiveOrZero;
-import java.util.List;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Positive;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
@@ -21,24 +20,16 @@
 @RestController
 public class AlarmCommandController implements AlarmCommandControllerDocs {
 
- private final AlarmService alarmService;
+ private final AlarmCommandService alarmCommandService;
 
- @RequestMapping("/report")
- public ResponseEntity<List<ReportActionAlarmResponse>> getReportActionAlarms(
- @RequestParam @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page,
- @Auth final Member member
+ @PatchMapping("/{id}")
+ public ResponseEntity<Void> readAlarm(
+ @PathVariable("id") @Positive(message = "알림 ID는 양수만 가능합니다.") final Long alarmId,
+ @RequestParam("type") @NotBlank(message = "알림 타입이 공백이거나 존재하지 않습니다.") final String type,
+ @Auth final Member loginMember
  ) {
- final List<ReportActionAlarmResponse> response = alarmService.getReportActionAlarms(member, page);
- return ResponseEntity.ok(response);
- }
-
- @RequestMapping("/report/{id}")
- public ResponseEntity<ReportActionResponse> getReportActionAlarm(
- @PathVariable("id") final Long reportActionAlarmId,
- @Auth final Member member
- ) {
- final ReportActionResponse response = alarmService.getReportActionAlarm(reportActionAlarmId, member);
- return ResponseEntity.ok(response);
+ alarmCommandService.readAlarm(alarmId, type, loginMember);
+ return ResponseEntity.ok().build();
  }
 
 }

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmCommandControllerDocs.java

@@ -1,32 +1,51 @@
 package com.votogether.domain.alarm.controller;
 
-import com.votogether.domain.alarm.dto.ReportActionAlarmResponse;
-import com.votogether.domain.alarm.dto.ReportActionResponse;
 import com.votogether.domain.member.entity.Member;
+import com.votogether.global.exception.ExceptionResponse;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.tags.Tag;
-import jakarta.validation.constraints.PositiveOrZero;
-import java.util.List;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Positive;
 import org.springframework.http.ResponseEntity;
 
-@Tag(name = "알림", description = "알림 API")
+@Tag(name = "알림 커맨드", description = "알림 커맨드 API")
 public interface AlarmCommandControllerDocs {
 
- @Operation(summary = "신고조치알림 조회", description = "신고조치알림목록을 조회한다.")
- @ApiResponse(responseCode = "201", description = "조회 성공")
- ResponseEntity<List<ReportActionAlarmResponse>> getReportActionAlarms(
- @Parameter(description = "현재 페이지 위치", example = "0")
- @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page,
- final Member member
- );
-
- @Operation(summary = "신고조치알림 상세 조회", description = "신고조치알림를 상세 조회한다.")
- @ApiResponse(responseCode = "201", description = "조회 성공")
- public ResponseEntity<ReportActionResponse> getReportActionAlarm(
- @Parameter(description = "신고조치알림 ID", example = "1") final Long reportActionAlarmId,
- final Member member
+ @Operation(
+ summary = "알림 읽기",
+ description = "알림을 읽을 수 있는 대상이라면 알림을 읽습니다."
+ )
+ @ApiResponses({
+ @ApiResponse(
+ responseCode = "200",
+ description = "알림 읽기 성공"
+ ),
+ @ApiResponse(
+ responseCode = "400",
+ description = """
+ 1.알림 ID가 양수가 아닌 경우
+
+ 2.알림을 읽을 수 있는 대상이 아닌 경우
+ """,
+ content = @Content(schema = @Schema(implementation = ExceptionResponse.class))
+ ),
+ @ApiResponse(
+ responseCode = "404",
+ description = "알림이 존재하지 않은 경우",
+ content = @Content(schema = @Schema(implementation = ExceptionResponse.class))
+ )
+ })
+ ResponseEntity<Void> readAlarm(
+ @Parameter(description = "알림 ID", example = "1")
+ @Positive(message = "알림 ID는 양수만 가능합니다.") final Long alarmId,
+ @Parameter(description = "알림 타입", example = "CONTENT")
+ @NotBlank(message = "알림 타입이 공백이거나 존재하지 않습니다.") final String alarmType,
+ final Member loginMember
  );
 
 }

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmQueryController.java

@@ -0,0 +1,54 @@
+package com.votogether.domain.alarm.controller;
+
+import com.votogether.domain.alarm.dto.ReportActionAlarmResponse;
+import com.votogether.domain.alarm.dto.ReportActionResponse;
+import com.votogether.domain.alarm.dto.response.PostAlarmResponse;
+import com.votogether.domain.alarm.service.AlarmQueryService;
+import com.votogether.domain.member.entity.Member;
+import com.votogether.global.jwt.Auth;
+import jakarta.validation.constraints.PositiveOrZero;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@Validated
+@RequiredArgsConstructor
+@RequestMapping("/alarms")
+@RestController
+public class AlarmQueryController implements AlarmQueryControllerDocs {
+
+ private final AlarmQueryService alarmQueryService;
+
+ @GetMapping("/content")
+ public ResponseEntity<List<PostAlarmResponse>> getPostAlarm(
+ @RequestParam @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page
+ ) {
+ final List<PostAlarmResponse> postAlarmResponses = alarmQueryService.getPostAlarm(page);
+ return ResponseEntity.ok(postAlarmResponses);
+ }
+
+ @GetMapping("/report")
+ public ResponseEntity<List<ReportActionAlarmResponse>> getReportActionAlarms(
+ @RequestParam @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page,
+ @Auth final Member member
+ ) {
+ final List<ReportActionAlarmResponse> response = alarmQueryService.getReportActionAlarms(member, page);
+ return ResponseEntity.ok(response);
+ }
+
+ @GetMapping("/report/{id}")
+ public ResponseEntity<ReportActionResponse> getReportActionAlarm(
+ @PathVariable("id") final Long reportActionAlarmId,
+ @Auth final Member member
+ ) {
+ final ReportActionResponse response = alarmQueryService.getReportActionAlarm(reportActionAlarmId, member);
+ return ResponseEntity.ok(response);
+ }
+
+}

backend/src/main/java/com/votogether/domain/alarm/controller/AlarmQueryControllerDocs.java

@@ -1,8 +1,12 @@
 package com.votogether.domain.alarm.controller;
 
+import com.votogether.domain.alarm.dto.ReportActionAlarmResponse;
+import com.votogether.domain.alarm.dto.ReportActionResponse;
 import com.votogether.domain.alarm.dto.response.PostAlarmResponse;
+import com.votogether.domain.member.entity.Member;
 import com.votogether.global.exception.ExceptionResponse;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
@@ -12,10 +16,13 @@
 import java.util.List;
 import org.springframework.http.ResponseEntity;
 
-@Tag(name = "알림", description = "알림 API")
+@Tag(name = "알림 조회", description = "알림 조회 API")
 public interface AlarmQueryControllerDocs {
 
- @Operation(summary = "게시글 내역 알림 조회", description = "게시글 내역 알림을 조회한다.")
+ @Operation(
+ summary = "게시글 내역 알림 조회",
+ description = "게시글 내역 알림을 조회한다."
+ )
  @ApiResponses({
  @ApiResponse(
  responseCode = "200",
@@ -31,4 +38,38 @@ ResponseEntity<List<PostAlarmResponse>> getPostAlarm(
  @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page
  );
 
+ @Operation(
+ summary = "신고조치알림 조회",
+ description = "신고조치알림목록을 조회한다."
+ )
+ @ApiResponses({
+ @ApiResponse(
+ responseCode = "201",
+ description = "신고조치알림 조회 성공"
+ ),
+ @ApiResponse(
+ responseCode = "400",
+ description = "페이지가 0이상 정수가 아닌 경우",
+ content = @Content(schema = @Schema(implementation = ExceptionResponse.class))
+ )
+ })
+ ResponseEntity<List<ReportActionAlarmResponse>> getReportActionAlarms(
+ @Parameter(description = "현재 페이지 위치", example = "0")
+ @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page,
+ final Member member
+ );
+
+ @Operation(
+ summary = "신고조치알림 상세 조회",
+ description = "신고조치알림를 상세 조회한다."
+ )
+ @ApiResponse(
+ responseCode = "201",
+ description = "신고조치알림 상세 조회 성공"
+ )
+ ResponseEntity<ReportActionResponse> getReportActionAlarm(
+ @Parameter(description = "신고조치알림 ID", example = "1") final Long reportActionAlarmId,
+ final Member member
+ );
+
 }

backend/src/main/java/com/votogether/domain/alarm/entity/Alarm.java

@@ -1,8 +1,10 @@
 package com.votogether.domain.alarm.entity;
 
 import com.votogether.domain.alarm.entity.vo.AlarmType;
+import com.votogether.domain.alarm.exception.AlarmExceptionType;
 import com.votogether.domain.common.BaseEntity;
 import com.votogether.domain.member.entity.Member;
+import com.votogether.global.exception.BadRequestException;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
 import jakarta.persistence.EnumType;
@@ -13,6 +15,7 @@
 import jakarta.persistence.Id;
 import jakarta.persistence.JoinColumn;
 import jakarta.persistence.ManyToOne;
+import java.util.Objects;
 import lombok.AccessLevel;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
@@ -61,4 +64,14 @@ private Alarm(
  this.isChecked = isChecked;
  }
 
+ public void read() {
+ this.isChecked = true;
+ }
+
+ public void checkOwner(final Member member) {
+ if (!Objects.equals(this.member.getId(), member.getId())) {
+ throw new BadRequestException(AlarmExceptionType.NOT_OWNER);
+ }
+ }
+
 }

backend/src/main/java/com/votogether/domain/alarm/entity/ReportActionAlarm.java

@@ -1,8 +1,10 @@
 package com.votogether.domain.alarm.entity;
 
+import com.votogether.domain.alarm.exception.AlarmExceptionType;
 import com.votogether.domain.common.BaseEntity;
 import com.votogether.domain.member.entity.Member;
 import com.votogether.domain.report.entity.vo.ReportType;
+import com.votogether.global.exception.BadRequestException;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
 import jakarta.persistence.EnumType;
@@ -13,6 +15,7 @@
 import jakarta.persistence.Id;
 import jakarta.persistence.JoinColumn;
 import jakarta.persistence.ManyToOne;
+import java.util.Objects;
 import lombok.AccessLevel;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
@@ -61,4 +64,14 @@ private ReportActionAlarm(
  this.isChecked = isChecked;
  }
 
+ public void read() {
+ this.isChecked = true;
+ }
+
+ public void checkOwner(final Member member) {
+ if (!Objects.equals(this.member.getId(), member.getId())) {
+ throw new BadRequestException(AlarmExceptionType.NOT_OWNER);
+ }
+ }
+
 }

backend/src/main/java/com/votogether/domain/alarm/entity/vo/AlarmActionType.java

@@ -0,0 +1,20 @@
+package com.votogether.domain.alarm.entity.vo;
+
+import com.votogether.domain.alarm.exception.AlarmExceptionType;
+import com.votogether.global.exception.BadRequestException;
+import java.util.Arrays;
+
+public enum AlarmActionType {
+
+ CONTENT,
+ REPORT,
+ ;
+
+ public static AlarmActionType from(final String actionType) {
+ return Arrays.stream(AlarmActionType.values())
+ .filter(alarmActionType -> alarmActionType.name().equals(actionType))
+ .findFirst()
+ .orElseThrow(() -> new BadRequestException(AlarmExceptionType.NOT_FOUND_ACTION_TYPE));
+ }
+
+}

backend/src/main/java/com/votogether/domain/alarm/exception/AlarmExceptionType.java

@@ -0,0 +1,23 @@
+package com.votogether.domain.alarm.exception;
+
+import com.votogether.global.exception.ExceptionType;
+import lombok.Getter;
+
+@Getter
+public enum AlarmExceptionType implements ExceptionType {
+
+ NOT_FOUND_ACTION(1300, "신고조치알림이 존재하지 않습니다."),
+ NOT_FOUND(1301, "알림이 존재하지 않습니다."),
+ NOT_OWNER(1302, "알림을 읽을 대상이 아닙니다."),
+ NOT_FOUND_ACTION_TYPE(1303, "등록되지 않은 알림 동작입니다."),
+ ;
+
+ private final int code;
+ private final String message;
+
+ AlarmExceptionType(final int code, final String message) {
+ this.code = code;
+ this.message = message;
+ }
+
+}