전승현[sprint7]#148
Hidden character warning
Conversation
…/전승현 [전승현]Sprint2
…t/전승현 전승현/스프린트미션3
|
@seunghyeonjeon57-dot 님 merge 하는 브랜치가 잘못된 것 같습니다. |
|
.gitignore 파일 안에 .ser 파일 관련하여 명시하여 원격 저장소에 저장되는 것을 제외해야 할 것 같습니다. |
| @RequiredArgsConstructor | ||
| public class AuthController implements AuthApi { | ||
|
|
||
| private final UserMapper mapper; |
There was a problem hiding this comment.
mapper 사용처가 없어보이는데 맞을까요? 맞다면 제거해도 될 것 같습니다.
|
|
||
| <springProfile name="dev"> | ||
| <root level="INFO"> | ||
| <appender-ref ref="CONSOLE"/> |
There was a problem hiding this comment.
환경 별로 세분화하신 부분 👍👍
구현하신 것과 같이 현업에서도 환경 별로 출력하는 곳을 다르게 설정합니다.
| </pattern> | ||
| </encoder> | ||
| <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"> | ||
| <fileNamePattern>${LOG_PATH}/archived/${LOG_FILE_NAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern> |
There was a problem hiding this comment.
파일의 크기가 너무 크면 서버에서 보기가 어려워 질 수 있어 조그마한 크기로 조각내는데 디테일하게 잘 구분해주셨습니다.
| datasource: | ||
| url: jdbc:postgresql://localhost:5432/discodeit | ||
| username: discodeit_user | ||
| password: discodeit1234 |
There was a problem hiding this comment.
동일 username 이지만 망 별로 패스워드를 다르게 하는 것을 추천드려요.
| @@ -0,0 +1,49 @@ | |||
| spring: | |||
There was a problem hiding this comment.
prod에는 server.port 가 존재하지 않는 것 같아요.
공통적으로 사용되는 부분들은 applicaiton.yaml 파일을 생성하여 선언해주세요.
| @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) | ||
| @ActiveProfiles("test") | ||
| @Transactional | ||
| @AutoConfigureMockMvc |
There was a problem hiding this comment.
선언하신 부분을 커스텀 애노테이션으로 선언하여 사용하면 어떨까요?
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@ActiveProfiles("test")
@Transactional
@AutoConfigureMockMvc
public @interface IntegrationTest {
}
애노테이션 명을 통해 의미적으로 부여할 수 있을 것 같습니다.
| .contentType(MediaType.APPLICATION_JSON) | ||
| .content(mapper.writeValueAsString(request))) | ||
| .andExpect(status().isCreated()); | ||
| var createChannel = channelRepository.findByName("하이").orElseThrow(); |
There was a problem hiding this comment.
저장 API 호출 이후 저장된 데이터가 정상적으로 저장되었는지 확인하려면 조회 API를 별도로 호출하는 것을 추천드려요.
즉, 저장 API -> 조회 API 순이 될 것 같아요.
| } | ||
|
|
||
| @Test | ||
| @DisplayName("채널 삭제 API를 호출하면 Db에서 채널 삭제가되어야한다") |
There was a problem hiding this comment.
위와 동일하게 삭제하기 위해 저장 -> 삭제 -> 조회 순으로 API를 호출하는 것을 권장드려요.
기능 별 API 호출 함수를 선언하여 사용하는 방식이면 재사용성이 좋을 것 같아요.
| @InjectMocks | ||
| private BasicChannelService channelService; | ||
|
|
||
| @Nested |
| assertThat(result).isNotNull(); | ||
| assertThat(result.name()).isEqualTo("공용채널1"); | ||
|
|
||
| verify(channelRepository).save(any(Channel.class)); |
There was a problem hiding this comment.
값 뿐만 아니라 호출 행위를 검증하는 부분도 좋습니다.
저는 버그가 발생할 가능성이 높은 즉 로직 복잡도가 높은 코드들에 대해 집중적으로 테스트 코드를 작성하는 편입니다.
개인적으로 통합 테스트를 선호하지 않아, 정말 통합 테스트가 필요한 기능들만 작성하는 편입니다.
잘하고 계시는 것 같아요. |
요구사항
기본
프로파일 기반 설정 관리
개발, 운영 환경에 대한 프로파일을 구성하세요.
application-dev.yaml, application-prod.yaml 파일을 생성하세요.
다음과 같은 설정값을 프로파일별로 분리하세요.
데이터베이스 연결 정보
서버 포트
로그 관리
Lombok의 @slf4j 어노테이션을 활용해 로깅을 쉽게 추가할 수 있도록 구성하세요.
application.yaml에 기본 로깅 레벨을 설정하세요.
기본적으로 info 레벨로 설정합니다.
환경 별 적절한 로깅 레벨을 프로파일 별로 설정해보세요.
SQL 로그를 보기위해 설정했던 레벨은 유지합니다.
우리가 작성한 프로젝트의 로그는 개발 환경에서 debug, 운영 환경에서는 info 레벨로 설정합니다.
Spring Boot의 기본 로깅 구현체인 Logback의 설정 파일을 구성하세요.
logback-spring.xml 파일을 생성하세요.
다음 예시와 같은 로그 메시지를 출력하기 위한 로깅 패턴과 출력 방식을 커스터마이징하세요.
로그 출력 예시
패턴
{년}-{월}-{일} {시}:{분}:{초}:{밀리초} [{스레드명}] {로그 레벨(5글자로 맞춤)} {로거 이름(최대 36글자)} - {로그 메시지}{줄바꿈}
콘솔과 파일에 동시에 로그를 기록하도록 설정하세요.
파일은 {프로젝트 루트}/.logs 경로에 저장되도록 설정하세요.
로그 파일은 일자별로 롤링되도록 구성하세요.
로그 파일은 30일간 보관하도록 구성하세요.
서비스 레이어와 컨트롤러 레이어의 주요 메소드에 로깅을 추가하세요.
로깅 레벨을 적절히 사용하세요: ERROR, WARN, INFO, DEBUG
다음과 같은 메소드에 로깅을 추가하세요:
사용자 생성/수정/삭제
채널 생성/수정/삭제
메시지 생성/수정/삭제
파일 업로드/다운로드
예외 처리 고도화
커스텀 예외를 설계하고 구현하세요.
패키지명: com.sprint.mission.discodeit.exception[.{도메인}]
ErrorCode Enum 클래스를 통해 예외 코드명과 메시지를 정의하세요.
모든 예외의 기본이 되는 DiscodeitException 클래스를 정의하세요.
DiscodeitException을 상속하는 주요 도메인 별 메인 예외 클래스를 정의하세요.
UserException, ChannelException 등
실제로 활용되는 클래스라기보다는 예외 클래스의 계층 구조를 명확하게 하기 위한 클래스 입니다.
도메인 메인 예외 클래스를 상속하는 구체적인 예외 클래스를 정의하세요.
기존에 구현했던 예외를 커스텀 예외로 대체하세요.
ErrorResponse를 통해 일관된 예외 응답을 정의하세요.
앞서 정의한 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를 활용해 테스트 가독성을 높이세요.
슬라이스 테스트
레포지토리 레이어의 슬라이스 테스트를 작성하세요.
@DataJpaTest를 활용해 테스트를 구현하세요.
테스트 환경을 구성하는 프로파일을 구성하세요.
application-test.yaml을 생성하세요.
데이터소스는 H2 인메모리 데이터 베이스를 사용하고, PostgreSQL 호환 모드로 설정하세요.
H2 데이터베이스를 위해 필요한 의존성을 추가하세요.
테스트 시작 시 스키마를 새로 생성하도록 설정하세요.
디버깅에 용이하도록 로그 레벨을 적절히 설정하세요.
테스트 실행 간 test 프로파일을 활성화 하세요.
JPA Audit 기능을 활성화 하기 위해 테스트 클래스에 @EnableJpaAuditing을 추가하세요.
주요 레포지토리(User, Channel, Message)의 주요 쿼리 메소드에 대해 각각 최소 2개 이상(성공, 실패)의 테스트 케이스를 작성하세요.
커스텀 쿼리 메소드
페이징 및 정렬 메소드
컨트롤러 레이어의 슬라이스 테스트를 작성하세요.
@WebMvcTest를 활용해 테스트를 구현하세요.
WebMvcTest에서 자동으로 등록되지 않는 유형의 Bean이 필요하다면 @import를 활용해 추가하세요.
예시
@import({ErrorCodeStatusMapper.class})
주요 컨트롤러(User, Channel, Message)에 대해 최소 2개 이상(성공, 실패)의 테스트 케이스를 작성하세요.
MockMvc를 활용해 컨트롤러를 테스트하세요.
서비스 레이어를 모의(mock)하여 컨트롤러 로직만 테스트하세요.
JSON 응답을 검증하는 테스트를 포함하세요.
통합 테스트
심화
요청 ID, 요청 URL, 요청 방식 등의 정보를 MDC에 추가하는 인터셉터를 구현하세요.
클래스명: MDCLoggingInterceptor
패키지명: com.**.discodeit.config
요청 ID는 랜덤한 문자열로 생성합니다. (UUID)
요청 ID는 응답 헤더에 포함시켜 더 많은 분석이 가능하도록 합니다.
헤더 이름: Discodeit-Request-ID
WebMvcConfigurer를 통해 MDCLoggingInterceptor를 등록하세요.
클래스명: WebMvcConfig
패키지명: com.**.discodeit.config
Spring Boot Admin 서버를 구현할 모듈을 생성하세요.
JaCoCo 플러그인을 추가하세요.
주요 변경사항
멘토에게