Java AOP 实现自定义log日志实例

正文

1:先引入需要的依赖

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-aop</artifactId>

</dependency>

2:定义一个自定义注解类;

用于注解Controller中的对外接口函数,被注解的接口被调用时不会”自动记录log“。默认所有的Controller中的对外接口都会自动记录log

 

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

* NoLogCtrlFunc用于注解Controller中的对外接口函数,被注解的函数被调用时不会”自动记录log“。默认所有的Controller中的对外接口都会自动记录log

* @author tian

*

*/

@Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上

@Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行

@Documented

public @interface NoLogCtrlFunc {

String operDesc() default ""; // 操作说明 可用户添加注解的时候带上说明 例如@NoLogCtrlFunc(operDesc="XXX")

}

3:定义aop切入类,采用的是@Around 环绕通知

仅用于com.yiguang.gtucloud.web.controller包下对外接口会自动调用log日志

 

package com.yiguang.gtucloud.web.config;

import java.lang.reflect.Method;

import java.util.Arrays;

import javax.servlet.ServletRequest;

import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServletRequest;

import org.aspectj.lang.JoinPoint;

import org.aspectj.lang.ProceedingJoinPoint;

import org.aspectj.lang.annotation.AfterThrowing;

import org.aspectj.lang.annotation.Around;

import org.aspectj.lang.annotation.Aspect;

import org.aspectj.lang.annotation.Pointcut;

import org.aspectj.lang.reflect.MethodSignature;

import org.springframework.stereotype.Component;

import org.springframework.web.context.request.RequestAttributes;

import org.springframework.web.context.request.RequestContextHolder;

import org.springframework.web.multipart.MultipartFile;

import com.alibaba.fastjson.JSON;

import com.alibaba.fastjson.JSONObject;

import com.alibaba.fastjson.serializer.SerializerFeature;

import lombok.extern.slf4j.Slf4j;

/**

* 切面处理类,仅限于com.yiguang.gtucloud.web.controller包下对外接口会自动调用log日志

*

*/

@Aspect

@Component

@Slf4j

