[Spring] Spring MVC에서 AOP 설정 (feat. 루트 컨텍스트와 서블릿 컨텍스트)

🥑 AOP

• 관점 지향 프로그래밍(Aspect Oriented Programming)
• 핵심 관심 사항과 공통 관심 사항을 분리하는 프로그래밍 방식
• 핵심 관심 사항에 적용되는 공통 관심 사항에 대해 모듈로 만들어 코드의 중복을 줄이고 핵심 로직에 집중한다.
• 스프링에서 AOP
  • target에 대해 프록시로 감싸고
  • 프록시가 메소드 호출이나 반환 시에 이를 가로채서
  • advice에 따라 Aspect의 코드를 실행하거나 target 함수를 호출한다.

 

📍 Spring MVC에 AOP 적용하기

공통 관심 사항 (Aspect)

• 공통 관심 사항에 대해 모듈 생성
• @Aspect 애노테이션을 통해 공통 관심 사항임을 설정
• @Pointcut 애노테이션과, 시점(@Before, @AfterReturning, @AfterThrowing, @After, @Around)을 설정하여 Advice 생성

 

Controller, Service, Repository 모든 메소드마다 로그를 찍는 Aspect

@Component
@Aspect
public class LoggingAspect {
	
	private final Logger logger = LoggerFactory.getLogger(LoggingAspect.class);
	
	@Pointcut("execution(* com..*.controller.*.*(..)) || execution(* com..*.model..*.*(..))")
	public void allMethod() {};
	
	@Before("allMethod()")
	public void debug(JoinPoint jp) {
		logger.debug("{} 메소드 실행 - 요청 파라미터 {}",
				jp.getSignature(),
				jp.getArgs());
	}
}

 

xml 설정

root-contex.xml

• 웹과 관련된 설정을 제외한 나머지 설정을 하는 xml
• controller를 제외한 나머지 빈 등록
• aop를 위한 auto-proxy 설정

<context:component-scan base-package="com..model, com..util, com..aop"></context:component-scan>
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

 

servlet-contex.xml

• 웹과 관련된 설정을 하는 xml
• controller 빈 등록
• controller에 대해 aop를 적용하기 위한 auto-proxy 설정

<context:component-scan base-package="com.*.controller" />
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

 

 

📑 AOP 설정에 따른 작동 방식

중복된 빈에 대한 Spring MVC의 빈 선택

• 서블릿 컨텍스트와 루트 컨텍스트에 빈을 중복으로 정의할 수 있다.
• 이때 서블릿 컨텍스의 빈이 루트 컨텍스트의 빈을 가린다.
  • 즉 동일한 이름의 빈이 정의되어 있다면 서블릿 컨텍스트의 빈을 우선적으로 사용한다.
• 서블릿 컨텍스트에서 빈을 찾을 수 없다면 루트 컨텍스트의 빈을 사용한다.
  • 서블릿 컨텍스트에 해당 이름의 빈이 없다면, 스프링은 루트 컨텍스트에서 해당 이름의 빈을 검색한다.
• 빈의 우선순위가 있기 때문에 서블릿 컨텍스트와 루트 컨텍스트의 빈을 구성할 때 중복 정의에 주의해야한다.
  • 서블릿 컨텍스트는 웹 애플리케이션에 특화된 빈(ex controller)를 정의하고, 
  • 루트 컨텍스트는 애플리케이션 전체에서 공유해야하는 빈(ex service, repository)를 정의하는데 사용한다.

 

 

1. 모든 빈에 aop를 적용하고 싶은 경우

# servlet-context.xml
<context:component-scan base-package="com.*.controller" />
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

# root-context.xml
<context:component-scan base-package="com..model, com..util, com..aop"></context:component-scan>
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

• 위의 설정파일 처럼 설정했을 경우 root, servlet context 모두 auto-proxy 설정이 있기 때문에
• 모든 빈에 대해서 proxy로 감싸진다.
• 따라서 모든 controller, service, repository 요청 시에 로깅 메소드가 호출된다.
• 이때 controller는 서블릿 컨텍스트의 빈, 나머지는 루트 컨텍스트의 빈을 사용한다.

 

2. controller 빈에 aop를 적용하고 싶지 않은 경우

# servlet-context.xml
<context:component-scan base-package="com.*.controller" />

# root-context.xml
<context:component-scan base-package="com..model, com..util, com..aop"></context:component-scan>
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

• 서블릿 컨텍스트에서 auto-proxy 설정을 제거한다.
• 서블릿 컨텍스트의 빈을 사용하는 controller는 프록시로 감싸지지 않고
• 루트 컨텍스트의 빈을 사용하는 나머지 빈들에 대해서는 루트 컨텍스트의 설정에 따라 auto-proxy가 적용된다.

 

3. 서블릿, 루트 모두 controller 빈을 가질 때 aop를 적용하고 싶지 않은 경우

# servlet-context.xml
<context:component-scan base-package="com.*.controller" />

# root-context.xml
<context:component-scan base-package="com" />
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

• 루트 컨텍스트는 애플리케이션에 존재하는 모든 빈을 가지고 있다.
• 이때 스프링은 서블릿 컨텍스트의 controller 빈을 선택하고 나머지 빈은 루트 컨텍스트에서 선택한다.
• 따라서 나머지 빈에 대해서만 auto-proxy가 적용되기 때문에 controller 빈에 대해서는 aop가 적용되지 않는다.
  
  • controller의 빈이 루트 컨텍스트에도 존재하기 때문에 auto-proxy 설정이 적용된다고 생각할 수 있지만
  • 스프링이 사용하는 controller 빈은 서블릿 컨텍스트의 빈이기 때문에 aop가 적용되지 않는다

 

💡 결론

• 스프링 컨테이너의 작동 방식에 따라 aop 설정을 유의
• 중복된 빈 설정을 피하고, aop를 적용할 컨텍스트에 대해 auto-proxy 설정