[조현아] sprint7 #202

hyohyo-zz · 2025-06-29T13:50:57Z

요구사항

기본

기본 요구사항

프로파일 기반 설정 관리

개발, 운영 환경에 대한 프로파일을 구성하세요.
- [ ] application-dev.yaml, application-prod.yaml 파일을 생성하세요.
- 다음과 같은 설정값을 프로파일별로 분리하세요.
  - 데이터베이스 연결 정보
  - 서버 포트

로그 관리

서비스 레이어와 컨트롤러 레이어의 주요 메소드에 로깅을 추가하세요.
- 로깅 레벨을 적절히 사용하세요: ERROR, WARN, INFO, DEBUG
- 다음과 같은 메소드에 로깅을 추가하세요:
  - 사용자 생성/수정/삭제
  - 채널 생성/수정/삭제
  - 메시지 생성/수정/삭제
  - 파일 업로드/다운로드

예외 처리 고도화

커스텀 예외를 설계하고 구현하세요.
- 패키지명: com.sprint.mission.discodeit.exception[.{도메인}]
- ErrorCode Enum 클래스를 통해 예외 코드명과 메시지를 정의하세요.
  - 아래는 예시입니다. 필요하다고 판단되는 다양한 코드를 정의하세요.
  - 예시
- 모든 예외의 기본이 되는 DiscodeitException 클래스를 정의하세요.
  - 클래스 다이어그램
  - details는 예외 발생 상황에 대한 추가정보를 저장하기 위한 속성입니다.
    - 예시
      - 조회 시도한 사용자의 ID 정보
      - 업데이트 시도한 PRIVATE 채널의 ID 정보
- DiscodeitException을 상속하는 주요 도메인 별 메인 예외 클래스를 정의하세요.
  - UserException, ChannelException 등
  - 실제로 활용되는 클래스라기보다는 예외 클래스의 계층 구조를 명확하게 하기 위한 클래스 입니다.
- 도메인 메인 예외 클래스를 상속하는 구체적인 예외 클래스를 정의하세요.
  - UserNotFoundException, UserAlreadyExistException 등 필요한 예외를 정의하세요.
  - 예시
기존에 구현했던 예외를 커스텀 예외로 대체하세요.
- NoSuchElementException
- IllegalArgumentException
- …
ErrorResponse를 통해 일관된 예외 응답을 정의하세요.
- 클래스 다이어그램
- int status: HTTP 상태코드
- String exceptionType: 발생한 예외의 클래스 이름
앞서 정의한 ErrorResponse와 @RestControllerAdvice를 활용해 예외를 처리하는 예외 핸들러를 구현하세요.
- 모든 핸들러는 일관된 응답(ErrorResponse)을 가져야 합니다.

유효성 검사

Spring Validation 의존성을 추가하세요.
https://rudaks.tistory.com/entry/varchar-5-%EA%B0%80-char%EC%9D%BC%EA%B9%8C-byte%EC%9D%BC%EA%B9%8C
주요 Request DTO에 제약 조건 관련 어노테이션을 추구하세요.
- @NotNull, @NotBlank, @Size, @Email 등
컨트롤러에 @Valid 를 사용해 요청 데이터를 검증하세요.
검증 실패 시 발생하는 MethodArgumentNotValidException을 전역 예외 핸들러에서 처리하세요.
유효성 검증 실패 시 상세한 오류 메시지를 포함한 응답을 반환하세요.

Actuator

Spring Boot Actuator 의존성을 추가하세요.
기본 Actuator 엔트포인트를 설정하세요.
- health, info, metrics, loggers
Actuator info를 위한 애플리케이션 정보를 추가하세요.
- 애플리케이션 이름: Discodeit
- 애플리케이션 버전: 1.7.0
- 자바 버전: 17
- 스프링 부트 버전: 3.4.0
- 주요 설정 정보
  - 데이터소스: url, 드라이버 클래스 이름
  - jpa: ddl-auto
  - storage 설정: type, path
  - multipart 설정: max-file-size, max-request-size
