[BE] refactor: 발자국 리팩터링 #92

takoyakimchi · 2024-07-17T06:42:45Z

이슈

발자국 기능 리팩터링 #79

개발 사항

해커톤 때 만든 코드에서 구조 및 가독성 개선
API 명세를 위한 테스트 코드 작성
로직 변경 X

전달 사항

Spring REST Docs 템플릿 관련 논의가 필요할 것 같아요. 나중에 하나로 묶어서 부모 클래스 만들어도 될 듯.
커스텀 예외를 만드는 것도 좋을 것 같네요. 이것도 나중에 같이 작업해봐요.

비고

ehtjsv2

리팩토링 좋아요~~

ehtjsv2 · 2024-07-17T07:17:40Z

backend/src/main/java/com/woowacourse/friendogly/footprint/domain/Location.java

@@ -1,5 +1,7 @@
 package com.woowacourse.friendogly.footprint.domain;

+import static java.lang.Math.*;


인텔리제이에서 자동으로 와일드카드를 사용하게 하는 옵션이 켜져있는 걸까요?

reformat 단축키 누르니까 잘 되네요 ,...!

jimi567 · 2024-07-17T08:32:55Z

backend/src/main/java/com/woowacourse/friendogly/footprint/domain/Location.java

-    private double radToDeg(double rad) {
-        return (rad * 180 / Math.PI);
+        dist = toDegrees(acos(dist));
+        return abs(dist * 60 * 1.1515 * 1609.344);


return abs(dist * 60 * 1.1515 * 1609.344);

이 부분 공식에서 각 값에 의미를 부여하기 힘들다면,
해당 반환문을 메서드로 따로 빼서 네이밍 해주면 이해하기 쉬울 것 같은데 어떠신가요?

이 부분은 어차피 공식이 워낙 복잡해서 하나의 메서드로 가져가도 될 것 같아요...!

jimi567 · 2024-07-17T08:35:46Z

...d/src/test/java/com/woowacourse/friendogly/footprint/controller/FootprintControllerTest.java

+@AutoConfigureRestDocs
+@WebMvcTest(FootprintController.class)
+class FootprintControllerTest {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @Autowired
+    private ObjectMapper objectMapper;
+
+    @MockBean
+    private FootprintCommandService footprintCommandService;


이거 RestDocs Base 코드 있어요. 추상 클래스라서 예시 Member 문서 테스트 참고해서 다시 작성해주시면 감사하겠습니다.

jimi567 · 2024-07-17T08:44:03Z

backend/src/main/java/com/woowacourse/friendogly/footprint/service/FootprintCommandService.java

@@ -20,7 +20,7 @@ public class FootprintCommandService {

    public Long save(SaveFootprintRequest request) {
        Member member = memberRepository.findById(request.memberId())
-            .orElseThrow(() -> new IllegalArgumentException("멤버 없음"));
+            .orElseThrow(() -> new IllegalArgumentException("존재하지 않는 사용자 ID입니다."));


이 부분도 저희 커스텀 예외 만들어둔걸로 대체해주세요.!

예외처리 repo로 내리는건 추후에 service 두꺼워지면 고려해봅시다

반영했습니다 👍

J-I-H-O

트레~ 고생했어요
코멘트 확인 부탁드려요!

J-I-H-O · 2024-07-17T07:52:55Z

backend/src/main/java/com/woowacourse/friendogly/footprint/service/FootprintCommandService.java

-            .orElseThrow(() -> new IllegalArgumentException("멤버 없음"));
+            .orElseThrow(() -> new IllegalArgumentException("존재하지 않는 사용자 ID입니다."));


#93
develop 브랜치 rebase 후에 IllegalArgumnetException 대신 Custom Exception 사용해주세요!

J-I-H-O · 2024-07-17T08:11:43Z

backend/src/main/java/com/woowacourse/friendogly/footprint/service/FootprintQueryService.java

-    private static final int HOURS_AGO = 24;
+    private static final int FOOTPRINT_REMAIN_HOURS = 24;


해당 상수는 실제로 현재 시간으로 부터 n시간 이내 를 나타내는데 사용되는 반면,
REMAIN_HOURS 라는 네이밍은 남은 시간 이라는 의미가 강한 것 같아요. 조금 더 적절한 네이밍을 고민해보면 좋겠습니다!

J-I-H-O · 2024-07-17T08:20:36Z

backend/src/main/java/com/woowacourse/friendogly/footprint/domain/Location.java

-    private double degToRad(double deg) {
-        return (deg * Math.PI / 180.0);
-    }
+    private double distanceAsMeter(Location other) {


Suggested change

private double distanceAsMeter(Location other) {

private double calculateDistanceAsMeter(Location other) {

메서드명은 동사로 시작하는게 좋겠습니당

동사로 통일!! 👍

J-I-H-O · 2024-07-17T08:30:37Z

backend/src/main/java/com/woowacourse/friendogly/footprint/domain/Location.java

    private double latitude;
    private double longitude;


약어만 사용하거나, 정확한 표현만 사용하거나 둘 중 하나로 통일하면 좋겠어요.

추가로 약어를 사용하는게 과연 좋을지 잘 모르겠어요.
오랜 시간이 지나고 해당 도메인을 유지보수할 때, 경도 를 나타내는 표현이 lon 이었는지 lng 였는지 헷갈리지 않을까요?

또 여러 개발자들과 협업하는 상황에서는 인지 비용을 줄이기 위해서라도 정확한 표현을 사용하는 것이 좋지 않을까 생각합니다. 쿼리 파라미터에서도 사용될 표현이기 때문에 안드로이드 크루들도 인지해야 한다는 점 또한 고려해야겠네요.

개인적으로, 적어도 협업에 있어서는 개발의 간편함 보다는 이해하기 쉬운 코드를 작성하는 것이 더 높은 우선순위를 가져야하지 않나 싶습니다.

투기장 오픈, 아무나 참전 가능(1/8)

query parameter를 짧게 가져가고 싶은 욕심이 있었는데, 일관성까지 챙기기는 확실히 어렵네요.

- Swaager UI , api 테스트 가능하도록 하기 위해 CORS 설정 추가

github-actions · 2024-07-17T10:28:51Z

Unit Test Results

20 tests 20 ✔️ 3s ⏱️
  8 suites   0 💤
  8 files   0 ❌

Results for commit 451caa7.

♻️ This comment has been updated with latest results.

github-actions · 2024-07-17T10:29:23Z

Test Results

3 tests 3 ✅ 0s ⏱️
1 suites 0 💤
1 files 0 ❌

Results for commit 451caa7.

♻️ This comment has been updated with latest results.

이에 따라 API 명세 변경

takoyakimchi added 7 commits July 17, 2024 14:14

refactor: 위도, 경도로 거리 계산하는 메서드 가독성 개선

9dbc53a

refactor: 반경 meter의 기준을 메서드의 파라미터로 넣을 수 있게 변경

1c73276

refactor: 변수명 및 상수명 가독성 개선

f4eb4df

refactor: 예외 메시지 구체화

51fb137

refactor: Query Parameter를 DTO로 받도록 변경

feec061

refactor: 주변 발자국 조회 명세에서 축약어 사용

117b737

test: FootprintController REST Docs용 테스트 추가

cd088ae

takoyakimchi requested review from jimi567, ehtjsv2 and J-I-H-O July 17, 2024 06:42

takoyakimchi self-assigned this Jul 17, 2024

takoyakimchi linked an issue Jul 17, 2024 that may be closed by this pull request

발자국 기능 리팩터링 #79

Closed

ehtjsv2 previously approved these changes Jul 17, 2024

View reviewed changes

jimi567 requested changes Jul 17, 2024

View reviewed changes

J-I-H-O requested changes Jul 17, 2024

View reviewed changes

jimi567 and others added 7 commits July 17, 2024 19:27

chore: api문서 자동화 의존성 추가

e1b21fb

test: 문서용 테스트 base클래스 및 예시 테스트 작성

9eff84d

feat: CORS 설정 추가

af6464b

- Swaager UI , api 테스트 가능하도록 하기 위해 CORS 설정 추가

[BE] feat: 커스텀 예외 도입 및 GlobalExceptionHandler 처리 예외 수정 (#93)

b7ec36e

[BE] chore: CI 구축 (#87)

231cc29

[AN] feat: 채팅 ui 구현 (#83)

d4e8569

refactor: 메서드명을 동사로 시작하도록 변경

a4b9402

takoyakimchi dismissed ehtjsv2’s stale review via a4b9402 July 17, 2024 10:27

takoyakimchi and others added 5 commits July 17, 2024 19:31

refactor: 예외 클래스 변경

504b713

refactor: 상수 이름 변경

a12912a

refactor: 위도, 경도 축약어 사용하지 않도록 변경

39baf3c

이에 따라 API 명세 변경

test: 발자국 API 문서화 클래스를 포맷에 맞게 수정

4e350b1

[BE] refactor: 회원 도메인 리팩토링 (#95)

451caa7

J-I-H-O approved these changes Jul 18, 2024

View reviewed changes

takoyakimchi mentioned this pull request Jul 18, 2024

[BE] refactor: 발자국 리팩터링 - rebase 관련 이슈 해결 버전 #105

Merged

takoyakimchi closed this Jul 18, 2024

takoyakimchi deleted the feat/backend/footprint branch July 18, 2024 07:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BE] refactor: 발자국 리팩터링 #92

[BE] refactor: 발자국 리팩터링 #92

takoyakimchi commented Jul 17, 2024 •

edited

Loading

ehtjsv2 left a comment

ehtjsv2 Jul 17, 2024 •

edited

Loading

takoyakimchi Jul 17, 2024

jimi567 Jul 17, 2024

takoyakimchi Jul 17, 2024

jimi567 Jul 17, 2024

jimi567 Jul 17, 2024

takoyakimchi Jul 17, 2024

J-I-H-O left a comment

J-I-H-O Jul 17, 2024

J-I-H-O Jul 17, 2024

J-I-H-O Jul 17, 2024

takoyakimchi Jul 17, 2024

J-I-H-O Jul 17, 2024

takoyakimchi Jul 17, 2024

github-actions bot commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024 •

edited

Loading

		@@ -1,5 +1,7 @@
		package com.woowacourse.friendogly.footprint.domain;

		import static java.lang.Math.*;

		.orElseThrow(() -> new IllegalArgumentException("멤버 없음"));
		.orElseThrow(() -> new IllegalArgumentException("존재하지 않는 사용자 ID입니다."));

		private static final int HOURS_AGO = 24;
		private static final int FOOTPRINT_REMAIN_HOURS = 24;

	private double distanceAsMeter(Location other) {
	private double calculateDistanceAsMeter(Location other) {

[BE] refactor: 발자국 리팩터링 #92

[BE] refactor: 발자국 리팩터링 #92

Conversation

takoyakimchi commented Jul 17, 2024 • edited Loading

이슈

개발 사항

전달 사항

비고

ehtjsv2 left a comment

Choose a reason for hiding this comment

ehtjsv2 Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

J-I-H-O left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jul 17, 2024 • edited Loading

Unit Test Results

github-actions bot commented Jul 17, 2024 • edited Loading

Test Results

takoyakimchi commented Jul 17, 2024 •

edited

Loading

ehtjsv2 Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024 •

edited

Loading

github-actions bot commented Jul 17, 2024 •

edited

Loading