springMVC自定义注解,用AOP来实现日志记录的方法

2023-09-17 13:02:05 59

需求背景

最近的一个项目，在项目基本完工的阶段，客户提出要将所有业务操作的日志记录到数据库中，并且要提取一些业务的关键信息(比如交易单号)体现在日志中。

为了保证工期，在查阅了资料以后，决定用AOP+自定义注解的方式来完成这个需求。

准备工作

自定义注解需要依赖的jar包有aspectjrt-XXX.jar,aspectjweaver-XXX.jar，XXX代表版本号。

自定义注解

在项目下单独建立了一个log包，来存放日志相关的内容

**.common.log.annotation//自定义注解存放位置
**.common.log.aop//aop工具类存放位置

在annotation包下面新建自定义注解类：

package**.common.log.annotation;
importjava.lang.annotation.ElementType;
importjava.lang.annotation.Retention;
importjava.lang.annotation.RetentionPolicy;
importjava.lang.annotation.Target;
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public@interfaceXXXOperateLog{
/**
*操作类型描述
*@return
*/
StringoperateTypeDesc()default"";
/**
*操作类型
*@return
*/
longoperateType()default-1;
/**
*模块编码
*@return
*/
StringmoudleCode()default"M30";
/**
*模块名称
*@return
*/
StringmoudleName()default"XX模块";
/**
*业务类型
*@return
*/
StringbussType()default"";
/**
*业务类型描述
*@return
*/
StringbussTypeDesc()default"";
}

在aop包下新建XXXOperateLogAop

package**.common.log.aop;
import**;//省略
@Aspect
@Component
publicclassXXXOperateLogAop{
@Autowired
SystemLogServicesystemLogService;
HttpServletRequestrequest=null;
Loggerlogger=LoggerFactory.getLogger(XXXOperateLogAop.class);
ThreadLocaltime=newThreadLocal();
//用于生成操作日志的唯一标识，用于业务流程审计日志调用
publicstaticThreadLocaltag=newThreadLocal();
//声明AOP切入点，凡是使用了XXXOperateLog的方法均被拦截
@Pointcut("@annotation(**.common.log.annotation.XXXOperateLog)")
publicvoidlog(){
System.out.println("我是一个切入点");
}
/**
*在所有标注@Log的地方切入
*@paramjoinPoint
*/
@Before("log()")
publicvoidbeforeExec(JoinPointjoinPoint){
time.set(System.currentTimeMillis());
info(joinPoint);
//设置日志记录的唯一标识号
tag.set(UUID.randomUUID().toString());
request=((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
}
@After("log()")
publicvoidafterExec(JoinPointjoinPoint){
MethodSignaturems=(MethodSignature)joinPoint.getSignature();
Methodmethod=ms.getMethod();
logger.debug("标记为"+tag.get()+"的方法"+method.getName()
+"运行消耗"+(System.currentTimeMillis()-time.get())+"ms");
}
//在执行目标方法的过程中，会执行这个方法，可以在这里实现日志的记录
@Around("log()")
publicObjectaroundExec(ProceedingJoinPointpjp)throwsThrowable{
Objectret=pjp.proceed();
try{
Object[]orgs=pjp.getArgs();
SystemLogvalueReturn=null;
for(inti=0;i800){
errMes=errMes.substring(0,800);
}
valueReturn.setErrorMessage(errMes);
valueReturn.setRequestIp(getRemoteHost(request));
valueReturn.setRequestUrl(request.getRequestURI());
valueReturn.setServerIp(request.getLocalAddr());
valueReturn.setUids(tag.get());
systemLogService.saveSystemLog(valueReturn);
}else{
logger.info("不记录日志信息");
}
}catch(Exceptione1){
e1.printStackTrace();
}
}
privatevoidinfo(JoinPointjoinPoint){
logger.debug("--------------------------------------------------");
logger.debug("King:\t"+joinPoint.getKind());
logger.debug("Target:\t"+joinPoint.getTarget().toString());
Object[]os=joinPoint.getArgs();
logger.debug("Args:");
for(inti=0;i参数["+i+"]:\t"+os[i].toString());
}
logger.debug("Signature:\t"+joinPoint.getSignature());
logger.debug("SourceLocation:\t"+joinPoint.getSourceLocation());
logger.debug("StaticPart:\t"+joinPoint.getStaticPart());
logger.debug("--------------------------------------------------");
}
/**
*获取远程客户端Ip
*@paramrequest
*@return
*/
privateStringgetRemoteHost(javax.servlet.http.HttpServletRequestrequest){
Stringip=request.getHeader("x-forwarded-for");
if(ip==null||ip.length()==0||"unknown".equalsIgnoreCase(ip)){
ip=request.getHeader("Proxy-Client-IP");
}
if(ip==null||ip.length()==0||"unknown".equalsIgnoreCase(ip)){
ip=request.getHeader("WL-Proxy-Client-IP");
}
if(ip==null||ip.length()==0||"unknown".equalsIgnoreCase(ip)){
ip=request.getRemoteAddr();
}
returnip.equals("0:0:0:0:0:0:0:1")?"127.0.0.1":ip;
}
}

修改配置文件spring-mvc.xml，添加如下配置

需要注意的是，上述配置必须放在同一个xml文件里面，要么spring-mvc.xml,要么spring-context.xml，否则可能不生效，暂时还未查明是为什么。

注解的使用

@XXXOperateLog(
bussType=XXXSysConstant.BUSINESS_TYPE.YYYY
,bussTypeDesc="业务类型描述"
,operateType=XXXSysConstant.LogOperateType.QUERY
,operateTypeDesc="操作描述"
)
@RequestMapping(value="/**/**/queryXXXXX4DataGrid.json",method=RequestMethod.POST)
publicvoidqueryXXXXX4DataGrid(HttpServletRequestrequest,HttpServletResponsearg1,Modelmodel,Writerwriter)
{
logger.info("==========验票查询(出库)交易信息开始=====================");
try{
//dosomethingforbusiness
}catch(SystemExceptionse){
throwse;
}catch(BusinessExceptionbe){
throwbe;
}catch(Exceptione){
thrownewSystemException(e);
}
}

以上这篇springMVC自定义注解,用AOP来实现日志记录的方法就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持毛票票。

springMVC自定义注解,用AOP来实现日志记录的方法

热门推荐

随机推荐