java 规范日志

最新推荐文章于 2025-05-22 15:15:05 发布

oqiuqian

最新推荐文章于 2025-05-22 15:15:05 发布

阅读量924

点赞数

CC 4.0 BY-SA版权

分类专栏： java 代码规范文章标签： java 规范日志

本文链接：https://blog.youkuaiyun.com/oQiuQian/article/details/80944844

java 代码规范专栏收录该内容

6 篇文章

订阅专栏

本文介绍了在软件开发中正确使用日志打印的方法，包括在出现错误时如何返回错误信息、遇到异常情况时如何处理及记录日志，以及如何利用调试级别的日志来辅助问题定位。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

什么时候打印日志

1.检查出错误时，要返回给前端错误信息。

在返回错误信息要打日志。

//参数判断
if (saveAgentInfoParam == null || saveAgentInfoParam.getAgentInfoDTO() == null) {
    log.warn(BaseErrorMsgEnum.ParamError.getMsg());//打印日志
    return new FailResult(BaseErrorMsgEnum.ParamError);
}

2.抓到异常的时候，往上抛异常或者返回错误信息。

在抛异常或者返回错误信息之前要打印日志。

try {
    // 这里将上传得到的文件保存指定目录下
    FileUtils.copyInputStreamToFile(file.getInputStream(),
            new File("E:\\work\\test\\testfile", System.currentTimeMillis() + file.getOriginalFilename()));
} catch (IOException e) {
    log.error("文件存储异常" ,e);
    throw e;
}

3.调试用日志。

比如调用其他接口返回的信息，用于排查问题出在自己代码还是远程服务。一般为debug级别。

日志内容是什么

错误说明+参数（参数引导用户核查错误），只打错误说明往往找不到问题。

if (agentInfoDTOResult.getData() == null) {
    log.warn("代理不存在,参数id="+gentQueryParam.getId());
    return new FailResult(MaidErrorMsgEnum.AgentNotExitError);
}

打印日志注意什么

不要打印出NPE

上面