매우 늦은 해커톤 후기와 나의 첫 백엔드로써 프로젝트에서 내 코드리뷰를 해볼 생각이다.
지금은 갓태어난 새 라면 이때는 알에 있었던 시기라고 할 수 있다. 그래도 운이 좋아서 이렇게 친구덕에 해커톤 경험도 해보고 너무 좋은 경험이였다. 성장 할 수 있는 곳에 가서 나의 실력을 매우 성장하고 싶다. 오히려 늦은 후기가 지금은 더 좋은 것 같다. 그 이유는 그때 보다 성장한 내가 그때 내가 했던 것을 보는건 좋은 경험이 될 것 같기 때문이다.

---

해커톤 후기

해커톤을 처음 가봤는데 사람이 진짜 진짜 많았다.. 다른 학교들 사람들도 보면서 내가 이런 경험도 해보다니 너무 좋은 경험이라고 생각했다.

친구들이랑 이런 사진도 찍구

날씨도 너무너무 좋았다~
여러가지 부스 체험도 해보고 팀원끼리 이야기도 나누면서 새벽을 보내고 좋은 경험이였다~

내가 백엔드로 가고 첫 프로젝트였는데 간단한 CRUD 구현과 네이버 뉴스 API 활용하는 담당을 맡았다.
솔직히 지금도 모르겠지만, 저 때는 내가 할 수 있을까? 라는 생각이 들었던것 같다.
간단한 CRUD 구현조차 구글링과 gpt의 도움을 받고, 네이버 뉴스 API 활용하는것은 구글링과 네이버 공식 문서 및 gpt를 쓰는데도 시간이 많이 걸렸다.
하지만 이렇게 하면서 성장을 많이 한것 같다.

내가 맡은 부분 중 2가지를 봐볼건데 좋아요 기능과 네이버뉴스 API를 활용하는 것이다.

---

첫 해커톤 프로젝트 리뷰 : 좋아요 기능과 네이버 뉴스 API 활용기

Code Review : 좋아요(Like) 기능 구현 및 개선 포인트

• 프로젝트 구조

  like/
  ├── common/
  │ └── ResponseResult.java
  ├── controller/
  │ └── LikeController.java
  ├── dto/
  │ └── LikeRequestDTO.java
  ├── entity/
  │ └── Like.java
  ├── exception/
  │ └── CustomException.java
  ├── repository/
  │ └── LikeRepository.java
  └── service/
  ㅒ └── LikeService.java

프로젝트 구조는 각 계층별 역할을 분리하여 유지보수와 확장에 용이한 구조가 아닐까 생각한다! (GPT 최고!)
근데 나중에 프로젝트할때 같이 하는 사람마다 다르게 분류할 수 도 있다는 것을 깨달았다!

<각 파일 및 코드 리뷰>

(common)

• ResponseResult.java
  역할: API 응답 구조(성공 여부, 데이터, 에러 메시지) 통일 관리
  아쉬운 점: 응답에 타임스탬프 등 추가 메타 정보 부족

(controller)

• LikeController.java
  역할: 클라이언트의 좋아요 추가/삭제 요청을 받아 서비스 호출 및 결과 반환
  아쉬운 점: 중복 try-catch로 인한 코드 반복, 글로벌 예외 처리 미적용

(dto)

• LikeRequestDTO.java
  역할: 좋아요 요청에 필요한 postId 데이터 캡슐화
  아쉬운 점: 향후 확장 대비 추가 데이터 고려 부족

(entity)

• Like.java
  역할: 좋아요 정보를 DB에 매핑, Board와 Member와의 연관관계 관리
  아쉬운 점: 양방향 연관관계 설정 미검토, 로깅 기능 부재

(exception)

• CustomException.java
  역할: 좋아요 기능 관련 예외 상황 전달
  아쉬운 점: 에러 코드 등 상세 예외 정보 미포함

(repository)

• LikeRepository.java
  역할: DB에서 Like 관련 CRUD 및 존재 여부 확인
  아쉬운 점: 복잡한 쿼리 최적화나 커스텀 쿼리 고려 미흡

(service)

• LikeService.java
  역할: 좋아요 생성/삭제, 중복 체크, 트랜잭션 관리 및 추천수 업데이트
  아쉬운 점: boardService 의존성으로 인한 도메인 간 결합, 이벤트 기반 처리 미고려, 로그 기록 미흡

Code Review : 좋아요(Like) 기능 구현 및 개선 포인트

