Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: 도메인명 변경 (memory -> category, moment -> staccato) #594 #596

Merged
merged 16 commits into from
Jan 19, 2025

Conversation

BurningFalls
Copy link
Contributor

@BurningFalls BurningFalls commented Jan 14, 2025

⭐️ Issue Number

🚩 Summary

구현 작업

  • 도메인명 변경
    • memory -> category
    • moment -> staccato
  • 수정한 부분
    • client의 원활한 작업을 위해 빠른 변경이 필요해서, controller 부분만 변경했습니다.
    • controller, dto, swagger, test

구현 방법

  • 코드의 충돌과 기존 API 삭제의 어려움을 최소화하고자, 전부 새로운 파일을 만들어 수정했습니다.
  • Dto 변경에 따른 서비스 클래스로의 변경 전파를 막기 위해, 서비스와 컨트롤러 사이에 DtoMapper 클래스를 만드는 방식으로 구현했습니다.

클라이언트 api 변경 완료 시 바뀌는 부분

  • memory 및 moment와 관련된 controller, dto, swagger, test 파일 삭제

🙂 To Reviewer

파일을 복사해서 고치는 방식으로 했고 테스트도 전부 구현했기 때문에 큰 문제가 없을 것으로 예상됩니다.
눈으로 코드 전부를 따라가며 코드 리뷰하는 것은 어려움이 있을 것 같아,
pull 받아서 swagger를 확인해보는 방법이 리뷰 과정에 도움이 될 것 같습니다.

📋 To Do

나중에 도메인명 변경 작업에서 이어서 할 부분

  • DB 스키마 변경
  • service, repository, domain 변경

@BurningFalls BurningFalls added backend We are backend>< refactor 리팩토링 (변수 및 메서드 네이밍 변경) labels Jan 14, 2025
@BurningFalls BurningFalls added this to the sprint-9 milestone Jan 14, 2025
@BurningFalls BurningFalls self-assigned this Jan 14, 2025
Copy link

github-actions bot commented Jan 14, 2025

Test Results

 33 files   33 suites   6s ⏱️
238 tests 238 ✅ 0 💤 0 ❌
255 runs  255 ✅ 0 💤 0 ❌

Results for commit dddb310.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jan 14, 2025

🌻Test Coverage Report

Overall Project 78.73% -3.76% 🍏
Files changed 78.85% 🍏

File Coverage
CategoryController.java 100% 🍏
CategoryReadRequest.java 100% 🍏
CategoryIdResponse.java 100% 🍏
StaccatoLocationResponses.java 100% 🍏
StaccatoIdResponse.java 100% 🍏
CategoryDtoMapper.java 97.39% -2.61% 🍏
StaccatoDtoMapper.java 96.3% -3.7% 🍏
StaccatoController.java 87.84% -12.16% 🍏
StaccatoResponse.java 72.97% -27.03% 🍏
CategoryResponse.java 68.75% -31.25%
CategoryRequest.java 68.42% -31.58%
CategoryNameResponse.java 68.18% -31.82%
StaccatoRequest.java 66.28% -33.72%
CategoryDetailResponse.java 65.38% -34.62%
StaccatoLocationResponse.java 63.64% -36.36%
StaccatoDetailResponse.java 63.28% -36.72%
CategoryResponses.java 50% -50%
CategoryNameResponses.java 50% -50%

Copy link
Contributor

@linirini linirini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Controller 계층까지만 수정했는데도 신경 쓸 부분이 많았네요, 고생 많으셨습니다!!
DtoMapper 분리해주신 것도 좋은 것 같아요!
꼼꼼하게 해주신 덕에 코멘트 남길 부분은 별로 없었습니다! 간단하게 남겼으니, 확인 후 재리뷰요청해주세요:)

return new CategoryNameResponses(categoryNameResponses);
}

public static StaccatoResponse toStaccatoResponse(MomentResponse momentResponse) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

하위 메서드에서만 사용하는 것 같네요! 접근 제어자를 private으로 변경해주세요!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

여기뿐만 아니라 StaccatoController에도 있었네요! 두 군데 모두 수정해주었습니다.


import io.swagger.v3.oas.annotations.media.Schema;

@Schema(description = "추억에 대한 응답 형식입니다.")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

추억 발견!

public record CategoryNameResponse(
@Schema(example = "1")
Long categoryId,
@Schema(example = "런던 추억")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

사소하지만 스키마 예시 중에 xx 추억처럼 되어있는 부분들도 같이 변경하면 어떨까요?
런던 추억보다는 런던 여행과 같은 표현이 저희에게는 더 자연스럽게 다가오지 않나 생각했어요:)

Copy link
Contributor Author

@BurningFalls BurningFalls Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

런던 여행으로 수정해주었습니다!
Fixture의 '추억' 단어들은 원래 테스트 파일과 연관되어 있어, 다른 코드들이 머지된 후 수정하겠습니다.

@BurningFalls BurningFalls requested a review from linirini January 17, 2025 07:06
Copy link
Contributor

@linirini linirini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

변경 사항 모두 확인했습니다. 수고 많으셨습니다!
다음주 중으로 도메인명 변경 같이 마무리해보아요:)

Copy link
Contributor

@Junyoung-WON Junyoung-WON left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

도메인 변경하는게 귀찮고 오래걸리는데도 빠르게 잘 바꿔주셨네요!!
고생 많으셨습니다 😄

@BurningFalls BurningFalls requested a review from linirini January 19, 2025 10:46
Copy link
Contributor

@linirini linirini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

확인했습니다! 수고많으셨어요~

@BurningFalls BurningFalls merged commit 7346e49 into develop Jan 19, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend We are backend>< refactor 리팩토링 (변수 및 메서드 네이밍 변경)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants