springboot统一日志打印

最新推荐文章于 2024-08-21 20:58:04 发布
最新推荐文章于 2024-08-21 20:58:04 发布
阅读量2.3k 收藏 3
点赞数 3
分类专栏： # web 文章标签： springboot 日志
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43283487/article/details/94406177
版权

git
https://github.com/haohongyaocom/bootdemo

效果

要打印前端和rpc接口调用的方法和参数以及返回结果，整个项目就可以减少很多手动的log打印，另外这些日志对运维排查问题非常有帮助

准备工作

package com.example.demo.pojo;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

import java.io.Serializable;
import java.util.Date;

@Getter
@Setter
@ToString
public class SysLog implements Serializable {
    private static final long serialVersionUID = 1L;

    private String username;

    private String operation;

    private String method;

    private String params;

    private String ip;

    private String resp;

    private Date createDate;


}

package com.example.demo.util;

import com.alibaba.fastjson.JSON;
import com.example.demo.pojo.SysLog;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Date;

/**
 * @author hongtao.hao
 * @date 2019/6/28
 */
public class LogUtil {
    private static final Logger logger = LoggerFactory.getLogger(LogUtil.class);

    public static SysLog getSysLog(JoinPoint joinPoint) {
        SysLog sysLog = new SysLog();

        // 从切面织入点处通过反射机制获取织入点处的方法
        MethodSignature signature = (MethodSignature)joinPoint.getSignature();
        Method method = signature.getMethod();

        // 请求方法名
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        sysLog.setMethod(className + "." + methodName + "()");

        // 请求的参数
        Object[] args = joinPoint.getArgs();
        String params = (args == null || args.length == 0) ? null : JSON.toJSONString(args);
        sysLog.setParams(params);

        // 请求时间
        sysLog.setCreateDate(new Date());
        return sysLog;
    }

    public static SysLog getSysLog(JoinPoint joinPoint, Object result) {
        SysLog sysLog = getSysLog(joinPoint);
        sysLog.setResp(JSON.toJSONString(result));
        return sysLog;
    }

    public static HttpServletRequest getHttpServletRequest() {
        return ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
    }

    /**
     * 获取IP地址
     *
     * 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
     * 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
     */
    public static String getIpAddr(HttpServletRequest request) {
        String ip = null;
        try {
            ip = request.getHeader("x-forwarded-for");
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("WL-Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("HTTP_CLIENT_IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("HTTP_X_FORWARDED_FOR");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getRemoteAddr();
            }
        } catch (Exception e) {
            logger.error("IPUtils ERROR ", e);
        }

        return ip;
    }
}

controller日志

package com.example.demo.interceptor;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import com.alibaba.fastjson.JSON;
import com.example.demo.pojo.SysLog;
import com.example.demo.util.LogUtil;

/**
 * @author hongtao.hao
 * @date 2019/6/27
 */
@Aspect
@Component
public class ControllerLogAspect extends HandlerInterceptorAdapter {
    private Logger logger = LoggerFactory.getLogger(getClass().getName());

    // 定义Pointcut，此方法不能有返回值，该方法只是一个标示
    @Pointcut("execution(* com.example.demo.controller.*.*(..))")
    public void logPointCut() {

    }

    @Before("logPointCut()")
    public void saveSysLog(JoinPoint joinPoint) {

        SysLog sysLog = LogUtil.getSysLog(joinPoint);
        // 请求用户名
        sysLog.setUsername(null);

        logger.info(">>> " + JSON.toJSONString(sysLog));
    }

    @AfterReturning(returning = "result", pointcut = "logPointCut()")
    public void doAfterReturning(JoinPoint joinPoint, Object result) {
        SysLog sysLog = LogUtil.getSysLog(joinPoint, result);

        logger.info(">>> " + JSON.toJSONString(sysLog));
    }

}

service日志

rpc之类的也是必须要打印的

package com.example.demo.interceptor;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import com.alibaba.fastjson.JSON;
import com.example.demo.pojo.SysLog;
import com.example.demo.util.LogUtil;

/**
 * @author hongtao.hao
 * @date 2019/6/27
 */
@Aspect
@Component
public class ServiceLogAspect extends HandlerInterceptorAdapter {
    private Logger logger = LoggerFactory.getLogger(getClass().getName());

    // 定义Pointcut，此方法不能有返回值，该方法只是一个标示
    // @annotation 指定自定义注解：在自定义注解出现的位置切入代码
    @Pointcut("execution(* com.example.demo.service.*.*(..))")
    public void logPointCut() {

    }

