[admin] refactor: 어드민 도메인 정리 (#428)

mikekks · web-flow · commit a408ead3b9a9 · 2025-08-06T15:41:13.000+09:00
* feat: 클릭 이벤트 및 추천 이벤트 전용 어드민 API 구현

* refactor: 클릭이벤트와 추천이벤트 분리

* refactor: 클릭이벤트와 추천이벤트 분리

* chore: 어드민 엔티티에 주석 추가

* chore: 엔티티 이름 수정으로 인한 변경

* chore: 엔티티 이름 수정으로 인한 클래스이름 변경
diff --git a/layer-admin/src/main/java/org/layer/admin/member/entity/AdminMemberSignupHistory.java b/layer-admin/src/main/java/org/layer/admin/member/entity/AdminMemberSignupHistory.java
@@ -14,6 +14,10 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * 특정 유저의 회원 가입 시점을 저장하는 엔티티
+ * 이 엔티티는 유저의 회원 가입 이벤트를 기록하여, 나중에 회원 가입 이력을 추적할 수 있도록 합니다.
+ */
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
diff --git a/layer-admin/src/main/java/org/layer/admin/retrospect/entity/AdminRetrospectAnswerHistory.java b/layer-admin/src/main/java/org/layer/admin/retrospect/entity/AdminRetrospectAnswerHistory.java
@@ -13,6 +13,9 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/*
+ * 특정 회고의 답변 생성 시점을 저장하는 엔티티
+ */
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
diff --git a/layer-admin/src/main/java/org/layer/admin/retrospect/entity/AdminRetrospectHistory.java b/layer-admin/src/main/java/org/layer/admin/retrospect/entity/AdminRetrospectHistory.java
@@ -12,6 +12,9 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/*
+ * 특정 회고의 생성 시점을 저장하는 엔티티
+ */
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
diff --git a/layer-admin/src/main/java/org/layer/admin/space/entity/AdminMemberSpaceHistory.java b/layer-admin/src/main/java/org/layer/admin/space/entity/AdminMemberSpaceHistory.java
@@ -12,6 +12,9 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/*
+ * 특정 스페이스에 멤버가 참여한 시점을 저장하는 엔티티
+ */
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
diff --git a/layer-admin/src/main/java/org/layer/admin/space/entity/AdminSpaceHistory.java b/layer-admin/src/main/java/org/layer/admin/space/entity/AdminSpaceHistory.java
@@ -16,6 +16,10 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/*
+ * 특정 스페이스의 생성 시점을 저장하는 엔티티
+ * 이 엔티티는 스페이스의 생성 이벤트를 기록하여, 나중에 스페이스의 생성 이력을 추적할 수 있도록 합니다.
+ */
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
diff --git a/layer-admin/src/main/java/org/layer/admin/template/controller/AdminTemplateController.java b/layer-admin/src/main/java/org/layer/admin/template/controller/AdminTemplateController.java
@@ -4,7 +4,7 @@
 import java.util.List;
 
 import org.layer.admin.template.controller.dto.TemplateChoiceCountResponse;
-import org.layer.admin.template.controller.dto.TemplateViewCountResponse;
+import org.layer.admin.template.controller.dto.TemplateClickCountResponse;
 import org.layer.admin.template.enums.AdminChoiceType;
 import org.layer.admin.template.service.AdminTemplateService;
 import org.springframework.http.ResponseEntity;
@@ -30,12 +30,12 @@ public ResponseEntity<List<TemplateChoiceCountResponse>> getTemplateChoiceTotalC
 		return ResponseEntity.ok().body(response);
 	}
 
