1、引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!-- aop依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.6</version>
</dependency>
2、实现思路
可以自己写一个注解，然后作用于方法上，不过借助swagger可以更方便的实现，使用@Api作用于类上，用来标识业务模块，使用@ApiOperation作用于方法上，用来标识具体方法，然后将切入点设置为注解ApiOperation：
@Pointcut("@annotation(io.swagger.annotations.ApiOperation) && (!@annotation(org.springframework.web.bind.annotation.GetMapping))")
这样设置后，当含有注解@ApiOperation的方法被执行时，就会执行环绕通知（ @Around() ）内的方法,注意，这里过滤掉了Get请求。
3、代码示例
控制器代码：
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Api(tags = "user", value = "用户模块")
@RestController
@RequestMapping("/user")
public class UserController {
@ApiOperation(value = "登录", notes = "用户登录")
@ApiImplicitParams({
@ApiImplicitParam(name = "username", value = "用户名", paramType = "query", dataTypeClass = String.class),
@ApiImplicitParam(name = "passwd", value = "密码", paramType = "query", dataTypeClass = String.class),
})
@GetMapping("/login")
public String login(String username,String passwd){
return "登录成功" + username + "===>" +passwd;
}
@ApiOperation(value = "注销", notes = "用户注销")
@ApiImplicitParams({
@ApiImplicitParam(name = "username", value = "用户名", paramType = "query", dataTypeClass = String.class)
})
@GetMapping("/logout")
public String logout(String username){
return "注销成功";
}
}
日志切面代码：
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
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.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
/**
* 日志切面
* @author liyinlong
* @date 2021/7/14 4:19 下午
*/
@Aspect
@Component
public class LogAspect {
@Pointcut("@annotation(io.swagger.annotations.ApiOperation && (@annotation(org.springframework.web.bind.annotation.GetMapping))")
public void pointcut() {
}
@Around("pointcut()")
public Object around(ProceedingJoinPoint point) {
System.out.println("记录操作日志");
Object result = null;
long beginTime = System.currentTimeMillis();
try {
// 执行方法
result = point.proceed();
} catch (Throwable e) {
e.printStackTrace();
}
// 执行时长(毫秒)
long time = System.currentTimeMillis() - beginTime;
// 保存操作日志
saveLog(point, time);
System.out.println("执行结果：");
System.out.println(result);
return result;
}
private void saveLog(ProceedingJoinPoint joinPoint, long time) {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Class<?> aClass = joinPoint.getTarget().getClass();
Api annotation = aClass.getAnnotation(Api.class);
String moduleName = annotation.value();
if (moduleName != null) {
System.out.println("模块：" + moduleName);
}
Method method = signature.getMethod();
ApiOperation logAnnotation = method.getAnnotation(ApiOperation.class);
if (logAnnotation != null) {
// 注解上的描述
System.out.println("操作：" + logAnnotation.value());
}
// 请求的方法名
String className = joinPoint.getTarget().getClass().getName();
String methodName = signature.getName();
System.out.println("方法：" + className + "." + methodName + "()");
// 请求的方法参数值
Object[] args = joinPoint.getArgs();
// 请求的方法参数名称
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];
}
System.out.println("参数：" + params);
}
// 获取RequestAttributes
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
// 从获取RequestAttributes中获取HttpServletRequest的信息
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
// 从获取RequestAttributes中获取HttpServletResponse的信息
HttpServletResponse response = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getResponse();
Cookie[] cookies = request.getCookies();
if (cookies != null) {
for (Cookie cookie : cookies) {
System.out.println(cookie.getName() + " " + cookie.getValue());
}
}
System.out.println("请求者的IP：" + request.getRemoteHost());
int status = response.getStatus();
System.out.println("http状态码 " + status);
System.out.println("执行时间：" + time + " 毫秒");
}
}
