作者：永动的图灵机\
链接：https://juejin.cn/post/684490...
对立后果返回
目前的前后端开发大部分数据的传输格局都是json，因而定义一个对立标准的数据格式有利于前后端的交互与UI的展现。
对立后果的个别模式
- 是否响应胜利；
- 响应状态码；
- 状态码形容；
- 响应数据
- 其余标识符
后果类枚举
- 前三者可定义后果枚举，如：success，code，message
@Getterpublic enum ResultCodeEnum { SUCCESS(true,20000,"胜利"), UNKNOWN_ERROR(false,20001,"未知谬误"),, PARAM_ERROR(false,20002,"参数谬误"), ; // 响应是否胜利 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; }}对立后果类
- 第5个属于自定义返回，利用前4者可定义对立返回对象
留神：
- 外接只能够调用对立返回类的办法，不能够间接创立，影刺结构器公有；
- 内置静态方法，返回对象；
- 为便于自定义对立后果的信息，倡议应用链式编程，将返回对象设类自身，即return this;
- 响应数据因为为json格局，可定义为JsonObject或Map模式；
@Datapublic class R { private Boolean success; private Integer code; private String message; private Map<String, Object> data = new HashMap<>(); // 结构器公有 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_ERROR.getSuccess()); r.setCode(ResultCodeEnum.UNKNOWN_ERROR.getCode()); r.setMessage(ResultCodeEnum.UNKNOWN_ERROR.getMessage()); return r; } // 设置后果，形参为后果枚举 public static R setResult(ResultCodeEnum result) { R r = new R(); r.setSuccess(result.getSuccess()); r.setCode(result.getCode()); r.setMessage(result.getMessage()); return r; } /**------------应用链式编程，返回类自身-----------**/ // 自定义返回数据 public R data(Map<String,Object> map) { this.setData(map); return this; } // 通用设置data 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; }}管制层返回
- 视图层应用对立后果
@RestController@RequestMapping("/api/v1/users")public class TeacherAdminController { @Autowired private UserService userService; @GetMapping public R list() { List<Teacher> list = teacherService.list(null); return R.ok().data("itms", list).message("用户列表"); }} - json后果
{ "success": true, "code": 20000, "message": "查问用户列表", "data": { "itms": [ { "id": "1", "username": "admin", "role": "ADMIN", "deleted": false, "gmtCreate": "2019-12-26T15:32:29", "gmtModified": "2019-12-26T15:41:40" },{ "id": "2", "username": "zhangsan", "role": "USER", "deleted": false, "gmtCreate": "2019-12-26T15:32:29", "gmtModified": "2019-12-26T15:41:40" } ] }}对立后果类的应用参考了mybatis-plus中R对象的设计
对立异样解决
应用对立返回后果时，还有一种状况，就是程序的保留是因为运行时异样导致的后果，有些异样咱们能够无奈提前预知，不能失常走到咱们return的R对象返回。
因而，咱们须要定义一个对立的全局异样来捕捉这些信息，并作为一种后果返回管制层
@ControllerAdvice
该注解为对立异样解决的外围
是一种作用于管制层的切面告诉（Advice），该注解可能将通用的@ExceptionHandler、@InitBinder和@ModelAttributes办法收集到一个类型，并利用到所有控制器上
该类中的设计思路：
- 应用@ExceptionHandler注解捕捉指定或自定义的异样；
- 应用@ControllerAdvice集成@ExceptionHandler的办法到一个类中；
- 必须定义一个通用的异样捕捉办法，便于捕捉未定义的异样信息；
- 自定一个异样类，捕捉针对我的项目或业务的异样;
- 异样的对象信息补充到对立后果枚举中；
自定义全局异样类
@Datapublic class CMSException extends RuntimeException { private Integer code; public CMSException(Integer code, String message) { super(message); this.code = code; } public CMSException(ResultCodeEnum resultCodeEnum) { super(resultCodeEnum.getMessage()); this.code = resultCodeEnum.getCode(); } @Override public String toString() { return "CMSException{" + "code=" + code + ", message=" + this.getMessage() + '}'; }}对立异样处理器
// ...import org.springframework.web.bind.annotation.ControllerAdvice;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.ResponseBody;@ControllerAdvicepublic class GlobalExceptionHandler { /**-------- 通用异样解决办法 --------**/ @ExceptionHandler(Exception.class) @ResponseBody public R error(Exception e) { e.printStackTrace(); return R.error(); // 通用异样后果 } /**-------- 指定异样解决办法 --------**/ @ExceptionHandler(NullPointerException.class) @ResponseBody public R error(NullPointerException e) { e.printStackTrace(); return R.setResult(ResultCodeEnum.NULL_POINT); } @ExceptionHandler(HttpClientErrorException.class) @ResponseBody public R error(IndexOutOfBoundsException e) { e.printStackTrace(); return R.setResult(ResultCodeEnum.HTTP_CLIENT_ERROR); } /**-------- 自定义定异样解决办法 --------**/ @ExceptionHandler(CMSException.class) @ResponseBody public R error(CMSException e) { e.printStackTrace(); return R.error().message(e.getMessage()).code(e.getCode()); }}管制层展现
以下为展现当遇到null指定异样时，返回的后果信息
{ "success": false, "code": 20007, "message": "空指针异样", "data": {}}对立日志收集
日志是追踪谬误定位问题的要害，尤其在生产环境中，须要及时修复热部署，不会提供开发者debug的环境，此时日志将会是最快解决问题的要害
日志的框架比拟丰盛，因为spring boot对logback的集成，因而举荐应用logback在我的项目中应用。
Spring Boot 根底就不介绍了，举荐下这个实战教程：
https://github.com/javastacks...
Logback
配置
以下间接贴出配置信息，介绍信息科间接参考备注
<?xml version="1.0" encoding="UTF-8"?><!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输入 --><!-- scan:当此属性设置为true时，配置文档如果产生扭转，将会被从新加载，默认值为true --><!-- scanPeriod:设置监测配置文档是否有批改的工夫距离，如果没有给出工夫单位，默认单位是毫秒。 当scan为true时，此属性失效。默认的工夫距离为1分钟。 --><!-- debug:当此属性设置为true时，将打印出logback外部日志信息，实时查看logback运行状态。默认值为false。 --><configuration scan="true" scanPeriod="10 seconds"> <contextName>logback</contextName> <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，能够使“${}”来应用变量。 --> <property name="log.path" value="D:/Documents/logs/edu" /> <!--0. 日志格局和色彩渲染 --> <!-- 黑白日志依赖的渲染类 --> <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" /> <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" /> <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" /> <!-- 黑白日志格局 --> <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}}"/> <!--1. 输入到控制台--> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <!--此日志appender是为开发应用，只配置最底级别，控制台输入的日志级别是大于或等于此级别的日志信息--> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>debug</level> </filter> <encoder> <Pattern>${CONSOLE_LOG_PATTERN}</Pattern> <!-- 设置字符集 --> <charset>UTF-8</charset> </encoder> </appender> <!--2. 输入到文档--> <!-- 2.1 level为 DEBUG 日志，工夫滚动输入 --> <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在记录的日志文档的门路及文档名 --> <file>${log.path}/edu_debug.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}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>100MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文档保留天数--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文档只记录debug级别的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>debug</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 2.2 level为 INFO 日志，工夫滚动输入 --> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在记录的日志文档的门路及文档名 --> <file>${log.path}/edu_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}/web-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> <!-- 2.3 level为 WARN 日志，工夫滚动输入 --> <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在记录的日志文档的门路及文档名 --> <file>${log.path}/edu_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}/web-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> <!-- 2.4 level为 ERROR 日志，工夫滚动输入 --> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!-- 正在记录的日志文档的门路及文档名 --> <file>${log.path}/edu_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}/web-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， 还有一个特俗值INHERITED或者同义词NULL，代表强制执行下级的级别。 如果未设置此属性，那么以后logger将会继承下级的级别。 addtivity:是否向下级logger传递打印信息。默认是true。 <logger name="org.springframework.web" level="info"/> <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/> --> <!-- 应用mybatis的时候，sql语句是debug下才会打印，而这里咱们只配置了info，所以想要查看sql语句的话，有以下两种操作： 第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会呈现很多其余音讯 第二种就是独自给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其余还是失常info级别： 【logging.level.org.mybatis=debug logging.level.dao=debug】 --> <!-- root节点是必选节点，用来指定最根底的日志输入级别，只有一个level属性 level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF， 不能设置为INHERITED或者同义词NULL。默认是DEBUG 能够蕴含零个或多个元素，标识这个appender将会增加到这个logger。 --> <!-- 4. 最终的策略 --> <!-- 4.1 开发环境:打印控制台--> <springProfile name="dev"> <logger name="com.cms" level="info"/> <root level="info"> <appender-ref ref="CONSOLE" /> <appender-ref ref="DEBUG_FILE" /> <appender-ref ref="INFO_FILE" /> <appender-ref ref="WARN_FILE" /> <appender-ref ref="ERROR_FILE" /> </root> </springProfile> <!-- 4.2 生产环境:输入到文档--> <springProfile name="pro"> <logger name="com.cms" level="warn"/> <root level="info"> <appender-ref ref="ERROR_FILE" /> <appender-ref ref="WARN_FILE" /> </root> </springProfile></configuration>日志收集异样信息
日志信息往往随同着异样信息的输入，因而，咱们须要批改对立异样的处理器，将异样信息以流的形式写到日志文件中
- 异样信息文件工具类
@Slf4jpublic class ExceptionUtil { /** * 打印异样信息 */ public static String getMessage(Exception e) { String swStr = null; try (StringWriter sw = new StringWriter(); PrintWriter pw = new PrintWriter(sw)) { e.printStackTrace(pw); pw.flush(); sw.flush(); swStr = sw.toString(); } catch (IOException ex) { ex.printStackTrace(); log.error(ex.getMessage()); } return swStr; }}- 批改对立异样处理器，将异样办法中的间接打印改为日志输出并打印
// ...import lombok.extern.slf4j.Slf4j;@ControllerAdvice@Slf4jpublic class GlobalExceptionHandler { /**-------- 通用异样解决办法 --------**/ @ExceptionHandler(Exception.class) @ResponseBody public R error(Exception e) { // e.printStackTrace(); log.error(ExceptionUtil.getMessage(e)); return R.error(); } // ...} 留神
- 日志的环境即spring.profiles.acticve，追随我的项目启动；
- 启动后，即可到自定目录查找到生成的日志文件；
- 本地idea调试时，举荐Grep Console插件可实现控制台的自定义色彩输入
近期热文举荐：
1.1,000+ 道 Java面试题及答案整顿(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！
5.《Java开发手册（嵩山版）》最新公布，速速下载！
感觉不错，别忘了顺手点赞+转发哦！