스프링부트 게시판 API 만들기 (18) - AOP를 통한 로그 출력, 개발환경과 배포환경 분리

 

 

 

 

 

 

어우 되게 오랜만에 글 쓰네요..ㅎㅎ AOP 공부하다가 늦었습니다...

아마 이번 포스팅 이후로 한동안 포스팅을 못 할 거 같네요...

학교도 복학하고, 회장이 되버려서 좀 이것저것 바쁩니다.. 그리고 토비의 스프링도 읽고, 이것저것 공부할 게 많아서요..ㅠㅠ 

오늘은 AOP를 적용하여 Controller, Service, Repository 계층에 대해 메서드가 수행되면 로그를 남기고, 이를 파일로 저장하도록 바꿔보겠습니다.

그리고 운영환경별 로그 수준을 다르게 남기는 것도 해보겠습니다!

 

 

 

 

 

 

• 시큐리티를 이용한 JSON 데이터로 로그인 (완료)
• JWT를 이용한 인증 (완료)
• 도메인, 테이블 설계, 엔티티 생성 (완료)
• 댓글 삭제 로직 구현 (완료)
• 회원가입 + 정보수정 등 회원 서비스 구현 (완료)
• 게시판 서비스 구현 (완료)
• 댓글 서비스 구현 (1댓글 -> *(무한) 대댓글 구조) (완료)
• 예외 처리 (완료)
• 예외 메세지 국제화
• 카테고리별 게시판 분류
• 게시글 페이징 (완료)
• 동적인 검색 조건을 사용한 검색 (완료)
• 사용자 간 쪽지 기능
• 무한 쪽지 스크롤
• 게시물 & 댓글에 대한 알람
• 쪽지에 대한 알람
• 접속한 사용자 간 실시간 채팅
• 회원가입 시 검증(예: XX대학교 XX과가 아니면 가입할 수 없게)
• Swagger를 사용한 API 문서 만들기
• 신고 & 블랙리스트 기능
• AOP를 통한 로그 (진행 중)
• 어드민 페이지
• 캐시
• 배포 (+ 무중단 배포)
• 배포 자동화
• 포트와 어댑터 설계를 따르는 패키지 구조 설계하기
• ...

 

 

 

 

 

 

 

 

 

 

 

 

TraceId 작성

TraceId는 어떤 유저가 보낸 요청인지(익명이라면 임의의 랜덤 번호로 구분)에 대한 정보를 가지고 있으며,

이 메서드가 메서드 콜스택 중에서 몇번째로 호출된 메서드인지에 대한 정보를 가지고 있습니다.

 

 

위치는 다음과 같습니다.

 

 

package boardexample.myboard.global.log;

import boardexample.myboard.global.util.security.SecurityUtil;

import java.util.UUID;

public class TraceId {

    private String id;
    private int level;//깊이


    public TraceId() {
        this.id = createId();
        this.level = 0;
    }

    public TraceId(String id, int level) {
        this.id = id;
        this.level = level;
    }

    private String createId() {
        try {
            SecurityUtil.getLoginUsername();
        }catch (NullPointerException | ClassCastException e ){ //로그인 안하고 접근 & signUp등일 경우 anonymousUser가 반환되므로 캐스팅이 불가능
            return String.format("[Anonymous: %S]",UUID.randomUUID().toString().substring(0,8));
        }
        return SecurityUtil.getLoginUsername();
    }

    public TraceId createNextId(){
        return new TraceId(id, level + 1);
    }

    public TraceId createPreviousId(){
        return new TraceId(id, level - 1);
    }

    public boolean isFirstLevel(){
        return level == 0;
    }

    public String getId() {
        return id;
    }

    public int getLevel() {
        return level;
    }
}

createId 메서드는 만약 로그인 한 유저가 있다면 해당 username을 id로 사용하고, 없다면 임의의 랜던 UUID를 사용합니다.

level은 메서드가 몇 번째로 호출되었는지에 대한 정보를 가지고 있습니다.

 

 

 

 

 

 

 

 

 

 

 

TraceStatus 구현

public class TraceStatus {

    private TraceId traceId;
    private Long startTimeMs;
    private String message;

    public TraceStatus(TraceId traceId, Long startTimeMs, String message) {
        this.traceId = traceId;
        this.startTimeMs = startTimeMs;
        this.message = message;
    }

