aop做日志收集，且不同外部接口入参种获取某一个特定标识（请求外部接口，需要收集出入参且失败成功都需要插入记录）

业务场景：通过aop的环绕模式，做请求外部接口的请求和响应日志收集。其中不同接口入参不一样，但是我需要获取一个唯一标识作为业务id。

1.定义一个注解：注入到方法

package com.jd.car.laserbeak.infrastructure.jd.jsf.logrecordaop;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author xyd
 * @description:
 * @date 2020/2/24
 */
@Target(ElementType.METHOD)//我是控制到方法，这个根据自己实际业务选
@Retention(RetentionPolicy.RUNTIME)//什么时候切，这个都可以根据业务定
public @interface LogRecord {

    String flag() default "";//用来获取入参的标识（每个业务的入参属性不一样）
}

2.切面：可以根据自己业务定义自己切面的范围，和用什么方式advice

package com.jd.car.laserbeak.web.config;

import com.alibaba.fastjson.JSON;
import com.jd.car.laserbeak.service.requsetlog.RequsetLogService;
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;

/**
 * @author xyd
 * @description: 日志记录切面处理类
 * @date 2020/2/24
 */
@Aspect
@Component
public class LogRecordAspect {
    private static Logger LOG = LoggerFactory.getLogger(LogRecordAspect.class);

    @Autowired
    private RequsetLogService requestLogServie;

//切的地方。我是对我的注解切入。我们可以根据需要定义作用域    @Pointcut("@annotation(com.jd.car.laserbeak.infrastructure.jd.jsf.logrecordaop.LogRecord)")
    public void pointcut() {
    }

    @Around("pointcut()")
    public Object around(ProceedingJoinPoint point) {
        Object result = null;
        String message;
        try {
            // 执行方法
            result = point.proceed();
//成功后，返回的业务信息获取。用作存日志使用
            message = JSON.toJSONString(result);
        } catch (Throwable e) {
//实际流程接口失败，获取失败的信息。存起来。我们也可以定义我们失败后业务如何处理
            LOG.warn("核销接口请求外部失败:{}", e.getMessage());
            message = e.getMessage();
        }
        // 保存日志。这个我需要异步执行我的保存日志。
        requestLogServie.saveLog(point, message);
        return result;
    }

}

3.异步执行的保存日志：这个是在其他service层定义的。供切面2调用。

我用的异步直接一个注解，但是可以根据业务用线程池等方式。可以自己在做优化

/**
     *  异步执行添加日志记录
     * @param joinPoint
     * @param message
     */
    @Async
    @Override
    public void saveLog(ProceedingJoinPoint joinPoint, String message) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        RequestLogEntity req = new RequestLogEntity();
        // 请求的方法名
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        req.setMethod(className + "." + methodName + "()");

        String flag = null;
        LogRecord logAnnotation = method.getAnnotation(LogRecord.class);
        if (logAnnotation != null) {
            // 注解上的描述，获取到实际执行方法上请求的入参某个值
            flag = logAnnotation.flag();

        }
        // 请求的方法参数值
        Object[] args = joinPoint.getArgs();
        //获取到接口请求入参，通过key获取入参的某个值（rag是一个数组，第几个arg[n]是外层实际接口请求的第几个参数）
        String string = JSON.parseObject(JSON.toJSONString(args[0])).getString(flag);
        req.setKeyWord(string);
        // 请求的方法参数名称
        LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
        String[] paramNames = u.getParameterNames(method);
        if (args != null && paramNames != null) {
            String params = "";
            for (int i = 0; i < args.length; i++) {
                params += "  " + paramNames[i] + ": " + args[i];
            }
            req.setReqStr(params);
        }
        // 获取request
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 设置IP地址
        req.setIp(IPUtil.getIpAddr(request));
        req.setReqTime(new Date());
        req.setRespStr(message);
        // 保存系统日志
        requestLogDao.insert(req);
    }

4.日志实体类

package com.jd.car.laserbeak.repository.entity.requestlog;

import com.jd.car.laserbeak.repository.entity.BaseEntity;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

import javax.persistence.Entity;
import javax.persistence.Table;
import java.util.Date;

/**
 * @author xyd
 * @description 请求日志表实体类
 * @date 2020/2/13 21:44
 **/
@Entity
@Table(name = "request_log")
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Data
@Accessors(chain = true)
public class RequestLogEntity extends BaseEntity {

    /**
     * 请求ip
     */
    private String ip;
    /**
     * 请求入参
     */
    private String reqStr;
    /**
     * 请求出参
     */
    private String respStr;
    /**
     * 请求方法
     */
    private String method;
    /**
     * 请求时间
     */
    private Date reqTime;
    /**
     * 关键字 比如核销码等
     */
    private String keyWord;
}

