java 实现AOP日志记录功能

     

           目前整个开发社区对AOP(Aspect Oriented Programing)推崇备至，也涌现出大量支持AOP的优秀Framework,--Spring, JAC, Jboss AOP 等等。AOP似乎一时之间成了潮流。Java初学者不禁要发出感慨，OOP还没有学通呢，又来AOP。本文不是要在理论上具体阐述何为AOP, 为何要进行AOP . 要详细了解学习AOP可以到它老家http://aosd.net去瞧瞧。这里只是意图通过一个简单的例子向初学者展示一下如何来进行AOP.

　　为了简单起见，例子没有没有使用任何第三方的AOP Framework, 而是利用Java语言本身自带的动态代理功能来实现AOP.

　　让我们先回到AOP本身，AOP主要应用于日志记录，性能统计，安全控制,事务处理等方面。它的主要意图就要将日志记录，性能统计，安全控制等等代码从商业逻辑代码中清楚的划分出来，我们可以把这些行为一个一个单独看作系统所要解决的问题，就是所谓的面向问题的编程(不知将AOP译作面向问题的编程是否欠妥)。通过对这些行为的分离，我们希望可以将它们独立地配置到商业方法中，而要改变这些行为也不需要影响到商业方法代码。

　　假设系统由一系列的BusinessObject所完成业务逻辑功能，系统要求在每一次业务逻辑处理时要做日志记录。这里我们略去具体的业务逻辑代码。

public interface BusinessInterface { 
　public void processBusiness(); 
} 

public class BusinessObject implements BusinessInterface { 
　private Logger logger = Logger.getLogger(this.getClass().getName()); 
　public void processBusiness(){ 
　　try { 
　　　logger.info("start to processing..."); 
　　　//business logic here. 
　　　System.out.println(“here is business logic”); 
　　　logger.info("end processing..."); 
　　} catch (Exception e){ 
　　　logger.info("exception happends..."); 
　　　//exception handling 
　　} 
　} 
} 

 

　　这里处理商业逻辑的代码和日志记录代码混合在一起，这给日后的维护带来一定的困难，并且也会造成大量的代码重复。完全相同的log代码将出现在系统的每一个BusinessObject中。


　　按照AOP的思想，我们应该把日志记录代码分离出来。要将这些代码分离就涉及到一个问题，我们必须知道商业逻辑代码何时被调用，这样我们好插入日志记录代码。一般来说要截获一个方法，我们可以采用回调方法或者动态代理。动态代理一般要更加灵活一些，目前多数的AOP Framework也大都采用了动态代理来实现。这里我们也采用动态代理作为例子。

　　JDK1.2以后提供了动态代理的支持，程序员通过实现java.lang.reflect.InvocationHandler接口提供一个执行处理器，然后通过java.lang.reflect.Proxy得到一个代理对象，通过这个代理对象来执行商业方法,在商业方法被调用的同时，执行处理器会被自动调用。

　　有了JDK的这种支持，我们所要做的仅仅是提供一个日志处理器。

public class LogHandler implements InvocationHandler { 

　private Logger logger ＝ Logger.getLogger(this.getClass().getName()); 
　　private Object delegate; 
　　public LogHandler(Object delegate){ 
　　　this.delegate = delegate; 
　　} 

　public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { 
　　Object o = null; 
　　try { 
　　　logger.info("method stats..." ＋ method); 
　　　o = method.invoke(delegate,args); 
　　　logger.info("method ends..." + method); 
　　} catch (Exception e){ 
　　　logger.info("Exception happends..."); 
　　　//excetpion handling. 
　　} 
　　return o; 
　} 
} 

　　现在我们可以把BusinessObject里面的所有日志处理代码全部去掉了。 

public class BusinessObject implements BusinessInterface { 

　private Logger logger = Logger.getLogger(this.getClass().getName()); 
　public void processBusiness(){ 
　　//business processing 
　　System.out.println(“here is business logic”); 
　} 
} 

 
　　客户端调用商业方法的代码如下：

BusinessInterface businessImp = new BusinessObject(); 

InvocationHandler handler = new LogHandler(businessImp); 

BusinessInterface proxy = (BusinessInterface) Proxy.newProxyInstance( 
　businessImp.getClass().getClassLoader(), 
　businessImp.getClass().getInterfaces(), 
　handler); 

proxy.processBusiness(); 

 
　　程序输出如下：

INFO: method stats...
here is business logic
INFO: method ends...

　　至此我们的第一次小尝试算是完成了。可以看到，采用AOP之后，日志记录和业务逻辑代码完全分开了，以后要改变日志记录的话只需要修改日志记录处理器就行了，而业务对象本身（BusinessObject）无需做任何修改。并且这个日志记录不会造成重复代码了，所有的商业处理对象都可以重用这个日志处理器。

　　当然在实际应用中，这个例子就显得太粗糙了。由于JDK的动态代理并没有直接支持一次注册多个InvocationHandler，那么我们对业务处理方法既要日志记录又要性能统计时，就需要自己做一些变通了。一般我们可以自己定义一个Handler接口，然后维护一个队列存放所有Handler, 当InvocationHandler被触发的时候我们依次调用自己的Handler。所幸的是目前几乎所有的AOP Framework都对这方面提供了很好的支持.这里推荐大家使用Spring。

评论

1 楼 leon.s.kennedy 2012-04-26  

博主您好
这样不就将日志信息 写死了吗？硬编码
怎么才能动态的生成日志呢？
参数是obj[] 如何判断实际做日志参数类型，难道要instanceof吗