5.2从一个输出日志的实例分析Java的代理机制

5.2  从一个输出日志的实例分析Java的代理机制

上面讲到&＃xff0c;要了解Spring的AOP&＃xff0c;先来了解Java的代理机制。本节主要通过一个输出日志的实例来分析Java的代理机制。首先介绍以前写日志的时候是怎么实现的&＃xff0c;然后讲解使用Java的代理机制怎么实现日志的输出&＃xff0c;接着讲解怎样通过Java的动态代理机制把这个日志输出改成通用的&＃xff0c;最后引出AOP的几个关键点。

5.2.1  通用的日志输出方法

在笔者使用Spring以前开发的程序中&＃xff0c;不管是使用Java自动的日志工具&＃xff0c;还是使用Log4j&＃xff0c;或是自己编写的日志工具&＃xff0c;都要在每一个业务逻辑方法里编写记录日志的代码。使用AOP就可以使业务逻辑和记录日志这两件事情分离开。这个输出日志实例的实现思路是&＃xff1a;首先给出原来在程序中编写日志的方法&＃xff0c;然后编写测试程序&＃xff0c;查看输出结果&＃xff0c;最后对这种方法进行总结&＃xff0c;指出这种方法的缺点。具体编写步骤如下&＃xff1a;

&＃xff08;1&＃xff09;打开Eclipse&＃xff0c;在com.gc.action包中建立一个Java文件TimeBook.java&＃xff0c;用来模拟实际业务中考勤审核的业务逻辑。

&＃xff08;2&＃xff09;原来在程序中编写日志时&＃xff0c;都要在每一个业务逻辑方法里编写记录日志的代码。TimeBook.java的示例代码如下&＃xff1a;

//******* TimeBook.java**************

import org.apache.log4j.Level;

import org.apache.log4j.Logger;

public class TimeBook {

         private Logger logger &＃61; Logger.getLogger(this.getClass().getName());

         //审核数据的相关程序

         public void doAuditing(String name) {

                  logger.log(Level.INFO, name &＃43; " 开始审核数据....");

                  //审核数据的相关程序

                  ……   

                  logger.log(Level.INFO, name &＃43; " 审核数据结束....");

         }

}

代码说明&＃xff1a;

  ●       在业务逻辑中使用log4j作为日志输出的工具。

  ●       doAuditing()方法用来处理实际业务中的考勤审核。

  ●       参数name&＃xff0c;用来传入是谁执行了类TimeBook中的doAuditing()方法。

  ●       在审核代码的前后添加了用logger.log()方法实现日志输出的功能。

&＃xff08;3&＃xff09;编写测试程序&＃xff0c;继续在以前的测试程序TestHelloWorld的基础上进行修改&＃xff0c;TestHelloWorld.java的示例代码如下&＃xff1a;

//******* TestHelloWorld.java**************

package com.gc.test;

import com.gc.action.TimeBook;

public class TestHelloWorld {

         public static void main(String[] args) {

                   TimeBook timeBook &＃61; new TimeBook();

timeBook.doAuditing("张三");

    }

}

代码说明&＃xff1a;timeBook.doAuditing("张三")表示该程序的执行人是“张三”。

&＃xff08;4&＃xff09;运行测试程序&＃xff0c;查看通过TimeBook类输出的日志信息&＃xff0c;如图5.1所示。

图5.1  通过TimeBook类输出日志信息

在上面的示例中&＃xff0c;笔者把日志信息添加在了具体的业务逻辑中&＃xff0c;假如程序中其他的代码都需要日志输出的功能&＃xff0c;那么每个程序就都要添加和上面类似的代码。这样&＃xff0c;在程序中&＃xff0c;就会存在很多类似的日志输出代码&＃xff0c;造成了很大的耦合&＃xff0c;通过什么方法可以使业务逻辑和输出日志的代码分离呢&＃xff1f;通过面向接口编程可以改进这个问题。

5.2.2  通过面向接口编程实现日志输出

通过前面的示例程序&＃xff0c;读者可以了解到以前添加日志信息方法的缺点。下面主要通过面向接口编程来改进这个缺点。其实现思路是&＃xff1a;首先把执行考勤审核的doAuditing()方法提取出来成为接口&＃xff0c;然后通过一个实体类来实现这个方法&＃xff0c;在这个方法里编写具体的考勤审核的业务逻辑&＃xff0c;接着通过一个代理类来进行日志输出&＃xff0c;最后编写测试程序&＃xff0c;查看输出结果。具体步骤如下&＃xff1a;

