Java项目构建基础：统一结果，统一异常，统一日志
作者:IT科技 来源:域名 浏览: 【大中小】 发布时间:2025-11-04 00:25:49 评论数:
在开发过程中，项目为了提升开发效率，构建果统提升代码规范，基础我们会将返回结果，统结统日异常以及日志进行统一封装处理，异常接下来我们一起来看看如何实现。项目
统一结果返回
目前的构建果统前后端开发大部分数据的传输格式都是json，因此定义一个统一规范的基础数据格式有利于前后端的交互与UI的展示。
1. 统一结果的统结统日一般形式是否响应成功；响应状态码；状态码描述；响应数据；其他标识符。2. 结果类枚举前三者可定义结果枚举，异常如：success，项目code，构建果统message
@Getter
public 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;
}
}
3. 统一结果类第5个属于自定义返回，利用前4者可定义统一返回对象。统结统日
注意：
外接只可以调用统一返回类的异常方法，不可以直接创建，影刺构造器私有；内置静态方法，返回对象；为便于自定义统一结果的信息，建议使用链式编程，将返回对象设类本身，即return this；响应数据由于为json格式，可定义为JsonObject或Map形式；@Data
public class R {
private Boolean success;
private Integer code;
private String message;
private Map
// 构造器私有
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;
}
// 设置结果，IT技术网形参为结果枚举
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
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;
}
}
4. 控制层返回视图层使用统一结果：
@RestController
@RequestMapping("/api/v1/users")
public class TeacherAdminController {
@Autowired
private UserService userService;
@GetMapping
public R list() {
List
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对象返回。
因此，我们需要定义一个统一的全局异常来捕获这些信息，并作为一种结果返回控制层。
1. @ControllerAdvice该注解为统一异常处理的核心：
是一种作用于控制层的切面通知(Advice)，该注解能够将通用的@ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一个类型，并应用到所有控制器上。
该类中的设计思路：
使用@ExceptionHandler注解捕获指定或自定义的异常；使用@ControllerAdvice集成@ExceptionHandler的方法到一个类中；必须定义一个通用的异常捕获方法，便于捕获未定义的异常信息；自定一个异常类，站群服务器捕获针对项目或业务的异常；异常的对象信息补充到统一结果枚举中；2. 自定义全局异常类@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() +};
}
}
3. 统一异常处理器// ...
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());
}
}
4. 控制层展示以下为展示当遇到null指定异常时，返回的结果信息：
{
"success": false,
"code": 20007,
"message": "空指针异常",
"data": {}
}
统一日志收集
日志是追踪错误定位问题的关键，尤其在生产环境中，需要及时修复热部署，不会提供开发者debug的环境，此时日志将会是最快解决问题的关键
日志的框架比较丰富，由于spring boot对logback的集成，因此推荐使用logback在项目中使用。
1. Logback关于logback的配置和介绍，可以参考官网。
2. 配置以下直接贴出配置信息，介绍信息科直接参考备注：
当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
以及指定。
一个可选的level和一个可选的服务器托管addtivity属性。
name:用来指定受此logger约束的某一个包或者具体的某一个类。
level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
如果未设置此属性，那么当前logger将会继承上级的级别。
addtivity:是否向上级logger传递打印信息。默认是true。
-->
使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看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。
-->
3. 日志收集异常信息日志信息往往伴随着异常信息的输出，因此，我们需要修改统一异常的处理器，将异常信息以流的方式写到日志文件中。
异常信息文件工具类：
@Slf4j
public 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
@Slf4j
public 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插件可实现控制台的自定义颜色输出