    public TraceId getTraceId() {
        return traceId;
    }
    public Long getStartTimeMs() {
        return startTimeMs;
    }
    public String getMessage() {
        return message;
    }



}

 

traceStatus는 TraceId와 메서드가 처음으로 호출된 시간, 그리고 메세지를 가지고 있습니다.

 

이제 이 두 클래스를 가지고 로그를 남겨보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

LogTrace 생성

public interface LogTrace {

    TraceStatus begin(String message);

    void end(TraceStatus status);
    void exception(TraceStatus status, Throwable e);
}

 

begin은 메서드가 실행되기 바로 직전에 호출되어 시작 시간과 메세지를 가진 TraceStatus를 반환합니다.

이후 예외나 메서드가 정상 종료되었을 때 이를 가지고 걸린 시간을 측정합니다.

 

 

 

 

 

 

 

 

 

 

 

 

ThreadLocalLogTrace 생성

package boardexample.myboard.global.log;


import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class ThreadLocalLogTrace implements LogTrace {

    private static final String START_PREFIX = "-->";
    private static final String COMPLETE_PREFIX = "<--";
    private static final String EX_PREFIX = "<X-";


    private ThreadLocal<TraceId> traceIdHolder = new ThreadLocal<>();

    @Override
    public TraceStatus begin(String message) {
        syncTraceId();
        TraceId traceId = traceIdHolder.get();

        Long startTimeMs = System.currentTimeMillis();

        log.info("[{}] {}{}",
                traceId.getId(),
                addSpace(START_PREFIX, traceId.getLevel()),
                message);

        return new TraceStatus(traceId, startTimeMs, message);
    }

    private void syncTraceId(){
        TraceId traceId = traceIdHolder.get();
        if(traceId == null){
            traceIdHolder.set(new TraceId());

        }else {
            traceIdHolder.set(traceId.createNextId());
        }
    }

    @Override
    public void end(TraceStatus status) {
        complete(status, null);
    }

    @Override
    public void exception(TraceStatus status, Throwable e) {
        complete(status, e);
    }

    private void complete(TraceStatus status, Throwable e) {
        Long stopTimeMs = System.currentTimeMillis();
        long resultTimeMs = stopTimeMs - status.getStartTimeMs();
        TraceId traceId = status.getTraceId();

        if (e == null) {
            log.info("[{}] {}{} time={}ms",
                    traceId.getId(),
                    addSpace(COMPLETE_PREFIX, traceId.getLevel()),
                    status.getMessage(),
                    resultTimeMs);
        } else {
            log.info("[{}] {}{} time={}ms ex={}",
                    traceId.getId(),
                    addSpace(EX_PREFIX, traceId.getLevel()),
                    status.getMessage(),
                    resultTimeMs,
                    e.toString());
        }
        releaseTraceId();
    }

    private void releaseTraceId() {
        TraceId traceId = traceIdHolder.get();
        if(traceId.isFirstLevel()){
            traceIdHolder.remove();
        }else{
            traceIdHolder.set(traceId.createPreviousId());
        }

    }


    private static String addSpace(String prefix, int level) {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < level; i++) {
            sb.append(
                    (i == level - 1)
                            ? "|" + prefix
                            : "|   "
            );
        }
        return sb.toString();
    }
}

 

ThreadLocal을 사용하여 동시성 문제가 발생하지 않도록 막아주었습니다.

위의 로그를 남기는 코드는 "스프링 핵심 원리 고급편"을 보고 참고한 것이니 자세하게 궁금하다면 사보는거 추천..

 

이제 해당 LogTrace를 적용하기 위한 AOP를 작성해보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

LogAop 작성

위치는 다음과 같습니다.

 

 

package boardexample.myboard.global.aop;

import boardexample.myboard.global.log.LogTrace;
import boardexample.myboard.global.log.TraceStatus;
import lombok.RequiredArgsConstructor;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

@Aspect
@Component
@RequiredArgsConstructor
public class LogAop {

    private final LogTrace logTrace;


    @Pointcut("execution(* boardexample.myboard.domain..*Service*.*(..))")
    public void allService(){};

    @Pointcut("execution(* boardexample.myboard.domain..*Repository*.*(..))")
    public void allRepository(){};

