SpringBoot 配置全局异常处理分析

访客 阅读:251 2021-03-31 13:29:30 评论:0

SpringBoot 项目pom.xml 依赖配置文件:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 
	<modelVersion>4.0.0</modelVersion> 
	<groupId>com.zzg</groupId> 
	<artifactId>migrate</artifactId> 
	<version>0.0.1-SNAPSHOT</version> 
 
	<parent> 
		<groupId>org.springframework.boot</groupId> 
		<artifactId>spring-boot-starter-parent</artifactId> 
		<version>1.5.18.RELEASE</version> 
	</parent> 
 
	<properties> 
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
		<encoding>UTF-8</encoding> 
		<java.version>1.8</java.version> 
		<commons-lang.version>2.6</commons-lang.version> 
		<commons-codec.version>1.10</commons-codec.version> 
		<commons-lang3.version>3.9</commons-lang3.version> 
		<commons-net.version>3.6</commons-net.version> 
		<commons-io.version>2.6</commons-io.version> 
		<commons-collections.version>3.2.1</commons-collections.version> 
		<commons-text.version>1.8</commons-text.version> 
		<oracle.version>1.0</oracle.version> 
		<mybatis-spring-boot-starter.version>1.3.2</mybatis-spring-boot-starter.version> 
		<com.alibaba.druid.version>1.1.10</com.alibaba.druid.version> 
	</properties> 
 
	<dependencies> 
		<!--web 模块依赖 --> 
		<dependency> 
			<groupId>org.springframework.boot</groupId> 
			<artifactId>spring-boot-starter-web</artifactId> 
		</dependency> 
		<!--web 单元测试 --> 
		<dependency> 
			<groupId>org.springframework.boot</groupId> 
			<artifactId>spring-boot-starter-test</artifactId> 
			<scope>test</scope> 
		</dependency> 
		<!-- apache common 模块 --> 
		<!--commons-lang3 工具包 --> 
		<dependency> 
			<groupId>org.apache.commons</groupId> 
			<artifactId>commons-lang3</artifactId> 
			<version>${commons-lang3.version}</version> 
		</dependency> 
		<!--commons-codec 加密工具包 --> 
		<dependency> 
			<groupId>commons-codec</groupId> 
			<artifactId>commons-codec</artifactId> 
			<version>${commons-codec.version}</version> 
		</dependency> 
		<!--commons-net 网络工具包 --> 
		<dependency> 
			<groupId>commons-net</groupId> 
			<artifactId>commons-net</artifactId> 
			<version>${commons-net.version}</version> 
		</dependency> 
		<!--common-io 工具包 --> 
		<dependency> 
			<groupId>commons-io</groupId> 
			<artifactId>commons-io</artifactId> 
			<version>${commons-io.version}</version> 
		</dependency> 
		<!--common-collection 工具包 --> 
		<dependency> 
			<groupId>commons-collections</groupId> 
			<artifactId>commons-collections</artifactId> 
			<version>${commons-collections.version}</version> 
		</dependency> 
		<!-- common-text 工具包 --> 
		<dependency> 
			<groupId>org.apache.commons</groupId> 
			<artifactId>commons-text</artifactId> 
			<version>${commons-text.version}</version> 
		</dependency> 
		<!-- springboot整合mybatis --> 
		<dependency> 
			<groupId>org.mybatis.spring.boot</groupId> 
			<artifactId>mybatis-spring-boot-starter</artifactId> 
			<version>${mybatis-spring-boot-starter.version}</version> 
		</dependency> 
		<!-- oracle驱动 --> 
		<dependency> 
 			<groupId>com.oracle</groupId> 
  			<artifactId>ojdbc6</artifactId> 
  			<version>${oracle.version}</version> 
		</dependency> 
		<!-- alibaba druid 数据库连接池  --> 
		<dependency> 
			<groupId>com.alibaba</groupId> 
			<artifactId>druid-spring-boot-starter</artifactId> 
			<version>${com.alibaba.druid.version}</version> 
		</dependency> 
		<!-- PageHelp  --> 
         <dependency> 
            <groupId>com.github.pagehelper</groupId> 
            <artifactId>pagehelper-spring-boot-starter</artifactId> 
            <version>1.2.5</version> 
        </dependency> 
        <!-- 集成Servlet-api 模块  --> 
        <dependency>  
		   <groupId>javax.servlet</groupId>  
		   <artifactId>servlet-api</artifactId>  
		   <version>2.5</version>  
		   <scope>provided</scope>  
		</dependency>  
	</dependencies> 
 
