Merge pull request #119 from KCY-Fit-a-Pet/feat/39

🚧 Push Notification Test API
KCY-Fit-a-Pet · Feb 27, 2024 · 36dd4cc · 36dd4cc
2 parents c999cf9 + 32e088b
commit 36dd4cc
Show file tree

Hide file tree

Showing 37 changed files with 1,193 additions and 25 deletions.
diff --git a/fitapet-app-external-api/.gitignore b/fitapet-app-external-api/.gitignore
@@ -39,4 +39,7 @@ bin/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store
+
+## TEST API ##
+## **/test
diff --git a/...-app-external-api/src/main/java/kr/co/fitapet/api/apis/profile/controller/AccountApi.java b/...-app-external-api/src/main/java/kr/co/fitapet/api/apis/profile/controller/AccountApi.java
@@ -7,6 +7,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
+import kr.co.fitapet.api.apis.profile.dto.DeviceTokenReq;
 import kr.co.fitapet.api.apis.profile.usecase.MemberAccountUseCase;
 import kr.co.fitapet.api.common.response.SuccessResponse;
 import kr.co.fitapet.api.common.security.authentication.CustomUserDetails;
@@ -51,6 +52,14 @@ public ResponseEntity<?> getProfile(@PathVariable("id") Long id) {
         return ResponseEntity.ok(SuccessResponse.from(member));
     }
 
+    @Operation(summary = "디바이스 토큰 등록")
+    @PostMapping("/{id}/device-token")
+    @PreAuthorize("isAuthenticated() and #id == principal.userId")
+    public ResponseEntity<?> postDeviceToken(@PathVariable("id") Long id, @RequestBody @Valid DeviceTokenReq req) {
+        memberAccountUseCase.registerDeviceToken(id, req);
+        return ResponseEntity.ok(SuccessResponse.noContent());
+    }
+
     @Operation(summary = "프로필 검색")
     @Parameter(name = "search", description = "검색할 닉네임", in = ParameterIn.QUERY, required = true)
     @GetMapping("")

diff --git a/...pet-app-external-api/src/main/java/kr/co/fitapet/api/apis/profile/dto/DeviceTokenReq.java b/...pet-app-external-api/src/main/java/kr/co/fitapet/api/apis/profile/dto/DeviceTokenReq.java
@@ -0,0 +1,23 @@
+package kr.co.fitapet.api.apis.profile.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import kr.co.fitapet.domain.domains.device.domain.DeviceToken;
+import kr.co.fitapet.domain.domains.member.domain.Member;
+
+@Schema(description = "디바이스 토큰 등록 요청")
+public record DeviceTokenReq(
+        @Schema(description = "디바이스 토큰", requiredMode = Schema.RequiredMode.REQUIRED)
+        @NotBlank
+        String deviceToken,
+        @Schema(description = "디바이스 OS", requiredMode = Schema.RequiredMode.REQUIRED)
+        @NotBlank
+        String os,
+        @Schema(description = "디바이스 모델명", requiredMode = Schema.RequiredMode.REQUIRED)
+        @NotBlank
+        String deviceModel
+) {
+        public DeviceToken toEntity(Member member) {
+                return DeviceToken.of(deviceToken, os, deviceModel, member);
+        }
+}
diff --git a/...ternal-api/src/main/java/kr/co/fitapet/api/apis/profile/usecase/MemberAccountUseCase.java b/...ternal-api/src/main/java/kr/co/fitapet/api/apis/profile/usecase/MemberAccountUseCase.java
@@ -1,17 +1,21 @@
 package kr.co.fitapet.api.apis.profile.usecase;
 
 import kr.co.fitapet.api.apis.auth.mapper.SmsRedisMapper;
+import kr.co.fitapet.api.apis.profile.dto.AccountSearchReq;
+import kr.co.fitapet.api.apis.profile.dto.DeviceTokenReq;
+import kr.co.fitapet.api.apis.profile.dto.ProfilePatchReq;
 import kr.co.fitapet.common.annotation.UseCase;
 import kr.co.fitapet.common.execption.BaseErrorCode;
 import kr.co.fitapet.common.execption.GlobalErrorException;
 import kr.co.fitapet.domain.common.redis.sms.type.SmsPrefix;
+import kr.co.fitapet.domain.domains.device.domain.DeviceToken;
+import kr.co.fitapet.domain.domains.device.service.DeviceTokenSaveService;
+import kr.co.fitapet.domain.domains.device.service.DeviceTokenSearchService;
 import kr.co.fitapet.domain.domains.manager.domain.Manager;
 import kr.co.fitapet.domain.domains.manager.service.ManagerSearchService;
 import kr.co.fitapet.domain.domains.member.domain.Member;
 import kr.co.fitapet.domain.domains.member.domain.MemberNickname;
 import kr.co.fitapet.domain.domains.member.dto.AccountProfileRes;
