AOP-通用的API日志实例

序

最近项目里整了一个通用的API日志。感觉挺不错的，整理一下分享出来。
接口大概时间图如下:

分析

除了【业务处理】，其它的处理都与业务无关。可以考虑把通用的部分抽离出来，【业务处理】单独处理。可以用两种方案去处理。

方案

**1：**使用抽象类。提供一个方法，从【开始】处理到【结束】。【业务处理】设一个抽像方法（无实现）。每个接口都继承抽象类。接口类重写抽业务处理抽象方法。
**2：**使用AOP，开发人员只管【业务处理】。通过AOP的方式在【业务处理】包面包一层日志记录。

对比两种方案觉得AOP的方案更好。
1：AOP的方案，在前期不需要做写日志的扩展考虑，后期调整不需要调整原来的代码。
2：AOP的方案，写的代码更优美，可扩展性更强。

AOP实现

1：注释，优美的代码当然离不开注解，对注解情有独钟。

package com.ly.mp.swcas.main.config;
import java.lang.annotation.*;

@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiTag {
 String apiCode(); //接口编号
 String apiName(); //接口描述
}

2：AOP

package com.ly.mp.swcas.main.config;

import com.google.gson.Gson;
import com.ly.mp.common.entities.RestResult;
import com.ly.mp.common.utils.BigDecimalUtils;
import com.ly.mp.swcas.main.entities.ApiLog;
import com.ly.mp.swcas.main.ibiz.IApiLogBiz;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.StopWatch;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Date;
import java.util.UUID;

@Aspect
@Component
public class ApiAspect {

    private static final Logger logger = LoggerFactory.getLogger(ApiAspect.class);

    @Autowired
    IApiLogBiz logBiz;
    /**
     * 拦截注解的方法
     */
    @Pointcut("@annotation(com.ly.mp.swcas.main.config.ApiTag)")
    public void pointcutMethod() {
    }

    /**
     * 流程
     * 1：存储数据到Log
     * 2：执行业务处理方法
     * 3：返回结果，保存Log
     *
     * @param joinPoint
     * @return
     */
    @Around("pointcutMethod()")
    public RestResult around(ProceedingJoinPoint joinPoint) {
        logger.debug("************拦截命中***************");
        ApiLog apiLog = new ApiLog();
        StopWatch watch = new StopWatch();
        watch.start();

        apiLog.setRequestTime(new Date());
        ApiTag cfg = getApiTag(joinPoint);
        apiLog.setApiCode(cfg.apiCode());
        apiLog.setApiName(cfg.apiName());
        apiLog.setRequestContent(joinPoint.getArgs()==null?"": new Gson().toJson(joinPoint.getArgs()));

        apiLog.setId(UUID.randomUUID().toString());
        apiLog.setCreatedDate(new Date());
        apiLog.setIsEnable("1");
        apiLog.setCreator("admin");

        RestResult rs = new RestResult(0,"初始化");

        try {
            logger.info("**********执行业务方法**********");
            rs = (RestResult) joinPoint.proceed();
            apiLog.setRequestStatus(rs.getResult());
        } catch (Throwable e) {
            e.printStackTrace();
            apiLog.setResponseContent(String.format("错误信息:%s",e.getMessage()));
            apiLog.setRequestStatus(0);
        }
        watch.stop();
        apiLog.setRequestCost(BigDecimalUtils.val(watch.getTotalTimeSeconds()));
        apiLog.setResponseContent(new Gson().toJson(rs));
        apiLog.setResponseTime(new Date());

        logBiz.add(apiLog);

        return rs;
    }

    private ApiTag getApiTag(ProceedingJoinPoint joinPoint) {
        String methodName = joinPoint.getSignature().getName();
        ApiTag rs;
        Method[] methods = joinPoint.getTarget().getClass().getMethods();

        for (Method m : methods) {
            if (methodName.equals(m.getName())) {
                Annotation[] annotations = m.getDeclaredAnnotations();
                for (Annotation a : annotations)
                    if (ApiTag.class.isInstance(a)) {
                        rs = (ApiTag) a;
                        return rs;
                    }
            }
        }
        return null;
    }
}

