feat: 운영진 관리 기능 구현 완료 #648

SongJaeHoonn · 2024-12-28T08:52:21Z

Summary

#642

효율적인 운영진 정보 관리를 위해, 운영진 CRUD를 구현했습니다.

Tasks

운영진 등록 기능
운영진 조회 기능
운영진 수정 기능
운영직 삭제 기능

ETC

MemberManagement 카테고리의 Executive 도메인을 새로 만들었습니다.
현재 Member entity처럼, PK가 학번인 경우 그 값은 고유하고 변경되지 않기 때문에 Executive의 PK도 학번(id)으로 설정했으며, 이 값은 변경할 수 없도록 했습니다.
운영진 직급을 회장,부회장과 같은 문자열로 처리하려고 했으나, 유지보수의 용이성을 위해 Enum으로 관리하도록 했습니다.
정렬 순서는 PRESIDENT -> VICE_PRESIDENT -> GENERAL(학번 순) 입니다.

Screenshot

등록

조회

수정 후 조회

삭제 후 조회

사진 등록

limehee

회장, 부회장, 운영진 등의 정보를 관리하기 위해 이전에 position 테이블을 생성한 적이 있어요. 이번에 작성된 부분과 일부 겹치는 내용이 있어, 두 도메인 중 하나를 삭제하고 통합하는 것이 더 효율적일 것 같아요.

...e/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRegisterController.java

...age/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRemoveController.java

...i/domain/memberManagement/executive/adapter/out/persistence/ExecutivePersistenceAdapter.java

src/main/java/page/clab/api/domain/memberManagement/executive/domain/Executive.java

src/main/java/page/clab/api/global/common/file/application/FileService.java

Copilot reviewed 15 out of 30 changed files in this pull request and generated 1 comment.

Files not reviewed (15)

src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRetrievalService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRegisterService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveUpdateService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRegisterController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRemoveService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRemoveController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/UpdateExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/RemoveExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/RetrieveExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/domain/Executive.java: Evaluated as low risk
src/main/java/page/clab/api/global/common/file/api/FileController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/exception/ExecutiveRegistrationException.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/RegisterExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/dto/mapper/ExecutiveDtoMapper.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/dto/request/ExecutiveUpdateRequestDto.java: Evaluated as low risk

limehee · 2024-12-28T10:20:21Z

.../clab/api/domain/memberManagement/executive/application/dto/request/ExecutiveRequestDto.java

+    private String name;
+
+    @NotNull(message = "{notNull.executive.email}")
+    @Schema(description = "이메일", example = "[email protected]")


There is a typo in the email example: "[email protected]" should be "[email protected]".

Suggested change

@Schema(description = "이메일", example = "clab.coreteam@gamil.com")

@Schema(description = "이메일", example = "clab.coreteam@gmail.com")

@SongJaeHoonn 오탈자 수정 부탁드려요

SongJaeHoonn · 2024-12-29T09:07:25Z

@limehee

회장, 부회장, 운영진 등의 정보를 관리하기 위해 이전에 position 테이블을 생성한 적이 있어요. 이번에 작성된 부분과 일부 겹치는 내용이 있어, 두 도메인 중 하나를 삭제하고 통합하는 것이 더 효율적일 것 같아요.

Position 테이블이 멤버의 직책을 담당하는 것이라고 알고 있었는데, 직책 중 일반 회원, 코어팀도 포함되어 있어 운영진 정보만(회장, 부회장, 운영진) 관리하는 테이블을 하나 더 만들도록 했었습니다.

그런데 다시 보니 겹치는 부분이 상당히 많고, 직책 등록이 더욱 포괄적인 것 같아 Executive도메인을 삭제하고, Position도메인으로 운영진을 관리할 수 있는 로직을 옮기는 방식이 더 좋을 것 같습니다! 감사합니다. 작업 후 다시 리뷰 요청 드리겠습니다.

...e/clab/api/domain/memberManagement/executive/adapter/out/persistence/ExecutiveJpaEntity.java

SongJaeHoonn · 2024-12-30T14:08:18Z

@limehee