    @Pointcut("execution(* boardexample.myboard.domain..*Controller*.*(..))")
    public void allController(){};


    @Around("allService() || allController() || allRepository()")
    public Object logTrace(ProceedingJoinPoint joinPoint) throws Throwable {

        TraceStatus status = null;

        try{

            status = logTrace.begin(joinPoint.getSignature().toShortString());
            Object result = joinPoint.proceed();

            logTrace.end(status);

            return result;
        }catch (Throwable e){
            e.printStackTrace();
            logTrace.exception(status, e);
            throw e;
        }
    }




}

 

 

 

잠깐 포인트컷 하나만 살펴보고 넘어가겠습니다.

@Pointcut("execution(* boardexample.myboard.domain..*Service*.*(..))")

위는 boardexample.myboard.domain과 그 하위 모든 폴더들 중 클래스 이름의 중간에 Service가 들어간 모든 메서드에 적용되는 포인트컷입니다.

 

joinPoint.getSignature().toShortString()을 하면 'MemberService.signUp(..)'과 같은 형식으로 반환되므로 이를 이용해 로그를 남길 것입니다.

다음과 같이 로그가 남는다.

 

 

 

 

 

 

 

 

 

 

환경의 분리

테스트환경은 예전에 이미 분리했으므로 이번에는 개발환경(dev)와 배포환경(prod)로 구분하여 환경을 나눠보도록 하겠습니다.

 

 

application.yml

spring:
  profiles:
    group:
      "dev-profile": "dev,jwt"
      "prod-profile": "prod,jwt"

위와 같이 dev-profile은 개발 환경이며, application-dev.yml와 application-jwt.yml를 사용합니다.

 

 

 

jwt는 이전에 작성한 것과 그대로입니다.

 

 

 

 

 

 

 

 

개발 환경 - application-dev.yml

spring:
  config:
    activate:
      on-profile: dev
  banner:
    location: dev-banner.txt


  datasource:
    driver-class-name: org.h2.Driver
    url: jdbc:h2:tcp://localhost/~/jpa
    username: sa
    password: 1
  data:
    web:
      pageable:
        default-page-size: 20  #페이징 할 때 기본값, 20개씩 조회




  servlet:
    multipart:
      max-request-size: 5MB  #업로드 파일 크기 총량 제한
      max-file-size: 2MB     #업로드 파일 크기 제한



  jpa:
    show-sql: true
    properties:
      hibernate:
        format_sql: true
        user_sql_cooments: true


        default_batch_fetch_size: 100 #배치 사이즈 (Collection 조회 최적화)

    hibernate:
      ddl-auto: none


    open-in-view: false #OSIV 사용하지 않기






logging:
  level:
    p6spy: debug

    org:
      apache:
        coyote:
          http11: debug #debug

      hiberante:
        SQL: debug

    boardexample:
      myboard: debug



file:
  dir: D:\files\

아직 데이터베이스는 개발환경과 배포환경이 분리가 되지 않았습니다.

그리고 개발환경에서는 실행되는 SQL 문을 로그로 남기는 것은 물론, 로깅 레벨을 debug로 설정하였습니다.

추가로 개발 환경 배너와 배포 환경 배너를 따로 만들어 구분하기 편하게 만들었습니다.

 

 

 

 

 

 

 

 

 

 

 

 

개발 환경 - application-prod.yml

spring:
  config:
    activate:
      on-profile: prod

  banner:
    location: prod-banner.txt

  datasource:
    driver-class-name: org.h2.Driver
    url: jdbc:h2:tcp://localhost/~/jpa
    username: sa
    password: 1
  data:
    web:
      pageable:
        default-page-size: 20  #페이징 할 때 기본값, 20개씩 조회




  servlet:
    multipart:
      max-request-size: 5MB  #업로드 파일 크기 총량 제한
      max-file-size: 2MB     #업로드 파일 크기 제한



  jpa:
    properties:
      hibernate:
        default_batch_fetch_size: 100 #배치 사이즈 (Collection 조회 최적화)


    hibernate:
      ddl-auto: none


    open-in-view: false #OSIV 사용하지 않기





logging:
  level:
    p6spy: error


    org:
      apache:
        coyote:
          http11: info #debug

  file:
    path: D:\Log\mybored-log.txt






    boardexample:
      myboard: info