</project>

项目结构整体截图:

如何实现SpringBoot 全局异常处理类:

SpringBoot 支持全局异常处理功能说明:SpringBoot中有一个ControllerAdvice的注解,使用该注解表示开启了全局异常的捕获,我们仅仅需要自定义一个方法使用ExceptionHandler注解然后定义捕获异常的类型即可对这些捕获的异常进行统一的处理。

示例:SpringBoot 全局异常编写

package com.zzg.global.exception.handler; 
 
import javax.servlet.http.HttpServletRequest; 
 
import org.slf4j.Logger; 
import org.slf4j.LoggerFactory; 
import org.springframework.web.bind.annotation.ControllerAdvice; 
import org.springframework.web.bind.annotation.ExceptionHandler; 
import org.springframework.web.bind.annotation.ResponseBody; 
 
import com.zzg.common.entity.Result; 
 
@ControllerAdvice 
public class GlobalExceptionHandler { 
	// 日志记录 
	public static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class); 
 
	/** 
	 * 处理其他异常 
	 *  
	 * @param req 
	 * @param e 
	 * @return 
	 */ 
	@ExceptionHandler(Exception.class) 
	@ResponseBody 
	public Result exceptionHandler(HttpServletRequest request, Exception e) { 
		logger.error("未知异常!原因是:", e); 
		return Result.error("系统未知异常"); 
	} 
} 

自定义响应数据格式:

package com.zzg.common.entity; 
 
import java.util.HashMap; 
import java.util.List; 
import java.util.Map; 
 
import com.zzg.common.BaseModel; 
import com.zzg.common.constant.WebAppConstants; 
 
 
public class Result implements java.io.Serializable { 
	/** 
	 *  
	 */ 
	private static final long serialVersionUID = -4122695267046209317L; 
	//成功返回 
	public static String RESULT_CODE_SUCCESS = "200"; 
	//失败返回 
	public static String RESULT_CODE_ERROR = "500"; 
 
	//返回码 
	protected String code; 
	//返回提示信息 
	protected String message; 
	//返回数据集合 
	public Map<String,Object> data = new HashMap<String,Object>(); 
	// set 和  get 方法 
	public String getCode() { 
		return code; 
	} 
	public void setCode(String code) { 
		this.code = code; 
	} 
	public String getMessage() { 
		return message; 
	} 
	public void setMessage(String message) { 
		this.message = message; 
	} 
	 
	// 构造函数 
	public Result() { 
		this.code = RESULT_CODE_SUCCESS; 
		this.message = "success"; 
	} 
	 
	public static Result ok() { 
		return new Result(); 
	} 
	 
	public static Result ok(String msg) { 
		return ok(RESULT_CODE_SUCCESS, msg); 
	} 
	 
	public static Result ok(String code, String msg) { 
		Result r = new Result(); 
		r.code = code; 
		r.message = msg; 
		return r; 
	} 
	 
	public static Result error(String msg) { 
		return error(RESULT_CODE_ERROR, msg); 
	} 
	 
	public static Result error(String code, String msg) { 
		Result r = new Result(); 
		r.code = code; 
		r.message = msg; 
		return r; 
	} 
	 
	/** 
	 *  
	 * @Title: setData    
	 * @Description: 添加返回数据到默认 data 节点 
	 * @param: @param obj 
	 * @param: @return       
	 * @return: Result       
	 * @throws 
	 */ 
	public Result setData(BaseModel obj){ 
		data.put("data", obj); 
		return this; 
	} 
	 
