SpringBoot微服务项目最佳实践—异常的全局统一处理

立即下载用AI写一个

发布时间：2019-11-20

2人 | 浏览：3220次 | 收藏 |

技术：springboot

概述

springboot项目看似简单，但在实际企业项目中，需要遵循很多最佳实践才称得上是在企业中“可用”的项目。本文章描述如何在springboot微服务项目中对异常做全局统一处理，同时也可以作为新项目的脚手架使用。

详细

###为什么要针对异常做全局处理：
##### 我们可以想象下如果没有针对异常做全局统一处理会怎样：  
1. 每个controller对应的业务代码，都要自己处理异常，风格不统一，搞不好还有人处理的有问题。
2. 当强制要求所有人都用统一的风格处理异常时，那么自然而然需要把相同的代码提取出来，做统一处理。

##### 将异常做全局统一处理的好处：
1. 具体业务逻辑的实现，不用考虑异常如何包装并返回给客户端，简化代码
2. 统一在一个地方处理，易于代码维护。

### 如何实现：
#####从spring4.3开始，提供一个注解@RestControllerAdvice，顾名思义，该注解表示针对RestController做切面增强，正好用来做我们需要的全局异常处理切面逻辑。另外还需要一个@ExceptionHandler注解配合用来表示在抛出某个异常时由该注解标注的方法来进行异常处理。
#####以下是demo中的部分代码:

@Order(0)
    @RestControllerAdvice("com.yourcompanyname.yourappname.module")
    public class GlobalExceptionHandler {
        
        private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);
        
        /**
         *针对业务异常的处理
         * @param exception
         * @return
         * @throws Exception
         */
        @ExceptionHandler(BaseException.class)
        public JSONResponse baseExceptionHandle(BaseException exception) throws Exception {
            String retMessage = exception.getRetMessage();
            int retCode = exception.getRetCode();
            LOGGER.error("Code {}, Message {}", retCode, retMessage, exception);
            return getJSONResult(retCode, retMessage);
        }

##### 可以看到定义了一个BaseException类表示业务处理时出现异常，这样所有的业务处理时，如果有需要，只要抛出这个异常即可。另外，这个BaseException是运行期异常，不会要求上层调用方一定要捕获该异常，因为GlobalExceptionHandler已经处理了。
#####除了自定义的业务异常以外，一般还要在GlobalExceptionHandler中处理Exceptino，作为兜底。参见下面代码：
     /**
             * 针对其他未指定特定处理逻辑的异常进行处理
         * @param exception
         * @return
         * @throws Exception
         */
        @ExceptionHandler(Exception.class)
        public JSONResponse exception(Exception exception) throws Exception {
            int retCode = ResultCodeEnum.ERROR_SYSTEM.getCode();
            String retMessage = ResultCodeEnum.ERROR_SYSTEM.getMessage();
            LOGGER.error("Code {}, Message {}", retCode, retMessage, exception);
            return getJSONResult(retCode, retMessage);
        }
		
		
####项目文件结构截图
![项目结构](/contentImages/image/20191119/pqL5Afmk4THNXzdpAFk.png "项目结构")
####本demo可以作为项目脚手架使用，里面已经有controller的例子，分别演示了没有任何异常、抛出业务异常以及抛出除业务异常以外的其他类型异常的例子。你只需要使用IDE（如eclipse）导入maven项目功能导入本例子，然后运行主类DemoApplication后，在浏览器上分别访问http://localhost:8080/someDomain/success，http://localhost:8080/someDomain/business-exception，http://localhost:8080/someDomain/exception
#####将分别看到没有任何异常、抛出业务异常以及抛出除业务异常以外的其他类型异常的效果
#####以下是运行截图:
######无任何异常运行效果
![无任何异常运行效果](/contentImages/image/20191119/ipw5XrM4YHVvgybqAR3.png "无任何异常运行效果")
######抛出业务异常运行效果
![业务异常运行效果](/contentImages/image/20191119/Hj2IjCJJKIkH99InLt6.png "业务异常运行效果")
######抛出其他异常运行效果
![其他异常效果](/contentImages/image/20191119/8XrGyVbe9h2fh1Y0gRp.png "其他异常效果")

####PS:在本地运行例子时，可以使用阿里云提供的maven仓库镜像，从而加快依赖的下载速度，可以参考以下的maven的settings配置文件：
    <?xml version="1.0" encoding="UTF-8"?>
    
    
    
    
    <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
      <localRepository>C:\work\maven_lib</localRepository>
      
      	 
      <pluginGroups>
        
      </pluginGroups>
    
      
      <proxies>
        
      </proxies>
    
      
      <servers>
        
    
        
      </servers>
    
      
    	<mirrors>
            <mirror>
                <id>mirror</id>
                <mirrorOf>!rdc-releases,!rdc-snapshots</mirrorOf>
                <name>mirror</name>
                <url>http://maven.aliyun.com/nexus/content/groups/public</url>
            </mirror>
    
        </mirrors>
    
      
      <profiles>
            <profile>
                <id>nexus</id>
                <repositories>
                    <repository>
                        <id>central</id>
                        <url>http://maven.aliyun.com/nexus/content/groups/public</url>
                        <releases>
                            <enabled>true</enabled>
                        </releases>
                        <snapshots>
                            <enabled>false</enabled>
                        </snapshots>
                    </repository>
                    <repository>
                        <id>snapshots</id>
                        <url>http://maven.aliyun.com/nexus/content/groups/public</url>
                        <releases>
                            <enabled>false</enabled>
                        </releases>
                        <snapshots>
                            <enabled>true</enabled>
                        </snapshots>
                    </repository>
                </repositories>
                <pluginRepositories>
                    <pluginRepository>
                        <id>central</id>
                        <url>http://maven.aliyun.com/nexus/content/groups/public</url>
                        <releases>
                            <enabled>true</enabled>
                        </releases>
                        <snapshots>
                            <enabled>false</enabled>
                        </snapshots>
                    </pluginRepository>
                    <pluginRepository>
                        <id>snapshots</id>
                        <url>http://maven.aliyun.com/nexus/content/groups/public</url>
                        <releases>
                            <enabled>false</enabled>
                        </releases>
                        <snapshots>
                            <enabled>true</enabled>
                        </snapshots>
                    </pluginRepository>
                </pluginRepositories>
            </profile>
    
        </profiles>
    
        <activeProfiles>
            <activeProfile>nexus</activeProfile>
    
        </activeProfiles>
    </settings>

本实例支付的费用只是购买源码的费用，如有疑问欢迎在文末留言交流，如需作者在线代码指导、定制等，在作者开启付费服务后，可以点击“购买服务”进行实时联系，请知悉，谢谢

感谢

手机上随时阅读、收藏该文章？请扫下方二维码

SpringBoot微服务项目最佳实践—异常的全局统一处理

概述

详细

相似例子推荐

评论

作者

评分详细

作者例子