Spring Boot 서버를 실행 후 각종 정보를 확인해보세요.
- /actuator/info
- /actuator/metrics
- /actuator/health
- /actuator/loggers

단위 테스트

서비스 레이어의 주요 메소드에 대한 단위 테스트를 작성하세요.
- 다음 서비스의 핵심 메소드에 대해 각각 최소 2개 이상(성공, 실패)의 테스트 케이스를 작성하세요.
  - UserService: create, update, delete 메소드
  - ChannelService: create(PUBLIC, PRIVATE), update, delete, findByUserId 메소드
  - MessageService: create, update, delete, findByChannelId 메소드
- [ ] Mockito를 활용해 Repository 의존성을 모의(mock)하세요.
- [ ] BDDMockito를 활용해 테스트 가독성을 높이세요.

슬라이스 테스트

메시지

MessageRepositoryTest 테스트 클래스

채널 정보, 유저 정보, 커서 정보, 거기에 약간의 메시지 더미 데이터

1. 채널 ID와 생성 시간으로 메시지를 페이징하여 조회할 수 있다

2. 채널의 마지막 메시지 시간을 조회할 수 있다

3. 메시지가 없는 채널에서는 마지막 메시지 시간이 없다

4. 채널의 모든 메시지를 삭제할 수 있다

3번은 채널이 존재하긴 하는데 메시지가 없는, 즉 채널을 만들어놓고 어떠한 채팅도 하지 않은 빈 채널을 테스트하는 것이고

4번은 특정 채팅방을 삭제하면, 그 채팅방에 존재하던 모든 메시지가 삭제되는지를 테스트하면 되겠죠?

통합 테스트

심화

주요 변경사항

스크린샷

멘토에게

기본 요구사항까지 완료했습니다

- yaml 파일 분리 - logback 파일 추가 - AOP class 생성 - 프론트 코드 변경

# Conflicts: # src/main/java/com/sprint/mission/discodeit/dto/request/MessageCreateRequest.java

- UserServiceTest - ChannelServiceTest - MessageServiceTest

- message content 검증 메서드 private으로 변경 - privateChannel 참여자Ids list로 변경

- Repository 테스트 작성 - Controller 테스트 작성 - AppConfig 수정, 기존 main에서 어노테이션 제거 - test-yaml 수정

ssjf409 · 2025-07-02T07:49:29Z

src/main/java/com/sprint/mission/discodeit/dto/request/UserUpdateRequest.java

+    @Pattern(regexp = "^(?:\\w+\\.?)*\\w+@(?:\\w+\\.)+\\w+$",
+        message = "이메일 형식이 올바르지 않습니다.")


정규표현식도 나쁘진않지만 @Email이라는 애노테이션이 이미 존재합니다
이미 있는걸 굳이 또 만드실 필요는 없으니 이걸 쓰시길 권장드립니다.

넵 수정하겠습니다!!

ssjf409 · 2025-07-02T07:51:56Z

src/main/java/com/sprint/mission/discodeit/mapper/ChannelMapper.java

+    @Mapping(target = "participants", expression = "java(resolveParticipants(channel))")
+    @Mapping(target = "lastMessageAt", expression = "java(resolveLastMessageAt(channel))")
+    abstract public ChannelDto toDto(Channel channel);


SpEL은 컴파일 시점에 정적 분석의 대상이 아니라서 코드에 문제가 있어도 발견되지 않아요. 그 상태로 배포가 나가서 실제 코드가 동작하는 순간에 확인이 되는데, 너무 리스크가 크다 생각합니다.

@Mapping을 저는 써본적이 없어서 리뷰 달면서 알게되었는데.. 잘 쓰면 유용한 면도 있을것 같다고 생각하는데요. 그만큼 리스크도 커 보이네요.

