【JavaEE】SSH+Spring Security基础上配置AOP+log4j

Spring Oauth2大多数情况下还是用不到的，主要使用的还是Spring+SpringMVC+Hibernate，有时候加上SpringSecurity，因此，本文及以后的文章的example中都不会包含oauth2的配置，需要的话把前文的applicationContext-security.xml和pom.xml加上就可以了，本文在“SSH+Spring Security搭建方法及example”一文的基础上做一些调整，主要内容是：配置Spring AOP并且用log4j来记录日志。

1. 微调了部分配置文件

前文的pom.xml、spring-dispatcher-servlet.xml、applicationContext.xml等配置文件都是一点一点加的，本文附的代码做了一些调整。

这几个文件不需要做什么实质性的修改，只是做了微调，换了换内容的位置，不多做描述。

2. Spring AOP

面向方面编程 (Aspect Oriented Programming，AOP) 将程序分解成各个方面或者叫关注点。有了AOP，像事务管理这些功能就可以横切多个对象的关注点。AOP的主要功能就是记录日志、事务管理或者数据校验，我的例子是为了记录日志。

Spring AOP的机制我两年前用SSH的时候就不是非常清楚，所以这里除了用法之外，多说几个关键概念：

• Aspect：Aspect就是一个类，它的方法要插入到其他类执行过程中，这个类可以通过XML配置，也可以通过@Aspect注解与Spring的AspectJ整合，比如说我要在日志里为每一个DAO的查询方法记录执行时间，那么记录时间的这些切面方法所在的类就是Aspect；
• Join Point：连接点，就是要插入方面代码的点，上面的例子中，每一个要被记录时间的dao方法就是一个Joinpoint；
• Advice：通知，某一个JoinPoint可以有多个通知，比如方法执行前“before”，方法执行前后“around”等，主要就是before、after、after returning、after throwing、arount这5种；
• Pointcut：是匹配Join Point的一个表达式，来决定Advice是否要触发。

下面就看具体的配置，当年是用XML来配置的，现在用aspectj提供的注解，要更方便和直观一些。

首先在pom.xml中引入aspectj的包（spring aop的包在前文中作为依赖已经引入了）：

<properties>
    ……
    <aspectj.version>1.8.2</aspectj.version>
</properties>
<dependencies>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjtools</artifactId>
        <version>${aspectj.version}</version>
    </dependency>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjrt</artifactId>
        <version>${aspectj.version}</version>
    </dependency>
</dependencies>

下面创建Aspect类，创建一个叫aspect的package（我的项目中是org.zhangfc.demo4ssh.aspect），并创建Aspect类：

@Component
@Aspect
public class LogAspect {

}

@Aspect是一个aspectj提供的注解，spring-aop可以根据这个注解以及PointCut等注解来解析aop配置，这儿需要注意的是@Component注解，我一开始怎么也配不出来，后来发现Spring容器里面根本没有生成logAspect这个bean，因为@Aspect这个注解并不是Spring自己的，IoC模块并不认识这个注解，所以没有创建管理这个bean。加上@Component这个注解就是为了让Spring来管理它。

下面加一个最简单的通知：

@Before("execution(* org.zhangfc.demo4ssh.service..*.*(..))")
public void loggingServiceAdvice() {
    System.out.println("Executing Service...");
}

这个通知是说，在service包及service子包下的任何类的具有任意参数和返回值的任何方法，在执行之前（@Before）都要执行这个方法。

因为要让Spring来管理这个bean，自然要配置一下让Spring去自动扫描Aspect所在的package，打开applicationContext.xml，加入：

<context:component-scan base-package="org.zhangfc.demo4ssh.aspect"/>

因为我现在配置aop主要是为了记录日志，所以aop的配置放在hibernate的配置文件里，打开infrastructure.xml，在最后加入一句让aop自动代理aspectj的配置：

<aop:aspectj-autoproxy />

然后运行程序，在执行Service方法的时候，就会打印出Executing Service...的语句。这只是一个简单的demo，下面来配置我们真正需要的，对dao访问的日志，首先来把程序中抛异常的情况都记下来，在LogAspect类中添加下面的方法：