其中：
1：这两个注释很关键，缺一不可，很多朋友说切面切不中。。应该是姿势不对。。（后面再细讲）

@Aspect 
//AOP 的声明
@Component
//声明本类是个组件，方便Spring boot 扫描

2：拦截方法的规则，本例使用注解的方式去拦截。强列推荐使用注释方式。

@Pointcut("@annotation(com.ly.mp.swcas.main.config.ApiTag)")
    public void pointcutMethod() { }

3：拦截的实现，没什么难懂的逻辑。
1）计时
2）访问信息记录到log
3) 调用【业务处理】的方法，这里注意要加上try catch，以防哪个粗心大意的程序员直接抛出错误。
4）记录结果
5）把【业务处理】的结果返回。

  @Around("pointcutMethod()")
    public RestResult around(ProceedingJoinPoint joinPoint) {
        logger.debug("************拦截命中***************");
        ApiLog apiLog = new ApiLog();
        StopWatch watch = new StopWatch();
        watch.start();

        apiLog.setRequestTime(new Date());
        ApiTag cfg = getApiTag(joinPoint);
        apiLog.setApiCode(cfg.apiCode());
        apiLog.setApiName(cfg.apiName());
        apiLog.setRequestContent(joinPoint.getArgs()==null?"": new Gson().toJson(joinPoint.getArgs()));

        apiLog.setId(UUID.randomUUID().toString());
        apiLog.setCreatedDate(new Date());
        apiLog.setIsEnable("1");
        apiLog.setCreator("admin");

        RestResult rs = new RestResult(0,"初始化");

        try {
            logger.info("**********执行业务方法**********");
            rs = (RestResult) joinPoint.proceed();
            apiLog.setRequestStatus(rs.getResult());
        } catch (Throwable e) {
            e.printStackTrace();
            apiLog.setResponseContent(String.format("错误信息:%s",e.getMessage()));
            apiLog.setRequestStatus(0);
        }
        watch.stop();
        apiLog.setRequestCost(BigDecimalUtils.val(watch.getTotalTimeSeconds()));
        apiLog.setResponseContent(new Gson().toJson(rs));
        apiLog.setResponseTime(new Date());

        logBiz.add(apiLog);

        return rs;
    }

APO实现起来就是那么从容，自然。

3:启动：

package com.ly.mp.swcas.main.config;
import com.ly.mp.common.web.LocalCommonInitializer;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.ImportResource;
import org.springframework.context.annotation.PropertySource;
import com.ly.mp.component.conf.cache.CachingConfig;
import javax.xml.ws.Endpoint;

@SpringBootApplication(exclude={ DataSourceAutoConfiguration.class,
		XADataSourceAutoConfiguration.class, ActiveMQAutoConfiguration.class })
@Import({ LocalCommonInitializer.class, SwaggerConfiguration.class, CachingConfig.class, ApiAspect.class })
@PropertySource({"classpath:ly-swcas.properties","classpath:application.properties"})
@ImportResource({"classpath:main-api.xml"})
@ComponentScan(basePackages={"com.ly.mp.swcas.main.api"})
public class MainApi {
	
	public static void main(String[] args)
	{
		System.setProperty("service.name", "ly.mp.swcas.main.api");
		SpringApplication.run(MainApi.class, args);
	}
}

关键：
ApiAspect 切点的类必须在启动的时候扫描，所以ApiAspect 必须使用@Component 注解。那些说切不中的基本上都是因为这个问题。

可以通过以下两种方式去扫描：
1）：

@Import({ LocalCommonInitializer.class, SwaggerConfiguration.class, CachingConfig.class, ApiAspect.class })

2）：

@ComponentScan({"com.ly.mp.swcas.main.config")

最后

看一下效果

AOP-通用的API日志实例

AOP-通用的API日志实例

序

分析

方案

AOP实现

最后

測試編譯機又雙叒叕不能編譯了

一篇文章快速搞懂Java對象創建與銷燬

Jquery $轉換的問題

吐血整理和分享 MySql索引原理與優化

IDEA 代碼分析工具

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結