Executive 도메인을 삭제하고 Position에 운영진 정보를 등록하고 조회하는 로직을 추가하려고 했으나,
현재 기획하고 구현한 운영진 관리 로직에는 직책 정보만이 아닌 이름, 프로필 사진, 이메일, 관심 분야 등이 있습니다.

Position 도메인 내에서 Member를 외부에서 불러와 운영진 정보를 조회시킬 순 있겠으나, 멤버스 계정에 사용하는 정보와 랜딩페이지에 노출시키고 싶은 정보는 다를 수 있으므로 Executive 테이블을 유지하는 것이 좋다고 생각했습니다. 그렇지만 Position 도메인 내에서 직급 정보를 관리한다고 Executive를 전부 Position 내부에 추가한다는 것은 한 도메인에서 두 책임을 한꺼번에 관리하는 것이라고 생각합니다.

그 이유는, Position은 직책에 관련된 책임만 가지고 Executive는 운영진 정보에 대한 책임을 가지기 때문입니다.

따라서, Executive 테이블 내에 Position정보를 포함하기로 결정해보았습니다.
운영진 조회시, external에서 Position정보를 가져와 조회할 수 있도록 구현했습니다.

검토해주시면 감사하겠습니다!!

limehee

운영진의 기존 서비스 가입 정보를 배제하고 새로 입력받아 랜딩 페이지에 게시하려는 것으로 이해했는데, 제가 해석한 내용이 맞는지 확인 부탁드려요.

랜딩 페이지에 게시되는 정보는 프로필 사진 정도만 변경되고, 학번, 이름, 이메일, 관심 분야 등 나머지 정보는 기존 가입 정보와 동일하게 유지되는 것이 더 적절하지 않을까 싶어요.

limehee · 2024-12-31T07:22:56Z

...lab/api/domain/memberManagement/executive/application/service/ExecutiveRetrievalService.java

+        "PRESIDENT", 1,
+        "VICE_PRESIDENT", 2,
+        "OPERATION", 3
+    );


Enum 상수 값을 외부에서 하드코딩하여 사용하는 방식은 변경 사항이 생겼을 때 문제를 일으킬 가능성이 있어요. 예를 들어, ExecutivePosition에 새로운 값이 추가되거나 기존 값이 변경되었을 때, PRIORITY와 같은 별도의 맵을 수정하지 않으면 데이터 불일치로 인해 의도하지 않은 동작이 발생할 수 있어요.

대안으로, Enum 내부에 우선순위 정보를 포함시키는 방식을 제안해요.

제안

package page.clab.api.domain.memberManagement.executive.domain; import lombok.AllArgsConstructor; import lombok.Getter; @Getter @AllArgsConstructor public enum ExecutivePosition { PRESIDENT("PRESIDENT", "회장", 1), VICE_PRESIDENT("VICE_PRESIDENT", "부회장", 2), GENERAL("GENERAL", "일반 운영진", 3); private final String key; private final String description; private final int priority; public static int getPriorityByKey(String key) { for (ExecutivePosition position : values()) { if (position.getKey().equals(key)) { return position.getPriority(); } } throw new IllegalArgumentException("Invalid ExecutivePosition key: " + key); } }

enum이 수정이 되면 Map도 바뀌어야 하는데 일일이 찾아서 바꾸기 어렵겠네요,, 좋은 지적 감사합니다!

다만 ExecutivePosition은 삭제하고 PositionType을 사용하고 있어서, 방법 강구해서 수정해보도록 하겠습니다.

SongJaeHoonn · 2024-12-31T13:19:33Z

운영진의 기존 서비스 가입 정보를 배제하고 새로 입력받아 랜딩 페이지에 게시하려는 것으로 이해했는데, 제가 해석한 내용이 맞는지 확인 부탁드려요.

랜딩 페이지에 게시되는 정보는 프로필 사진 정도만 변경되고, 학번, 이름, 이메일, 관심 분야 등 나머지 정보는 기존 가입 정보와 동일하게 유지되는 것이 더 적절하지 않을까 싶어요.