file:
  dir: D:\files\

 

로그를 info 혹은 error로만 설정하였습니다. 그리고 logging.file.path 속성을 통해 로그 파일이 저장되는 위치를 지정해 주었습니다. 저렇게만 해주면 로그 파일이 자동으로 생성됩니다.

(아직 제가 로그를 제대로 활용해 본 적이 없어서 콘솔창에 출력되는 로그와 파일에 저장되는 로그의 레벨을 다르게 하거나 요일별로 로그파일을 따로 관리하는 방법 등을 적용하지는 못했습니다..ㅠㅠ 다음에 공부해서 적용해 보도록 하겠습니다.)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

이렇게 해서 AOP를 통해 로그를 남겨보고, 개발환경과 배포환경을 분리하는 작업을 진행해 보았습니다.

다음번에는... 음... 뭔가 막막하네요...ㅠㅠ  redis도 써보고 싶고, 막 이것저것 해보고 싶은데 시간도 너무 부족하고 실력도 너무 부족하다 보니...

뭐 할지는 모르겠습니다.

그래도 기본적인 게시판은 다 만들었으니 혹시나 저의 이런 부족한 포스팅을 봐주시는 분들이 계신다면... 지금부터는 맘대로 꾸며보시는 것도..ㅎㅎ

(봐주시는 분들이 계시다면 감사합니다..!!)

 

 

 

 

 

아래는 개발 환경별 배너와, 환경별로 실행하는 방법, 깃허브 주소입니다.

 

 

 

 

 

 

배너 Text

██████╗ ███████╗██╗   ██╗    ██████╗ ██████╗  ██████╗ ███████╗██╗██╗     ███████╗
██╔══██╗██╔════╝██║   ██║    ██╔══██╗██╔══██╗██╔═══██╗██╔════╝██║██║     ██╔════╝
██║  ██║█████╗  ██║   ██║    ██████╔╝██████╔╝██║   ██║█████╗  ██║██║     █████╗
██║  ██║██╔══╝  ╚██╗ ██╔╝    ██╔═══╝ ██╔══██╗██║   ██║██╔══╝  ██║██║     ██╔══╝
██████╔╝███████╗ ╚████╔╝     ██║     ██║  ██║╚██████╔╝██║     ██║███████╗███████╗
╚═════╝ ╚══════╝  ╚═══╝      ╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚═╝     ╚═╝╚══════╝╚══════╝

 

 

██████╗ ██████╗  ██████╗ ██████╗     ██████╗ ██████╗  ██████╗ ███████╗██╗██╗     ███████╗
██╔══██╗██╔══██╗██╔═══██╗██╔══██╗    ██╔══██╗██╔══██╗██╔═══██╗██╔════╝██║██║     ██╔════╝
██████╔╝██████╔╝██║   ██║██║  ██║    ██████╔╝██████╔╝██║   ██║█████╗  ██║██║     █████╗
██╔═══╝ ██╔══██╗██║   ██║██║  ██║    ██╔═══╝ ██╔══██╗██║   ██║██╔══╝  ██║██║     ██╔══╝
██║     ██║  ██║╚██████╔╝██████╔╝    ██║     ██║  ██║╚██████╔╝██║     ██║███████╗███████╗
╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚═════╝     ╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚═╝     ╚═╝╚══════╝╚══════╝

 

 

 

 

 

 

 

 

 

 

 

 

 

환경별로 실행하는 법

 

배포환경(prod-profile) 실행

인텔리제이 우측 상단에 망치버튼 바로 오른쪽의 칸을 클릭해 보면 Edit Configuration이라는 옵션이 뜹니다.

(파일은 메인 메서드가 있는 파일을 선택해주세요)

위와 같이 Active profiles에 prod-profile을 입력해주세요.

 

똑같이 개발환경도 dev-profile을 입력해 주시면 됩니다.

 

 

 

 

 

 

 

 

 

 

전체 코드는 깃허브에서 확인하실 수 있습니다.

 

https://github.com/ShinDongHun1/SpringBoot-Board-API

GitHub - ShinDongHun1/SpringBoot-Board-API

 

 

 

 

 

 

 

 

이상하거나 오류가 나는 부분이 있다면 댓글로 알려주시면 감사하겠습니다.

광고도 한번씩 눌러주시면 감사하겠습니다  :)