[关闭]
@wangzhuanyun 2020-08-22T02:35:14.000000Z 字数 10835 阅读 1359

Springboot 日志处理（三）

springboot

日志存入数据库（AOP）

1.引入aop依赖

  1. <!-- aop依赖 -->
  2. <dependency>
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-aop</artifactId>
  5. </dependency>

2.创建自定义注解类（用于在Controller层使用注解标注哪个方法需要增加日志）

  1. 在log包下创建Log.java文件
  3. @Target(ElementType.METHOD)
  4. @Retention(RetentionPolicy.RUNTIME)
  5. public @interface Log {
  6.     String value() default "";
  7. }
  10. @interface 注解类，自定义注解
  12. @Target  用来说明该注解可以被声明在那些元素之前  
  13. ElementType.METHOD说明该注解只能被声明在一个类的方法前
  15. @Retention 用来说明该注解类的生命周期。  
  16. RetentionPolicy.RUNTIME注解保留在程序运行期间，此时可以通过反射获得定义在某个类上的所有注解

3.编写LogAspect增强类与增强方法（我们使用环绕增强around）

  2. @Aspect
  3. @Component
  4. public class LogAspect {
  5.     //切入点，指定当使用Log注解时进入环绕增强
  6.     @Pointcut("@annotation(com.hz.log.Log)")
  7.     public void pointcut() {}
  9.     @Around("pointcut()")
  10.     public Object around(ProceedingJoinPoint point) {
  12.         try {
  13.             System.out.println("执行环绕增强..............开始");
  14.             Object result = point.proceed();//执行方法
  15.             System.out.println("结束..........");
  16.             return result;
  17.         } catch (Throwable throwable) {
  18.             throwable.printStackTrace();
  19.         }
  21.         return null;
  22.     }
  24. }

4.创建controller进行测试

  1. @Log("获取所有用户集合")
  2. @GetMapping("/getSfUserList")
  3. public List<SfUser> getSfUserList() {
  4.     List<SfUser> sfUserList = sfUserService.getSfUserList(1);
  5.     System.out.println(sfUserList.size());
  6.     return sfUserList;
  7. }