일단, 현재 랜딩페이지에서 관리되고 있는 운영진 정보는 클라이언트에서 관리되고 있습니다. 운영진 정보를 받을 때, 운영진들에게 프로필 사진과 이메일 등을 전달받는 것으로 알고 있었습니다.
기존에 정보를 받아 클라이언트에 저장해두는 방식을 서버에 저장해두는 방식으로 생각했습니다.(클라이언트 저장 -> 서버 저장)

또한 운영진 관리 기능을 구현할 때, 기존 가입 정보와 운영진 정보를 일치시키는 것을 생각하고 있긴 했습니다. 물론 이름이나 학번과 같은 경우에는 달라질 일이 없지만, 공공연하게 보여지는 이메일을 바꾸거나 관심분야를 다르게 설정할 수도 있지 않을까 싶어 함께 묶어 등록할 수 있도록 구현해 둔 것이었습니다. 이러한 이유로 Executive도메인을 남겨두게 되었습니다.(책임 분리를 위해 Executive테이블은 필요하다고 생각합니다)
이름과 학번같은 변경되지 않는 요소들은 Member도메인에서 가져와도 될 것 같긴 합니다!

limehee · 2024-12-31T16:41:51Z

또한 운영진 관리 기능을 구현할 때, 기존 가입 정보와 운영진 정보를 일치시키는 것을 생각하고 있긴 했습니다. 물론 이름이나 학번과 같은 경우에는 달라질 일이 없지만, 공공연하게 보여지는 이메일을 바꾸거나 관심분야를 다르게 설정할 수도 있지 않을까 싶어 함께 묶어 등록할 수 있도록 구현해 둔 것이었습니다. 이러한 이유로 Executive도메인을 남겨두게 되었습니다.(책임 분리를 위해 Executive테이블은 필요하다고 생각합니다) 이름과 학번같은 변경되지 않는 요소들은 Member도메인에서 가져와도 될 것 같긴 합니다!

해당 부분은 운영진 분들과도 논의해보는게 좋을 것 같아요. 실제로 이 기능을 이용하는 사용자는 운영진이니까요. Executive 테이블의 필요성은 공감합니다.

Copilot reviewed 20 out of 35 changed files in this pull request and generated 1 comment.

Files not reviewed (15)

src/main/java/page/clab/api/domain/memberManagement/position/domain/PositionType.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRemoveService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRetrievalController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveUpdateController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/dto/mapper/ExecutiveDtoMapper.java: Evaluated as low risk
src/main/java/page/clab/api/external/memberManagement/position/application/port/ExternalRetrievePositionUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRemoveController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/domain/Executive.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/adapter/in/web/ExecutiveRegisterController.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveUpdateService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRegisterService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/service/ExecutiveRetrievalService.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/exception/ExecutiveRegistrationException.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/UpdateExecutiveUseCase.java: Evaluated as low risk
src/main/java/page/clab/api/domain/memberManagement/executive/application/port/in/RemoveExecutiveUseCase.java: Evaluated as low risk

2025-01-01T19:50:01Z

...api/domain/memberManagement/executive/application/dto/request/ExecutiveUpdateRequestDto.java

+    @Schema(description = "이름", example = "홍길동")
+    private String name;
+
+    @Schema(description = "이메일", example = "[email protected]")


The example email provided in the Schema annotation has a typo: '[email protected]' should be '[email protected]'.

Suggested change

@Schema(description = "이메일", example = "clab.coreteam@gamil.com")

@Schema(description = "이메일", example = "clab.coreteam@gmail.com")

limehee

코파일럿에서 지적한 이메일 오탈자만 수정되면, 추가적으로 수정할 부분은 없을 것 같습니다.

SongJaeHoonn added 7 commits December 23, 2024 18:19

feat(ExecutiveJpaEntity): 엔티티 설계

3b54855

feat(ExecutiveRegisterService): 운영진 등록 기능 구현

b9ec0ff

feat(File): 운영진 사진 업로드 API 구현

b0e862a

feat(ExecutiveRetrieve): 운영진 정보 조회 기능 구현

2bd8be6

feat(Executive): 운영진 수정, 삭제 기능 구현

4c3c9aa

