[Web_3] STUSSY CLONE PROJECT 4 😶

08627·2022년 10월 4일

Spring

목록 보기

12/13

📌 AOP (관점 지향 프로그래밍)
📌 @어노테이션 으로 AOP 구현하기
🐊 @Aspect / @Pointcut / @Around / @Before
👾 메소드 실행 시 로그 정보가 출력되도록 하는 @어노테이션
👾 유효성 검사 @어노테이션

💡 AOP (관점 지향 프로그래밍)

'핵심' 기능과 '부가' 기능을 나누어 개발하도록 하는 것.

주 비즈니스 로직과 공통 기능으로 구분하고, 공통 기능은 필요한 때 불러와 적용한다.

💡 @어노테이션 으로 AOP 구현하기

어노테이션 맨들어서 AOP 구현

🐊 @Aspect / @Pointcut / @Around

@Aspect ; AOP 공통 기능을 구현하는 클래스에 주는 어노테이션
@Pointcut ; 주 비즈니스 로직을 따라가다가 공통 기능이 필요한 시점(메소드)에 포인트컷 어노테이션을 주어서 기능을 사용할 수 있도록 한다.
@Around ; 실행되기 전, 후에 동작한다. ( ※ 공통 기능 수행 후에도 동작해야 하므로 proceed 되어지는 Object를 반환해주어야 함 )

👾 메소드 실행 시 로그 정보가 출력되도록 하는 @어노테이션

▫️ @LogAspect

@Retention(RetentionPolicy.RUNTIME) // 어노테이션 메모리를 동작하는 동안 가지고 있겠다 .. (라이프사이클 설정) 
@Target({ElementType.TYPE, ElementType.METHOD}) // 어노테이션을 달 수 있는 타입을 정해준다
public 📍@interface LogAspect {
}

＊ ElementType.TYPE
→ 클래스, 인터페이스 (어노테이션 포함), emum (열거형 ⁓ 집합 같은 ) 타입

▫️ LogAop.java

@Slf4j
@Aspect // AOP 구현 클래스이다
@Component // 스프링 IoC 빈 등록
public class LogAop {

    @Pointcut("@annotation(com.stussy._.aop.annotation.LogAspect)")
    private void annotationLog() {} 
    // ➡️ @LogAspect 어노테이션이 달린 지점


	// ➡️ annotationLog()이 실행되는 시점의 Before/After 에 아래의 메소드를 실행함   
    @Around("annotationLog()") 
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        Object[] args = joinPoint.getArgs();

        CodeSignature codeSignature = (CodeSignature) joinPoint.getSignature();
        String[] argNames = codeSignature.getParameterNames();

        StringBuilder argNameString = new StringBuilder();
        StringBuilder argDataString = new StringBuilder();

        for(int i = 0; i < args.length; i++) {
            argNameString.append(argNames[i]);
            argDataString.append(args[i].toString());
            if(i < args.length - 1) {
                argNameString.append(", ");
                argDataString.append(", ");
            }
        }
        log.info("Method Call -- {}.{}({}) >> {}",
                joinPoint.getSignature().getDeclaringTypeName(),
                joinPoint.getSignature().getName(),
                argNameString.toString(),
                argDataString.toString());

        Object result = joinPoint.proceed(); // ⭐ Target 메소드 실행 제어

        log.info("Method Return -- {}.{}({}) >> {}",
                joinPoint.getSignature().getDeclaringTypeName(),
                joinPoint.getSignature().getName(),
                argNameString.toString(),
                result);

        return result;
    }
}

🦎 ( Proceeding ) JoinPoint

조인포인트는 대상 객체, 메서드 및 전달되는 파라미터에 대한 정보들( → 로직을 끼워넣을 수 있는 합류 지점이 됨 )을 모두 배열로 가져오는 객체이다.

즉, JoinPoint로 어노테이션을 다는 객체를 사용할 수 있음.

👾 유효성 검사 @어노테이션

▫️ @ValidAspect

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface ValidAspect {
}

▫️ ValidationAop.java

@Slf4j
@Aspect // AOP 구현 클래스이다
@Component // 스프링 IoC 빈 등록
public class ValidationAOP {

    @Pointcut("@annotation(com.stussy.stussy._.aop.annotation.ValidAspect)")
    private void annotationValid () {}
    // ➡️ @ValidAspect 어노테이션이 달린 지점
	
    // ➡️ annotationValid()가 실행되는 시점의 Before(전)에 아래의 메소드를 실행함
    @Before("annotationValid()")
    public void before(📍JoinPoint joinPoint) throws Throwable { 
    	// '전' 에만 실행되므로 메소드에서 Proceed 해 줄 필요 없음.  

        Object[] args = joinPoint.getArgs();
        BeanPropertyBindingResult bindingResult = null; // 오류 정보 초기화

        // log.info("args 배열 0번째 >>> {}", args[0]);
        // log.info("args 배열 1번째 >>>{}", args[1]);

        for (Object arg : args) {
            if (arg.getClass() == BeanPropertyBindingResult.class) {
                bindingResult = (BeanPropertyBindingResult) arg;
                break;
            }
        }

        if (bindingResult.hasErrors()) {
            log.info("확인로그 : 잘 들어갔나요? > {}", bindingResult);

            Map<String, String> errorMap = new HashMap<String, String>();

            bindingResult.getFieldErrors().forEach(error -> {
            	log.error("유효성 검사 오류 발생");
                log.info("Error: 필드명({}), 메세지({})" + error.getField(), error.getDefaultMessage());
                errorMap.put(error.getField(), error.getDefaultMessage());
            });
            
            throw new CustomValidationException("Validation failed", errorMap); 
            // ➡️ 에러 정의된 Exception
        }
    }

    @AfterReturning(value = "annotationValid()", returning = "returnObj") 
    // returning ; 리턴 객체 가져와서 사용할 수 있도록 함. 
    // ⭐ 실행 후에 AfterReturning 이 있어야지만 메소드로 다시 돌아가게 됨 ! 
    public void afterReturning(JoinPoint joinPoint, Object returnObj) {
        log.info("Validation success: {}", returnObj);
    }

}