开始写入数据库
1.创建日志记录表sys_log

  1. DROP TABLE IF EXISTS `sys_log`;
  2. CREATE TABLE `sys_log` (
  3.   `ID` bigint(20) NOT NULL AUTO_INCREMENT,
  4.   `USERNAME` varchar(50) DEFAULT NULL COMMENT '用户名',
  5.   `OPERATION` varchar(50) DEFAULT NULL COMMENT '用户操作',
  6.   `TIME` int(11) DEFAULT NULL COMMENT '响应时间',
  7.   `METHOD` varchar(200) DEFAULT NULL COMMENT '请求方法',
  8.   `PARAMS` varchar(500) DEFAULT NULL COMMENT '请求参数',
  9.   `IP` varchar(64) DEFAULT NULL COMMENT 'IP地址',
  10.   `CREATE_TIME` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  11.   PRIMARY KEY (`ID`)
  12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

2.创建实体类

  1. /**
  2.  * 日志记录实体类
  3.  */
  4. public class SysLog {
  5.     private Long id;
  6.     private String username;
  7.     private String operation;
  8.     private Integer time;
  9.     private String method;
  10.     private String params;
  11.     private String ip;
  12.     private Date createTime;
  14.     .....get...set...
  15. }

3.编写DAO层接口与实现，向表中插入数据

  1. @Repository
  2. public class SysLogDaoImpl implements SysLogDao {
  3.     @Autowired
  4.     @Qualifier("mysqlJdbcTemplateOne") //使用第一个数据源
  5.     private JdbcTemplate jdbcTemplate;
  7.     //保存信息到日志表
  8.     @Override
  9.     public void saveSysLog(SysLog syslog) {
  10. String sql = "insert into sys_log(USERNAME,OPERATION,TIME,METHOD,PARAMS,IP)";
  12. jdbcTemplate.update(sql,new Object[]{syslog.getUsername(),syslog.getOperation(),syslog.getTime(),syslog.getMethod(),syslog.getParams(),syslog.getIp()});
  13.     }
  14. }

4.修改LogAspect增强类与增强方法

  2. @Aspect
  3. @Component
  4. public class LogAspect {
  6.     @Autowired
  7.     private SysLogDao sysLogDao;
  9.     @Pointcut("@annotation(com.hz.log.Log)")
  10.     public void pointcut() {}
  12.     @Around("pointcut()")
  13.     public Object around(ProceedingJoinPoint point) {
  16.         try {
  17.             long beginTime = System.currentTimeMillis();//开始执行时间
  19.             Object result = point.proceed();//执行方法
  20.             // 执行时长(毫秒)
  21.             long time = System.currentTimeMillis() - beginTime;
  22.             //实例化日志类
  23.             SysLog sysLog = new SysLog();
  24.             sysLog.setUsername("wzy");//模拟一个用户名  实际可以从session中获取
  25.             sysLog.setTime((int) time);//执行时长(毫秒)
  26.             // 获取request
  27.             HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
  28.             // 设置IP地址
  29.             sysLog.setIp(IPUtils.getIpAddr(request));
  31.             MethodSignature signature = (MethodSignature) point.getSignature();
  32.             Method method = signature.getMethod();
  33.             Log logAnnotation = method.getAnnotation(Log.class);
  34.             if (logAnnotation != null) {
  35.                 // 注解上的描述
  36.                 sysLog.setOperation(logAnnotation.value());
  37.             }
  39.             // 请求的方法名
  40.             String className = point.getTarget().getClass().getName();
  41.             String methodName = signature.getName();
  42.             sysLog.setMethod(className + "." + methodName + "()");
  45.             // 请求的方法参数值
  46.             Object[] args = point.getArgs();
  47.             // 请求的方法参数名称
  48.             LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
  49.             String[] paramNames = u.getParameterNames(method);
  50.             if (args != null && paramNames != null) {
  51.                 String params = "";
  52.                 for (int i = 0; i < args.length; i++) {
  53.                     params += "  " + paramNames[i] + ": " + args[i];
  54.                 }
  55.                 sysLog.setParams(params);
  56.             }
  59.             // 保存系统日志
  60.             sysLogDao.saveSysLog(sysLog);
  62.             return result;
  63.         } catch (Throwable throwable) {
  64.             throwable.printStackTrace();
  65.         }
  67.         return null;
  68.     }
  70. }
  71. 注意：
  72. IP的获取需要工具类，网上可以自行查找
  73. 获取参数与获取方法名的方式都可以从网站查询

5.运行测试@Log

日志控制台打印与写入文件（logback）

1.创建logback-spring.xml文件放入resource下，并复制内容到该文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
  3. <!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
  4. <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
  5. <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
  6. <configuration  scan="true" scanPeriod="10 seconds">
  8.     <!--<include resource="org/springframework/boot/logging/logback/base.xml" />-->
  10.     <contextName>logback</contextName>
  11.     <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
  12.     <property name="log.path" value="D:/nmyslog/nmys" />
  14.     <!-- 彩色日志 -->
  15.     <!-- 彩色日志依赖的渲染类 -->
  16.     <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
  17.     <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
  18.     <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
  19.     <!-- 彩色日志格式 -->
  20.     <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
  23.     <!--输出到控制台-->
  24.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  25.         <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
  26.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  27.             <level>info</level>
  28.         </filter>
  29.         <encoder>
  30.             <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
  31.             <!-- 设置字符集 -->
  32.             <charset>UTF-8</charset>
  33.         </encoder>
  34.     </appender>
  37.     <!--输出到文件-->
  39.     <!-- 时间滚动输出 level为 DEBUG 日志 -->
  40.     <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  41.         <!-- 正在记录的日志文件的路径及文件名 -->
  42.         <file>${log.path}/log_debug.log</file>
  43.         <!--日志文件输出格式-->
  44.         <encoder>
  45.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  46.             <charset>UTF-8</charset> <!-- 设置字符集 -->
  47.         </encoder>
  48.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  49.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  50.             <!-- 日志归档 -->
  51.             <fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  52.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  53.                 <maxFileSize>100MB</maxFileSize>
  54.             </timeBasedFileNamingAndTriggeringPolicy>
  55.             <!--日志文件保留天数-->
  56.             <maxHistory>15</maxHistory>
  57.         </rollingPolicy>
  58.         <!-- 此日志文件只记录debug级别的 -->
  59.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  60.             <level>debug</level>
  61.             <onMatch>ACCEPT</onMatch>
  62.             <onMismatch>DENY</onMismatch>
  63.         </filter>
  64.     </appender>
  66.     <!-- 时间滚动输出 level为 INFO 日志 -->
  67.     <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  68.         <!-- 正在记录的日志文件的路径及文件名 -->
  69.         <file>${log.path}/log_info.log</file>
  70.         <!--日志文件输出格式-->
  71.         <encoder>
  72.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  73.             <charset>UTF-8</charset>
  74.         </encoder>
  75.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  76.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  77.             <!-- 每天日志归档路径以及格式 -->
  78.             <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  79.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  80.                 <maxFileSize>100MB</maxFileSize>
  81.             </timeBasedFileNamingAndTriggeringPolicy>
  82.             <!--日志文件保留天数-->
  83.             <maxHistory>15</maxHistory>
  84.         </rollingPolicy>
  85.         <!-- 此日志文件只记录info级别的 -->
  86.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  87.             <level>info</level>
  88.             <onMatch>ACCEPT</onMatch>
  89.             <onMismatch>DENY</onMismatch>
  90.         </filter>
  91.     </appender>
  93.     <!-- 时间滚动输出 level为 WARN 日志 -->
  94.     <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  95.         <!-- 正在记录的日志文件的路径及文件名 -->
  96.         <file>${log.path}/log_warn.log</file>
  97.         <!--日志文件输出格式-->
  98.         <encoder>
  99.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  100.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  101.         </encoder>
  102.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  103.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  104.             <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  105.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  106.                 <maxFileSize>100MB</maxFileSize>
  107.             </timeBasedFileNamingAndTriggeringPolicy>
  108.             <!--日志文件保留天数-->
  109.             <maxHistory>15</maxHistory>
  110.         </rollingPolicy>
  111.         <!-- 此日志文件只记录warn级别的 -->
  112.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  113.             <level>warn</level>
  114.             <onMatch>ACCEPT</onMatch>
  115.             <onMismatch>DENY</onMismatch>
  116.         </filter>
  117.     </appender>
  120.     <!-- 时间滚动输出 level为 ERROR 日志 -->
  121.     <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  122.         <!-- 正在记录的日志文件的路径及文件名 -->
  123.         <file>${log.path}/log_error.log</file>
  124.         <!--日志文件输出格式-->
  125.         <encoder>
  126.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  127.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  128.         </encoder>
  129.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  130.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  131.             <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  132.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  133.                 <maxFileSize>100MB</maxFileSize>
  134.             </timeBasedFileNamingAndTriggeringPolicy>
  135.             <!--日志文件保留天数-->
  136.             <maxHistory>15</maxHistory>
  137.         </rollingPolicy>
  138.         <!-- 此日志文件只记录ERROR级别的 -->
  139.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  140.             <level>ERROR</level>
  141.             <onMatch>ACCEPT</onMatch>
  142.             <onMismatch>DENY</onMismatch>
  143.         </filter>
  144.     </appender>
  146.     <!--
  147.         <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
  148.         以及指定<appender>。<logger>仅有一个name属性，
  149.         一个可选的level和一个可选的addtivity属性。
  150.         name:用来指定受此logger约束的某一个包或者具体的某一个类。
  151.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
  152.               还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
  153.               如果未设置此属性，那么当前logger将会继承上级的级别。
  154.         addtivity:是否向上级logger传递打印信息。默认是true。
  155.     -->
  156.     <!--<logger name="org.springframework.web" level="info"/>-->
  157.     <!--<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->
  158.     <!--
  159.         使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
  160.         第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
  161.         第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：
  162.      -->
  165.     <!--
  166.         root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
  167.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
  168.         不能设置为INHERITED或者同义词NULL。默认是DEBUG
  169.         可以包含零个或多个元素，标识这个appender将会添加到这个logger。
  170.     -->
  172.     <!--开发环境:打印控制台-->
  173.     <springProfile name="dev">
  174.         <logger name="com.nmys.view" level="debug"/>
  175.     </springProfile>
  177.     <root level="info">
  178.         <appender-ref ref="CONSOLE" />
  179.         <appender-ref ref="DEBUG_FILE" />
  180.         <appender-ref ref="INFO_FILE" />
  181.         <appender-ref ref="WARN_FILE" />
  182.         <appender-ref ref="ERROR_FILE" />
  183.     </root>
  185.     <!--生产环境:输出到文件-->
  186.     <!--<springProfile name="pro">-->
  187.     <!--<root level="info">-->
  188.     <!--<appender-ref ref="CONSOLE" />-->
  189.     <!--<appender-ref ref="DEBUG_FILE" />-->
  190.     <!--<appender-ref ref="INFO_FILE" />-->
  191.     <!--<appender-ref ref="ERROR_FILE" />-->
  192.     <!--<appender-ref ref="WARN_FILE" />-->
  193.     <!--</root>-->
  194.     <!--</springProfile>-->
  196. </configuration>

2.配置application.properties文件

  1. #读取配置文件
  2. logging.config=classpath:logback-spring.xml
  3. #日志打印文件所在目录
  4. logging.path=D:/项目名/log

3.编写controller测试

  1. Logger log = Logger.getLogger(SfUserController.class);
  3. log.info("要输出的内容"）；//输出信息
  5. 等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF则不打出任何信息，如果配置为INFO这样只显示INFO, WARN, ERROR的log信息，而DEBUG信息不会被显示
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注