개인적으로는 이걸 쓰는 것보다 이전 코드가 훨씬 더 나아보입니다.

ssjf409 · 2025-07-02T08:10:46Z

src/main/java/com/sprint/mission/discodeit/service/basic/BasicMessageService.java


-        return messageMapper.toDto(savedMessage);
+        return messageMapper.toDto(message);


이전에 return messageMapper.toDto(savedMessage);가 저장된 결과를 반환하는 거라 더 좋은 코드로 보여요.
지금 코드에서 message 안에는 id 값이 null일거에요.

ssjf409 · 2025-07-02T08:12:31Z

src/main/java/com/sprint/mission/discodeit/service/basic/BasicUserService.java

-        savedUser.setUserStatus(userStatus);    //연관 관계 설정
-
-        return userMapper.toDto(savedUser);
+        return userMapper.toDto(user);


여기도 마찬가지로 userRepository.save(user);의 반환값을 userMapper.toDto()의 인자로 넣어주는게 적절해보이네요.

ssjf409 · 2025-07-02T08:15:36Z

src/main/resources/logback-spring.xml

+    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+      <fileNamePattern>${LOG_PATH}/${APP_NAME}-error.%d{yyyy-MM-dd}.log</fileNamePattern>
+      <maxHistory>30</maxHistory>
+    </rollingPolicy>


로깅 파일을 시간단위로 롤링하는 정책은 현업에서도 많이 쓰고 굉장히 잘 하신것 같아요.
하지만 파일이 너무 커져서 문제가 되는 경우도 있거든요.
그래서 보통은 최대 파일크기도 같이 설정으로 걸어둬요.

아래 파일 크기 + 시간 주기로 롤링하는 정책입니다.

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>./logs/app.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> <fileNamePattern>./logs/app.%d{yyyy-MM-dd}.%i.log</fileNamePattern> <maxFileSize>100MB</maxFileSize>  <maxHistory>30</maxHistory>  <totalSizeCap>5GB</totalSizeCap>  </rollingPolicy> <encoder> <pattern>${ROLLING_PATTERN}</pattern> </encoder> </appender>

ssjf409 · 2025-07-02T08:16:34Z

src/test/java/com/sprint/mission/discodeit/controller/ChannelControllerTest.java

+        // When & Then
+        mockMvc.perform(post("/api/channels/public")
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(requestJson))
+            .andExpect(status().isCreated())
+            .andExpect(jsonPath("$.type").value(ChannelType.PUBLIC.name()))
+            .andExpect(jsonPath("$.name").value("채널1"))
+            .andExpect(jsonPath("$.description").value("테스트 채널입니다."))
+            .andDo(print());


when과 then은 명확히 구분하는게 더 좋습니다.

// When ResultActions result = mockMvc.perform(post("/api/channels/public") .contentType(MediaType.APPLICATION_JSON) .content(requestJson)); // Then result.andExpect(status().isCreated()) .andExpect(jsonPath("$.type").value(ChannelType.PUBLIC.name())) .andExpect(jsonPath("$.name").value("채널1")) .andExpect(jsonPath("$.description").value("테스트 채널입니다.")) .andDo(print());

ssjf409 · 2025-07-02T08:17:40Z

src/test/java/com/sprint/mission/discodeit/controller/ChannelControllerTest.java

+        PrivateChannelCreateRequest request = new PrivateChannelCreateRequest(participantIds);
+        ChannelDto channelDto = new ChannelDto(UUID.randomUUID(), ChannelType.PRIVATE, null, null,
+            null, null);
+


빈 공백 문자가 given, when, then에서 사용되기 때문 내부에서 불필요하게 공백쓰는건 지양하는게 더 가독성이 좋습니다.

ssjf409 · 2025-07-02T08:19:33Z

src/test/java/com/sprint/mission/discodeit/service/basic/BasicUserServiceTest.java