    @Before("logPointCut()")
    public void saveSysLog(JoinPoint joinPoint) {
        SysLog sysLog = LogUtil.getSysLog(joinPoint);

        logger.info(">>> " + JSON.toJSONString(sysLog));
    }

    @AfterReturning(returning = "result", pointcut = "logPointCut()")
    public void doAfterReturning(JoinPoint joinPoint, Object result) {
        SysLog sysLog = LogUtil.getSysLog(joinPoint, result);

        logger.info(">>> " + JSON.toJSONString(sysLog));
    }
}

自定义

拦截自定义的注解，对加了该注解的方法进行特殊的日志处理

package com.example.demo.annotation;

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;

/**
 * @author hongtao.hao
 * @date 2019/6/27
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MySysLog {
    String value() default "";
}


package com.example.demo.interceptor;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import com.alibaba.fastjson.JSON;
import com.example.demo.pojo.SysLog;
import com.example.demo.util.LogUtil;

/**
 * 拦截自定义的MySysLog注解，进行特殊处理
 * 
 * @author hongtao.hao
 * @date 2019/6/27
 */
@Aspect
@Component
public class MySysLogAspect extends HandlerInterceptorAdapter {
    private Logger logger = LoggerFactory.getLogger(getClass().getName());

    // @annotation 指定自定义注解：在自定义注解出现的位置切入代码
    @Pointcut("@annotation(com.example.demo.annotation.MySysLog)")
    public void logPointCut() {

    }

    @Before("logPointCut()")
    public void saveSysLog(JoinPoint joinPoint) {

    }