&＃xff08;1&＃xff09;在com.gc.impl包中&＃xff0c;建立一个接口TimeBookInterface。TimeBookInterface.java的示例代码如下&＃xff1a;

//******* TimeBookInterface.java**************

package com.gc.impl;

import org.apache.log4j.Level;

//通过面向接口编程实现日志输出

public interface TimeBookInterface {

         public void doAuditing(String name);

}

&＃xff08;2&＃xff09;在com.gc.action包中&＃xff0c;使前面已经建立好的类TimeBook实现接口TimeBookInterface&＃xff0c;在doAuditing()方法中编写具体的考勤审核代码。TimeBook.java的示例代码如下&＃xff1a;

//******* TimeBook.java**************

package com.gc.action;

import com.gc.impl.TimeBookInterface;

public class TimeBook implements TimeBookInterface {

public void doAuditing(String name) {

//审核数据的相关程序

……   

}

}

&＃xff08;3&＃xff09;编写一个代理类&＃xff0c;用来实现日志的输出&＃xff0c;在该类中针对前面的接口TimeBookInterface编程&＃xff0c;而不针对具体的类&＃xff0c;从而实现具体业务逻辑与日志输出代码。TimeBookProxy.java的示例代码如下&＃xff1a;

//******* TimeBookProxy.java**************

package com.gc.action;

import org.apache.log4j.Level;

import org.apache.log4j.Logger;

import com.gc.impl.TimeBookInterface;

public class TimeBookProxy {

private Logger logger &＃61; Logger.getLogger(this.getClass().getName());

private TimeBookInterface timeBookInterface;

     //在该类中针对前面的接口TimeBookInterface编程&＃xff0c;而不针对具体的类

     public TimeBookProxy(TimeBookInterface timeBookInterface) {

        this.timeBookInterface &＃61; timeBookInterface;

     }

          //实际业务处理

          public void doAuditing(String name) {

                   logger.log(Level.INFO, name &＃43; " 开始审核数据....");

                   timeBookInterface.doAuditing(name);   

                   logger.log(Level.INFO, name &＃43; " 审核数据结束....");

          }

}

&＃xff08;4&＃xff09;修改测试程序TestHelloWorld&＃xff0c;把类TimeBook当作参数传入代理类TimeBookProxy中&＃xff0c;从而实现对具体负责考勤审核类TimeBook的调用。TestHelloWorld.java的示例代码如下&＃xff1a;

//******* TestHelloWorld.java**************

package com.gc.test;

import com.gc.action.TimeBook;

import com.gc.action.TimeBookProxy;

public class TestHelloWorld {

         public static void main(String[ ] args) {

           //这里针对接口进行编程

TimeBookProxy timeBookProxy  &＃61; new TimeBookProxy(new TimeBook());

timeBookProxy .doAuditing("张三");

    }

}

&＃xff08;5&＃xff09;运行测试程序&＃xff0c;可以得到通过TimeBookProxy类输出日志信息&＃xff0c;如图5.2所示。

图5.2  通过TimeBookProxy类输出日志信息

和前面一个日志输出做对比&＃xff0c;可以看到&＃xff0c;在这个示例中&＃xff0c;具体负责考勤审核的业务逻辑代码和日志信息的代码分离开了&＃xff0c;并且以后只要实现了接口TimeBookInterface的类&＃xff0c;都可以通过代理类TimeBookProxy实现日志信息的输出&＃xff0c;而不用再每个类里面都写日志信息输出的代码&＃xff0c;从而实现了日志信息的代码重用。

5.2.3  使用Java的代理机制进行日志输出

前面的代码虽然有了一些改进&＃xff0c;但是仍然有一定局限性&＃xff0c;因为要使用代理类&＃xff0c;就必须要实现固定的接口&＃xff0c;有没有一种通用的机制&＃xff0c;不管是不是实现这个接口&＃xff0c;都可以实现日志信息的输出呢&＃xff1f;

Java提供的InvocationHandler接口可以实现这种功能&＃xff0c;首先编写一个日志信息的代理类&＃xff0c;这个代理类实现了接口InvocationHandler&＃xff0c;然后和前面一个实例类似&＃xff0c;编写一个接口&＃xff0c;并实现这个接口&＃xff0c;在实现类中编写具体的考勤审核代码&＃xff0c;最后针对接口编写测试类&＃xff0c;查看测试结果。具体步骤如下&＃xff1a;

