[김준우] sprint7 #352

normaldeve · 2025-04-05T15:24:41Z

기본 요구사항

프로파일 기반 설정 관리

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

로그 관리

예외 처리 고도화

커스텀 예외를 설계하고 구현하세요.
- 패키지명: 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 의존성을 추가하세요.
주요 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를 활용해 테스트 가독성을 높이세요.

슬라이스 테스트

통합 테스트

심화 요구사항

MDC를 활용한 로깅 고도화

요청 ID, 요청 URL, 요청 방식 등의 정보를 MDC에 추가하는 인터셉터를 구현하세요.
- 클래스명: MDCLoggingInterceptor
- 패키지명: com.**.discodeit.config
- 요청 ID는 랜덤한 문자열로 생성합니다. (UUID)
- 요청 ID는 응답 헤더에 포함시켜 더 많은 분석이 가능하도록 합니다.
  - 헤더 이름: Discodeit-Request-ID
[ ] WebMvcConfigurer를 통해 MDCLoggingInterceptor를 등록하세요.
- 클래스명: WebMvcConfig
- 패키지명: com.**.discodeit.config

Logback 패턴에 MDC 값을 포함시키세요.

로그 출력 예시

# 패턴
{년}-{월}-{일} {시}:{분}:{초}:{밀리초} [{스레드명}] {로그 레벨(5글자로 맞춤)} {로거 이름(최대 36글자)} [{MDC:요청ID} | {MDC:요청 메소드} | {MDC:요청 URL}] - {로그 메시지}{줄바꿈}

# 예시
25-01-01 10:33:55.740 [main] DEBUG o.s.api.AbstractOpenApiResource [827cbc0b | GET | /v3/api-docs] - Init duration for springdoc-openapi is: 216 ms

Spring Boot Admin을 활용한 메트릭 가시화

Spring Boot Admin 서버를 구현할 모듈을 생성하세요.
- IntelliJ 화면 참고
- 모듈 정보는 다음과 같습니다.
- 의존성

admin 모듈의 메인 클래스에 @EnableAdminServer 어노테이션을 추가하고, 서버는 9090번 포트로 설정합니다.

import de.codecentric.boot.admin.server.config.EnableAdminServer;

@SpringBootApplication
@EnableAdminServer
public class AdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(AdminApplication.class, args);
    }
}

# application.yaml
spring:
    application:
        name: admin
server:
    port: 9090

