Agenda Service and Controller 기능 구현 - [merged]

[halucinor]

Merges feature/agendaService -> dev

@mentor/mentor_2023.01

📝 Description

안건 생성, 조회 기능 구현

💻 How To Test

### 💽 Commits 구현 사항 요약 1. Agenda repository, service, controller 구현 2. 관련 dto 및 user, vote entity 구현 ### 🖼 결과 ex) 실행, 테스트 결과 또는 사진 첨부

[halucinor]

In GitLab by @Kai on Jan 10, 2023, 16:02

Commented on src/main/java/com/gabia/evoting/web/dto/AgendaResponseDto.java line 31

컨벤션을 현재 다시 수정하고 있는건가요? snake_case 형태가 있는데 변경을 안하는 이유가 혹시 따로 있는지 궁금해서 물어봅니다.

[halucinor]

In GitLab by @Kai on Jan 10, 2023, 16:02

Commented on src/main/java/com/gabia/evoting/web/AgendaController.java line 64

PutMapping 을 사용하기에는 조금 아쉬워 보입니다. 다른 HTTP Method 가 있는지 한번 찾아보세요.

[halucinor]

In GitLab by @Kai on Jan 10, 2023, 16:02

Commented on src/main/java/com/gabia/evoting/web/AbstractController.java line 47

현재 AbstractController 라는 추상 클래스는 어떤 역할을 하기 위한 클래스인가요?

그리고 getUser, isGuestUser 메서드는 나중에 Controller 에서 사용하기 위해 미리 정의한 것인가요?

[halucinor]

python에서 사용하던 컨벤션이 손에 익어 가끔 snake_case 형태가 나오는 거 같습니다;; 😅 컨벤션은 가독성을 위해 camel case로 변경하려고 하고 있습니다. 찾아주셔서 감사합니다!

[halucinor]

In GitLab by @Charlie on Jan 10, 2023, 16:12

Commented on src/main/java/com/gabia/evoting/web/AgendaController.java line 47

HTTP Status Code 는 무엇이 있고 각각은 무엇을 의미하나요? 설계하신 각 API 응답에 응답 코드가 적합한지를 고민해보시면 좋을 것 같네요.

[halucinor]

put vs patch

• put : 자원의 모든 데이터 변경
• patch : 자원의 부분적 데이터 변경

PatchMapping 으로 변경해보겠습니다 :D

[halucinor]

AbstractController는 컨트롤러에서 공통적으로 사용할 기능에 대한 추상화와 구현을 위한 클래스입니다.

• Response시 return 값의 형태를 통일하기 위한 메서드
• api를 호출한 사용자에 대한 정보 가지고 오기위한 getUser, isGuestUser

인증 기능을 구현하면서 기능을 추가하거나 제거할 계획입니다.

[halucinor]

In GitLab by @Pablo on Jan 10, 2023, 16:30

Commented on src/main/java/com/gabia/evoting/service/AgendaService.java line 23

단순 조회가 발생되는 서비스 로직 같은데 @Transactional 어노테이션을 활용하신 이유가 있을까요?

[halucinor]

복붙하다가 @Transectional이 같이 들어간것 같습니다...

[halucinor]

다음 상태코드에 대한 문서를 확인하여 수정하겠습니다.

HTTP 상태 코드

[halucinor]

changed this line in version 2 of the diff

[halucinor]

changed this line in version 2 of the diff

[halucinor]

changed this line in version 2 of the diff

[halucinor]

added 1 commit

• 0831bff8 - 1. convention fix

Compare with previous version

[halucinor]

In GitLab by @Pablo on Jan 10, 2023, 16:48

Commented on src/main/java/com/gabia/evoting/service/AgendaService.java line 23

확인했습니다. :smiley:

[halucinor]

In GitLab by @Luke on Jan 10, 2023, 16:50

Commented on src/main/java/com/gabia/evoting/service/AgendaService.java line 36

빌더 패턴에 대해서 찾아보면 좋을듯 싶습니다 :)

[halucinor]

changed this line in version 3 of the diff

[halucinor]

added 1 commit

• c8852355 - agendamodel builder 패턴 적용

Compare with previous version

[halucinor]

builder 패턴 적용해서 코드 수정해봤습니다 :smile:

[halucinor]

In GitLab by @Charlie on Jan 10, 2023, 17:12

Commented on src/main/java/com/gabia/evoting/web/dto/AgendaResponseDto.java line 31

