f-lab-edu / study-together

Study Together

프로젝트 소개

함께 모여 공부하는 온라인 독서실 플랫폼입니다.

사용 기술

Spring Boot Java intellij IDEA H2 Database

기능

회원

• 회원가입
• 로그인, 로그 아웃

스터디룸

• 방 생성(생성한 유저가 방장이 됨)
• 방 입장
• 방 퇴장(방장이 퇴장 시 다른 유저에게 방장 권한 위임)

ERD

https://www.erdcloud.com/d/SXY85jvx7GipunbrM

기술적 고민

예상 UI (제작중)

study-together's Issues

예상 UI 완성 및 프로토타입 UI 프론트엔드 구현

• 예상 UI를 완성해주세요
• 완성된 예상 UI를 가볍게 표현할 수 있을 수준의 프론트엔드 View 영역을 템플릿엔진 (타임리프, JSP등) 으로 구현해주세요

Study Room 퇴장 Service 생성

Study Room 입장/퇴장 API

사용자 스터디룸 입장과 퇴장시 인원 체크 API 설계 및 구현

• API 설계
• API 구현

로그인 체크 중복 로직 제거

매번 로그인 체크를 할 때마다 중복된 로그인 체크 로직이 작성될텐데요, 이를 servlet filter, spring mvc interceptor, aop 중 구현 가능한 방법을 검토해보고 구현해봅시다!

Filter, Interceptor, AOP 차이

• Filter 구현 예시
• Interceptor 구현 예시
• AOP 구현 예시

권한 관리 기능 추가

세션 권한 관리 기능 추가: 권한 생성 로직 및 서비스 구현

로그 활성화 하기 (모든 요청에 대해) Filter 버전

이전에 AOP로 구현했던 로깅을 이번엔 Filter로 구현해봅시다.

구현했던 AOP는 그대로 두어도 되고, 제거해도 됩니다.

• Servlet Filter

Scheduler 생성 API

사용자가 Scheduler을 생성할 때 사용하게 될 API를 설계하고 구현해주세요.

• scheduler 생성시 해당 스케줄러의 todo까지 같이 요청 받을것인지? API를 분리할것인지 고려
• 요청과 응답 디자인을 충분히 고려

요청 e.g.)
POST /api/v1/schedulers

{
 ...
}

응답 e.g.)
201 Created

{
 "schedulerId": 1,
 "todos": [1, 2, 3]
}

Study Room 조회 기능 구현

• 활성화된 전체 스터디룸 조회
• 현재 입장 가능한 스터디룸 조회

Service 레이어 클래스 테스트 코드 작성하기

Service 레이어에 있는 모든 클래스의 테스트 코드를 작성해주세요.

테스트코드를 작성하는 관점에는 여러 방법론이 있습니다.

각 테스트 작성 방법에 대해 학습해보고 적절하게 구현해주세요!

• Classicist
• Mockist

https://dev-monkey-dugi.tistory.com/140

Room 생성 API

사용자가 Room을 생성할 때 사용하게 될 API를 설계하고 구현해주세요.

• 요청과 응답 디자인을 충분히 고려

요청 e.g.)
POST /api/v1/rooms

{
 ...
}

응답 e.g.)
201 Created

{
 "roomId": 1
}

로그 활성화 하기 (모든 요청에 대해)

모든 요청에대해 로그를 활성화해주세요.

다음 키워드를 검색하여 학습하고 현 프로젝트에 적용해주세요!

• slf4j
• logback
• log4j2

회원가입 아이디 중복확인 로직 구현

H2 In-Memory 모드로 변경

현재 TCP 모드 사용하는 H2 Database를 Local(In-Memory) 모드로 변경

Spring profile별 properties 분리하기

우리가 개발하는 프로그램은 각 상황에 따라 접근해야 하는 리소스(DB, 메세지 큐 등)가 달라질 수 있습니다.

이 때 매번 실행할때마다 별도로 코드를 수정해서 하기엔 너무 복잡합니다. 이를 해결하기 위해 어떻게 할 수 있을까요?

다음 블로그 글을 보고 적절하게 profile을 나눠봅시다.

https://velog.io/@choidongkuen/spring-Spring-%EC%84%A4%EC%A0%95-%ED%8C%8C%EC%9D%BC-%EB%82%98%EB%88%84%EA%B8%B0

애플리케이션 헬스체크(health check) 엔드포인트 구현

• 헬스체크? (헬스체크에 대해 잘 모르겠다면, 어떤건지부터 파악해봅시다!)
• 스프링 애플리케이션(OSI 7layer중 application layer에서의 헬스체크)에서의 헬스체크 방법
  • https://toss.tech/article/how-to-work-health-check-in-spring-boot-actuator

View 영역을 제외한 클래스 테스트코드 작성

• 가능하면 Mockito를 사용하지 않기
• 자체 Dummy, Fake, Stub, Mock 객체 사용해보기, 사용하기 어려운 구조라면 인터페이스를 새로 설계하거나 Mockito를 사용해도 좋습니다.
• Spring ApplicationContext 등 스프링 통합 관련 설정이 필요한 테스트 또한 @SpringBootTest 등의 통합테스트 어노테이션을 활용하여 테스트 해보기!

애플리케이션 성능테스트

아직 프로젝트 미완성된 부분이 있기에 우선순위는 낮습니다.

내가 개발한 애플리케이션의 최대 요청 임계점은 어떤 정도일지 궁금하다면 어떻게 검증해볼 수 있을까요?

아래 대표적인 성능테스트 도구 사용법과, 사용 사례들을 살펴봅시다

• Jmeter
• Ngrinder

위 성능테스트 도구 사용법 숙지가 되었다면 성능테스트를 통해 다음과 같은 결과들을 도출해봅시다.

• 임계점 도달 피크 수준 요청량 찾기
• 병목 지점 찾기
• 애플리케이션의 CPU, 메모리 HotSpot찾기
• 적정 스레드 수 찾기
  • Tomcat Thraed Pool
  • Hikari DBCP
  • 그 외

Service Layer 테스트 코드 작성

Swagger를 활용하여 API 문서 만들기

다음 블로그 글을 참고하여 API 문서를 만들어봅시다.

https://hogwart-scholars.tistory.com/entry/Spring-Boot-SpringDoc%EA%B3%BC-Swagger%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%B4-API-%EB%AC%B8%EC%84%9C%ED%99%94-%EC%9E%90%EB%8F%99%ED%99%94%ED%95%98%EA%B8%B0