Spring 10. AOP 프로그래밍 (1) - 프록시와 AOP

2021. 1. 13. 18:02

AOP

AOP를 공부하기 전에 AOP의 사용예를 한가지만 살펴보겠습니다.

다음과 같은 UserController 가 있다고 해봅시다.

잘 동작하는 코드인지, 어떻게 동작하는 코드인지는 생각하지 마시고 코드의 의미만 이해하시면 됩니다.

join 함수는 회원가입이 성공하면 statusCode가 201 Created 인 HttpResponse 객체를 return합니다.

public class UserController {
    
    public ResponseEntity join(JoinRequest joinRequest) {    // 회원가입
        userService.join(joinRequest);

        return ResponseEntity
            .created()
            .build();
    }
    
    public ResponseEntity login(LoginRequest loginRequest) {    // 로그인
        userService.login(loginRequest);

        return ResponseEntity
            .ok();
    }
}

두 함수는 모두 핵심 로직을 userService 에게 위임하고있습니다. 그런데 이 userService 에서 가끔씩 WrongUserInputException 예외객체를 throw 한다고 해봅시다.

예를들어 회원가입 요청에 비밀번호가 누락되어있다거나, 로그인 요청에 아이디 비밀번호가 null 일 경우 UserService 가 WrongUserInputException 예외를 throw 하도록 구현한 것입니다.

그리고 저는 WrongUserInputException이 발생하면 400 Bad Request 응답을 내려주고 싶습니다. 그렇다면 아래와 같이 코드를 수정하면 됩니다.

public class UserController {
    
    public ResponseEntity join(JoinRequest joinRequest) {    // 회원가입
        try {
            userService.join(joinRequest);

            return ResponseEntity
                .created()
                .build();
        } catch (WrongUserInputException e) {
            return ResponseEntity.status(HttpStatus.BAD_REQUEST)
                .body(e.getMessage());
        }
    }
    
    public ResponseEntity login(LoginRequest loginRequest) {    // 로그인
        try {
            userService.login(loginRequest);

            return ResponseEntity
                .ok();
        } catch (WrongUserInputException e) {
            return ResponseEntity.status(HttpStatus.BAD_REQUEST)
                .body(e.getMessage());
        }

    }
}

회원가입/로그인 과정에서 WrongUserInputException 예외가 발생하면

컨트롤러가 이를 catch 해서

statusCode 가 400 Bad Request 인 HttpResponse 를 return 하도록 구현했습니다.

그런데 코드 자체는 try-catch 가 적용되기 전이 더 깔끔하죠?

try-catch 부분은 핵심 기능도 아닐 뿐더러 두 함수에서 반복적으로 등장했습니다.

UserController 에는 이 중복되는 부가기능 코드를 남겨두지 않은 채로

WrongUserInputException 이 발생하면 400 응답 하게 할 수 없을까요?

이럴 때 적용하면 좋은것이 AOP 입니다.

AOP 란, 여러 객체에 공통적으로 적용할 수 있는 기능을 분리해서 재사용성을 높여주는 프로그래밍 기법입니다.

어떤 프로젝트에 UserController 뿐만 아니라 PostController, CommentController 도 있다고 해봅시다. 이 컨트롤러들도 잘못된 HttpRequest가 들어오면 400 Bad Request 응답을 return하고 싶습니다. 그러면 앞서 등장한 try-catch 코드가 똑같이 사용되겠죠. 이 예시에서는 이 부분이 '여러 객체에 공통적으로 적용할 수 있는 기능'인 것입니다.

// 여러 객체에 공통적으로 적용할 수 있는 기능
try {

} catch (WrongUserInputException e) {
    return ResponseEntity.status(HttpStatus.BAD_REQUEST)
        .body(e.getMessage());
}

AOP 란?

핵심 기능의 코드를 수정하지 않으면서 공통 기능의 구현을 추가하는 것

프록시와 AOP

예제코드는 다음과 같이 아주 간단하게 Printer, GreetingPrinter, LovePrinter를 사용하겠습니다.

package message;

public interface Message {

    String getValue();
}

package message;

public class GreetingMessage implements Message {

    @Override
    public String getValue() {
        return "Hello!";
    }
}

package message;

public class LoveMessage implements Message {

    @Override
    public String getValue() {
        return "I ♡ you";
    }
}

이 클래스들은 다음과 같이 사용될 것입니다.

import message.Message;
import message.LoveMessage;

public class Test {

    public static void main(String[] args) {
        Message message = new LoveMessage();
        System.out.println(message.getValue());
    }
}