    @AfterReturning(returning = "result", pointcut = "logPointCut()")
    public void doAfterReturning(JoinPoint joinPoint, Object result) {

    }
}
orange大数据技术探索者
关注
专栏目录
关于SpringBoot的日志打印
a1780764437的博客
07-05 482
关于SpringBoot的日志打印 在以往项目开发过程中，我们往往习惯性使用System.out.println()这个常用的打印输出语句来显示断点信息或业务运行对象信息或控制台日志记录，其实大量的使用System.out.println()在一定程度上会增加资源的消耗。Java日志框架众多，常用的有java.util.logging，log4j，logback，commons-logging等等。而且SpringBoot 提供了一套日志系统，logback是最优的选择。因此本文根据实际项目中使用slf4j
SpringBoot统一日志处理
2401_84048149的博客
04-10 599
2020年在匆匆忙忙慌慌乱乱中就这么度过了，我们迎来了新一年，互联网的发展如此之快，技术日新月异，更新迭代成为了这个时代的代名词，坚持下来的技术体系会越来越健壮，JVM作为如今是跳槽大厂必备的技能，如果你还没掌握，更别提之后更新的新技术了。更多JVM面试整理：《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！图片转存中…(img-eoxSgIDk-1712684654326)]
Springboot统一web请求日志
07-05
Springboot统一web请求日志Springboot统一web请求日志Springboot统一web请求日志
Spring Boot日志
最新发布
2202_76101487的博客
08-21 1075
本文主要写了spring项目中日志的配置信息和一些知识点；
springboot 日志集成
lizsy的博客
03-09 486
springboot 日志
SpringBoot 统一请求返回的实现
08-18
主要介绍了SpringBoot 统一请求返回的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot 中的aop配置，完成日志记录功能
爬虫小能手，安卓逆向，欢迎砸单
11-25 1448
参考博客：https://blog.csdn.net/chenyao1994/article/details/79708496 第一步：在pom.xml下添加依赖 因为springboot已经添加过日志记录功能的依赖 <!-- 核心模块，包括自动配置支持、日志支持 --> <dependency> <groupId>org.springf...
SpringBoot自定义注解实现操作日志（适用于毕设）
lslxgg的博客
02-10 2395
在目录中，有一个annotation文件夹，这里面放的就是日志的注解。String value() default "未命名日志";在aop文件夹中，存放改注解的切面@Aspect@Order@Component//这里操作人姓名暂时设置未知，具体操作的人，需要通过其他方法获取，这里仅对日志以及自定义注解的使用做简单介绍。String userName = "未知";// 异步记录日志。
springboot中统一日志管理
daimenglaoshi的博客
12-08 2272
一般分为两个大类：操作日志和系统日志**操作日志：**用户在操作软件时记录下来的操作步骤，便于用户自己查看。主要针对的是用户。**系统日志：**系统日志是记录系统中硬件、软件和系统问题的信息，同时还可以监视系统中发生的事件。用户可以通过它来检查错误发生的原因，或者寻找受到攻击时攻击者留下的痕迹。系统日志包括系统日志、应用程序日志和安全日志。主要针对的是软件开发人员（包括测试、维护人员）。日志的作用：日志是系统运行的“照妖镜”，通过它能够实时反映系统的运行状态；
maven的日志在哪里看_SpringBoot统一日志处理原理
weixin_39929138的博客
11-20 2329
SpringBoot作为日常开发利器，开箱即用，大量的star等已经成为节省开发的重要框架之一，但是各个框架的star中引入的日志框架却不尽相同，有的是log4j，有的是slf4j，这导致我们在引入多个框架的star的时候，往往会引入多个日志框架，每一个日志框架彼此效率不尽相同，那么我们能不能做到在项目中仅引入一个统一的日志框架呢？本篇我们就来探索SpringBoot如何实现统一日志操作...
SpringBoot统一日志处理原理，springcloud微服务架构面试
m0_61439560的博客
09-05 529
| JCL、SLF4j、jboss-logging | Log4j、 JUL（java.util.logging） Log4j2、 Logback | 每一种日志框架输出信息的效率也不尽相同，而我们日常开发使用的框架中往往都会引入一个日志框架来辅助输出框架信息，然而框架之间由于历史迭代原因及框架性能等问题，选择的日志框架也不一样，常见的框架与默认选择的日志系统关系如下: 框架 日志 Spring JCL SpringBoot Sfl4j–>logback Hibernate3
Logutil日志工具
sinat_18179367的博客
09-05 304
日志工具
self4j日志工具类 : LogUtil
jcmcom的博客
10-09 584
import java.text.MessageFormat; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * * 日志工具类 */ public class LogUtil { /** * logger */ protected Logger log = null;...
Spring Boot 篇五: Log的使用
Wrote Ideas Down, Together with Skills
10-26 3799
Spring Boot的学习过程。本篇主要讲述Log。
spring声明事务管理之细节session.getCurrentSession()
fmwind的专栏
12-13 5129
第一：在Spring @Transactional声明式事务管理的配置中,hibernate.current_session_context_class=thread… 这一句是不能加的…加了就会出错..那为什么不能加呢? 那是因为在Spring事务管理中,current Session是绑定到SpringSessionContext中的,而不是ThreadLocalSessionContex
logback在springboot中配置和打印日志的工具类
godhexin的博客
09-19 1924
<?xml version="1.0" encoding="utf-8"?> <configuration> <springProperty scope="context" name="logName" source="spring.application.name"/> <appende
springboot日志工具
qq_43001609的博客
10-14 965
springboot日志工具 初体验 在spring开发中免不了要记录日志，听说有个lombok非常好用(它当然不止来记日志这么好用) 给个例子体验下 @Slf4j public class WebSocketServer { public void onOpen() { ...
日志工具类Log
代码成碑
03-02 195
文章目录1. Log类方法2. Log使用快捷方法 1. Log类方法 Log.v：意义最小的日志信息。——verbose级别 Log.d：调试信息。——debug级别 Log.i：数据。——info级别 Log.w：警告信息。——warn级别 Log.e：错误信息。——error级别 2. Log使用快捷方法 log[v/d/i/w/e]+Tab键：自动补全语句 在onCreate()方法...
关于Spring/SpringBoot在静态工具类中注入Service的解决方案
Anthony_1223的博客
03-17 8155
    最近遇到了需要在工具类中注入Service，由于工具类中方法一般都是静态的，所以要求该属性也要是静态的（Service）。但是由于Spring/SpringBoot正常情况下不能支持注入静态属性（会报空指针异常）。主要原因在于：Spring的依赖注入实际上是依赖于Set方法进行注入值的，Spring是基于对象层面的依赖注入，而静态属性/静态变量实际上是属于类的。解决方案一：给当前的工具类加...
SpringBoot中AOP实现接口日志打印的实战教程
本文主要探讨了SpringBoot中如何利用AOP（面向切面编程）技术来有效地打印接口日志。首先，AOP是对面向对象编程的一种补充，旨在解决在业务代码中频繁出现的与业务逻辑无关但又分散的问题，如事务管理、日志记录等。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

orange大数据技术探索者

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值