public class OperLogAspect {

/**

* 默认在所有controller包下切入日志,当对外接口加上注解NoLogCtrlFunc的情况下被调用时不会"自动记录log"

*/

@Pointcut("execution(* com.yiguang.gtucloud.web.controller..*.*(..)) && !@annotation(com.yiguang.gtucloud.web.config.NoLogCtrlFunc)")

public void operLogPoinCut() {

}

/**

* 设置操作异常切入点记录异常日志 扫描所有controller包下操作,只要controller下触发异常,则一定被此方法拦截

*/

@Pointcut("execution(* com.yiguang.gtucloud.web.controller..*.*(..))")

public void operExceptionLogPoinCut() {

}

/**

* 环绕通知

*

* @param joinPoint 切入点

* @throws Throwable

*/

@Around("operLogPoinCut()")

public Object around(ProceedingJoinPoint joinPoint) throws Throwable {

// 获取RequestAttributes

RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();

// 从获取RequestAttributes中获取HttpServletRequest的信息

HttpServletRequest request = (HttpServletRequest) requestAttributes

.resolveReference(RequestAttributes.REFERENCE_REQUEST);

long startTime = System.currentTimeMillis();

// result的值就是被拦截方法的返回值

Object result = joinPoint.proceed();

try {

// 从切面织入点处通过反射机制获取织入点处的方法

MethodSignature signature = (MethodSignature) joinPoint.getSignature();

// 获取切入点所在的方法

Method method = signature.getMethod();

// 获取请求的类名

String className = joinPoint.getTarget().getClass().getName();

// 获取请求的方法名

String methodName = method.getName();

methodName = className + "." + methodName;

String url=request.getRequestURL().toString();

String queryString = request.getQueryString();

String fullPath = url+"?"+queryString;

long endTime = System.currentTimeMillis();

String body="";

if(null!=result) {

body=JSON.toJSONString(result,SerializerFeature.WriteMapNullValue);

body=body.length()>100?body.substring(0, 100):body;

}

String params="";

Object[] args = joinPoint.getArgs();

if (args.length > 0) {

if ("POST".equals(request.getMethod()) || "PUT".equals(request.getMethod())) {

Object[] arguments = new Object[args.length];

for (int i = 0; i < args.length; i++) {

if (args[i] instanceof ServletRequest || args[i] instanceof ServletResponse || args[i] instanceof MultipartFile) {

continue;

}

arguments[i] = args[i];

}

if (arguments != null) {

try {

params = JSONObject.toJSONString(arguments);

} catch (Exception e) {

params = arguments.toString();

}

}

} else if ("GET".equals(request.getMethod())) {

//params = url;

}else {

params=Arrays.toString(joinPoint.getArgs());

}

}

log.info("LogStart;HTTPMethod:{},URL:{},params:{},ClassMethod:{},IP:{},responseBody:{},RequestTime:{}ms.;LogEnd",

request.getMethod(),fullPath,params,methodName,request.getRemoteAddr(),body,(endTime - startTime));

} catch (Exception e) {

e.printStackTrace();

}

return result;

}

/**

* 异常返回通知,用于拦截异常日志信息 连接点抛出异常后执行

*

* @param joinPoint 切入点

* @param e 异常信息

*/

@AfterThrowing(pointcut = "operExceptionLogPoinCut()", throwing = "e")

public void saveExceptionLog(JoinPoint joinPoint, Throwable e) {

// 获取RequestAttributes

RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();

// 从获取RequestAttributes中获取HttpServletRequest的信息

HttpServletRequest request = (HttpServletRequest) requestAttributes

.resolveReference(RequestAttributes.REFERENCE_REQUEST);

long startTime = System.currentTimeMillis();

try {

// 从切面织入点处通过反射机制获取织入点处的方法

MethodSignature signature = (MethodSignature) joinPoint.getSignature();

// 获取切入点所在的方法

Method method = signature.getMethod();

// 获取请求的类名

String className = joinPoint.getTarget().getClass().getName();

// 获取请求的方法名

String methodName = method.getName();

methodName = className + "." + methodName;

String url=request.getRequestURL().toString();

String queryString = request.getQueryString();

String fullPath = url+"?"+queryString;

long endTime = System.currentTimeMillis();

String params="";

Object[] args = joinPoint.getArgs();

if (args.length > 0) {

if ("POST".equals(request.getMethod()) || "PUT".equals(request.getMethod())) {

Object[] arguments = new Object[args.length];

for (int i = 0; i < args.length; i++) {

if (args[i] instanceof ServletRequest || args[i] instanceof ServletResponse || args[i] instanceof MultipartFile) {

continue;

}

arguments[i] = args[i];

}

if (arguments != null) {

try {

params = JSONObject.toJSONString(arguments);

} catch (Exception e2) {

params = arguments.toString();

}

}

} else if ("GET".equals(request.getMethod())) {

//params = url;

}else {

params=Arrays.toString(joinPoint.getArgs());

}

}

log.error("LogStart;HTTPMethod:{},URL:{},params:{},ClassMethod:{},IP:{},RequestTime:{}ms.;LogEnd",

request.getMethod(),fullPath,params,methodName,request.getRemoteAddr(),(endTime - startTime));

} catch (Exception e2) {

e.printStackTrace();

}

}

}

此时所有的Controller下的接口被调用都会默认输出log日志

如果有不想输出日志的接口,添加以下注解即可

 

//@NoLogCtrlFunc //在接口上加上此注解,则不会自动记录log日志

public DataResponse<PageResult<GtuApproveHistory>> list(@RequestBody QueryRequest queryRequest) {

PageResult<GtuApproveHistory> pageResult = gtuApproveHistoryService.list(queryRequest);

return new DataResponse<>(pageResult);

}

至此就结束了.

算是比较合理的一种日志方式,可灵活变动注入方式, 也是借鉴了很多大佬们的用法 改进出来的,不算什么难点,就是记录一下

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
回答: AOP实现自定义权限注解可以通过使用Spring AOP实现。首先,你需要定义一个自定义注解,用于标记需要进行权限控制的方法。然后,你可以使用AOP的方式,在方法执行前或执行后进行权限验证。具体实现可以参考以下步骤: 1. 定义自定义注解:你可以使用@PreventRepeat注解来标记需要进行权限控制的方法。 2. 创建切面:你需要创建一个切面类,使用@Aspect注解标记,并在该类中定义一个切点,用于匹配被@PreventRepeat注解标记的方法。 3. 实现权限验证逻辑:在切面类中,你可以使用@Before或@After注解来定义权限验证的逻辑。在方法执行前或执行后,你可以进行相应的权限验证操作。 4. 配置AOP:最后,你需要在Spring配置文件中配置AOP,将切面类和切点与目标对象关联起来。 通过以上步骤,你就可以实现自定义权限注解的AOP实现了。这样,在被@PreventRepeat注解标记的方法执行前或执行后,你可以进行相应的权限验证操作。\[1\]\[2\]\[3\] #### 引用[.reference_title] - *1* *2* *3* [java-使用spring AOP实现自定义注解](https://blog.csdn.net/weixin_43846708/article/details/129547120)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^control_2,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值