코딩 컨벤션은 실수가 나올 수 있고, 여러 작업자가 함께 개발한다면 컨벤션은 더욱 지켜지기 어려울 수 있습니다.

이런 문제를 해결할 수 있는 방법이 무엇이 있을지 고민해보는 것도 좋은 경험이 될 것 같네요.

[halucinor]

In GitLab by @Charlie on Jan 10, 2023, 17:14

Commented on src/main/java/com/gabia/evoting/web/AgendaController.java line 64

/agenda 라는 URL 은 적합한가요? collection 과 resource 의 차이는 무엇인지 생각해보세요.

[halucinor]

In GitLab by @Pablo on Jan 10, 2023, 17:20

Commented on src/main/java/com/gabia/evoting/web/AbstractController.java line 27

~QUESTION

successMessage 메서드는 올바른 응답 결과의 구조를 통일하기 위해 작성하신 것 같은데,
그럼 Controller에서 failureMessage 메서드는 어떻게 활용하실 계획인가요?

[halucinor]

failureMessage 에는 실패 사유에 대한 간단한 description을 data에 넣어 return 하려고 생각 중 입니다.

[halucinor]

In GitLab by @Pablo on Jan 11, 2023, 20:10

Commented on src/main/java/com/gabia/evoting/web/AbstractController.java line 27

~QUESTION

failureMessage 에는 실패 사유에 대한 간단한 description을 data에 넣어 return 하려고 생각 중 입니다.

현재로선 실패라는 부분이 올바른 성공 케이스의 API 응답이 아닌 경우 정도라고 생각하고 질문드립니다.

어떤 경우의 실패를 나타내기 위함인지 예를 들어 말씀해주실 수 있을까요?
(Service 로직에서 의도한 실패인지, 의도하지 않은 실패인지, 혹은 둘다 포함하는지)
또 그러한 무언가의 실패가 발생했을 때, Controller에서 코드로 어떻게 표현할 생각이신가요?

또한 실패라는 경우가 예외가 발생된 경우라면,
예외 발생했을 때 Controller에서 failureMessage 메서드를 활용하는 것 보다
통일된 API 응답 구조를 나타낼 수 있는 더 좋은 방안이 있을 것 같습니다.

[halucinor]

collection은 자원의 집합 그리고 resource는 하나의 자원을 의미합니다.

단일 agenda에 대한 변경 URI를 다음과 같이 변경하겠습니다. PUT /agenda -> PATCH /agendas/{id}

[halucinor]

제가 구현 시 생각했던 실패는

• Service 로직에서 의도한 실패
• 사용자의 잘못된 요청에 의한 실패

이 두가지를 모두 포함하고 있습니다. 지금 구현된 상태로는, 실패에 대한 정의가 모호하여 통일된 구조로 API 응답을 하기 힘들거 같습니다. :disappointed:

HTTP 상태 코드를 참고하여 여러 상황에 따른 예외처리 로직을 따로 구현하는 방향으로 다시 구현해보겠습니다.

참고 https://velog.io/@aidenshin/Spring-Boot-Exception-Controller

[halucinor]

resolved all threads

[halucinor]

changed this line in version 4 of the diff

[halucinor]

added 1 commit

• d5da236d - uri 수정 및 상태코드 변경

Compare with previous version

[halucinor]

TODO

1. http 상태 코드에 따른 API 응답 예외처리 로직 구현

dev 브랜치로 머지 후 나머지 내용에 완료되지 않은 부분에 대해 다시 구현하겠습니다 :smile:

[halucinor]

approved this merge request

[halucinor]

mentioned in commit 24f4e54e56c7660fc13f01ea3f79a825ef031d92

[halucinor]

In GitLab by @Pablo on Jan 12, 2023, 13:10

Commented on src/main/java/com/gabia/evoting/web/AbstractController.java line 27

HTTP 상태 코드를 참고하여 여러 상황에 따른 예외처리 로직을 따로 구현하는 방향으로 다시 구현해보겠습니다.

~CHECK

• Service 로직에서 의도한 실패
• 사용자의 잘못된 요청에 의한 실패

사용자의 잘못된 요청에 의한 실패 또한 실패 케이스를 어떠한 관점으로 보는지에 따라 의도한 실패로 간주할 수 있을 것 같습니다.

[halucinor]

In GitLab by @Pablo on Jan 12, 2023, 13:10

resolved all threads

[halucinor]

In GitLab by @Charlie on Jan 12, 2023, 13:23

Commented on src/main/java/com/gabia/evoting/web/AgendaController.java line 64

~CHECK