admin 서버 실행 후 [localhost:9090/applications](http://localhost:9090/applications) 에 접속해봅니다.

discodeit 프로젝트에 Spring Boot Admin Client를 적용합니다.

의존성을 추가합니다.

dependencies {
    ...
    implementation 'de.codecentric:spring-boot-admin-starter-client:3.4.5
}

admin 서버에 등록될 수 있도록 설정 정보를 추가합니다.

# application.yml
spring:
  application:
    name: discodeit
    ...
  boot:
    admin:
      client:
        instance:
          name: discodeit
...

# application-dev.yml
spring:
  application:
    name: discodeit
    ...
  boot:
    admin:
      client:
        url: http://localhost:9090
...

# application-prod.yml
spring:
  application:
    name: discodeit
    ...
  boot:
    admin:
      client:
        url: ${SPRING_BOOT_ADMIN_CLIENT_URL}
...

discodeit 서버를 실행하고, admin 대시보드에 discodeit 인스턴스가 추가되었는지 확인합니다.

admin 대시보드 화면을 조작해보면서 각종 메트릭 정보를 확인해보세요.
- 주요 API의 요청 횟수, 응답시간 등
- 서비스 정보

테스트 커버리지 관리

JaCoCo 플러그인을 추가하세요.


plugins {
    id 'jacoco'
}

test {
    finalizedBy jacocoTestReport
}

jacocoTestReport {
    dependsOn test
    reports {
        xml.required = true
        html.required = true
    }
}

테스트 실행 후 생성된 리포트를 분석해보세요.
- 리포트는 build/reports/jacoco 경로에서 확인할 수 있습니다.
com.sprint.mission.discodeit.service.basic 패키지에 대해서 60% 이상의 코드 커버리지를 달성하세요.

스크린샷

멘토에게

아직 통합 테스트를 작성하지 못했습니다. 제출 기한이 넘어가도 작성할 계획입니다
서비스 코드 커버리지가 60%를 넘지 못했습니다. 이 부분도 추후 확인해서 보완할 예정입니다
실무에서 Spring Boot Actuator와 Spring Boot Admin을 어떤 용도로 가장 많이 활용하는지 궁금합니다

…준우-sprint6 [김준우] sprint6

- MDC를 활용한 로깅 고도화 완료 - Admin을 활용한 메트릭 가시화 완료 - 테스트 커버리지 관리 설정 및 확인 완료

- 예외 필드 수정 - DiscodeitException을 상속하는 주요 도메인 별 메인 예외 클래스 정의 완료 - 도메인 메인 예외 클래스를 상속하는 구체적인 예외 클래스 정의 완료 - 기존 구현한 예외를 커스텀 예외로 대체 완료

# [타입] 커밋 제목 (한 줄 요약)

yeongunheo

안녕하세요 준우님,

통합테스트를 제외한 나머지 요구사항을 모두 잘 구현해주셨네요 💯

참고하면 좋을 코멘트 몇가지 남겨두었습니다!

질문주신 내용에 대한 답변은 아래에 따로 남겨둘게요.

실무에서 Spring Boot Actuator와 Spring Boot Admin을 어떤 용도로 가장 많이 활용하는지 궁금합니다

제가 속한 팀을 기준으로 하면 Spring Boot Actuator는 현재 사용하고 있고, Spring Boot Admin은 따로 사용하고 있지 않습니다.

Actuator는 스프링부트 서버의 메트릭을 노출하는 용도로 사용하고 있어요.

모니터링 환경 구축에는 Actuator를 포함해 프로메테우스, 그라파나라는 도구를 사용하고 있습니다!

이미지 출처 : https://hudi.blog/spring-boot-actuator-prometheus-grafana-set-up/

모니터링 환경을 어떻게 구축할 것인가에 대한 이야기는 길어질 것 같으니 이정도로만 이야기하고 넘어갈게요.

yeongunheo · 2025-04-09T12:31:49Z

src/main/resources/application-prod.yaml

+    password: ${DB_PASSWORD}
+  jpa:
+    hibernate:
+      ddl-auto: none


운영환경에서 ddl-auto: none보다 더 좋은건 validate라고 생각해요.
엔터티와 DB 테이블의 불일치를 서버를 띄울 때 바로 알 수 있어서요!

yeongunheo · 2025-04-09T12:33:13Z

src/main/resources/application-dev.yaml

+logging:
+  level:


logging.level.root 설정도 추가되면 좋을 것 같아요.

Suggested change

logging:

level:

logging:

level:

root: info

yeongunheo · 2025-04-09T12:34:22Z

src/main/java/com/sprint/mission/discodeit/exception/GlobalExceptionHandler.java

+
+  @ExceptionHandler(IllegalArgumentException.class)
+  public ResponseEntity<String> handleException(IllegalArgumentException e) {
+    e.printStackTrace();


e.printStackTrace();는 성능 상의 문제를 야기하기에 지양하는게 좋습니다.

https://dev-jwblog.tistory.com/167

yeongunheo · 2025-04-09T12:34:43Z

src/main/java/com/sprint/mission/discodeit/exception/GlobalExceptionHandler.java

+  @ExceptionHandler(NoSuchElementException.class)
+  public ResponseEntity<String> handleException(NoSuchElementException e) {
+    e.printStackTrace();
+    return ResponseEntity
+        .status(HttpStatus.NOT_FOUND)
+        .body(e.getMessage());
+  }


여기선 따로 log를 안찍어도 괜찮을까요?

yeongunheo · 2025-04-09T12:36:06Z

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

@@ -0,0 +1,9 @@
+package com.sprint.mission.discodeit.dto.request;


컨트롤러 Req, Res는 controller 패키지 하위에 있어도 좋을 것 같아요.

yeongunheo · 2025-04-09T12:37:29Z

src/main/resources/application-prod.yaml

+  info:
+    env:
+      enabled: true
+


env.enabled: true 설정은 환경 변수와 프로퍼티 정보를 제공하는데요,
운영 환경에서는 이러한 정보가 보안 취약점이 될 수 있으므로, false로 설정하는 것이 좋습니다.

yeongunheo · 2025-04-09T12:42:01Z

src/test/java/com/sprint/mission/discodeit/repository/MessageRepositoryTest.java

+  @Test
+  @DisplayName("채널 ID로 가장 마지막 메시지 시간을 조회한다.")
+  void findLastMessageAtByChannelId() {
+    UUID channelId = UUID.fromString("11111111-1111-1111-1111-111111111111");
+
+    Optional<Message> message = messageRepository.findById(UUID.fromString("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaa0020"));
+    Optional<Instant> result = messageRepository.findLastMessageAtByChannelId(channelId);
+
+    assertThat(result).isPresent();
+    assertThat(message.get().getCreatedAt()).isEqualTo(result.get());
+  }


이 테스트는 when절이 2개인데요,
하나의 테스트가 여러 행동을 검증하는건 아닐까요?

normaldeve added 30 commits January 8, 2025 23:00

Start project

1755c0d

Create entity class and service interface

ef7e362

Exclude Main class

c62a7c1

Update entity class add getter method

c6688d8

Implement business logic for User, Message, Channel Service

46efe92

Update Message class

6622cdb

Add JavaApplication

8674e1f

Update JavaApplication

98373b3

Refactor

275fc73

Update Service

61d0de2

Refactor the service code

7291f70

Refactor the service code

ee39c05

Add fileservice class

39073cb

Add Factory interface

3b19d12

Update main code

41b54b1

Add repository interface each service

5b8a424

Add repository file

a3bbd93

Add convertJson method

006a424

Add JCF, File repository

70be29c

Update repository

beef1bf

Add custom exception

0434dff

Update JCFRepository

4d8d7d5

Update JCFRepository

f7743a3

Update JCFService

6a5ef60

Modify method name create

403f625

Remove setter from DTO

9b466db

Repository code implementation completed

95c9de0

Refactor code

8eab77b

Update Service

d1659c0

Refactoring channel service

787cfef

junwoo and others added 17 commits March 12, 2025 23:56

Controller 요구 사항 반영 완료

2f808c8

기본 요구사항 구현 완료

de43eb2

기본 요구사항 구현 완료

002d8f0

♻️ 코드 리팩토링

33b2706

Merge pull request codeit-bootcamp-spring#316 from normaldeve/part2-김…

dbfe42d

…준우-sprint6 [김준우] sprint6

베이스 코드로 변경

b79afe0

베이스코드로 변경

2fa7133

♻️ 개발, 운영 환경에 대한 프로파일 구성

8837dee

♻️ 개발, 운영 환경에 대한 프로파일 구성 + 로깅 설정 파일 구성

f13a8cc

♻️ Service 계층에 로그 설정 완료

e5779dc

♻️ 유효성 검사 코드 작성 완료

03076d1

✨ 단위테스트 및 슬라이스 테스트 작성 완료

84dc08e

✨ 통합 테스트 작성 완료

0145279

✨ 심화 요구사항

c3297f8

- MDC를 활용한 로깅 고도화 완료 - Admin을 활용한 메트릭 가시화 완료 - 테스트 커버리지 관리 설정 및 확인 완료

♻️ RequestDTO에 제약 조건 관련 어노테이션 수정

7e83358

♻️ 레포지토리, 서비스, 컨트롤러 단위 테스트 작성 완료 -> 통합 테스트 작성 못함

d6925ec

normaldeve requested a review from yeongunheo April 5, 2025 15:25

normaldeve assigned normaldeve and unassigned normaldeve Apr 5, 2025

normaldeve added the 미완성🛠️ 스프린트 미션 제출일이지만 미완성했습니다. 죄송합니다. label Apr 8, 2025

junwoo added 7 commits April 8, 2025 13:25

♻️ 커밋 템플릿 테스트

ad44fae

✅ Git Action 자동 테스트 확인

114e27d

✅ 자동 테스트 구동되는지 확인

39d4c58

✅ 커밋 테스트

fc00733

# [타입] 커밋 제목 (한 줄 요약)

♻️ 자동 테스트 확인

727a19e

ci test

1064cf5

Delete github workflows

b2523c3

yeongunheo approved these changes Apr 9, 2025

View reviewed changes

yeongunheo merged commit 0fedd11 into codeit-bootcamp-spring:part3-김준우 Apr 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[김준우] sprint7 #352

[김준우] sprint7 #352

normaldeve commented Apr 5, 2025

yeongunheo left a comment

yeongunheo Apr 9, 2025

yeongunheo Apr 9, 2025

yeongunheo Apr 9, 2025

yeongunheo Apr 9, 2025

yeongunheo Apr 9, 2025

yeongunheo Apr 9, 2025

yeongunheo Apr 9, 2025

		@@ -0,0 +1,9 @@
		package com.sprint.mission.discodeit.dto.request;

[김준우] sprint7 #352

[김준우] sprint7 #352

Conversation

normaldeve commented Apr 5, 2025

기본 요구사항

프로파일 기반 설정 관리

로그 관리

예외 처리 고도화

유효성 검사

Actuator

단위 테스트

슬라이스 테스트

통합 테스트

심화 요구사항

MDC를 활용한 로깅 고도화

Spring Boot Admin을 활용한 메트릭 가시화

테스트 커버리지 관리

스크린샷

멘토에게

yeongunheo left a comment

Choose a reason for hiding this comment

yeongunheo Apr 9, 2025

Choose a reason for hiding this comment

yeongunheo Apr 9, 2025

Choose a reason for hiding this comment

yeongunheo Apr 9, 2025

Choose a reason for hiding this comment

yeongunheo Apr 9, 2025

Choose a reason for hiding this comment

yeongunheo Apr 9, 2025

Choose a reason for hiding this comment

yeongunheo Apr 9, 2025

Choose a reason for hiding this comment

yeongunheo Apr 9, 2025

Choose a reason for hiding this comment