spring-boot | 日志

嘿,好久不见,你还好吗?

我一般都是为大家带来项目上比较实用的东西,这次我们来试试项目开发中对日志的处理,希望对你有所帮助。

理论知识

1、为什么要用日志?

你是否因为项目出现问题,查找日志文件定位错误花费N多时间,为此苦不堪言?

2、Spring Boot 默认集成Logback。日志输出内容元素具体如下:

  • 时间日期:精确到毫秒
  • 日志级别:ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID
  • 分隔符:— 标识实际日志的开始
  • 线程名:方括号括起来(可能会截断控制台输出)
  • Logger名:通常使用源代码的类名
  • 日志内容

3、日志级别从低到高分为:

TRACE < DEBUG < INFO < WARN < ERROR < FATAL

4、根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:

Logback:logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j:log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2:log4j2-spring.xml, log4j2.xml
JDK (Java Util Logging):logging.properties

Spring Boot官方推荐优先使用带有 -spring 的文件名作为你的日志配置(如使用 logback-spring.xml ,而不是logback.xml),
命名为logback-spring.xml的日志配置文件,spring boot可以为它添加一些spring boot特有的配置项。

理论知识很重要!!!
虽说实践出真知,但是没有理论做支持,实践只能是盲目的瞎摸,所以,在学好理论的前提下,结合实践,就能更好的为我们服务。

以前在写项目的时候,用的是Log4j,那时候就感觉他很强大,日志滚动啊,日志保存期限啊,设置最大存储量,异常发送邮件,等等功能。
总之,log很强大,他能帮助我们解决很多很多的问题。

实际开发

日志功能如此强大,那我们怎么在项目中如何配置,又该如何使用呢?

先申明:
我这里是用Spring Boot搭建的项目,版本是2.x,
有可能你用的是Struts2+Spring+SpringMVC,等等之类的框架搭建。
我想说的是,推荐使用Spring Boot,你也可以将你的SS*项目改成Spring Boot。
如果你有好的建议也可以push给我,我们一起交流,学习。

1、我们先看项目目录:

项目目录

2、在 application.yml中需要这样配置以下内容:

spring:
  profiles:
    active: dev
logback:
  appName: examplelog
  fileType: out

3、在 -dev.yml, -test.yml, -prod.yml 中需要添加以下配置:

logback:
  logDir: log/dev

logging:
  level:
    com.fengwenyi.log: debug
    com.fengwenyi.log.service: error

4、我们来看一下 logback-spring.xml 写法:

请参见源码

5、他有什么功能呢?

  • 日志可以输出到指定文件
  • 日志可以按运行环境进行输出
  • 日志可以按日期进行输出
  • 不同包可以指定不同的输出级别

下面我们详细说明一下:

程序运行环境

他会根据你的配置生成对应的目录,来存放相应的日志文档,方便我们查询。比如,开发时,我们看dev,测试人员看test,上线运行,运维人员看 prod,这样的好处是,我们不仅可以方便查询错误定位,也可以设置不同的输出级别。像酱紫

日志样式

是不是很清晰?
另外,他外按日期,每天一个文档,是不是很贴心?
保存多久由你定。
是不是快要感动哭了?
那就 star 一下吧,谢谢咯。

API

还是简单说一下配置问题吧:

第一步,你要将 logback-spring.xml,放到跟我相同的目录,内容,可以复制过去,也可以适当修改。

第二步,application.yml

logback:
  appName: examplelog # 日志文件前缀
  fileType: out # 日志后缀名

第三步,application-dev.yml,-test.yml,-prod.yml

logback:
  logDir: log/dev # 日志目录

logging:
  level:
    # 日志级别配置,格式:(包名: 级别)
    com.fengwenyi.log: debug 
    com.fengwenyi.log.service: error

参考文档

[1] SpringBoot进阶教程 | 第二篇:日志组件logback实现日志分级打印

[2] Spring Boot 日志配置(超详细)

[3] 本节源码

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容