5.切入的方法：里面调用外部的接口

1.请求平台a的方式，我需要获取参数，注意我用的flag。后面的值是ReqLocCodeInstall 对象里面的值

 @LogRecord(flag = "pwdNumber")
    public Result consumeCodeNum(ReqLocCodeInstall req) throws Exception {
        log.info("[{}] 调用 [LOC核销码安装Jsf接口], Request = {}", "LOC核销码安装处理器", JSON.toJSON(req));
        Result result = locOrderSoaService.consumeCodeNum(req.getVenderId(), req.getCodeNum(), req.getPwdNumber(), req.getShopId(), req.getShopName(), req.getCodeType());
        log.info("[{}] 调用 [LOC核销码安装Jsf接口], Response = {}", "LOC核销码安装处理器", JSON.toJSON(result));
        return result;
    }

2.平台b的方式。我都需要获取一个值为业务流程id，然后字段不一样。就用到注解里面的flag来获取

然后这个值在切面种，通过json串的key来获取。可以看看上面的代码。这两个方法都是外部提供的入参对象和返回对象

@LogRecord(flag = "verCode")
    public InstallResponse findWsfInstallCode(InstallRequest req){
        log.info("[{}] 调用 [汪师傅校验核销码Jsf接口findWsfInstallCode], Request = {}","汪师傅核销码核销业务", JSON.toJSON(req));
        InstallResponse res = carService.install(req);
        log.info("[{}] 调用 [汪师傅校验核销码Jsf接口findWsfInstallCode], Response = {}","汪师傅核销码核销业务", JSON.toJSON(res));
        return res;
    }

6.service测试调用

方法1：调用实力

@Override
    public void aspect(){

        RequestLogEntity requestLogEntity = new RequestLogEntity();
        requestLogEntity.setKeyWord("ssss").setReqStr("dsd").setMethod("sdsd");
        requestLogDao.insert(requestLogEntity);

        InstallRequest installRequest = new InstallRequest();
        installRequest.setSecKey("222");
        installRequest.setSource("car");
        installRequest.setVerStoreName("222");
        installRequest.setWokerIdNum("fgfdd发的");
        installRequest.setVerCode("WSF核销码001");
        InstallResponse wsfInstallCode = wsfJsfTransfer.findWsfInstallCode(installRequest);
    }

方法2：

@Override
    public void qyersdfsa(){
        ReqLocCodeInstall reqLoc = new ReqLocCodeInstall();
        reqLoc.setCodeType(0).setPwdNumber("LOCHXM3333").setVenderId(111L)
                .setShopId(3333333333L).setShopName("sddddddddddd");
        com.jd.pop.order.loc.assembledflow.soa.service.result.Result response;
        try {
            response = locJsfTransfer.consumeCodeNum(reqLoc);
        }catch (Exception e){
            response =null;
        }
    }

7.controll层

两个不同的方法：调用测试就可以

@ResponseBody
    @PostMapping("/api/consume/test")
    public ResponseEntity verificationCode() {
        consumeCodeService.aspect();
        return ok();
    }

    @ResponseBody
    @PostMapping("/api/consume/qyersdfsa")
    public ResponseEntity qyersdfsa() {
        consumeCodeService.qyersdfsa();
        return ok();
    }

8.结果：

9.表sql

CREATE TABLE `request_log` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
  `is_deleted` tinyint(1) DEFAULT '0' COMMENT '是否删除',
  `gmt_create` datetime DEFAULT NULL COMMENT '创建时间',
  `gmt_modified` datetime DEFAULT NULL COMMENT '修改时间',
  `creator` bigint(10) unsigned DEFAULT '0' COMMENT '创建人id',
  `modifier` bigint(10) unsigned DEFAULT '0' COMMENT '修改人id',
  `ip` varchar(40) DEFAULT '' COMMENT '商品货号',
  `req_str` text COMMENT '请求入参',
  `resp_str` text COMMENT '请求出参',
  `method` varchar(200) DEFAULT '' COMMENT '请求方法',
  `req_time` datetime DEFAULT NULL COMMENT '请求时间',
  `key_word` varchar(100) DEFAULT NULL COMMENT '关键字 比如核销码等',
  PRIMARY KEY (`id`),
  KEY `key_key_word` (`key_word`) USING BTREE
) ENGINE=InnoDB AUTO_INCREMENT=11 DEFAULT CHARSET=utf8 COMMENT='请求日志表';

来源：CSDN

作者：冬子一定要努力

链接：https://blog.csdn.net/qq_39809613/article/details/104483945

标签

string

aop