+        // When & Then
+        assertThatThrownBy(() -> userService.delete(userId))
+            .isInstanceOf(UserNotFoundException.class);
+
+        then(userRepository).should().findById(userId);
+        then(userRepository).should(never()).deleteById(any());
+        then(userStatusRepository).should(never()).deleteByUserId(any());


// When Throwable thrown = catchThrowable(() -> userService.delete(userId)); // Then assertThat(thrown) .isInstanceOf(UserNotFoundException.class); then(userRepository).should().findById(userId); then(userRepository).should(never()).deleteById(any()); then(userStatusRepository).should(never()).deleteByUserId(any());

이렇게 하시면 더 좋을거 같아요.

넵 리뷰해주신부분 반영해서 수정하겠습니다!! 감사합니다!

ssjf409 · 2025-07-02T08:21:13Z

전체적으로 잘 작성하신 것 같습니다.
딱히 코멘트 달만한 부분도 없네요. 테스트 코드 관련해서 컨벤션만 좀 더 명확히 해주시면 좋을 것 같습니다.

hyohyo-zz added 15 commits June 19, 2025 11:46

refactor: sprint7 베이스 코드 참고하여 로직개선

d0fd938

feat: 환경별 프로파일 설정 및 로깅 기능 구성

fecd2b0

chore: AOP, 서비스 메서드 로깅 추가

86f4c10

- yaml 파일 분리 - logback 파일 추가 - AOP class 생성 - 프론트 코드 변경

docs: update README

cd448f2

feat: 커스텀예외처리 생성, 적용/yaml,logback 수정

afebc79

chore: .gitignore에 로그 및 저장소 폴더 추가, Git 추적에서 제거

541c835

feat: spring validation을 이용한 유효성 검사

9180153

feat: actuator 설정

17781f4

feat: dto 유효성 수정

d08d5e1

# Conflicts: # src/main/java/com/sprint/mission/discodeit/dto/request/MessageCreateRequest.java

test: 단위 테스트 작성

7963332

- UserServiceTest - ChannelServiceTest - MessageServiceTest

refactor: 서비스코드 수정

bb15449

- message content 검증 메서드 private으로 변경 - privateChannel 참여자Ids list로 변경

feat: dto에 제약 조건 추가, Controller에 @Valid 추가

1f89565

test: 슬라이스 테스트 작성

5fe1aa3

- Repository 테스트 작성 - Controller 테스트 작성 - AppConfig 수정, 기존 main에서 어노테이션 제거 - test-yaml 수정

test: 통합테스트 작성

adb9a74

test: 통합테스트 수정, 유효성검증 수정

6c83246

hyohyo-zz requested a review from ssjf409 June 29, 2025 13:51

hyohyo-zz added the 순한맛🐑 마음이 많이 여립니다.. label Jun 29, 2025

ssjf409 reviewed Jul 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[조현아] sprint7 #202

[조현아] sprint7 #202

Uh oh!

hyohyo-zz commented Jun 29, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

hyohyo-zz Jul 2, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

ssjf409 Jul 2, 2025

Uh oh!

hyohyo-zz Jul 2, 2025

Uh oh!

ssjf409 commented Jul 2, 2025

Uh oh!

Uh oh!

		@Pattern(regexp = "^(?:\\w+\\.?)*\\w+@(?:\\w+\\.)+\\w+$",
		message = "이메일 형식이 올바르지 않습니다.")


		return messageMapper.toDto(savedMessage);
		return messageMapper.toDto(message);

[조현아] sprint7 #202

Are you sure you want to change the base?

[조현아] sprint7 #202

Uh oh!

Conversation

hyohyo-zz commented Jun 29, 2025

요구사항

기본

기본 요구사항

프로파일 기반 설정 관리

로그 관리

예외 처리 고도화

유효성 검사

Actuator

단위 테스트

슬라이스 테스트

통합 테스트

심화

주요 변경사항

스크린샷

멘토에게

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ssjf409 commented Jul 2, 2025

Uh oh!

Uh oh!