今天对项目的日志进行重构,采用Aop对日志进行统一处理,日志采用Slf4j+logback框架
spring aop 概念
AOP ( Aspect Oriented Programing) 面向切面编程, AOP 是对 OOP (面向对象编程)思想一个延伸。
AOP采取横向抽取机制,取代了传统纵向继承体系重复性代码(性能监视、事务管理、安全检查、缓存)
概念不多讲,重点注意下面的几个概念
1.Joinpoint(连接点):
所谓连接点是指那些被拦截到的点。在spring中,这些点指的是方法, 因为spring只支持方法类型的连接点。
2.Pointcut(切入点):
所谓切入点是指我们要对哪些Joinpoint进行拦截的定义.
3.Advice(通知/增强):
所谓通知是指拦截到Joinpoint之后所要做的事情就是通知.通知分为前置通知,后置通知,异常通知,最终通知,环绕通知(切面要完成的功能)
Introduction(引介):
引介是一种特殊的通知在不修改类代码的前提下, Introduction可以在运行期为类动态地添加一些方法或Field.
Target(目标对象):
代理的目标对象
Weaving(织入):
是指把增强应用到目标对象来创建新的代理对象的过程.spring采用动态代理织入,而AspectJ采用编译期织入和类装在期织入
Proxy(代理):
一个类被AOP织入增强后,就产生一个结果代理类
Aspect(切面):
是切入点和通知(引介)的结合,一个切面可以由多个切点和多个通知组成.
下面我们从代码中来具体解释:
从业务上说我们将每个方法中日志代码抽出,编写到代理类中。
LoginController 是我们需要被代理的类既Target(目标对象)
类中的方法(login,queryUserType) 是Joinpoint(连接点)
/**
* Created by Tomas on 2017/9/26.
* 登录 controller
* @author ThomasZou
*/
@Controller
public class LoginController {
@Autowired
private LoginService loginService;
private static Logger logger = LoggerFactory.getLogger(LoginController.class);
/**
* 登陆 Joinpoint(连接点)
* @param session
* @param request
* @param loginName
* @param pwd
* @return
* @throws Exception
*/
@RequestMapping("/login")
@ResponseBody
public String login(HttpSession session, HttpServletRequest request,
String loginName, String pwd) throws Exception {
if (loginService.loginCheck(loginName, pwd) != null) {
SysUser user = loginService.loginCheck(loginName, pwd);
session.setAttribute("user", user);
return "success";
}
return "error";
}
/**
* 登出 Joinpoint(连接点)
* @param session
* @param request
* @return
*/
@RequestMapping("/loginout")
public String userExit(HttpSession session, HttpServletRequest request) {
if (((SysUser) session.getAttribute("user")) != null) {
logger.info("用户:"
+ ((SysUser) session.getAttribute("user")).getUserName()
+ "登出,IP:" + request.getRemoteAddr());
}
session.invalidate();
return "login/login.html";
}
/**
* 验证用户类型 Joinpoint(连接点)
* @param session
* @return
*/
@RequestMapping("/queryUserType")
@ResponseBody
public SysUser queryUserType(HttpSession session) {
SysUser user = (SysUser) session.getAttribute("user");
return user;
}
}
下面是我们的切面(Aspect):
我直接把对应的概念写到注释中,这里就不再赘述。
/**
* Aop Aspect(切面)
* 对 LoginController 进行代理
* @author ThomasZou
*/
@Aspect
@Component
@Slf4j
public class WebLogAspect {
/**
* Pointcut(切入点):@Pointcut("execution(public * com.wlw.controller.LoginController.*(..))")
* 这个注释指将LoginController中的全部连接点作为切入点。
*/
@Pointcut("execution(public * com.wlw.controller.LoginController.*(..))")
public void webLog(){
System.out.println("111111111111111");
}
/**
* Advice(通知/增强):
* 使用@Before在切入点开始处切入内容
* @param joinPoint 连接点:代理过程中可以被拦截的方法
* 对应LoginController中的全部方法
*/
@Before("webLog()")
public void doBefore(JoinPoint joinPoint){
System.out.println(joinPoint);
log.info("WebLogAspect.doBefore()");
}
/**
* 增强
* 使用@AfterReturning在切入点return内容之后切入内容(可以用来对处理返回值做一些加工处理)
* @param joinPoint
*/
@AfterReturning("webLog()")
public void doAfterReturning(JoinPoint joinPoint){
// 处理完请求,返回内容
log.info("WebLogAspect.doAfterReturning()");
}
}
其中传统的Spring AOP 提供了五个通知(Advice)
使用@Before在切入点开始处切入内容
使用@After在切入点结尾处切入内容
使用@AfterReturning在切入点return内容之后切入内容(可以用来对处理返回值做一些加工处理)
使用@Around在切入点前后切入内容,并自己控制何时执行切入点自身的内容
使用@AfterThrowing用来处理当切入内容部分抛出异常之后的处理逻辑
这里附带对@Aspect,@Pointcut说明一下:
使用@Aspect注解将一个java类定义为切面类
使用@Pointcut定义一个切入点,可以是一个规则表达式,比如下例中某个package下的所有函数,也可以是一个注解等。
根据需要在切入点不同位置的切入内容