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

复制粘贴即可

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

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。