基于Spring原生AOP的实现为特定业务对象添加简易日志实现。
定义RequiredLog注解,用于描述目标业务对象
package com.cy.spring.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RequiredLog {
}
定义搜索业务接口,用于定义搜索业务规范
package com.cy.spring.aop;
public interface SearchService {
Object search(String key);
}
定义搜索业务接口实现,并使用requiredLog注解描述
package com.cy.spring.aop;
import org.springframework.stereotype.Service;
import com.cy.spring.annotation.RequiredLog;
@Service
public class DefaultSearchService implements SearchService {
@RequiredLog
@Override
public Object search(String key) {
System.out.println("search by "+key);
return null;
}
}
日志Advice对象定义
定义LogAdvice对象,基于此对象为目标业务对象做日志增强。
package com.cy.spring.advisor;
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
public class LogAdvice implements MethodInterceptor {
@Override
public Object invoke(MethodInvocation invocation)
throws Throwable {
System.out.println("start:"+System.currentTimeMillis());
Object result=invocation.proceed();
System.out.println("after:"+System.currentTimeMillis());
return result;
}
}
其中,MethodInterceptor对象继承Advice对象,基于此对象方法可以对目标方法进行拦截。
创建日志Advisor对象,在对象内部定义要切入扩展功能的点以及要应用的通知(Advice)对象。
import java.lang.reflect.Method;
import org.springframework.aop.support.StaticMethodMatcherPointcutAdvisor;
import org.springframework.stereotype.Component;
import com.cy.spring.annotation.RequiredLog;
@Component
public class LogAdvisor extends StaticMethodMatcherPointcutAdvisor {
private static final long serialVersionUID = 7022316764822635205L;
public LogAdvisor() {
//在特定切入点上要执行的通知
setAdvice(new LogAdvice());
}
// Pointcut
// 方法返回值为true时,则可以为目标方法对象创建代理对象
@Override
public boolean matches(Method method, Class<?> targetClass) {
try {
Method targetMethod =
targetClass.getMethod(method.getName(),
method.getParameterTypes());
return targetMethod.isAnnotationPresent(RequiredLog.class);
} catch (Exception e) {
return false;
}
}
}
其中,StaticMethodMatcherPointcutAdvisor类为Spring框架中定义的一种Advisor,我们自己写的Advisor可以直接继承此类进行资源整合。
日志业务单元测试实现
基于Spring boot项目进行单元测试:
package com.cy;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import com.cy.spring.aop.SearchService;
@SpringBootTest
public class CgbSbootAop01ApplicationTests {
@Autowired
private SearchService searchService;
@Test
public void testSearch() {
//System.out.println(searchService);
searchService.search("tedu");
}
}
说明:在spring 框架中,很多功能都是原生AOP进行了功能的扩展和实现。