@AfterThrowing(value="within(org.zhangfc.demo4ssh..*)", throwing = "ex")
public void loggingExceptions(JoinPoint joinPoint, Exception ex) {
    System.err.println("Exception thrown in Method = "
            + joinPoint.toString() + " " + ex.getClass().getSimpleName() + " = " + ex.getMessage());
}

@AfterThrowing是在匹配的方法抛出异常的情况下执行，我这个配置就是指明在我的项目包下面任意package的任意类中，抛出异常之后都会让loggingExceptions来记录，现在我在某个Dao方法中写了一行会抛异常的代码：

Integer.parseInt("asd");

运行过程中就会打印如下的内容：

Exception thrown in Method = execution(List org.zhangfc.demo4ssh.service.UserService.getAllUsers()) NumberFormatException = For input string: "asd"

最后配置dao的访问记录，我要在每一个dao方法执行前后各创建一个切面，那么就要用到@Around通知了，首先来创建一个Pointcut：

@Pointcut("execution(* org.zhangfc.demo4ssh.repo..*.*(..))")
public void daoPointCut() {
}

这个Pointcut匹配了repo package及子package下的任意类的任意方法，之后就可以根据这个Pointcut来创建Around通知：

@Around("daoPointCut()")
public Object loggingAround(ProceedingJoinPoint joinpoint) throws Throwable {
    long start = System.currentTimeMillis();
    System.out.println("method starts...."
            + joinpoint.getSignature().getDeclaringTypeName() + "_"
            + joinpoint.getSignature().getName() + " with "
            + arrayToString(joinpoint.getArgs()));
    Object result = joinpoint.proceed();
    long diff = System.currentTimeMillis() - start;
    System.out.println("method ends...."
            + joinpoint.getSignature().getDeclaringTypeName() + "_"
            + joinpoint.getSignature().getName() + " with " + diff + "ms");
    return result;
}

private String arrayToString(Object[] traces) {
    StringBuilder trace = new StringBuilder();
    for (Object s : traces) {
        trace.append(s == null ? "" : s.toString() + "\t");
    }
    if (trace.length() == 0) {
        trace.append("no parameter");
    }
    return trace.toString();
}

运行输出如下：

method starts....org.zhangfc.demo4ssh.repo.UserDao_findAll with no parameter
method ends....org.zhangfc.demo4ssh.repo.UserDao_findAll with 537ms

3. Log4j

AOP就说到这儿，下面来配置log4j，首先导入log4j的jar包：

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

log4j默认的配置文件需要放在classpath下，而且不能是子目录下，配置文件多了这就非常不方便，如果觉得放在classpath下没有问题，那么把配置文件放过去就可以直接运行了，我现在要改这个配置文件的目录，正好，spring的一个类可以帮我们处理这个事情，不过要在web.xml里面配置一下：

<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>classpath:/META-INF/properties/log4j.properties</param-value>
</context-param>
<context-param>
    <param-name>log4jRefreshInterval</param-name>
    <param-value>60000</param-value>
</context-param>
<listener>
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

这个配置要放在spring listener的前面，指定配置文件位置并且每60秒重新读取配置文件，这样如果变更了配置也不需要重启应用。配置文件的配置方法我就不详述了，这里贴出来我的配置，我把配置往Console和文件里各输出了一份：

log4j.rootLogger=INFO,CONSOLE,ROLLING_FILE
#INFO,CONSOLE,ROLLING_FILE
#ERROR,ROLLING_FILE

###################
# Console Appender
###################
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.Threshold=INFO
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern= [%p] %d %c - %m%n

########################
# Rolling File
########################
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender
log4j.appender.ROLLING_FILE.Threshold=INFO
log4j.appender.ROLLING_FILE.File=${webapp.root}/WEB-INF/webapp.log
log4j.appender.ROLLING_FILE.Append=true
log4j.appender.ROLLING_FILE.MaxFileSize=5000KB
log4j.appender.ROLLING_FILE.MaxBackupIndex=2
log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.ROLLING_FILE.layout.ConversionPattern=[%p] %d %c - %m%n

输出的格式demo如下：

[INFO] 2014-11-22 11:30:07,944 LogAspect - method ends....org.zhangfc.demo4ssh.repo.UserDao_findAll with 385ms

日志文件按配置放在了项目的WEB-INF下面。

源码下载