• 프로젝트 구조

  healthnews/
  ├── client/
  │ └── JsoupCrawling.java
  ├── controller/
  │ └── HealthNewsController.java
  ├── dto/
  │ ├── HealthNewsResponseDto.java
  │ ├── NewsApiResponseDto.java
  │ └── NewsSummaryDto.java
  ├── entity/
  │ └── HealthNews.java
  ├── exception/
  │ ├── NaverApiCallException.java
  │ ├── NewsControllerAdvice.java
  │ └── NewsNullException.java
  ├── repository/
  │ ├── HealthNewsRepository.java
  │ └── NewsApiResponseRepository.java
  └── service/
  ㅐ └── HealthNewsService.java

<각 파일 및 코드 리뷰>

(client)

• JsoupCrawling.java
  역할: Jsoup을 사용해 URL의 HTML을 파싱하고, 지정된 쿼리로 요소(Elements)를 추출하여 반환
  아쉬운 점: 예외 발생 시 단순 e.printStackTrace()에 의존, 로깅 및 재시도 메커니즘 미구현

(controller)

• HealthNewsController.java
  역할: 키워드 기반 건강 뉴스 검색과 사용자 건강 상태 기반 뉴스 제공 API 엔드포인트 관리
  아쉬운 점: 검색과 사용자 뉴스 조회 기능이 혼재, 입력 검증 및 예외 처리 보완 필요

(dto)

• HealthNewsResponseDto.java
  역할: 뉴스 응답 데이터(제목, 링크, 설명, 이미지 URL)를 캡슐화하고 이미지 링크 유효성 검사 제공
  아쉬운 점: 추가적인 메타 정보나 확장 시 고려할 필드 부족

• NewsApiResponseDto.java
  역할: 뉴스 API 응답 데이터를 담고, Naver 뉴스만 필터링 및 HealthNewsResponseDto 변환 제공
  아쉬운 점: JsoupCrawling 인스턴스를 직접 생성하여 DI(의존성 주입) 미적용, 테스트 용이성 저하

• NewsSummaryDto.java
  역할: 뉴스 요약 정보를 담고, 이미지 크롤링을 통해 HealthNewsResponseDto로 변환
  아쉬운 점: JsoupCrawling 의존성을 외부 주입 대신 내부 처리하여 유연성 부족

(entiry)

• HealthNews.java
  역할: 건강 뉴스 엔티티로, DB 테이블과 매핑되어 뉴스 저장 관리
  아쉬운 점: 기본 CRUD 외에 추가 검색이나 비즈니스 로직 반영 미흡

(exception)

• NaverApiCallException.java
  역할: 네이버 API 호출 실패 시 발생하는 커스텀 예외 정의
  아쉬운 점: 디버깅을 위한 추가 정보 제공 미흡

• NewsControllerAdvice.java
  역할: NewsNullException과 NaverApiCallException에 대한 전역 예외 처리
  아쉬운 점: 추가 예외 유형 처리 및 통일된 응답 포맷 적용 필요

• NewsNullException.java
  역할: 뉴스 결과가 없을 경우 발생하는 커스텀 예외 정의
  아쉬운 점: 상세 메시지 및 예외 코드 부여 미흡

(repository)

• HealthNewsRepository.java
  역할: HealthNews 엔티티에 대한 CRUD 작업을 수행하는 Repository
  아쉬운 점: 기본 CRUD 외 추가 검색 조건 및 페이징 기능 미구현

• NewsApiResponseRepository.java
  역할: 네이버 뉴스 API 호출 및 응답 데이터를 Optional 형태로 반환
  아쉬운 점: RestTemplate 사용 시 커넥션 타임아웃, 에러 핸들링 개선 필요

(service)

• HealthNewsService.java
  역할: 네이버 뉴스 API를 통해 뉴스 데이터를 수집, 필터링, 가공하여 최종 HealthNewsResponseDto로 반환 및 DB저장
  아쉬운 점: 반복 API 호출 시 매직넘버(2000, 100, 4)사용, API 제한 고려 및 효율성 개선 필요

---

마무리 한마디

이번 리뷰를 통해서 좋아요 기능과 네이버 뉴스 API 모두에서 전역 예외 처리, 로깅, 의존성 관리 및 API 호출 최적화 등 개선할 부분이 많음을 확인했으니 앞으로 이러한 점들을 보완해 더 안정적이고 확장 가능한 시스템을 만들어보자잇~ 나의 코드를 보는 눈을 더 키워 봅시다!