• Spring Boot 项目统一结果，统一异常，统一日志，写的太好了

    统一结果返回

    目前的前后端开发大部分数据的传输格式都是json，因此定义一个统一规范的数据格式有利于前后端的交互与UI的展示。

    统一结果的一般形式

    1. 是否响应成功；
    2. 响应状态码；
    3. 状态码描述；
    4. 响应数据
    5. 其他标识符

    结果类枚举

    • 前三者可定义结果枚举，如：success，code，message
    1. @Getter
    2. public enum ResultCodeEnum {
    3.     SUCCESS(true,20000,"成功"),
    4.     UNKNOWN_ERROR(false,20001,"未知错误"),,
    5.     PARAM_ERROR(false,20002,"参数错误"),
    6.     ;
    7.  
    8.     // 响应是否成功
    9.     private Boolean success;
    10.     // 响应状态码
    11.     private Integer code;
    12.     // 响应信息
    13.     private String message;
    14.  
    15.     ResultCodeEnum(boolean success, Integer code, String message) {
    16.         this.success = success;
    17.         this.code = code;
    18.         this.message = message;
    19.     }
    20. }

    统一结果类

    • 第5个属于自定义返回，利用前4者可定义统一返回对象

    注意：

    1. 外接只可以调用统一返回类的方法，不可以直接创建，影刺构造器私有；
    2. 内置静态方法，返回对象；
    3. 为便于自定义统一结果的信息，建议使用链式编程，将返回对象设类本身，即return this;
    4. 响应数据由于为json格式，可定义为JsonObject或Map形式；
    1. @Data
    2. public class R {
    3.     private Boolean success;
    4.  
    5.     private Integer code;
    6.  
    7.     private String message;
    8.  
    9.     private Map<String, Object> data = new HashMap<>();
    10.  
    11.     // 构造器私有
    12.     private R(){}
    13.  
    14.     // 通用返回成功
    15.     public static R ok() {
    16.         R r = new R();
    17.         r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
    18.         r.setCode(ResultCodeEnum.SUCCESS.getCode());
    19.         r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
    20.         return r;
    21.     }
    22.  
    23.     // 通用返回失败，未知错误
    24.     public static R error() {
    25.         R r = new R();
    26.         r.setSuccess(ResultCodeEnum.UNKNOWN_ERROR.getSuccess());
    27.         r.setCode(ResultCodeEnum.UNKNOWN_ERROR.getCode());
    28.         r.setMessage(ResultCodeEnum.UNKNOWN_ERROR.getMessage());
    29.         return r;
    30.     }
    31.  
    32.     // 设置结果，形参为结果枚举
    33.     public static R setResult(ResultCodeEnum result) {
    34.         R r = new R();
    35.         r.setSuccess(result.getSuccess());
    36.         r.setCode(result.getCode());
    37.         r.setMessage(result.getMessage());
    38.         return r;
    39.     }
    40.  
    41.     /**------------使用链式编程，返回类本身-----------**/
    42.     
    43.     // 自定义返回数据
    44.     public R data(Map<String,Object> map) {
    45.         this.setData(map);
    46.         return this;
    47.     }
    48.  
    49.     // 通用设置data
    50.     public R data(String key,Object value) {
    51.         this.data.put(key, value);
    52.         return this;
    53.     }
    54.  
    55.     // 自定义状态信息
    56.     public R message(String message) {
    57.         this.setMessage(message);
    58.         return this;
    59.     }
    60.  
    61.     // 自定义状态码
    62.     public R code(Integer code) {
    63.         this.setCode(code);
    64.         return this;
    65.     }
    66.  
    67.     // 自定义返回结果
    68.     public R success(Boolean success) {
    69.         this.setSuccess(success);
    70.         return this;
    71.     }
    72. }

    控制层返回

    • 视图层使用统一结果
    1. @RestController
    2. @RequestMapping("/api/v1/users")
    3. public class TeacherAdminController {
    4.  
    5.     @Autowired
    6.     private UserService userService;
    7.  
    8.     @GetMapping
    9.     public R list() {
    10.         List<Teacher> list = teacherService.list(null);
    11.         return R.ok().data("itms", list).message("用户列表");
    12.     }
    13. }
    • json结果
    1. {
    2.   "success": true,
    3.   "code": 20000,
    4.   "message": "查询用户列表",
    5.   "data": {
    6.     "itms": [
    7.       {
    8.         "id": "1",
    9.         "username": "admin",
    10.         "role": "ADMIN",
    11.         "deleted": false,
    12.         "gmtCreate": "2019-12-26T15:32:29",
    13.         "gmtModified": "2019-12-26T15:41:40"
    14.       },{
    15.         "id": "2",
    16.         "username": "zhangsan",
    17.         "role": "USER",
    18.         "deleted": false,
    19.         "gmtCreate": "2019-12-26T15:32:29",
    20.         "gmtModified": "2019-12-26T15:41:40"
    21.       }
    22.     ]
    23.   }
    24. }

    统一结果类的使用参考了mybatis-plus中R对象的设计。

    统一异常处理

    使用统一返回结果时，还有一种情况，就是程序的保存是由于运行时异常导致的结果，有些异常我们可以无法提前预知，不能正常走到我们return的R对象返回。

    因此，我们需要定义一个统一的全局异常来捕获这些信息，并作为一种结果返回控制层

    @ControllerAdvice

    该注解为统一异常处理的核心

    是一种作用于控制层的切面通知（Advice），该注解能够将通用的@ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一个类型，并应用到所有控制器上

    该类中的设计思路：

    1. 使用@ExceptionHandler注解捕获指定或自定义的异常；
    2. 使用@ControllerAdvice集成@ExceptionHandler的方法到一个类中；
    3. 必须定义一个通用的异常捕获方法，便于捕获未定义的异常信息；
    4. 自定一个异常类，捕获针对项目或业务的异常;
    5. 异常的对象信息补充到统一结果枚举中；

    自定义全局异常类

    1. @Data
    2. public class CMSException extends RuntimeException {
    3.     private Integer code;
    4.  
    5.     public CMSException(Integer code, String message) {
    6.         super(message);
    7.         this.code = code;
    8.     }
    9.  
    10.     public CMSException(ResultCodeEnum resultCodeEnum) {
    11.         super(resultCodeEnum.getMessage());
    12.         this.code = resultCodeEnum.getCode();
    13.     }
    14.  
    15.     @Override
    16.     public String toString() {
    17.         return "CMSException{" + "code=" + code + ", message=" + this.getMessage() + '}';
    18.     }
    19. }

    统一异常处理器

    1. // ...
    2. import org.springframework.web.bind.annotation.ControllerAdvice;
    3. import org.springframework.web.bind.annotation.ExceptionHandler;
    4. import org.springframework.web.bind.annotation.ResponseBody;
    5.  
    6. @ControllerAdvice
    7. public class GlobalExceptionHandler {
    8.  
    9.     /**-------- 通用异常处理方法 --------**/
    10.     @ExceptionHandler(Exception.class)
    11.     @ResponseBody
    12.     public R error(Exception e) {
    13.         e.printStackTrace();
    14.         return R.error(); // 通用异常结果
    15.     }
    16.  
    17.     /**-------- 指定异常处理方法 --------**/
    18.     @ExceptionHandler(NullPointerException.class)
    19.     @ResponseBody
    20.     public R error(NullPointerException e) {
    21.         e.printStackTrace();
    22.         return R.setResult(ResultCodeEnum.NULL_POINT);
    23.     }
    24.  
    25.     @ExceptionHandler(HttpClientErrorException.class)
    26.     @ResponseBody
    27.     public R error(IndexOutOfBoundsException e) {
    28.         e.printStackTrace();
    29.         return R.setResult(ResultCodeEnum.HTTP_CLIENT_ERROR);
    30.     }
    31.     
    32.     /**-------- 自定义定异常处理方法 --------**/
    33.     @ExceptionHandler(CMSException.class)
    34.     @ResponseBody
    35.     public R error(CMSException e) {
    36.         e.printStackTrace();
    37.         return R.error().message(e.getMessage()).code(e.getCode());
    38.     }
    39. }

    控制层展示

    以下为展示当遇到null指定异常时，返回的结果信息

    1. {
    2.   "success": false,
    3.   "code": 20007,
    4.   "message": "空指针异常",
    5.   "data": {}
    6. }

    统一日志收集

    日志是追踪错误定位问题的关键，尤其在生产环境中，需要及时修复热部署，不会提供开发者debug的环境，此时日志将会是最快解决问题的关键

    日志的框架比较丰富，由于spring boot对logback的集成，因此推荐使用logback在项目中使用。

    Logback

    配置

    以下直接贴出配置信息，介绍信息科直接参考备注

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
    3. <!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true -->
    4. <!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。
    5.                  当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
    6. <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
    7. <configuration  scan="true" scanPeriod="10 seconds">
    8.     <contextName>logback</contextName>
    9.  
    10.     <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->
    11.     <property name="log.path" value="D:/Documents/logs/edu" />
    12.  
    13.     <!--0. 日志格式和颜色渲染 -->
    14.     <!-- 彩色日志依赖的渲染类 -->
    15.     <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    16.     <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    17.     <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    18.     <!-- 彩色日志格式 -->
    19.     <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    20.  
    21.     <!--1. 输出到控制台-->
    22.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    23.         <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
    24.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    25.             <level>debug</level>
    26.         </filter>
    27.         <encoder>
    28.             <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
    29.             <!-- 设置字符集 -->
    30.             <charset>UTF-8</charset>
    31.         </encoder>
    32.     </appender>
    33.  
    34.     <!--2. 输出到文档-->
    35.     <!-- 2.1 level为 DEBUG 日志，时间滚动输出  -->
    36.     <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    37.         <!-- 正在记录的日志文档的路径及文档名 -->
    38.         <file>${log.path}/edu_debug.log</file>
    39.         <!--日志文档输出格式-->
    40.         <encoder>
    41.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
    42.             <charset>UTF-8</charset> <!-- 设置字符集 -->
    43.         </encoder>
    44.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
    45.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    46.             <!-- 日志归档 -->
    47.             <fileNamePattern>${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
    48.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    49.                 <maxFileSize>100MB</maxFileSize>
    50.             </timeBasedFileNamingAndTriggeringPolicy>
    51.             <!--日志文档保留天数-->
    52.             <maxHistory>15</maxHistory>
    53.         </rollingPolicy>
    54.         <!-- 此日志文档只记录debug级别的 -->
    55.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
    56.             <level>debug</level>
    57.             <onMatch>ACCEPT</onMatch>
    58.             <onMismatch>DENY</onMismatch>
    59.         </filter>
    60.     </appender>
    61.  
    62.     <!-- 2.2 level为 INFO 日志，时间滚动输出  -->
    63.     <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    64.         <!-- 正在记录的日志文档的路径及文档名 -->
    65.         <file>${log.path}/edu_info.log</file>
    66.         <!--日志文档输出格式-->
    67.         <encoder>
    68.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
    69.             <charset>UTF-8</charset>
    70.         </encoder>
    71.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
    72.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    73.             <!-- 每天日志归档路径以及格式 -->
    74.             <fileNamePattern>${log.path}/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
    75.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    76.                 <maxFileSize>100MB</maxFileSize>
    77.             </timeBasedFileNamingAndTriggeringPolicy>
    78.             <!--日志文档保留天数-->
    79.             <maxHistory>15</maxHistory>
    80.         </rollingPolicy>
    81.         <!-- 此日志文档只记录info级别的 -->
    82.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
    83.             <level>info</level>
    84.             <onMatch>ACCEPT</onMatch>
    85.             <onMismatch>DENY</onMismatch>
    86.         </filter>
    87.     </appender>
    88.  
    89.     <!-- 2.3 level为 WARN 日志，时间滚动输出  -->
    90.     <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    91.         <!-- 正在记录的日志文档的路径及文档名 -->
    92.         <file>${log.path}/edu_warn.log</file>
    93.         <!--日志文档输出格式-->
    94.         <encoder>
    95.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
    96.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
    97.         </encoder>
    98.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
    99.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    100.             <fileNamePattern>${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
    101.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    102.                 <maxFileSize>100MB</maxFileSize>
    103.             </timeBasedFileNamingAndTriggeringPolicy>
    104.             <!--日志文档保留天数-->
    105.             <maxHistory>15</maxHistory>
    106.         </rollingPolicy>
    107.         <!-- 此日志文档只记录warn级别的 -->
    108.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
    109.             <level>warn</level>
    110.             <onMatch>ACCEPT</onMatch>
    111.             <onMismatch>DENY</onMismatch>
    112.         </filter>
    113.     </appender>
    114.  
    115.     <!-- 2.4 level为 ERROR 日志，时间滚动输出  -->
    116.     <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    117.         <!-- 正在记录的日志文档的路径及文档名 -->
    118.         <file>${log.path}/edu_error.log</file>
    119.         <!--日志文档输出格式-->
    120.         <encoder>
    121.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
    122.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
    123.         </encoder>
    124.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
    125.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    126.             <fileNamePattern>${log.path}/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
    127.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    128.                 <maxFileSize>100MB</maxFileSize>
    129.             </timeBasedFileNamingAndTriggeringPolicy>
    130.             <!--日志文档保留天数-->
    131.             <maxHistory>15</maxHistory>
    132.         </rollingPolicy>
    133.         <!-- 此日志文档只记录ERROR级别的 -->
    134.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
    135.             <level>ERROR</level>
    136.             <onMatch>ACCEPT</onMatch>
    137.             <onMismatch>DENY</onMismatch>
    138.         </filter>
    139.     </appender>
    140.  
    141.     <!--
    142.         <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
    143.         以及指定<appender>。<logger>仅有一个name属性，
    144.         一个可选的level和一个可选的addtivity属性。
    145.         name:用来指定受此logger约束的某一个包或者具体的某一个类。
    146.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
    147.               还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
    148.               如果未设置此属性，那么当前logger将会继承上级的级别。
    149.         addtivity:是否向上级logger传递打印信息。默认是true。
    150.         <logger name="org.springframework.web" level="info"/>
    151.         <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
    152.     -->
    153.  
    154.     <!--
    155.         使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
    156.         第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
    157.         第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：
    158.         【logging.level.org.mybatis=debug logging.level.dao=debug】
    159.      -->
    160.  
    161.     <!--
    162.         root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
    163.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
    164.         不能设置为INHERITED或者同义词NULL。默认是DEBUG
    165.         可以包含零个或多个元素，标识这个appender将会添加到这个logger。
    166.     -->
    167.  
    168.     <!-- 4. 最终的策略 -->
    169.     <!-- 4.1 开发环境:打印控制台-->
    170.     <springProfile name="dev">
    171.         <logger name="com.cms" level="info"/>
    172.         <root level="info">
    173.             <appender-ref ref="CONSOLE" />
    174.             <appender-ref ref="DEBUG_FILE" />
    175.             <appender-ref ref="INFO_FILE" />
    176.             <appender-ref ref="WARN_FILE" />
    177.             <appender-ref ref="ERROR_FILE" />
    178.         </root>
    179.     </springProfile>
    180.  
    181.  
    182.     <!-- 4.2 生产环境:输出到文档-->
    183.     <springProfile name="pro">
    184.         <logger name="com.cms" level="warn"/>
    185.         <root level="info">
    186.             <appender-ref ref="ERROR_FILE" />
    187.             <appender-ref ref="WARN_FILE" />
    188.         </root>
    189.     </springProfile>
    190.  
    191. </configuration>

    日志收集异常信息

    日志信息往往伴随着异常信息的输出，因此，我们需要修改统一异常的处理器，将异常信息以流的方式写到日志文件中

    • 异常信息文件工具类
    1. @Slf4j
    2. public class ExceptionUtil {
    3.  
    4.     /**
    5.      * 打印异常信息
    6.      */
    7.     public static String getMessage(Exception e) {
    8.         String swStr = null;
    9.         try (StringWriter sw = new StringWriter(); PrintWriter pw = new PrintWriter(sw)) {
    10.             e.printStackTrace(pw);
    11.             pw.flush();
    12.             sw.flush();
    13.             swStr = sw.toString();
    14.         } catch (IOException ex) {
    15.             ex.printStackTrace();
    16.             log.error(ex.getMessage());
    17.         }
    18.         return swStr;
    19.     }
    20. }
    • 修改统一异常处理器，将异常方法中的直接打印改为日志输入并打印
    1. // ...
    2. import lombok.extern.slf4j.Slf4j;
    3.  
    4. @ControllerAdvice
    5. @Slf4j
    6. public class GlobalExceptionHandler {
    7.  
    8.     /**-------- 通用异常处理方法 --------**/
    9.     @ExceptionHandler(Exception.class)
    10.     @ResponseBody
    11.     public R error(Exception e) {
    12.         // e.printStackTrace();
    13.         log.error(ExceptionUtil.getMessage(e));
    14.         return R.error();
    15.     }
    16.     
    17.    // ...
    18. }

    注意

    1. 日志的环境即spring.profiles.acticve，跟随项目启动；
    2. 启动后，即可到自定目录查找到生成的日志文件；
    3. 本地idea调试时，推荐Grep Console插件可实现控制台的自定义颜色输出

     

     

  • 相关阅读:
    WSL下安装ubuntu 18.04 +meep进行FDTD仿真计算
    Vue脚手架创建TS项目
    【2023研电赛】兆易创新命题三等奖： 低成本单母线电流永磁同步无感驱动器
    BluePrism里WorkQueue的几种传法和区别
    代码随想录打卡—day59—【单调栈】— 9.5 单调栈2
    Atom CMS SQL注入漏洞 （CVE-2022-25488）
    java数据结构与算法刷题-----LeetCode572. 另一棵树的子树（经典题，树字符串化KMP）
    ulink仿真器固件降级适配老版本方法
    MyBatis-plus 从入门到入土
    JSON和全局异常处理
  • 原文地址：https://blog.csdn.net/m0_71777195/article/details/125520995