-import kr.co.fitapet.api.apis.profile.dto.AccountSearchReq;
-import kr.co.fitapet.api.apis.profile.dto.ProfilePatchReq;
 import kr.co.fitapet.domain.domains.member.dto.MemberInfo;
 import kr.co.fitapet.domain.domains.member.dto.UidRes;
 import kr.co.fitapet.domain.domains.member.exception.AccountErrorCode;
@@ -41,9 +45,11 @@
 @Slf4j
 public class MemberAccountUseCase {
     private final MemberSearchService memberSearchService;
-
     private final ManagerSearchService managerSearchService;
 
+    private final DeviceTokenSearchService deviceTokenSearchService;
+    private final DeviceTokenSaveService deviceTokenSaveService;
+
     private final ScheduleSearchService scheduleSearchService;
     private final MemoSearchService memoSearchService;
 
@@ -57,6 +63,17 @@ public AccountProfileRes getProfile(Long userId) {
         return AccountProfileRes.from(member);
     }
 
+    @Transactional
+    public void registerDeviceToken(Long memberId, DeviceTokenReq req) {
+        Member member = memberSearchService.findById(memberId);
+
+        if (!deviceTokenSearchService.isExistByMemberIdAndDeviceToken(memberId, req.deviceToken())) {
+            log.info("디바이스 토큰 등록: {}", req);
+            DeviceToken deviceToken = req.toEntity(member);
+            deviceTokenSaveService.save(deviceToken);
+        }
+    }
+
     @Transactional(readOnly = true)
     public MemberInfo searchProfile(Long requesterId, String search) {
         return memberSearchService.findMemberInfo(requesterId, search);

diff --git a/...pp-external-api/src/main/java/kr/co/fitapet/api/apis/test/NotificationTestController.java b/...pp-external-api/src/main/java/kr/co/fitapet/api/apis/test/NotificationTestController.java
@@ -0,0 +1,25 @@
+package kr.co.fitapet.api.apis.test;
+
+import io.swagger.v3.oas.annotations.tags.Tag;
+import kr.co.fitapet.api.common.security.authentication.CustomUserDetails;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@Tag(name = "푸시 테스트 API", description = "push notification을 위한 개발자용 임시 API 입니다. 테스트 후 삭제 예정")
+@RestController
+@RequiredArgsConstructor
+@Slf4j
+@RequestMapping("/api/v2/test/members")
+public class NotificationTestController {
+    private final NotificationTestService notificationTestService;
+
+    @RequestMapping("/push")
+    @PreAuthorize("isAuthenticated()")
+    public void push(@AuthenticationPrincipal CustomUserDetails user) {
+        notificationTestService.push(user.getUserId());
+    }
+}
diff --git a/...t-app-external-api/src/main/java/kr/co/fitapet/api/apis/test/NotificationTestService.java b/...t-app-external-api/src/main/java/kr/co/fitapet/api/apis/test/NotificationTestService.java
@@ -0,0 +1,67 @@
+package kr.co.fitapet.api.apis.test;
+
+import kr.co.fitapet.domain.domains.device.domain.DeviceToken;
+import kr.co.fitapet.domain.domains.device.service.DeviceTokenSearchService;
+import kr.co.fitapet.infra.client.fcm.NotificationDataKey;
+import kr.co.fitapet.infra.client.fcm.NotificationService;
+import kr.co.fitapet.infra.client.fcm.request.NotificationRequest;
+import kr.co.fitapet.infra.client.fcm.request.NotificationSingleRequest;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+import java.util.Map;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class NotificationTestService {
+    private final DeviceTokenSearchService deviceTokenSearchService;
+    private final NotificationService notificationService;
+
+    public void push(Long userId) {
+        log.info("push to {}", userId);
+
+        List<DeviceToken> deviceTokens = deviceTokenSearchService.findDeviceTokensByMemberId(userId);
+        log.info("deviceTokens: {}", deviceTokens);
+
+        log.info("send push message");
+        deviceTokens.forEach(deviceToken -> {
+            NotificationSingleRequest request = NotificationSingleRequest.builder()
+                    .token(deviceToken.getDeviceToken())
+                    .title("푸시 테스트")
+                    .content("푸시 테스트 메시지")
+                    .build();
+
+            notificationService.sendMessage(request);
+        });
+
+        log.info("send push message with image");
+        deviceTokens.forEach(deviceToken -> {
+            NotificationSingleRequest request = NotificationSingleRequest.builder()
+                    .title("이미지 테스트")
+                    .content("푸시 이미지 테스트 메시지")
+                    .imageUrl("https://pkcy.kr.object.ncloudstorage.com/profile/0bb25dde9020.jpeg")
+                    .build();
+
+            notificationService.sendMessage(request);
+        });
+
+        log.info("send push message with data");
+        deviceTokens.forEach(deviceToken -> {
+            NotificationSingleRequest request = NotificationSingleRequest.builder()
+                    .title("데이터 테스트")
+                    .content("푸시 데이터 테스트 메시지")
+                    .data(
+                            Map.of(
+                                    NotificationDataKey.NOTICE_TYPE.getField(), "TEST_TYPE",
+                                    NotificationDataKey.TO_ID.getField(), userId.toString()
+                            )
+                    )
+                    .build();
+
+            notificationService.sendMessage(request);
+        });
+    }
+}
diff --git a/...rnal-api/src/main/java/kr/co/fitapet/api/common/event/notification/AnnouncementEvent.java b/...rnal-api/src/main/java/kr/co/fitapet/api/common/event/notification/AnnouncementEvent.java
@@ -0,0 +1,22 @@
+package kr.co.fitapet.api.common.event.notification;
+
+import kr.co.fitapet.domain.domains.notification.domain.Notification;
+import kr.co.fitapet.domain.domains.notification.type.NotificationType;
+import lombok.Builder;
+
+@Builder
+public record AnnouncementEvent(
+        String title,
+        String content,
+        String imageUrl
+) {
+    public Notification toEntity(Long toId) {
+        return Notification.builder()
+                .title(title)
+                .content(content)
+                .imageUrl(imageUrl)
+                .ctype(NotificationType.ANNOUNCEMENT)
+                .toId(toId)
+                .build();
+    }
+}
diff --git a/...p-external-api/src/main/java/kr/co/fitapet/api/common/event/notification/NoticeEvent.java b/...p-external-api/src/main/java/kr/co/fitapet/api/common/event/notification/NoticeEvent.java
@@ -0,0 +1,76 @@
+package kr.co.fitapet.api.common.event.notification;
+
+import kr.co.fitapet.domain.domains.notification.domain.Notification;
+import kr.co.fitapet.domain.domains.notification.type.NotificationType;
+import kr.co.fitapet.infra.client.fcm.NotificationDataKey;
+import lombok.Builder;
+
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * FCM Push Notification Event를 위한 Data Type Class
+ *
+ * @param memberId Long : 푸시 알림을 받을 회원 ID
+ * @param noticeType {@link NoticeType} : push 알림을 위한 알림 타입
+ * @param notificationType {@link NotificationType} : DB에 저장될 알림 타입
+ * @param title String : 푸시 알림 제목
+ * @param content String : 푸시 알림 내용. {@link NoticeType}에 따라 동적으로 생성
+ * @param imageUrl String : 푸시 알림 이미지 URL (optional)
+ * @param data Map<{@link NotificationDataKey}, String> : 푸시 알림에 포함될 데이터
+ */
+@Builder
+public record NoticeEvent(
+        Long memberId,
+        NoticeType noticeType,
+        NotificationType notificationType,
+        String title,
+        String content,
+        String imageUrl,
+        Map<NotificationDataKey, String> data
+) {
+    public Notification toEntity() {
+        Map<String, Long> idFields = getIdFields();
+
+        return Notification.builder()
+                .title(title)
+                .content(getFormattedContent())
+                .imageUrl(imageUrl)
+                .ctype(notificationType)
+                .fromId(idFields.getOrDefault(NotificationDataKey.FROM_ID.getField(), null))
+                .toId(idFields.getOrDefault(NotificationDataKey.TO_ID.getField(), null))
+                .domainId(idFields.getOrDefault(NotificationDataKey.DOMAIN_ID.getField(), null))
+                .subjectId(idFields.getOrDefault(NotificationDataKey.SUBJECT_ID.getField(), null))
+                .build();
+    }
+
+    /**
+     * data의 정보를 {@link NoticeType}에 따라 동적으로 생성된 content를 반환합니다.
+     * @return String : 동적으로 생성된 content
+     */
+    public String getFormattedContent() {
+        return noticeType.createFormattedContent(getNameFields());
+    }
+
+    private Map<String, Long> getIdFields() {
+        return data.entrySet().stream()
+                .filter(e -> e.getKey().isIdField())
+                .collect(
+                        Collectors.toMap(
+                                e -> e.getKey().getField(),
+                                e -> Long.parseLong(e.getValue())
+                        )
+                );
+    }
+
+    private Map<String, String> getNameFields() {
+        return data.entrySet().stream()
+                .filter(e -> e.getKey().isNameField())
+                .collect(
+                        Collectors.toMap(
+                                e -> e.getKey().getField(),
+                                Map.Entry::getValue
+                        )
+                );
+    }
+}