refactor : Shop

[zuminzi]

목적

Shop 리팩토링

작업 상세 내용

• refactor : Global
• [x] 리팩토링 필요하거나 미사용 로직 임의로 주석 처리
• Favorite과 Shop 도메인의 ShopTitle 코드 (https://github.com/4-frame-photos-map/backend/pull/59/commits/9e26af51da82c889e8dbc27223bc8d994df87b79)
• ResponseReviewDto shopInfo 코드 (https://github.com/4-frame-photos-map/backend/pull/59/commits/07d9fbb3ab4eb24eb35819fc1c7d27d5aa30642a)
• [x] Shop, Favorite 응답 구조 통일
• 성공 후 반환데이터 없을 시 빈 데이터 응답
• [x] 공통 에러 응답(ErrorResponse.class) JsonNaming SnakeCase 반영
• [x] @ RequestParam, @PathVariable을 Validation으로 유효성 검사 시 발생하는 Error Handler 추가
• ConstraintViolationException 500(Server Error)에서 400(Client Error)로
• [error field] msg로 에러메세지 구조화 (이전에는 Validation BindingResult 에러만)

• refactor : Shop 도메인
  • [x] @ NotNull 유효성 검증 어노테이션 올바르게 적용
    • 키워드 검색, 브랜드별 검색 요청 DTO 위도/경도 자료형 Wrapper로 변경
  • [x] 카카오 API 호출 로직 중복 제거
    • 키워드검색, 브랜드별 검색 공통 메서드 사용하도록 수정
    • 키워드검색, 브랜드별 검색 카카오 응답 DTO 통일
    • @JsonProperty로 중복 제거 및 가독성 개선
  • [x] 리뷰 평점, 리뷰 개수 계산하여 update하는 코드 추가
  • [x] 장소 url, 찜 가능 여부, 리뷰 평점, 리뷰 개수 모든 Shop API 응답에 추가
    • 피그마 프로토타입 반영
  • [x] 리스트와 마커형 페이지에서 불필요한 도로명주소 응답에서 제거
    • 피그마 프로토타입 반영
• refactor : 키워드 조회
  • [x] 성공 후 빈 데이터 반환 시 4xx 대신 200 처리
• refactor : 브랜드별 조회
  • [x] 브랜드 파라미터 유효성 검사
    • 대표브랜드(인생네컷, 포토이즘박스, 포토그레이, 하루필름) 여부 체크
  • [x] 브랜드 검색(기존 /brand)과 전체 검색(기존 /marker) 로직 합치기
    • 2km 반경 제한, 거리순 정렬
  • refactor : 상세 조회
  • [x] 카카오 API 장소명 반영하기
    • 카카오 API 호출 대신 요청 파라미터에서 가져오는 방법으로
    • [x] 새로운 요청 파라미터 반영 및 파라미터 유효성 검사
  • [x] 피그마 프로토타입에 반영되지 않은 찜 수 미포함 처리
    • 다음 회의에 논의 필요
  • feat : 간단 조회 (Map Marker 모달용)
  • [x] 개발 완료
  • [x] 상세조회와 공통 메서드 추출
    • 상세조회 로직과 비슷하여 메서드 공유하기 위해 상세조회 응답 DTO가 간단조회 응답 DTO로부터 상속 받음
• refactor : JsonNaming Snake Case 스프링 설정에 추가
  • Shop 도메인 카카오 통신 후 역직렬화에 문제 없는지 테스트
  • 다른 도메인 작동 여부 테스트

    참고 사항

    Jackson Property Naming Strategy 스프링 전체 설정에 작동하지 않는 이슈

    결론

    스프링 전체 설정 대신 필요한 클래스나 필드에 개별 설정 필요

    상황

• 프로젝트에 적용된 jackson-databind 버전 : com.fasterxml.jackson.core:jackson-databind:2.12
• jackson-databind 2.12 공식문서 : PropertyNamingStrategy 비권장(Deprecation)
• Deprecation으로 인해 완전히 지원이 중단되거나 종료된 것은 아니나 일부 기능이 작동하지 않는다는 자료들 존재
• 클래스 단위로 적용되는 @Naming은 PropertyNamingStrategy 대신 PropertyNamingStrategies로 작동

• yml이나 ObjectMapper에도 설정 시도했으나 미작동

  시도 방법 1. yml

  • yml의 property-naming-strategy를 클릭 시 setPropertyNamingStrategy()로 이동
  • setPropertyNamingStrategy()가 PropertyNamingStrategies 클래스에 속한 메서드이므로 작동을 기대했지만 미작동

    # Not Working
    spring:
    jackson:
    property-naming-strategy: SNAKE_CASE

    # Not Working
    spring:
    jackson:
    property-naming-strategy: SnakeCaseStrategy

    # Not Working
    spring:
    jackson:
    property-naming-strategy: 'com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy'

    시도 방법 2. ObjectMapper에 적용 시도

    
    // Not Working
    // JacksonConfig.java

  @Bean public ObjectMapper objectMapper() { return new ObjectMapper() .. .setPropertyNamingStrategy(new PropertyNamingStrategies.SnakeCaseStrategy()); }

PropertyNamingStrategy 관련 참고자료

- [참고자료 1 - StackOverFlow](https://stackoverflow.com/questions/74714449/alternatives-for-propertynamingstrategy-snake-case-or-propertynamingstrategy-sna) - ObjectMapper에 setPropertyNamingStrategy() 미작동 - [참고자료 2 ](https://www.appsloveworld.com/springboot/100/180/springboot-restcontroller-not-recognizing-spring-jackson-property-naming-strategy) - @Naming은 PropertyNamingStrategy 대신 PropertyNamingStrategies로 작동 - [참고자료 3](https://steady-coding.tistory.com/454) - 2021.06 기준 yml에 적용됐던 spring.jackson.property-naming-strategy - [참고자료 4](http://daplus.net/java-%EB%82%99%ED%83%80-%EC%82%AC%EA%B1%B4%EC%97%90-%EC%B0%AC%EC%84%B1%ED%95%98%EC%97%AC-%EB%B0%91%EC%A4%84%EC%9D%84-%EA%B7%B9%EB%B3%B5%ED%95%98%EB%8A%94-%EC%9E%AD%EC%8A%A8/) - yml, ObjectMapper, @Naming, @JsonProperty - [참고자료 5](https://www.tabnine.com/code/java/methods/com.fasterxml.jackson.databind.ObjectMapper/setPropertyNamingStrategy)