Springboot异常日志输出方式

lombok插件使用

引入依赖,在项目中使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写 ↓

<!--lombok用来简化实体类-->
<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.16.20</version>
</dependency>

idea中安装lombok插件↓

创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码） ↓`

@Data
public class User {
   private Long id;
   private String name;
   private Integer age;
   private String email;
}

点击查看注解编译结果↓

统一异常处理

我们想让异常结果也显示为统一的返回结果对象,并且统一处理系统的异常信息,那么需要统一异常处理,

创建统一异常处理类GlobalExceptionHandler.java ↓

package com.ywj.handler;
import com.ywj.constants.ResultCodeEnum;
import com.ywj.exception.MyException;
import com.ywj.util.ExceptionUtil;
import com.ywj.vo.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
//全局异常处理
@ExceptionHandler(Exception.class)
@ResponseBody
public R error(Exception e){
//e.printStackTrace();//输出异常堆栈信息
log.error(e.getMessage());
return R.error();
}
//特定异常处理
@ExceptionHandler(ArithmeticException.class)
@ResponseBody
public R error(ArithmeticException e){
//e.printStackTrace();//输出异常堆栈信息
//log.error(e.getMessage());
log.info("错误信息----------------------------");
log.error(e.getMessage());
return R.setResult(ResultCodeEnum.MY_ERROR);
}
//自定义异常处理
@ExceptionHandler(MyException.class)
@ResponseBody
public R error(MyException e){
//e.printStackTrace();//输出异常堆栈信息
//log.error(e.getMessage());
log.error(ExceptionUtil.getMessage(e));
return R.error().message(e.getMessage()).code(e.getCode());
}
}

创建MyException.java通用异常类,继承RuntimeException↓

package com.ywj.exception;
import com.ywj.constants.ResultCodeEnum;
import lombok.Data;
@Data
//@ApiModel(value = "自定义全局异常类")
public class MyException extends RuntimeException {
//@ApiModelProperty(value = "状态码")
private Integer code;
/**
* 接收状态码和错误消息
* @param code
* @param message
*/
public MyException(Integer code, String message){
super(message);
this.code = code;
}
public MyException(ResultCodeEnum resultCodeEnum){
super(resultCodeEnum.getMessage());
this.code = resultCodeEnum.getCode();
}
@Override
public String toString() {
return "MyException{" +
"code=" + code +
", message=" + this.getMessage() +
'}';
}
}

业务中需要的位置抛出自定义异常↓

package com.ywj.controller;
import com.ywj.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class IndexController {
   @GetMapping("/")
   public String index(Model model){
       //System.out.println(10/0);
       if (true){
           throw new MyException(10086, "自定义异常");
       }
       System.out.println("index");
       model.addAttribute("name", "ywj");
       return "index";
   }
}

依赖的其他类补充说明↓

统一结果返回类R↓

package com.ywj.vo;
import com.ywj.constants.ResultCodeEnum;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
@Data
//@ApiModel(value="全局统一返回结果")
public class R {
//@ApiModelProperty(value = "是否成功")
private Boolean success;
//@ApiModelProperty(value = "返回码")
private Integer code;
//@ApiModelProperty(value = "返回消息")
private String message;
//@ApiModelProperty(value = "返回数据")
private Map<String, Object> data = new HashMap<String, Object>();
private R(){}
public static R ok(){
R r = new R();
r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
r.setCode(ResultCodeEnum.SUCCESS.getCode());
r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
return r;
}
public static R error(){
R r = new R();
r.setSuccess(ResultCodeEnum.UNKNOWN_REASON.getSuccess());
r.setCode(ResultCodeEnum.UNKNOWN_REASON.getCode());
r.setMessage(ResultCodeEnum.UNKNOWN_REASON.getMessage());
return r;
}
public R data(Map<String, Object> map){
this.setData(map);
return this;
}
public R data(String key, Object value){
this.data.put(key, value);
return this;
}
public R message(String message){
this.setMessage(message);
return this;
}
public R code(Integer code){
this.setCode(code);
return this;
}
public R success(Boolean success){
this.setSuccess(success);
return this;
}
public static R setResult(ResultCodeEnum resultCodeEnum){
R r = new R();
r.setSuccess(resultCodeEnum.getSuccess());
r.setCode(resultCodeEnum.getCode());
r.setMessage(resultCodeEnum.getMessage());
return r;
}
}

结果枚举常量类ResultCodeEnum↓

package com.ywj.constants;
import lombok.Getter;
@Getter
public enum ResultCodeEnum {
SUCCESS(true, 20000,"成功"),
UNKNOWN_REASON(false, 20001, "未知错误"),
BAD_SQL_GRAMMAR(false, 21001, "sql语法错误"),
JSON_PARSE_ERROR(false, 21002, "json解析异常"),
PARAM_ERROR(false, 21003, "参数不正确"),
FILE_UPLOAD_ERROR(false, 21004, "文件上传错误"),
EXCEL_DATA_IMPORT_ERROR(false, 21005, "Excel数据导入错误"),
MY_ERROR(false, 21006, "算术异常错误");
private Boolean success;//响应是否成功
private Integer code;//返回码
private String message;//返回消息
ResultCodeEnum(Boolean success, Integer code, String message) {
this.success = success;
this.code = code;
this.message = message;
}
}

异常栈信息输出工具类ExceptionUtil↓

package com.ywj.util;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
public class ExceptionUtil {
public static String getMessage(Exception e) {
StringWriter sw = null;
PrintWriter pw = null;
try {
sw = new StringWriter();
pw = new PrintWriter(sw);
// 将出错的栈信息输出到printWriter中
e.printStackTrace(pw);
pw.flush();
sw.flush();
} finally {
if (sw != null) {
try {
sw.close();
} catch (IOException e1) {
e1.printStackTrace();
}
}
if (pw != null) {
pw.close();
}
}
return sw.toString();
}
}

上面只是解释说明一下,直接拷贝资料文件夹的相关类到公司包即可,比如拷贝到ywj包下,项目结构如下↓

统一日志输出

配置日志级别↓

日志记录器（Logger）的行为是分等级的。如下表所示：

分为：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL

默认情况下，spring boot从控制台打印出来的日志级别只有INFO及以上级别，可以配置日志级别↓

# 设置日志级别
logging.level.root=WARN

以上方式只能将日志打印在控制台上 ↑

Logback日志↓

spring boot内部使用Logback作为日志实现的框架。

Logback和log4j非常相似，如果你对log4j很熟悉，那对logback很快就会得心应手。

配置logback日志↓

删除application.properties中的日志配置

安装idea彩色日志插件：grep-console

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上下文中。定义变量后，可以使“${}”来使用变量。 -->
   <property name="log.path" value="E:/ywj_log/edu" />
   <!-- 彩色日志 -->
   <!-- 配置格式变量：CONSOLE_LOG_PATTERN 彩色日志格式 -->
   <!-- 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 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>
   <!--输出到文件-->
   <!-- 时间滚动输出 level为 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>15</maxHistory>
       </rollingPolicy>
       <!-- 此日志文件只记录info级别的 -->
       <filter class="ch.qos.logback.classic.filter.LevelFilter">
           <level>INFO</level>
           <onMatch>ACCEPT</onMatch>
           <onMismatch>DENY</onMismatch>
       </filter>
   </appender>
   <!-- 时间滚动输出 level为 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>15</maxHistory>
       </rollingPolicy>
       <!-- 此日志文件只记录warn级别的 -->
       <filter class="ch.qos.logback.classic.filter.LevelFilter">
           <level>warn</level>
           <onMatch>ACCEPT</onMatch>
           <onMismatch>DENY</onMismatch>
       </filter>
   </appender>
   <!-- 时间滚动输出 level为 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>15</maxHistory>
       </rollingPolicy>
       <!-- 此日志文件只记录ERROR级别的 -->
       <filter class="ch.qos.logback.classic.filter.LevelFilter">
           <level>ERROR</level>
           <onMatch>ACCEPT</onMatch>
           <onMismatch>DENY</onMismatch>
       </filter>
   </appender>
   <!--
       <logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。
       <logger>仅有一个name属性，
       一个可选的level和一个可选的addtivity属性。
       name:用来指定受此logger约束的某一个包或者具体的某一个类。
       level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
             如果未设置此属性，那么当前logger将会继承上级的级别。
   -->
   <!--
       使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
       第一种把<root level="INFO">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
       第二种就是单独给mapper下目录配置DEBUG模式，代码如下，这样配置sql语句会打印，其他还是正常DEBUG级别：
    -->
   <!--开发环境:打印控制台-->
   <springProfile name="dev">
       <!--可以输出项目中的debug日志，包括mybatis的sql日志-->
       <logger name="com.ywj" level="INFO" />
       <!--
           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="pro">
       <!--可以输出项目中的debug日志，包括mybatis的sql日志-->
       <logger name="com.ywj" level="WARN" />
       <root level="INFO">
           <appender-ref ref="ERROR_FILE" />
           <appender-ref ref="WARN_FILE" />
       </root>
   </springProfile>
</configuration>

最后,别忘了,在application.yml配置文件中用profiles激活dev开发环境或其他环境比如生产环境pro等↓

server:
 port: 8888
spring:
 mvc:
   view:
     prefix: /WEB-INF/jsp/
     suffix: .jsp
 profiles:
   active: dev
#logging:
#  level:
#    root: warn

复制粘贴即可

其实,上面都只是解释一下,不想太麻烦,直接拷贝资料文件夹的里面的相关类和日志配置文件到项目中即可↑↓

来源：https://blog.csdn.net/dxdxdx11/article/details/109294506