SpringBoot 配置全局异常处理

墨蓝 2023-10-10 11:44 10阅读 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>
    		
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    		
    		
    		<dependency>
    			<groupId>org.apache.commons</groupId>
    			<artifactId>commons-lang3</artifactId>
    			<version>${commons-lang3.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>commons-codec</groupId>
    			<artifactId>commons-codec</artifactId>
    			<version>${commons-codec.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>commons-net</groupId>
    			<artifactId>commons-net</artifactId>
    			<version>${commons-net.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>commons-io</groupId>
    			<artifactId>commons-io</artifactId>
    			<version>${commons-io.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>commons-collections</groupId>
    			<artifactId>commons-collections</artifactId>
    			<version>${commons-collections.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.apache.commons</groupId>
    			<artifactId>commons-text</artifactId>
    			<version>${commons-text.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.mybatis.spring.boot</groupId>
    			<artifactId>mybatis-spring-boot-starter</artifactId>
    			<version>${mybatis-spring-boot-starter.version}</version>
    		</dependency>
    		
    		<dependency>
    　			<groupId>com.oracle</groupId>
      			<artifactId>ojdbc6</artifactId>
      			<version>${oracle.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>com.alibaba</groupId>
    			<artifactId>druid-spring-boot-starter</artifactId>
    			<version>${com.alibaba.druid.version}</version>
    		</dependency>
    		
             <dependency>
                <groupId>com.github.pagehelper</groupId>
                <artifactId>pagehelper-spring-boot-starter</artifactId>
                <version>1.2.5</version>
            </dependency>
            
            <dependency> 
    		   <groupId>javax.servlet</groupId> 
    		   <artifactId>servlet-api</artifactId> 
    		   <version>2.5</version> 
    		   <scope>provided</scope> 
    		</dependency> 
    	</dependencies>
    
    </project>

项目结构整体截图:

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70][]

如何实现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 包依赖

<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"?> 
      
      
      
      
      
      
      
    <configuration scan="true" scanPeriod="60 seconds" debug="false">  
          
        <property name="log_dir" value="/logs/migrate" />  
          
        <property name="maxHistory" value="30"/>  
      
      
          
        <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>  
          
          
          
          
        <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <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>${maxHistory}</maxHistory>  
            </rollingPolicy>  
                      
            <encoder>  
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>  
            </encoder>  
        </appender>  
          
          
          
        <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <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>  
          
          
          
        <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <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>  
          
          
          
        <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 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 日志输出功能代码和效果截图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70 1][]

![20201105154322553.png][]

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();
    	}

效果截图

:![20201105154807921.png][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201105152748367.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201105154303775.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n,size_16,color_FFFFFF,t_70
[20201105154322553.png]: https://img-blog.csdnimg.cn/20201105154322553.png
[20201105154807921.png]: https://img-blog.csdnimg.cn/20201105154807921.png