-	@GetMapping("/admin/template/recommended-list-count")
-	public ResponseEntity<List<TemplateViewCountResponse>> getTemplateRecommendedListCount(
+	@GetMapping("/admin/template/click-count")
+	public ResponseEntity<List<TemplateClickCountResponse>> getTemplateClickCount(
 		@RequestParam(name = "startDate") LocalDateTime startDate,
 		@RequestParam(name = "endDate") LocalDateTime endDate
 	) {
-		List<TemplateViewCountResponse> responses = adminTemplateService.getTemplateRecommendedListCount(
+		List<TemplateClickCountResponse> responses = adminTemplateService.getTemplateClickCount(
 			startDate, endDate);
 
 		return ResponseEntity.ok().body(responses);
diff --git a/layer-admin/src/main/java/org/layer/admin/template/controller/dto/TemplateClickCountResponse.java b/layer-admin/src/main/java/org/layer/admin/template/controller/dto/TemplateClickCountResponse.java
@@ -2,11 +2,11 @@
 
 import org.layer.admin.template.enums.AdminChoiceType;
 
-public record TemplateViewCountResponse(
+public record TemplateClickCountResponse(
 	AdminChoiceType viewType,
 	long count
 ) {
-	public TemplateViewCountResponse(AdminChoiceType viewType, long count) {
+	public TemplateClickCountResponse(AdminChoiceType viewType, long count) {
 		this.viewType = viewType;
 		this.count = count;
 	}
diff --git a/layer-admin/src/main/java/org/layer/admin/template/entity/AdminTemplateChoice.java b/layer-admin/src/main/java/org/layer/admin/template/entity/AdminTemplateChoice.java
@@ -17,6 +17,11 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * 특정 유저의 템플릿 선택 이력을 저장하는 엔티티
+ * 이 엔티티는 유저가 템플릿을 선택한 시점과 관련된 정보를 기록하여, 나중에 템플릿 선택 이력을 추적할 수 있도록 합니다.
+ * 추천을 통해 선택된 템플릿은 AdminChoiceType.RECOMMENDATION으로, 목록에서 선택된 템플릿은 AdminChoiceType.LIST_VIEW로 저장됩니다.
+ */
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
diff --git a/layer-admin/src/main/java/org/layer/admin/template/entity/AdminTemplateClickHistory.java b/layer-admin/src/main/java/org/layer/admin/template/entity/AdminTemplateClickHistory.java
@@ -16,10 +16,14 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * 특정 유저의 템플릿 클릭 이력을 저장하는 엔티티
+ * 이 엔티티는 유저가 [추천받기] 또는 [리스트 보기] 버튼을 클릭한 시점을 기록합니다.
+ */
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
-public class AdminTemplateViewHistory {
+public class AdminTemplateClickHistory {
 	@Id
 	@GeneratedValue(strategy = GenerationType.IDENTITY)
 	private Long id;
@@ -38,7 +42,7 @@ public class AdminTemplateViewHistory {
 	private String eventId;
 
 	@Builder
-	private AdminTemplateViewHistory(AdminChoiceType viewType, LocalDateTime eventTime, Long memberId, String eventId) {
+	private AdminTemplateClickHistory(AdminChoiceType viewType, LocalDateTime eventTime, Long memberId, String eventId) {
 		this.viewType = viewType;
 		this.eventTime = eventTime;
 		this.memberId = memberId;
diff --git a/layer-admin/src/main/java/org/layer/admin/template/listener/TemplateListViewEventListener.java b/layer-admin/src/main/java/org/layer/admin/template/listener/TemplateListViewEventListener.java
@@ -2,7 +2,8 @@
 
 import org.layer.admin.common.UserOnlyEventListener;
 import org.layer.admin.template.service.AdminTemplateService;
-import org.layer.event.template.TemplateListViewEvent;
+import org.layer.event.template.TemplateListViewChoiceEvent;
+import org.layer.event.template.TemplateListViewClickEvent;
 import org.springframework.context.event.EventListener;
 import org.springframework.stereotype.Component;
 
@@ -15,7 +16,13 @@ public class TemplateListViewEventListener {
 
 	@UserOnlyEventListener
 	@EventListener
-	public void handleTemplateListView(TemplateListViewEvent event) {
-		adminTemplateService.saveTemplateListViewHistory(event);
+	public void handleTemplateListViewChoiceEvent(TemplateListViewChoiceEvent event) {
+		adminTemplateService.saveTemplateChoice(event);
+	}
+
+	@UserOnlyEventListener
+	@EventListener
+	public void handleTemplateListViewClickEvent(TemplateListViewClickEvent event) {
+		adminTemplateService.saveTemplateClickHistory(event);
 	}
 }
diff --git a/layer-admin/src/main/java/org/layer/admin/template/listener/TemplateRecommendedEventListener.java b/layer-admin/src/main/java/org/layer/admin/template/listener/TemplateRecommendedEventListener.java
@@ -2,7 +2,8 @@
 
 import org.layer.admin.common.UserOnlyEventListener;
 import org.layer.admin.template.service.AdminTemplateService;
-import org.layer.event.template.TemplateRecommendedEvent;
+import org.layer.event.template.TemplateRecommendedChoiceEvent;
+import org.layer.event.template.TemplateRecommendedClickEvent;
 import org.springframework.context.event.EventListener;
 import org.springframework.stereotype.Component;
 
@@ -15,8 +16,13 @@ public class TemplateRecommendedEventListener {
 
 	@UserOnlyEventListener
 	@EventListener
-	public void handleTemplateRecommended(TemplateRecommendedEvent event) {
-		adminTemplateService.saveTemplateRecommendation(event);
-		adminTemplateService.saveTemplateRecommendedViewHistory(event);
+	public void handleTemplateRecommendedChoiceEvent(TemplateRecommendedChoiceEvent event) {
+		adminTemplateService.saveTemplateChoice(event);
+	}
+
+	@UserOnlyEventListener
+	@EventListener
+	public void handleTemplateRecommendedClickEvent(TemplateRecommendedClickEvent event) {
+		adminTemplateService.saveTemplateClickHistory(event);
 	}
 }
diff --git a/layer-admin/src/main/java/org/layer/admin/template/repository/AdminTemplateChoiceRepository.java b/layer-admin/src/main/java/org/layer/admin/template/repository/AdminTemplateChoiceRepository.java
@@ -10,7 +10,7 @@
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 
-public interface AdminTemplateRecommendationRepository extends JpaRepository<AdminTemplateChoice, Long> {
+public interface AdminTemplateChoiceRepository extends JpaRepository<AdminTemplateChoice, Long> {
 
 	@Query("SELECT new org.layer.admin.template.controller.dto.TemplateChoiceCountResponse(r.formTag, COUNT(r)) " +
 		"FROM AdminTemplateChoice r " +
diff --git a/layer-admin/src/main/java/org/layer/admin/template/repository/AdminTemplateClickHistoryRepository.java b/layer-admin/src/main/java/org/layer/admin/template/repository/AdminTemplateClickHistoryRepository.java
@@ -0,0 +1,17 @@
+package org.layer.admin.template.repository;
+
+import java.time.LocalDateTime;
+import java.util.List;
+
+import org.layer.admin.template.controller.dto.TemplateClickCountResponse;
+import org.layer.admin.template.entity.AdminTemplateClickHistory;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+
+public interface AdminTemplateClickHistoryRepository extends JpaRepository<AdminTemplateClickHistory, Long> {
+	@Query("SELECT new org.layer.admin.template.controller.dto.TemplateClickCountResponse(v.viewType, COUNT(v)) " +
+		"FROM AdminTemplateClickHistory v " +
+		"WHERE v.eventTime BETWEEN :startDate AND :endDate " +
+		"GROUP BY v.viewType ")
+	List<TemplateClickCountResponse> countByViewType(LocalDateTime startDate, LocalDateTime endDate);
+}
diff --git a/layer-admin/src/main/java/org/layer/admin/template/repository/AdminTemplateViewHistoryRepository.java b/layer-admin/src/main/java/org/layer/admin/template/repository/AdminTemplateViewHistoryRepository.java
diff --git a/layer-admin/src/main/java/org/layer/admin/template/service/AdminTemplateService.java b/layer-admin/src/main/java/org/layer/admin/template/service/AdminTemplateService.java
@@ -6,15 +6,17 @@
 import java.util.List;
 
 import org.layer.admin.template.controller.dto.TemplateChoiceCountResponse;
-import org.layer.admin.template.controller.dto.TemplateViewCountResponse;
+import org.layer.admin.template.controller.dto.TemplateClickCountResponse;
 import org.layer.admin.template.entity.AdminTemplateChoice;
-import org.layer.admin.template.entity.AdminTemplateViewHistory;
+import org.layer.admin.template.entity.AdminTemplateClickHistory;
 import org.layer.admin.template.enums.AdminFormTag;
 import org.layer.admin.template.enums.AdminChoiceType;
-import org.layer.admin.template.repository.AdminTemplateRecommendationRepository;
-import org.layer.admin.template.repository.AdminTemplateViewHistoryRepository;
-import org.layer.event.template.TemplateListViewEvent;
-import org.layer.event.template.TemplateRecommendedEvent;
+import org.layer.admin.template.repository.AdminTemplateChoiceRepository;
+import org.layer.admin.template.repository.AdminTemplateClickHistoryRepository;
+import org.layer.event.template.TemplateListViewChoiceEvent;
+import org.layer.event.template.TemplateListViewClickEvent;
+import org.layer.event.template.TemplateRecommendedChoiceEvent;
+import org.layer.event.template.TemplateRecommendedClickEvent;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
@@ -26,62 +28,76 @@
 @RequiredArgsConstructor
 @Slf4j
 public class AdminTemplateService {
-	private final AdminTemplateRecommendationRepository templateRecommendationRepository;
-	private final AdminTemplateViewHistoryRepository templateViewHistoryRepository;
+	private final AdminTemplateChoiceRepository templateChoiceRepository;
+	private final AdminTemplateClickHistoryRepository templateClickHistoryRepository;
 
 	public List<TemplateChoiceCountResponse> getTemplateChoiceCount(
 		LocalDateTime startDate, LocalDateTime endDate, AdminChoiceType choiceType) {
 
-		if( choiceType != null) {
-			return templateRecommendationRepository.countByChoiceType(startDate, endDate, choiceType);
+		if (choiceType != null) {
+			return templateChoiceRepository.countByChoiceType(startDate, endDate, choiceType);
 		}
 
-		return templateRecommendationRepository.countAll(startDate, endDate);
+		return templateChoiceRepository.countAll(startDate, endDate);
 	}
 
-	public List<TemplateViewCountResponse> getTemplateRecommendedListCount(
+	public List<TemplateClickCountResponse> getTemplateClickCount(
 		LocalDateTime startDate, LocalDateTime endDate) {
 
-		return templateViewHistoryRepository.countByViewType(startDate, endDate);
+		return templateClickHistoryRepository.countByViewType(startDate, endDate);
 	}
 
 	@Transactional(propagation = REQUIRES_NEW)
 	@Async
-	public void saveTemplateRecommendation(TemplateRecommendedEvent event) {
-		AdminTemplateChoice recommendation = AdminTemplateChoice.builder()
+	public void saveTemplateChoice(TemplateRecommendedChoiceEvent event) {
+		AdminTemplateChoice choice = AdminTemplateChoice.builder()
 			.formTag(AdminFormTag.from(event.formTag()))
 			.eventTime(event.eventTime())
 			.memberId(event.memberId())
 			.eventId(event.eventId())
 			.choiceType(AdminChoiceType.RECOMMENDATION)
 			.build();
 
-		templateRecommendationRepository.save(recommendation);
+		templateChoiceRepository.save(choice);
 	}
 
 	@Transactional(propagation = REQUIRES_NEW)
 	@Async
-	public void saveTemplateRecommendedViewHistory(TemplateRecommendedEvent event) {
-		AdminTemplateViewHistory viewHistory = AdminTemplateViewHistory.builder()
+	public void saveTemplateChoice(TemplateListViewChoiceEvent event) {
+		AdminTemplateChoice choice = AdminTemplateChoice.builder()
+			.formTag(AdminFormTag.from(event.formTag()))
+			.eventTime(event.eventTime())
+			.memberId(event.memberId())
+			.eventId(event.eventId())
+			.choiceType(AdminChoiceType.LIST_VIEW)
+			.build();
+
+		templateChoiceRepository.save(choice);
+	}
+
+	@Transactional(propagation = REQUIRES_NEW)
+	@Async
+	public void saveTemplateClickHistory(TemplateRecommendedClickEvent event) {
+		AdminTemplateClickHistory clickHistory = AdminTemplateClickHistory.builder()
 			.viewType(AdminChoiceType.RECOMMENDATION)
 			.eventTime(event.eventTime())
 			.memberId(event.memberId())
 			.eventId(event.eventId())
 			.build();
 
-		templateViewHistoryRepository.save(viewHistory);
+		templateClickHistoryRepository.save(clickHistory);
 	}
 
 	@Transactional(propagation = REQUIRES_NEW)
 	@Async
-	public void saveTemplateListViewHistory(TemplateListViewEvent event) {
-		AdminTemplateViewHistory viewHistory = AdminTemplateViewHistory.builder()
+	public void saveTemplateClickHistory(TemplateListViewClickEvent event) {
+		AdminTemplateClickHistory clickHistory = AdminTemplateClickHistory.builder()
 			.viewType(AdminChoiceType.LIST_VIEW)
 			.eventTime(event.eventTime())
 			.memberId(event.memberId())
 			.eventId(event.eventId())
 			.build();
 
-		templateViewHistoryRepository.save(viewHistory);
+		templateClickHistoryRepository.save(clickHistory);
 	}
 }
diff --git a/layer-api/src/main/java/org/layer/domain/form/service/FormService.java b/layer-api/src/main/java/org/layer/domain/form/service/FormService.java
@@ -27,13 +27,12 @@
 import org.layer.domain.space.repository.SpaceRepository;
 import org.layer.domain.template.entity.TemplateMetadata;
 import org.layer.domain.template.repository.TemplateMetadataRepository;
-import org.layer.event.template.TemplateRecommendedEvent;
+import org.layer.event.template.TemplateRecommendedChoiceEvent;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
-import org.springframework.transaction.annotation.Propagation;
 
 import java.util.List;
 import java.util.Optional;
@@ -87,7 +86,7 @@ public RecommendFormResponseDto getRecommendTemplate(RecommendFormQueryDto query
 		Form form = formRepository.findByFormTagAndFormTypeOrThrow(recommandFormTag, FormType.TEMPLATE);
 		TemplateMetadata metadata = metadataRepository.findByFormIdOrThrow(form.getId());
 
-		eventPublisher.publishEvent(new TemplateRecommendedEvent(
+		eventPublisher.publishEvent(new TemplateRecommendedChoiceEvent(
 			customRandom.generateRandomValue(), memberId, recommandFormTag.getTag(), time.now()));
 
 		return RecommendFormResponseDto.of(form, metadata.getTemplateImageUrl());
diff --git a/layer-api/src/main/java/org/layer/domain/stats/StatsTemplateApi.java b/layer-api/src/main/java/org/layer/domain/stats/StatsTemplateApi.java
@@ -0,0 +1,22 @@
+package org.layer.domain.stats;
+
+import org.layer.annotation.MemberId;
+import org.layer.domain.form.enums.FormTag;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+@Tag(name = "[어드민] 템플릿 관련", description = "템플릿 관련한 어드민 기능 API")
+public interface StatsTemplateApi {
+
+	@Operation(summary = "템플릿 리스트 보기 클릭 이벤트", description = "템플릿 리스트 보기를 클릭했을 때 해당 API를 호출합니다.")
+	ResponseEntity<Void> publishTemplateListViewClickEvent(@MemberId Long memberId);
+
+	@Operation(summary = "템플릿 리스트 보기 내에서 선택 이벤트", description = "템플릿 리스트에서 특정 템플릿을 선택했을 때 해당 API를 호출합니다.")
+	ResponseEntity<Void> publishTemplateListViewChoiceEvent(@MemberId Long memberId, @RequestParam FormTag formTag);
+
+	@Operation(summary = "템플릿 추천 클릭 이벤트", description = "템플릿 추천을 클릭했을 때 해당 API를 호출합니다.")
+	ResponseEntity<Void> publishTemplateRecommendedClickEvent(@MemberId Long memberId);
+}
diff --git a/layer-api/src/main/java/org/layer/domain/stats/StatsTemplateController.java b/layer-api/src/main/java/org/layer/domain/stats/StatsTemplateController.java
diff --git a/layer-event/src/main/java/org/layer/event/template/TemplateListViewChoiceEvent.java b/layer-event/src/main/java/org/layer/event/template/TemplateListViewChoiceEvent.java
diff --git a/layer-event/src/main/java/org/layer/event/template/TemplateListViewClickEvent.java b/layer-event/src/main/java/org/layer/event/template/TemplateListViewClickEvent.java
diff --git a/layer-event/src/main/java/org/layer/event/template/TemplateRecommendedChoiceEvent.java b/layer-event/src/main/java/org/layer/event/template/TemplateRecommendedChoiceEvent.java
diff --git a/layer-event/src/main/java/org/layer/event/template/TemplateRecommendedClickEvent.java b/layer-event/src/main/java/org/layer/event/template/TemplateRecommendedClickEvent.java