Message 객체의 getValue 리턴값을 항상 대문자로 받고싶다고 해봅시다. 그러려면 다음과 같이

GreetingMessage 와 LoveMessage를 수정하면 될 것입니다.

package message;

public class GreetingMessage implements Message {

    @Override
    public String getValue() {
        return "Hello!".toUpperCase();
    }
}

package message;

public class LoveMessage implements Message {

    @Override
    public String getValue() {
        return "I ♡ you".toUpperCase();
    }
}

예제가 너무 단순해서 느낌이 안올지도 모르겠지만 toUpperCase() 가 반복해서 등장하고 있습니다. toUpperCase() 는 앞서 등장했던 UserController 예시의 try-catch 코드에 대응됩니다.

이 toUpperCase 부분을 추출해보겠습니다. 새로 추가된 클래스는 UpperCaseMessage 입니다.

package message;

public class UpperCaseMessage implements Message {

    private Message message;

    public UpperCaseMessage(Message message) {
        this.message = message;
    }

    @Override
    public String getValue() {
        return message.getValue()
            .toUpperCase();
    }
}

package message;

public class GreetingMessage implements Message {

    @Override
    public String getValue() {
        return "Hello!";
    }
}

package message;

public class LoveMessage implements Message {

    @Override
    public String getValue() {
        return "I ♡ you";
    }
}

그리고 사용법은 다음과 같이 변할것입니다.

import message.Message;
import message.UpperCaseMessage;
import message.LoveMessage;

public class Test {

    public static void main(String[] args) {
        Message message = new UpperCaseMessage(new LoveMessage());
        System.out.println(message.getValue());
    }
}

이제 LoveMessage 와 GreetingMessage 코드에서 .toUpperCase() 가 사라졌습니다. 그러면서도 이 기능은 그대로 사용할 수 있죠. 대신 사용법이 조금 달라졌네요.

이 때 LoveMessage(또는 GreetingMessage)와 클라이언트(해당 객체를 사용하는 쪽) 사이에 존재하는 UpperCaseMessage 객체를 프록시 객체라고 합니다.

또한, LoveMessage 처럼 핵심 기능을 가지고 있는 객체는 target 또는 target object 라고 합니다.

그리고 target 에 부가적인 기능을 런타임 시 다이내믹하게 부여해주기 위해 프록시를 사용하는 패턴을 데코레이터 패턴이라고 합니다.

이렇게 프록시 객체를 사용하여 핵심 코드와 부가기능 코드를 분리할 수 있다는 것을 알아봤습니다. 그런데 프록시 객체를 만드는 것은 번거로운 일일 수 있습니다. 예를들어, Message 인터페이스에 엄청나게 많은 메소드들이 선언되어있다고 해봅시다. (예시로는 두개의 메소드만 추가해보겠습니다)

package message;

public interface Message {

    String getValue();
    
    void printValue();
    
    int getLength();
}

그런데 부가기능은 getValue() 에만 적용하고 싶다고 해봅시다.

그럼에도 불구하고 프록시 객체를 사용하려면

부가기능이 필요 없는 다른 메소드들도 모두 구현해서 타깃으로 위임하는 코드를 일일히 만들어줘야 합니다.

아래 코드에서 printValue() 와 getLength() 가 바로 그 예시입니다. 이런 메서드가 한두개면 몰라도 엄청나게 많아지면 굉장히 번거롭겠죠. 코드도 쓸데없이 길어지구요.

package message;

public class UpperCaseMessage implements Message {

    private Message message;

    public UpperCaseMessage(Message message) {
        this.message = message;
    }

    @Override
    public String getValue() {
        return message.getValue()
            .toUpperCase();
    }

    @Override
    public void printValue() {
        message.printValue();
    }

    @Override
    public int getLength() {
        return message.getLength();
    }
}

또한 타깃 인터페이스의 메소드가 추가되거나 변경될 때마다 프록시 객체 클래스도 함께 수정해줘야 한다는 부담도 있습니다.

스프링을 이용해서 AOP를 구현하면 이런 문제를 겪지 않을 수 있습니다.

'2021 Spring Study' 카테고리의 다른 글

Spring 12. AOP 프로그래밍 (3) - 포인트컷 표현식 (0)	2021.01.13
Spring 11. AOP 프로그래밍 (2) - 스프링 AOP 구현 (0)	2021.01.13
Spring 9. Bean 라이프사이클 미션 (0)	2021.01.08
Spring 8. 컴포넌트 스캔 연습 (0)	2021.01.07
Spring 7. 컴포넌트 스캔 핵심 요약 (0)	2021.01.05

Yerim's Blog