[TIL] 원티드 프리온보딩 백엔드 인턴십 Week1) 3일차, 0822

오늘은 두번째 세션이 있는 날이었다.

✔️ 오늘 한 일

• 2차 오프라인 세션 참여
• ERD 설계 보완
• API 명세 보완
• 디렉토리 구조 설정
• 역할 분담 구체화
• GitHub Labels 설정
• Jira 스토리 및 GitHub 이슈 생성
• Discord와 GitHub 연동을 위해 WebHook 설정
• Post 관련 도메인, 서비스, 레포지토리 생성
• Docker 설치

👀 오늘의 이슈

1. 게시물 해시태그 JSON 응답 타입

• 배경 : 복수의 해시태그 데이터를 다루는 JSON 응답 타입을 결정하는 과정에서 String과 List 중에 어떤 타입으로 사용할지 고민함
• 분석
  • String
    • 장점 : 데이터를 단일 문자열로 반환하기 때문에 간단하고 직관적일 수 있음
    • 단점 : split 함수 등을 이용해 데이터의 문자열을 분리하는 작업 필요
  • List
    • 장점 : 해시태그가 이미 리스트로 분리되어 있기 때문에 가공할 필요가 없음. 구조가 명확하며, 이후 데이터 처리 시 쉽게 활용 가능
    • 단점 : 리스트 타입으로 제공되기 때문에 서버에서 추가적인 메모리가 필요할 수 있음
• 결론 : 데이터 구조의 명확성을 고려하여 리스트라는 것이 명시되어 있는 List 타입으로 결정함

2. 커밋 메시지 형식

• 배경 : 커밋 메시지에 이슈번호를 부착할지에 대해 고민함
• 분석
  • 장점 : 이슈번호 부착 시 관련 이슈를 쉽게 추적할 수 있어 협업 및 코드 리뷰 과정에서 유용함. 문제 발생 시 특정 커밋과 관련된 이슈를 빠르게 파악가능
  • 단점 : 매 커밋 시 이슈번호를 확인하고 기재하는 추가 작업이 필요함. 단기간 프로젝트에서는 이러한 작업이 반복되어 생산성을 저하할 가능성이 있음
• 결론 : 프로젝트의 단기간이라는 특성과 생산성을 고려하여 이슈번호를 커밋 메시지에서 제외하기로 결정함. 이를 통해 작업 속도를 높이고, 간결한 커밋 메시지 형식을 유지
  * 결정된 형식 : [Feat] 제목

💡 Today I Learned

1. WebHook을 설정하여 Discord와 Github를 연동할 수 있다.

• 연동 방법을 블로그에 정리해보았다.
  🔗 https://velog.io/@ryuneng2/GitHub-WebHook을-통해-Discord와-GitHub-연동하기

2. ServiceImpl 패턴

• 모든 Service 계층을 ServiceImpl로 구현하면 더 객체지향적인 코드를 작성할 수 있다.
  단점은 조금 더 번거롭고, 복잡해질 수 있다는 점이다. 그러나 유지보수성 측면에서 중요한 이점이 있다.

 

---

< 해당 글은 velog에서 이전하며 옮겨온 글로, 가독성이 좋지 않을 수 있는 점 양해 부탁드립니다. >

🔗 velog 버전 보기 : https://velog.io/@ryuneng2/TIL-원티드-프리온보딩-백엔드-인턴십-Week1-3일차-0822