&＃xff08;1&＃xff09;编写一个日志信息的代理类LogProxy&＃xff0c;这个代理类实现了接口InvocationHandler&＃xff0c;可以对任何接口实现日志信息的输出。LogProxy.java的示例代码如下&＃xff1a;

//******* LogProxy.java**************

package com.gc.action;

import java.lang.reflect.InvocationHandler;

import java.lang.reflect.Method;

import java.lang.reflect.Proxy;

import org.apache.log4j.Level;

import org.apache.log4j.Logger;

//代理类实现了接口InvocationHandler

public class LogProxy implements InvocationHandler {

         private Logger logger &＃61; Logger.getLogger(this.getClass().getName());

    private Object delegate;

    //绑定代理对象

    public Object bind(Object delegate) {

        this.delegate &＃61; delegate;

        return Proxy.newProxyInstance(delegate.getClass().getClassLoader(), delegate.getClass().
getInterfaces(), this);

    }

    //针对接口编程

    public Object invoke(Object proxy, Method method, Object[ ] args) throws Throwable {

        Object result &＃61; null;

        try {

                            //在方法调用前后进行日志输出

logger.log(Level.INFO, args[0] &＃43; " 开始审核数据....");

              result &＃61; method.invoke(delegate, args);

                            logger.log(Level.INFO, args[0] &＃43; " 审核数据结束....");

        } catch (Exception e){

            logger.log(Level.INFO, e.toString());

        }

        return result;

    }

}

&＃xff08;2&＃xff09;使用com.gc.impl包中的接口TimeBookInterface。TimeBookInterface.java的示例代码如下&＃xff1a;

//******* TimeBookInterface.java**************

package com.gc.impl;

import org.apache.log4j.Level;

//针对接口编程

public interface TimeBookInterface {

         public void doAuditing(String name);

}

&＃xff08;3&＃xff09;使用com.gc.action包中的类TimeBook&＃xff0c;doAuditing()方法中编写具体的考勤审核代码。TimeBook.java的示例代码如下&＃xff1a;

//******* TimeBook.java**************

package com.gc.action;

import com.gc.impl.TimeBookInterface;

public class TimeBook implements TimeBookInterface {

public void doAuditing(String name) {

//审核数据的相关程序

……   

}

}

&＃xff08;4&＃xff09;修改测试代码TestHelloWorld&＃xff0c;使用日志代理类LogProxy 实现日志的输出。TestHelloWorld.java的示例代码如下&＃xff1a;

//******* TestHelloWorld.java**************

package com.gc.test;

import com.gc.action.TimeBook;

import com.gc.action.TimeBookProxy;

import com.gc.impl.TimeBookInterface;

import com.gc.action.LogProxy;

public class TestHelloWorld {

         public static void main(String[ ] args) {

           //实现了对日志类的重用

           LogProxy logProxy  &＃61; new LogProxy();

TimeBookInterface timeBookProxy &＃61; (TimeBookInterface)logProxy.bind(new TimeBook());

timeBookProxy.doAuditing("张三");

    }

}

&＃xff08;5&＃xff09;运行测试程序&＃xff0c;可以得到通过LogProxy类输出日志信息&＃xff0c;如图5.3所示。

图5.3  通过LogProxy类输出日志信息

这种方式&＃xff0c;对于其他的类也同样适用&＃xff0c;这样就真正地实现了业务逻辑和输出日志信息代码的分离。

5.2.4  对这3种实现方式进行总结

第一种方式&＃xff0c;需要在每个类里都增加对输出日志信息的代码&＃xff1b;第二种方式&＃xff0c;虽然实现了业务逻辑与输出日志信息代码的分离&＃xff0c;但还是必须依赖于固定的接口&＃xff1b;第三种方式&＃xff0c;真正实现了对输出日志信息代码的重用&＃xff0c;并且不依赖于固定的接口实现。

从第三种方式中&＃xff0c;也可以看出Java动态代理机制的强大&＃xff0c;而Spring的AOP正是建立在Java动态代理的基础上的&＃xff0c;当读者通过上面的示例一步一步地对Java的动态代理机制有了一定的了解后&＃xff0c;接下来就可以逐渐地进入AOP了。