feat(ExecutiveRegisterService): 운영진 수정시 검증 로직 추가 작성

ce80cc1

refactor(ExecutiveRegisterController): 어노테이션 추가

2d1be29

SongJaeHoonn added the ✨ Feature 새로운 기능 명세 및 개발 label Dec 28, 2024

SongJaeHoonn requested a review from mingmingmon December 28, 2024 08:52

SongJaeHoonn self-assigned this Dec 28, 2024

SongJaeHoonn requested a review from limehee as a code owner December 28, 2024 08:52

SongJaeHoonn linked an issue Dec 28, 2024 that may be closed by this pull request

운영진 관리 기능 구현 #642

Open

4 tasks

Merge branch 'develop' into feat/#642

99186a3

limehee requested changes Dec 28, 2024

View reviewed changes

limehee requested a review from Copilot December 28, 2024 10:19

Copilot AI reviewed Dec 28, 2024

View reviewed changes

mingmingmon requested changes Dec 30, 2024

View reviewed changes

...e/clab/api/domain/memberManagement/executive/adapter/out/persistence/ExecutiveJpaEntity.java Show resolved Hide resolved

SongJaeHoonn added 5 commits December 30, 2024 22:44

refactor(Executive): ExecutivePosition을 기존의 Position 엔티티와 연계

d62fc19

refactor(Executive): id를 executiveId로 변경 및 로깅 메시지 변경

7e6852f

refactor(FileService): 줄바꿈 변경

0803dd7

refactor(Executive): 관심분야 변수명 변경

2a59ac3

refactor(ExecutivePosition): enum 삭제

9be32fc

refactor(messages): 검증 메시지 프로퍼티 변경

649310b

SongJaeHoonn requested a review from limehee December 30, 2024 14:15

limehee reviewed Dec 31, 2024

View reviewed changes

refactor(ExecutiveRetrievalService): 정렬 우선순위 관리를 enum에서 하도록 변경

6def65f

limehee requested a review from Copilot January 1, 2025 19:48

Copilot AI reviewed Jan 1, 2025

View reviewed changes

limehee approved these changes Jan 1, 2025

View reviewed changes

mingmingmon approved these changes Jan 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 운영진 관리 기능 구현 완료 #648

feat: 운영진 관리 기능 구현 완료 #648

SongJaeHoonn commented Dec 28, 2024

limehee left a comment

Copilot AI left a comment

Copilot AI Dec 28, 2024

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

limehee Jan 1, 2025

SongJaeHoonn commented Dec 29, 2024

SongJaeHoonn commented Dec 30, 2024

limehee left a comment

limehee Dec 31, 2024

SongJaeHoonn Dec 31, 2024

SongJaeHoonn commented Dec 31, 2024

limehee commented Dec 31, 2024 •

edited

Loading

Copilot AI left a comment

Copilot AI Jan 1, 2025

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

limehee left a comment

	@Schema(description = "이메일", example = "clab.coreteam@gamil.com")
	@Schema(description = "이메일", example = "clab.coreteam@gmail.com")

feat: 운영진 관리 기능 구현 완료 #648

Are you sure you want to change the base?

feat: 운영진 관리 기능 구현 완료 #648

Conversation

SongJaeHoonn commented Dec 28, 2024

Summary

Tasks

ETC

Screenshot

limehee left a comment

Choose a reason for hiding this comment

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI Dec 28, 2024

Choose a reason for hiding this comment

limehee Jan 1, 2025

Choose a reason for hiding this comment

SongJaeHoonn commented Dec 29, 2024

SongJaeHoonn commented Dec 30, 2024

limehee left a comment

Choose a reason for hiding this comment

limehee Dec 31, 2024

Choose a reason for hiding this comment

제안

SongJaeHoonn Dec 31, 2024

Choose a reason for hiding this comment

SongJaeHoonn commented Dec 31, 2024

limehee commented Dec 31, 2024 • edited Loading

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI Jan 1, 2025

Choose a reason for hiding this comment

limehee left a comment

Choose a reason for hiding this comment

limehee commented Dec 31, 2024 •

edited

Loading