java使用AOP切面获取请求日志并记录

  • 请求时间

*/

@Column(name = “create_time”)

private Date createTime;

/**

  • 请求方式

*/

private String method;

/**

  • 请求参数

*/

private String params;

/**

  • 请求状态:1 成功 0 失败

*/

private Integer status;

/**

  • 请求IP

*/

private String ip;

/**

  • 请求来源地址

*/

private String location;

/**

  • 请求耗时

*/

private Integer time;

/**

  • 返回内容

*/

private String response;

}

3.AOP切面如下

package com.tjair.tjapi.config;

import com.alibaba.fastjson.JSON;

import com.alibaba.fastjson.JSONObject;

import com.tjair.common.log.TjapiLogVo;

import com.tjair.common.util.IPUtil;

import com.tjair.tjapi.feign.LogFeignService;

import com.tjair.tjapi.util.HttpHelper;

import io.swagger.annotations.ApiOperation;

import lombok.extern.slf4j.Slf4j;

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.beans.factory.annotation.Autowired;

import org.springframework.context.annotation.Configuration;

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.HttpServletRequest;

import java.io.IOException;

import java.util.Date;

import java.util.Objects;

/**

  • @description 拦截所有控制器的返回,记录响应报文

  • @author unhejing

  • @date 2021-03-17 上午11:52:26

*/

@Aspect

@Configuration

@Slf4j

public class LogAspect {

@Autowired

private LogFeignService logFeignService;

public LogAspect() {

}

@Pointcut(“execution(public * com.tjair.tjapi.controller..(…))”)

public void pointCutMethod() {

}

// 声明环绕通知

@Around(“pointCutMethod()”)

public Object doAround(ProceedingJoinPoint pjp) throws Throwable {

Long startTime = System.currentTimeMillis();

ApiOperation apiOperation = ((MethodSignature)pjp.getSignature()).getMethod().getAnnotation(ApiOperation.class);

// 获取request对象

RequestAttributes ra = RequestContextHolder.getRequestAttributes();

ServletRequestAttributes sra = (ServletRequestAttributes) ra;

HttpServletRequest request = sra.getRequest();

Object ret = pjp.proceed();

Long endTime = System.currentTimeMillis();

TjapiLogVo tjapiLogVo = getTjapiLogVo(request,Objects.nonNull(apiOperation) ? apiOperation.value() : “”,endTime-startTime,JSON.toJSONString(ret));

// 添加日志

addLog(tjapiLogVo);

log.info(“响应数据耗时{}:响应数据{}”,endTime-startTime,JSON.toJSONString(ret));

return ret;

}

public void addLog(TjapiLogVo tjapiLogVo) {

log.info(“添加日志:{}”,JSON.toJSONString(tjapiLogVo));

Long startTime = System.currentTimeMillis();

logFeignService.addTjapiLog(tjapiLogVo);

Long endtime = System.currentTimeMillis();

log.info(“添加日志耗时:{}”,endtime-startTime);

}

private TjapiLogVo getTjapiLogVo(HttpServletRequest request,String apiName,Long time,String response) throws IOException {

TjapiLogVo tjapiLogVo = new TjapiLogVo();

String jsonBody = HttpHelper.getBodyString(request);

log.info(“请求参数:{}”,jsonBody);

JSONObject reqObj = Objects.nonNull(JSON.parseObject(jsonBody)) ? JSON.parseObject(jsonBody) : new JSONObject();

JSONObject resObj = Objects.nonNull(JSON.parseObject(response)) ? JSON.parseObject(response) : new JSONObject();

//设置请求参数

tjapiLogVo.setParams(jsonBody);

tjapiLogVo.setPartnerid(Objects.nonNull(reqObj.getString(“partnerId”)) ? reqObj.getString(“partnerId”) : “-1”);

// 设置IP地址

tjapiLogVo.setIp(IPUtil.getIpAddr(request));

// 设置位置

tjapiLogVo.setLocation(IPUtil.getCityInfo(tjapiLogVo.getIp()));

//设置请求方法,GET,POST…

tjapiLogVo.setMethod(request.getMethod());

//设置请求路径

tjapiLogVo.setUrl(request.getRequestURI());

// 设置请求方法名称

tjapiLogVo.setApiName(apiName);

// 设置创建时间

tjapiLogVo.setCreateTime(new Date());

// 设置请求状态

Integer code = Objects.nonNull(resObj.getInteger(“code”)) ? resObj.getInteger(“code”) : 1;

tjapiLogVo.setStatus(code);

// 设置接口消耗时间

tjapiLogVo.setTime(time.intValue());

// 设置响应内容

tjapiLogVo.setResponse(response);

return tjapiLogVo;

}

}

4.测试接口

package com.tjair.tjapi.controller;

import com.alibaba.fastjson.JSON;

import com.alibaba.fastjson.JSONObject;

import com.tjair.common.service.RedisUtils;

import com.tjair.common.util.Result;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RestController;

/**

  • @author jingyujie

  • @create 2021-03-16 下午2:39

**/

@RestController

@RequestMapping(“/test”)

@Api(tags = “测试API控制器”)

public class TestController {

@Autowired

private RedisUtils redisUtils;

@PostMapping(“/apiTest”)

@ApiOperation(“接口测试”)

public Result apiTest(@RequestBody JSONObject obj){

return Result.returnSuccess(“接口已联通,请求入参:”+ JSON.toJSONString(obj));

}

}

5.请求结果如下

备注说明:

1.LogFeignService是添加日志的service

2.IPUtil是获取IP和地址信息相关的工具类