	/** 
	 *  
	 * @Title: setData    
	 * @Description: 添加结果集到 data节点,如果有分页信息添加分页数据 
	 * @param: @param list 
	 * @param: @return       
	 * @return: Result       
	 * @throws 
	 */ 
	public Result setData(PageDate list){ 
		this.setData(list.getData()); 
		this.setData(WebAppConstants.LIMIT, list.getPageSize()); 
		this.setData(WebAppConstants.PAGE, list.getPageNum()); 
		this.setData(WebAppConstants.TOTAL, list.getTotalCount()); 
		return this; 
	} 
	 
	public Result setData(Map rs){ 
		data.putAll(rs); 
		return this; 
	} 
	 
	public Result setData(List list){ 
		data.put("list", list); 
		return this; 
	} 
	 
	public Result setData(String name, Object value){ 
		data.put(name, value); 
		return this; 
	} 
	 
	public Result setSid(Long sid) { 
		setData("sid", sid); 
		return this; 
	} 
	 
	public Result setSid(String sid) { 
		setData("sid", sid); 
		return this; 
	} 
} 

SpringBoot 配置logback日志输出

logback 日志模块简介:

logback是继log4j后的又一个日志框架,logback是springboot自带的日志框架,logback以严格的日志级别区分不同级别的日志(其他日志都是继承上一级的日志级别,例如:log4j2,log4j都是继承更高级别的日志),logback分为三个模块,logback-core,logback-classic,logback-access。

  • logback-core:logback-core是logback的核心模块,是logback-classic和的logback-access的基础。
  • logback-classic:实现了 slf4j API,配合 slf4j 使用,可以方便的切换其他日志框架。
  • logback-access:与Servlet容器(如Tomcat和Jetty)集成,提供了 HTTP 访问日志接口。

 

SpringBoot 集成logbakc 日志

pom.xml 文件涉及日志记录jar 包依赖

        <!--web 模块依赖 --> 
		<dependency> 
			<groupId>org.springframework.boot</groupId> 
			<artifactId>spring-boot-starter-web</artifactId> 
		</dependency>

application.properties 涉及日志记录配置

 
# 指定日志文件配置 
logging.config=classpath:logback.xml

logback.xml 文件涉及日志记录配置

<?xml version="1.0" encoding="UTF-8"?>  
   
<!-- 从高到地低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->   
<!-- 日志输出规则  根据当前ROOT 级别,日志输出时,级别高于root默认的级别时  会输出 -->   
<!-- 以下  每个配置的 filter 是过滤掉输出文件里面,会出现高级别文件,依然出现低级别的日志信息,通过filter 过滤只记录本级别的日志-->   
   
   
<!-- 属性描述 scan:性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位, 
默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。    
    debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->   
