Java项目构建基础：统一结果，统一异常，统一日志（好文推荐）

本文链接：https://blog.csdn.net/2401_84048467/article/details/138457633

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 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的方法到一个类中；
必须定义一个通用的异常捕获方法，便于捕获未定义的异常信息；
自定一个异常类，捕获针对项目或业务的异常;
异常的对象信息补充到统一结果枚举中；

自定义全局异常类

@Data

public 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;

@ControllerAdvice

public 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”: {}

}

本节介绍统一异常较为简略，详细参考：

https://juejin.im/post/5cbc744a6fb9a0685a3f01a7

统一日志收集

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

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

Logback

关于logback的配置和介绍，可以参考官网或推荐博客glmapper的logback博客，logback-spring.xml配置文件

https://blog.csdn.net/xu_san_duo/article/details/80364600

配置

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

<?xml version="1.0" encoding="UTF-8"?>

logback

debug

${CONSOLE_LOG_PATTERN}

UTF-8

${log.path}/edu_debug.log

%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

UTF-8

${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log

100MB

debug

DENY

${log.path}/edu_info.log

%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

UTF-8

${log.path}/web-info-%d{yyyy-MM-dd}.%i.log

100MB

info

DENY

${log.path}/edu_warn.log

%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

UTF-8

${log.path}/web-warn-%d{yyyy-MM-dd}.%i.log

100MB

warn

DENY

${log.path}/edu_error.log

%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

UTF-8

${log.path}/web-error-%d{yyyy-MM-dd}.%i.log

100MB

ERROR

DENY

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
-->

ERROR

DENY

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

[外链图片转存中…(img-wXkOcSLd-1714856481684)]

[外链图片转存中…(img-vMSCilJi-1714856481685)]

[外链图片转存中…(img-bsIDaBGO-1714856481685)]

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！