栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

springboot如何使用aop统一处理请求日志、异常日志、返回日志?

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

springboot如何使用aop统一处理请求日志、异常日志、返回日志?

springboot有很多方法处理日志,例如拦截器,aop切面,service中代码记录等,

这些方法各有优劣,拦截器处理起来看似简单,但在获取入参之后必须重写RequestWrapper类,否则会报HttpMessageNotReadableException: Required request body is missing异常。如何处理这种异常可以见文章:在拦截器种使用了request.getInputStream()或者getReader(),导致在controller中无法获取请求参数_慕枫520的博客-CSDN博客_controller无法获取参数问题描述:在拦截器种使用了request.getInputStream()或者getReader(),然后在controller接口种使用了@requestbody ,导致controller中无法获取入参,报错:HttpMessageNotReadableException: Required request body is missing:原因分析:ServletRequest中getReader()和getInputStream()只能调用一次。而又由于@RequestBody注解获取输出https://blog.csdn.net/qq_20446879/article/details/120693963

在service中使用代码记录虽然简单自由,但是在开发工作量大的时候会显得异常繁琐,不适合大量开发任务的编程工作。

而使用aop切面编程处理则简单轻松许多,即可以避免重复开发,又不用考虑请求body丢失问题。

这里我们以aop切面为例:

引入aop依赖和日志依赖:

        
        
            org.springframework.boot
            spring-boot-starter-aop
        
        

        
        
            log4j
            log4j
            1.2.12
        
       

 aop代码:

import com.example.empboxwarehousing.common.util.IpUtil;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;


@Aspect
@Component
@Slf4j
public class WebLogAspect {


    
    @Pointcut("execution(* com.example.empboxwarehousing.*.controller.*.*(..))")
    public void webLog() {
    }

    
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) {
        //收到请求,记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder
                .getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        log.info("请求METHOD,URL : {},{}", request.getMethod(), request.getRequestURL());
        log.info("请求IP :{} ", IpUtil.getIpAddr(request));
        log.info("请求处理CLASS_METHOD : {}", joinPoint.getSignature().getDeclaringTypeName() + "."
                + joinPoint.getSignature().getName());
        log.info("请求参数:{} : " + Arrays.toString(joinPoint.getArgs()));
    }


    
    @AfterThrowing(throwing = "ex", pointcut = "webLog()")
    public void doRecoveryActions(JoinPoint point, Throwable ex) {
        String className = point.getTarget().getClass().getSimpleName() + "[" + point.getSignature().getName() + "]";
        log.error("[Result] 异常" + className + "" + " 返回 " + ex);
    }

    
    @AfterReturning(returning = "res", pointcut = "webLog()")
    public void doAfterReturning(Object res) throws JsonProcessingException {
        //获取返回值
        log.info("返回值 : " + new ObjectMapper().writeValueAsString(res));
    }
}

这里要注意点是 AOP中@Pointcut切入点表达式的使用,不能使用execution(public * *(..)) ,这个代表切入全部请求,会在启动项目的时候报空指针异常,因为启动项目时候无法获取request。所以建议切入点表达式指定为controller包下的方法。

IpUtil.getIpAddr(request)方法为获取请求者的IP地址的方法,代码如下:
import org.springframework.util.StringUtils;

import javax.servlet.http.HttpServletRequest;
import java.util.regex.Pattern;


public class IpUtil {
    
    public static String getIpAddr(HttpServletRequest request){
        try{
            if (request == null) {
                //throw (new Exception("getIpAddr method HttpServletRequest Object is null"));
                return "";
            }
            String ipString = request.getHeader("x-forwarded-for");
            if (StringUtils.isEmpty(ipString) || "unknown".equalsIgnoreCase(ipString)) {
                ipString = request.getHeader("Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ipString) || "unknown".equalsIgnoreCase(ipString)) {
                ipString = request.getHeader("WL-Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ipString) || "unknown".equalsIgnoreCase(ipString)) {
                ipString = request.getRemoteAddr();
            }
            // 多个路由时,取第一个非unknown的ip
            String[] arr = ipString.split(",");
            for (String str : arr) {
                if (!"unknown".equalsIgnoreCase(new StringBuffer(str).toString())) {
                    ipString = str;
                    break;
                }
            }
            if(ipString.equals("0:0:0:0:0:0:0:1")){
                ipString = "127.0.0.1";
            }
            return ipString;
        }catch(Exception e){
            return "";
        }
    }
}

执行效果如下:

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/958782.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号