spring boot整合logback日志输出到日志文件（输出执行SQL以及异常信息）
一、需求
将项目运行时执行的SQL及其执行结果输出到日志文件中，另外出现异常的时候将异常信息输出到日志文件中。
本文只是讲解输出日志的思路，部分具体配置徐自行解决。
二、部分依赖
<!-- mybatis --> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.2.0</version> </dependency> <!-- pageHelper --> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.5</version> <exclusions> <exclusion> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> </exclusion> <exclusion> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> </exclusion> </exclusions> </dependency> <!-- mybatis-plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.0.5</version> </dependency> <!-- velocity 模板引擎, Mybatis-plus 代码生成器需要 --> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>velocity-engine-core</artifactId> <version>2.0</version> </dependency>
三、返回数据封装
/** * @description 统一返回结果的类 **/ @Data @Accessors(chain = true) public class Result<R> { @ApiModelProperty(value = "是否成功") private Boolean success; @ApiModelProperty(value = "返回码") private Integer code; @ApiModelProperty(value = "返回提示消息") private String message; @ApiModelProperty(value = "返回数据") private R data; /** * 构造方法私有化 */ private Result() { } /** * 处理成功静态方法 * * @return */ public static Result success() { Result r = new Result(); r.setSuccess(true); r.setCode(KmapStatusEnum.SUCCESS.getCode()); r.setMessage(KmapStatusEnum.SUCCESS.getMsg()); return r; } /** * 处理失败静态方法 * * @return */ public static Result error() { Result r = new Result(); r.setSuccess(false); r.setCode(KmapStatusEnum.ERROR.getCode()); r.setMessage(KmapStatusEnum.ERROR.getMsg()); return r; } }
自定义异常类
@Data @AllArgsConstructor public class KmapException extends RuntimeException { private KmapStatusEnum statusEnum; }
异常枚举类
/** * @Description 返回码及返回信息枚举类 */ public enum KmapStatusEnum { SUCCESS(20000, "成功"), ERROR(20001, "失败"), INSERT_ERROR(20002, "添加失败"), UPDATE_ERROR(20003, "更新失败"), DELETE_ERROR(20004, "删除失败"), QUERY_ERROR(20005, "查询信息失败"); @ApiModelProperty("返回码") private Integer code; @ApiModelProperty("返回码") private String msg; public Integer getCode() { return code; } public String getMsg() { return msg; } KmapStatusEnum(Integer code, String msg) { this.code = code; this.msg = msg; } }
异常处理类
/** * @description 异常处理类 **/ @ControllerAdvice public class GlobalExceptionHandler { private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class); /** * 全局异常友好处理 * * @param e * @return */ @ExceptionHandler(Exception.class) @ResponseBody public Result error(Exception e) { LOGGER.error(getExceptionInfo(e)); return Result.error().setMessage("系统出现错误！"); } /** * 自定义异常 * * @param e * @return */ @ExceptionHandler(KmapException.class) @ResponseBody public Result error(KmapException e) { LOGGER.error(e.getStatusEnum().getMsg()); return Result.error().setCode(e.getStatusEnum().getCode()).setMessage(e.getStatusEnum().getMsg()); } /** * 获取异常信息转为字符串 * * @param e * @return */ private static String getExceptionInfo(Exception e) { StackTraceElement[] stackTrace = e.getStackTrace(); StringBuffer sb = new StringBuffer(); sb.append(e.toString()).append("\r\n"); for (StackTraceElement stackTraceElement : stackTrace) { sb.append("\tat ").append(stackTraceElement.getClassName()).append(".") .append(stackTraceElement.getMethodName()) .append("(").append(stackTraceElement.getFileName()).append(":").append(stackTraceElement.getLineNumber()) .append(")\r\n"); } return sb.toString(); } }
四、配置文件处理
application.properities文件修改mybatis-plus（没有用mybatis-plus的修改mybatis的也一样）日志实现
# 指定mybatis-plus日志实现，不用默认的org.apache.ibatis.logging.stdout.StdOutImpl，因为这种配置只能打印日志到控制台，不能输出到日志文件
#mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.slf4j.Slf4jImpl
在resources文件夹下创建logback-spring.xml日志配置文件（需要修改的地方已经用黄色背景色标注，如需修改其他相应配置自行修改即可）
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="10 seconds"> <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 --> <!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true --> <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 --> <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 --> <contextName>logback</contextName> <!-- 全局属性：name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 --> <!-- 日志文件路径属性,不同环境日志输出位置不一样 --> <springProfile name="dev"> <property name="log.path" value="D:/dev/workspace/kmap_bg_logs"/> </springProfile> <springProfile name="prod"> <property name="log.path" value="/kmap_bg_logs"/> </springProfile> <!-- 控制台日志输出格式属性，magenta:洋红,boldMagenta:粗红,cyan:青色,white:白色,magenta:洋红--> <property name="CONSOLE_LOG_PATTERN" value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/> <!--输出到控制台的Appender配置--> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息--> <!-- 例如：如果此处配置了INFO级别，则后面其他位置即使配置了DEBUG级别的日志，也不会被输出 --> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>INFO</level> </filter> <encoder> <!-- 输出日志格式 --> <Pattern>${CONSOLE_LOG_PATTERN}</Pattern> <!-- 设置字符集 --> <charset>UTF-8</charset> </encoder> </appender> <!--输出到文件的Appender配置 info日志--> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 日志具体路径及文件名 --> <file>${log.path}/log_info.log</file> <!--日志文件输出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> </encoder> <!-- 日志记录器的滚动策略，按日期，按大小记录 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 每天日志归档路径以及格式 --> <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天数--> <maxHistory>60</maxHistory> </rollingPolicy> <!-- 此日志文件只记录info级别的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--输出到文件的Appender配置 warn日志--> <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${log.path}/log_warn.log</file> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> </encoder> <!-- 日志记录器的滚动策略，按日期，按大小记录 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天数--> <maxHistory>60</maxHistory> </rollingPolicy> <!-- 此日志文件只记录warn级别的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>warn</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--输出到文件的Appender配置 error日志--> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${log.path}/log_error.log</file> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> </encoder> <!-- 日志记录器的滚动策略，按日期，按大小记录 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天数--> <maxHistory>60</maxHistory> </rollingPolicy> <!-- 此日志文件只记录ERROR级别的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--输出到文件的Appender配置 SQL执行日志--> <appender name="SQL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${log.path}/log_sql.log</file> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> </encoder> <!-- 日志记录器的滚动策略，按日期，按大小记录 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/sql/log-sql-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文件保留天数--> <maxHistory>60</maxHistory> </rollingPolicy> <!-- 此日志文件记录TRACE级别以上 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>DEBUG</level> <onMatch>ACCEPT</onMatch> <!-- <onMismatch>DENY</onMismatch>--> </filter> </appender> <!-- <logger>用来设置某一个包或者具体的某一个类的日志打印级别。有name属性，可选的level和可选的addtivity属性，以及可指定appender。 name:用来指定受此logger约束的某一个包或者具体的某一个类。 level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，如果未设置此属性，那么当前logger将会继承上级的级别。 addtivity :是否向上级loger传递打印信息。默认是true。--> <!-- 使用mybatis的时候，sql语句是debug下才会打印，spring默认日志级别是INFO，所以想要查看sql语句的话，有以下两种操作： 第一种把<root level="INFO">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息 第二种就是单独给mapper下目录配置DEBUG级别： 例如：<logger name="com.kingoit.mapper" level="DEBUG"/> 或者在配置文件中配置：logging.level.com.kingoit.mapper=DEBUG，这样配置sql语句会打印，其他还是正常INFO级别：--> <!--开发环境--> <springProfile name="dev"> <!--单独设置mapper包下的日志级别为TRACE，因为输出执行的sql需要DEBUG级别，TRACE级别小于DEBUG，设置为TRACE级别同时将SQL执行结果输出--> <logger name="com.kingoit.mapper" level="TRACE"> <appender-ref ref="SQL_FILE"/> </logger> <!-- root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性 level:指定打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，默认是DEBUG 可以包含零个或多个appender元素。--> <root level="INFO"> <appender-ref ref="CONSOLE"/> <appender-ref ref="INFO_FILE"/> <appender-ref ref="WARN_FILE"/> <appender-ref ref="ERROR_FILE"/> </root> </springProfile> <!--生产环境--> <springProfile name="prod"> <!--单独设置mapper包下的日志级别为DEBUG，因为输出执行的sql需要DEBUG级别--> <logger name="com.kingoit.mapper" level="DEBUG"> <appender-ref ref="SQL_FILE"/> </logger> <root level="INFO"> <appender-ref ref="CONSOLE"/> <appender-ref ref="INFO_FILE"/> <appender-ref ref="ERROR_FILE"/> <appender-ref ref="WARN_FILE"/> </root> </springProfile> </configuration>
启动项目，访问接口后会创建响应的文件夹及日志文件（文件夹看具体配置什么时候生成，无需担心第一天没有）