<configuration scan="true" scanPeriod="60 seconds" debug="false">   
    <!-- 定义日志文件 输入位置 -->   
    <property name="log_dir" value="/logs/migrate" />   
    <!-- 日志最大的历史 30天 -->   
    <property name="maxHistory" value="30"/>   
   
   
    <!-- ConsoleAppender 控制台输出日志 -->   
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
        <!-- 对日志进行格式化 -->   
        <encoder>   
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger -%msg%n</pattern>   
        </encoder>   
    </appender>   
       
       
    <!-- ERROR级别日志 -->   
    <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 RollingFileAppender-->   
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <!-- 过滤器,只记录WARN级别的日志 -->   
        <filter class="ch.qos.logback.classic.filter.LevelFilter">   
            <level>ERROR</level>   
            <onMatch>ACCEPT</onMatch>   
            <onMismatch>DENY</onMismatch>   
        </filter>   
        <!-- 最常用的滚动策略,它根据时间来制定滚动策略.既负责滚动也负责出发滚动 -->   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
            <!--日志输出位置  可相对、和绝对路径 -->   
            <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-error-log.log</fileNamePattern>   
            <!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件假设设置每个月滚动,且<maxHistory>是6,   
            则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除-->   
            <maxHistory>${maxHistory}</maxHistory>   
        </rollingPolicy>   
                   
        <encoder>   
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>   
        </encoder>   
    </appender>   
       
       
    <!-- WARN级别日志 appender -->   
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <!-- 过滤器,只记录WARN级别的日志 -->   
        <filter class="ch.qos.logback.classic.filter.LevelFilter">   
            <level>WARN</level>   
            <onMatch>ACCEPT</onMatch>   
            <onMismatch>DENY</onMismatch>   
        </filter>   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
            <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-warn-log.log   
            </fileNamePattern>   
            <maxHistory>${maxHistory}</maxHistory>   
        </rollingPolicy>   
        <encoder>   
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>   
        </encoder>   
    </appender>   
       
       
    <!-- INFO级别日志 appender -->   
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <!-- 过滤器,只记录INFO级别的日志 -->   
        <filter class="ch.qos.logback.classic.filter.LevelFilter">   
            <level>INFO</level>   
            <onMatch>ACCEPT</onMatch>   
            <onMismatch>DENY</onMismatch>   
        </filter>   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
            <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-info-log.log   
            </fileNamePattern>   
            <maxHistory>${maxHistory}</maxHistory>   
        </rollingPolicy>   
        <encoder>   
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>   
        </encoder>   
    </appender>   
       
       
    <!-- DEBUG级别日志 appender -->   
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <filter class="ch.qos.logback.classic.filter.LevelFilter">   
            <level>DEBUG</level>   
            <onMatch>ACCEPT</onMatch>   
            <onMismatch>DENY</onMismatch>   
        </filter>   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
            <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-debug-log.log   
            </fileNamePattern>   
            <maxHistory>${maxHistory}</maxHistory>   
        </rollingPolicy>   
        <encoder>   
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>   
        </encoder>   
    </appender>   
     
    
    <logger name="java.sql.PreparedStatement" value="DEBUG" />     
    <logger name="java.sql.Connection" value="DEBUG" />     
    <logger name="java.sql.Statement" value="DEBUG" />     
    <logger name="com.ibatis" value="DEBUG" />     
    <logger name="com.ibatis.common.jdbc.SimpleDataSource" value="DEBUG" />     
    <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG"/>     
    <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate" value="DEBUG" />     
    <logger name="org.springframework.web" level="DEBUG"/> 
	 <logger name="com.zzg" level="DEBUG"/> 
       
    <!-- root级别   DEBUG -->   
    <root level="WARN">   
        <!-- 控制台输出 -->   
        <appender-ref ref="STDOUT" />   
        <!-- 文件输出 -->   
        <appender-ref ref="ERROR" />   
        <appender-ref ref="INFO" />   
        <appender-ref ref="WARN" />   
        <appender-ref ref="DEBUG" />   
    </root>   
</configuration>

SpringBoot 中涉及logbcak 日志输出功能代码和效果截图

 SpringBoot 实现全局异常处理效果截图:

前提:SpringBoot 全局异常处理,基于SpringBoot +MyBatis 事务管理配置,具体请参考文章:

ServiceImpl:出现异常功能代码片段:

	@Override 
	@Transactional(propagation = Propagation.REQUIRED,isolation = Isolation.DEFAULT,timeout=36000,rollbackFor=Exception.class) 
	public void deleteByPrimaryKey(Long sid) { 
		// TODO Auto-generated method stub 
		mapper.deleteByPrimaryKey(sid); 
		//模拟事务失败处理 
		int a = 10/0; 
	}

Controller:调用异常功能代码:

	@RequestMapping("/delete") 
	@ResponseBody 
	public Result delete() { 
		log.warn("执行删除"); 
		ermsGuideProjBaseInfoService.deleteByPrimaryKey(1898980L); 
		return Result.ok(); 
	}

效果截图

:

声明

1.本站遵循行业规范,任何转载的稿件都会明确标注作者和来源;2.本站的原创文章,请转载时务必注明文章作者和来源,不尊重原创的行为我们将追究责任;3.作者投稿可能会经我们编辑修改或补充。

发表评论
搜索
KIKK导航

KIKK导航

排行榜
关注我们

一个IT知识分享的公众号