3.HttpHelper是解析request中的请求参数的工具类

4.ApiOperation是获取接口的注解上面的接口描述

5.partnerId是我请求参数里面必传的用户编码

6.code是响应参数里面的状态码,用于判断接口是否请求成功

末尾附上工具类:

IPUtil.java

类中的/ip2region.db这个是一个地址库,可直接百度下载即可。

package com.tjair.common.util;

import org.apache.commons.io.FileUtils;

import org.lionsoul.ip2region.DataBlock;

import org.lionsoul.ip2region.DbConfig;

import org.lionsoul.ip2region.DbSearcher;

import org.lionsoul.ip2region.Util;

import javax.servlet.http.HttpServletRequest;

import java.io.File;

import java.lang.reflect.Method;

/**

  • ip操作相关工具类

  • @author jingyujie

  • @create 2020-06-24 下午2:11

**/

public class IPUtil {

public static String getCityInfo(String ip){

try {

//db

String dbPath = IPUtil.class.getResource(“/ip2region.db”).getPath();

System.out.println(“路径:”+dbPath);

File file = new File(dbPath);

if (file.exists() == false) {

System.out.println(“Error: Invalid ip2region.db file”);

String tmpDir = System.getProperties().getProperty(“java.io.tmpdir”);

dbPath = tmpDir + “ip.db”;

System.out.println(dbPath);

file = new File(dbPath);

FileUtils.copyInputStreamToFile(IPUtil.class.getClassLoader().getResourceAsStream(“classpath:ip2region.db”), file);

}

//查询算法

int algorithm = DbSearcher.BTREE_ALGORITHM; //B-tree

//DbSearcher.BINARY_ALGORITHM //Binary

//DbSearcher.MEMORY_ALGORITYM //Memory

DbSearcher searcher = null;

try {

DbConfig config = new DbConfig();

searcher = new DbSearcher(config, dbPath);

//define the method

Method method = null;

switch (algorithm) {

最后总结

ActiveMQ+Kafka+RabbitMQ学习笔记PDF

image.png

  • RabbitMQ实战指南

image.png

  • 手写RocketMQ笔记

image.png

  • 手写“Kafka笔记”

image

关于分布式,限流+缓存+缓存,这三大技术(包含:ZooKeeper+Nginx+MongoDB+memcached+Redis+ActiveMQ+Kafka+RabbitMQ)等等。这些相关的面试也好,还有手写以及学习的笔记PDF,都是啃透分布式技术必不可少的宝藏。以上的每一个专题每一个小分类都有相关的介绍,并且小编也已经将其整理成PDF啦

//define the method

Method method = null;

switch (algorithm) {

最后总结

ActiveMQ+Kafka+RabbitMQ学习笔记PDF

[外链图片转存中…(img-ff2nhJh9-1714129089178)]

  • RabbitMQ实战指南

[外链图片转存中…(img-3GGzKdO5-1714129089179)]

  • 手写RocketMQ笔记

[外链图片转存中…(img-58PP0y6d-1714129089180)]

  • 手写“Kafka笔记”

[外链图片转存中…(img-FTbW4pyQ-1714129089180)]

关于分布式,限流+缓存+缓存,这三大技术(包含:ZooKeeper+Nginx+MongoDB+memcached+Redis+ActiveMQ+Kafka+RabbitMQ)等等。这些相关的面试也好,还有手写以及学习的笔记PDF,都是啃透分布式技术必不可少的宝藏。以上的每一个专题每一个小分类都有相关的介绍,并且小编也已经将其整理成PDF啦

本文已被CODING开源项目:【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

  • 8
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
好的,下面是一个简单的示例,演示如何使用 AOP 实现切面存储操作日志: ```java @Aspect @Component public class LogAspect { private static final Logger logger = LoggerFactory.getLogger(LogAspect.class); @Autowired private HttpServletRequest request; @Pointcut("execution(public * com.example.controller.*.*(..))") public void controllerLog() {} @Before("controllerLog()") public void doBefore(JoinPoint joinPoint) { logger.info("Request URL : {} {}", request.getRequestURL().toString(), request.getMethod()); logger.info("IP : {}", request.getRemoteAddr()); logger.info("Class Method : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName()); logger.info("Args : {}", Arrays.toString(joinPoint.getArgs())); } @AfterReturning(returning = "result", pointcut = "controllerLog()") public void doAfterReturning(Object result) { logger.info("Response : {}", result); } } ``` 代码解释: - `@Aspect` 注解表示这是一个切面类。 - `@Component` 注解表示让 Spring 自动扫描并注册该组件。 - `private static final Logger logger = LoggerFactory.getLogger(LogAspect.class);` 声明一个日志记录器。 - `@Autowired private HttpServletRequest request;` 注入 HttpServletRequest 对象,以便获取请求信息。 - `@Pointcut("execution(public * com.example.controller.*.*(..))")` 定义切点,表示匹配 com.example.controller 包下的所有公共方法。 - `@Before("controllerLog()")` 定义前置通知,表示在切点方法执行前执行该方法。 - `JoinPoint` 是 Spring AOP 提供的用于获取连接点信息的类,可以获取方法名、参数等信息。 - `@AfterReturning(returning = "result", pointcut = "controllerLog()")` 定义后置通知,表示在切点方法执行后执行该方法。 - `returning = "result"` 表示将方法的返回值赋值给 result 参数。 - `logger.info()` 是日志记录器的方法,用于记录日志信息。 以上代码实现了一个简单的 AOP 切面,用于记录 controller 的操作日志。在具体的业务场景中,可以根据实际需要进行扩展和定制。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值