转:spring boot log4j2配置(使用log4j2.yml文件)---YAML 语言教程

时间:2022-07-25 21:48:59

转:spring boot log4j2配置(使用log4j2.yml文件) - CSDN博客
http://blog.csdn.net/ClementAD/article/details/51498864

YAML 语言教程 - 阮一峰的网络日志
http://www.ruanyifeng.com/blog/2016/07/yaml.html

yml转javaScript 在线工具:YAML parser for JavaScript - JS-YAML    http://nodeca.github.io/js-yaml/#yaml=LS

============

在spring boot中,配置log4j2的几个步骤(使用yml文件):

 

1、pom文件的依赖配置中,去掉spring boot默认的log配置,引入log4j2依赖包:

  1. <!-- log related -->  
  2.     <dependency> <!-- exclude掉spring-boot的默认log配置 -->  
  3.         <groupId>org.springframework.boot</groupId>  
  4.         <artifactId>spring-boot-starter</artifactId>  
  5.         <exclusions>  
  6.             <exclusion>  
  7.                 <groupId>org.springframework.boot</groupId>  
  8.                 <artifactId>spring-boot-starter-logging</artifactId>  
  9.             </exclusion>  
  10.         </exclusions>  
  11.     </dependency>  
  12.     <dependency> <!-- 引入log4j2依赖 -->  
  13.         <groupId>org.springframework.boot</groupId>  
  14.         <artifactId>spring-boot-starter-log4j2</artifactId>  
  15.     </dependency>  
  16.     <dependency>  <!-- 加上这个才能辨认到log4j2.yml文件 -->  
  17.         <groupId>com.fasterxml.jackson.dataformat</groupId>  
  18.         <artifactId>jackson-dataformat-yaml</artifactId>  
  19.     </dependency>  
  20. <!-- end of log related -->     
	

2、log4j2.yml文件配置(放置在resources文件夹中):

 

 

  1. Configuration:  
  2.   status: warn  
  3.   
  4.   Properties: # 定义全局变量  
  5.     Property: # 缺省配置(用于开发环境)。其他环境需要在VM参数中指定,如下:  
  6.       #测试:-Dlog.level.console=warn -Dlog.level.xjj=trace  
  7.       #生产:-Dlog.level.console=warn -Dlog.level.xjj=info        
  8.       - name: log.level.console  
  9.         value: trace  
  10.       - name: log.level.xjj  
  11.         value: trace         
  12.       - name: log.path  
  13.         value: /opt/logs  
  14.       - name: project.name  
  15.         value: my-spring-boot  
  16.     
  17.   Appenders:  
  18.     Console:  #输出到控制台  
  19.       name: CONSOLE  
  20.       target: SYSTEM_OUT  
  21.       ThresholdFilter:  
  22.         level: ${sys:log.level.console} # “sys:”表示:如果VM参数中没指定这个变量值,则使用本文件中定义的缺省全局变量值  
  23.         onMatch: ACCEPT  
  24.         onMismatch: DENY  
  25.       PatternLayout:  
  26.         pattern: "%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"  
  27.     RollingFile: # 输出到文件,超过128MB归档  
  28.       - name: ROLLING_FILE  
  29.         ignoreExceptions: false  
  30.         fileName: ${log.path}/${project.name}.log  
  31.         filePattern: "${log.path}/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"  
  32.         PatternLayout:  
  33.           pattern: "%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"  
  34.         Policies:  
  35.           SizeBasedTriggeringPolicy:  
  36.             size: "128 MB"  
  37.         DefaultRolloverStrategy:  
  38.           max: 1000  
  39.   
  40.   Loggers:  
  41.     Root:  
  42.       level: info  
  43.       AppenderRef:  
  44.         - ref: CONSOLE  
  45.         - ref: ROLLING_FILE  
  46.     Logger: # 为com.xjj包配置特殊的Log级别,方便调试  
  47.       - name: com.xjj  
  48.         additivity: false  
  49.         level: ${sys:log.level.xjj}  
  50.         AppenderRef:  
  51.           - ref: CONSOLE  
  52.           - ref: ROLLING_FILE  
{ Configuration: 
   { status: 'warn',
     Properties: 
      { Property: 
         [ { name: 'log.level.console', value: 'trace' },
           { name: 'log.level.xjj', value: 'trace' },
           { name: 'log.path', value: '/opt/logs' },
           { name: 'project.name', value: 'my-spring-boot' } ] },
     Appenders: 
      { Console: 
         { name: 'CONSOLE',
           target: 'SYSTEM_OUT',
           ThresholdFilter: 
            { level: '${sys:log.level.console}',
              onMatch: 'ACCEPT',
              onMismatch: 'DENY' },
           PatternLayout: { pattern: '%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n' } },
        RollingFile: 
         [ { name: 'ROLLING_FILE',
             ignoreExceptions: false,
             fileName: '${log.path}/${project.name}.log',
             filePattern: '${log.path}/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz',
             PatternLayout: { pattern: '%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n' },
             Policies: { SizeBasedTriggeringPolicy: { size: '128 MB' } },
             DefaultRolloverStrategy: { max: 1000 } } ] },
     Loggers: 
      { Root: 
         { level: 'info',
           AppenderRef: [ { ref: 'CONSOLE' }, { ref: 'ROLLING_FILE' } ] },
        Logger: 
         [ { name: 'com.xjj',
             additivity: false,
             level: '${sys:log.level.xjj}',
             AppenderRef: [ { ref: 'CONSOLE' }, { ref: 'ROLLING_FILE' } ] } ] } } }

上方的yml文件转换成 json格式


3、测试用例:
 
  1. @RunWith(SpringJUnit4ClassRunner.class)  
  2. @SpringApplicationConfiguration(classes = MySpringBootApplication.class)  
  3. public class MySpringBootApplicationTests {  
  4.     protected final Logger logger = LoggerFactory.getLogger(this.getClass());  
  5.     protected final ObjectMapper objectMapper = new ObjectMapper();  
  6.       
  7.     @Test  
  8.     public void contextLoads() {  
  9.         logger.trace("I am trace log.");  
  10.         logger.debug("I am debug log.");  
  11.         logger.warn("I am warn log.");  
  12.         logger.error("I am error log.");  
  13.     }  
  14.   
  15. }  
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = MySpringBootApplication.class)
public class MySpringBootApplicationTests {
	protected final Logger logger = LoggerFactory.getLogger(this.getClass());
	protected final ObjectMapper objectMapper = new ObjectMapper();
	
	@Test
	public void contextLoads() {
		logger.trace("I am trace log.");
		logger.debug("I am debug log.");
		logger.warn("I am warn log.");
		logger.error("I am error log.");
	}

}

测试结果:

 

 

[plain] view plain copy
 
print ?
  1.   .   ____          _            __ _ _  
  2.  /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \  
  3. ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \  
  4.  \\/  ___)| |_)| | | | | || (_| |  ) ) ) )  
  5.   '  |____| .__|_| |_|_| |_\__, | / / / /  
  6.  =========|_|==============|___/=/_/_/_/  
  7.  :: Spring Boot ::        (v1.3.5.RELEASE)  
  8.   
  9. 2016-05-25 15:36:30,245:INFO main (StartupInfoLogger.java:48) - Starting MySpringBootApplicationTests on WIN-UCBBGRHGRK9 with PID 27276 (C:\workspace-sts\my-spring-boot\target\test-classes started by Xu in C:\workspace-sts\my-spring-boot)  
  10. 2016-05-25 15:36:30,245:DEBUG main (StartupInfoLogger.java:51) - Running with Spring Boot v1.3.5.RELEASE, Spring v4.2.6.RELEASE  
  11. 2016-05-25 15:36:30,245:INFO main (SpringApplication.java:666) - No active profile set, falling back to default profiles: default  
  12. 2016-05-25 15:36:30,285:INFO main (AbstractApplicationContext.java:578) - Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@638ef7ed: startup date [Wed May 25 15:36:30 CST 2016]; root of context hierarchy  
  13. 2016-05-25 15:36:30,522:INFO background-preinit (Version.java:30) - HV000001: Hibernate Validator 5.2.4.Final  
  14. 2016-05-25 15:36:31,673:INFO main (StartupInfoLogger.java:57) - Started MySpringBootApplicationTests in 1.726 seconds (JVM running for 2.749)  
  15. 2016-05-25 15:36:31,681:TRACE main (MySpringBootApplicationTests.java:20) - I am trace log.  
  16. 2016-05-25 15:36:31,681:DEBUG main (MySpringBootApplicationTests.java:21) - I am debug log.  
  17. 2016-05-25 15:36:31,682:WARN main (MySpringBootApplicationTests.java:22) - I am warn log.  
  18. 2016-05-25 15:36:31,682:ERROR main (MySpringBootApplicationTests.java:23) - I am error log.  
  19. 2016-05-25 15:36:31,689:INFO Thread-1 (AbstractApplicationContext.java:960) - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@638ef7ed: startup date [Wed May 25 15:36:30 CST 2016]; root of context hierarchy  
可以看到4个log都出来了,调整log.level参数可以决定让哪个级别的log出来。

 

同时,硬盘中/opt/logs/目录下也自动生成了一个叫做my-spring-boot.log的文件,保存了相同的log内容。

详细的源代码参考:https://github.com/xujijun/my-spring-boot

=====================================

编程免不了要写配置文件,怎么写配置也是一门学问。

YAML 是专门用来写配置文件的语言,非常简洁和强大,远比 JSON 格式方便。

本文介绍 YAML 的语法,以 JS-YAML 的实现为例。你可以去在线 Demo 验证下面的例子。

转:spring boot log4j2配置(使用log4j2.yml文件)---YAML 语言教程

一、简介

YAML 语言(发音 /ˈjæməl/ )的设计目标,就是方便人类读写。它实质上是一种通用的数据串行化格式。

它的基本语法规则如下。

  • 大小写敏感
  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键,只允许使用空格。
  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可

# 表示注释,从这个字符一直到行尾,都会被解析器忽略。

YAML 支持的数据结构有三种。

  • 对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)
  • 数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)
  • 纯量(scalars):单个的、不可再分的值

以下分别介绍这三种数据结构。

二、对象

对象的一组键值对,使用冒号结构表示。


animal: pets

转为 JavaScript 如下。


{ animal: 'pets' }

Yaml 也允许另一种写法,将所有键值对写成一个行内对象。


hash: { name: Steve, foo: bar } 

转为 JavaScript 如下。


{ hash: { name: 'Steve', foo: 'bar' } }

三、数组

一组连词线开头的行,构成一个数组。


- Cat
- Dog
- Goldfish

转为 JavaScript 如下。


[ 'Cat', 'Dog', 'Goldfish' ]

数据结构的子成员是一个数组,则可以在该项下面缩进一个空格。


-
 - Cat
 - Dog
 - Goldfish

转为 JavaScript 如下。


[ [ 'Cat', 'Dog', 'Goldfish' ] ]

数组也可以采用行内表示法。


animal: [Cat, Dog]

转为 JavaScript 如下。


{ animal: [ 'Cat', 'Dog' ] }

四、复合结构

对象和数组可以结合使用,形成复合结构。


languages:
 - Ruby
 - Perl
 - Python 
websites:
 YAML: yaml.org 
 Ruby: ruby-lang.org 
 Python: python.org 
 Perl: use.perl.org 

转为 JavaScript 如下。


{ languages: [ 'Ruby', 'Perl', 'Python' ],
  websites: 
   { YAML: 'yaml.org',
     Ruby: 'ruby-lang.org',
     Python: 'python.org',
     Perl: 'use.perl.org' } }

五、纯量

纯量是最基本的、不可再分的值。以下数据类型都属于 JavaScript 的纯量。

  • 字符串
  • 布尔值
  • 整数
  • 浮点数
  • Null
  • 时间
  • 日期

数值直接以字面量的形式表示。


number: 12.30

转为 JavaScript 如下。


{ number: 12.30 }

布尔值用truefalse表示。


isSet: true

转为 JavaScript 如下。


{ isSet: true }

null~表示。


parent: ~ 

转为 JavaScript 如下。


{ parent: null }

时间采用 ISO8601 格式。


iso8601: 2001-12-14t21:59:43.10-05:00 

转为 JavaScript 如下。


{ iso8601: new Date('2001-12-14t21:59:43.10-05:00') }

日期采用复合 iso8601 格式的年、月、日表示。


date: 1976-07-31

转为 JavaScript 如下。


{ date: new Date('1976-07-31') }

YAML 允许使用两个感叹号,强制转换数据类型。


e: !!str 123
f: !!str true

转为 JavaScript 如下。


{ e: '123', f: 'true' }

六、字符串

字符串是最常见,也是最复杂的一种数据类型。

字符串默认不使用引号表示。


str: 这是一行字符串

转为 JavaScript 如下。


{ str: '这是一行字符串' }

如果字符串之中包含空格或特殊字符,需要放在引号之中。


str: '内容: 字符串'

转为 JavaScript 如下。


{ str: '内容: 字符串' }

单引号和双引号都可以使用,双引号不会对特殊字符转义。


s1: '内容\n字符串'
s2: "内容\n字符串"

转为 JavaScript 如下。


{ s1: '内容\\n字符串', s2: '内容\n字符串' }

单引号之中如果还有单引号,必须连续使用两个单引号转义。


str: 'labor''s day' 

转为 JavaScript 如下。


{ str: 'labor\'s day' }

字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格。


str: 这是一段
  多行
  字符串

转为 JavaScript 如下。


{ str: '这是一段 多行 字符串' }

多行字符串可以使用|保留换行符,也可以使用>折叠换行。


this: |
  Foo
  Bar
that: >
  Foo
  Bar

转为 JavaScript 代码如下。


{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }

+表示保留文字块末尾的换行,-表示删除字符串末尾的换行。


s1: |
  Foo

s2: |+
  Foo


s3: |-
  Foo

转为 JavaScript 代码如下。


{ s1: 'Foo\n', s2: 'Foo\n\n\n', s3: 'Foo' }

字符串之中可以插入 HTML 标记。


message: |

  <p style="color: red">
    段落
  </p>

转为 JavaScript 如下。


{ message: '\n<p style="color: red">\n 段落\n</p>\n' }

七、引用

锚点&和别名*,可以用来引用。


defaults: &defaults
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  <<: *defaults

test:
  database: myapp_test
  <<: *defaults

等同于下面的代码。


defaults:
  adapter:  postgres
  host:     localhost

development:
  database: myapp_development
  adapter:  postgres
  host:     localhost

test:
  database: myapp_test
  adapter:  postgres
  host:     localhost

&用来建立锚点(defaults),<<表示合并到当前数据,*用来引用锚点。

下面是另一个例子。


- &showell Steve 
- Clark 
- Brian 
- Oren 
- *showell 

转为 JavaScript 代码如下。


[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]

八、函数和正则表达式的转换

这是 JS-YAML 库特有的功能,可以把函数和正则表达式转为字符串。


# example.yml
fn: function () { return 1 }
reg: /test/

解析上面的 yml 文件的代码如下。


var yaml = require('js-yaml');
var fs   = require('fs');

try {
  var doc = yaml.load(
    fs.readFileSync('./example.yml', 'utf8')
  );
  console.log(doc);
} catch (e) {
  console.log(e);
}

从 JavaScript 对象还原到 yaml 文件的代码如下。


var yaml = require('js-yaml');
var fs   = require('fs');

var obj = {
  fn: function () { return 1 },
  reg: /test/
};

try {
  fs.writeFileSync(
    './example.yml',
    yaml.dump(obj),
    'utf8'
  );
} catch (e) {
  console.log(e);
}

九、参考链接

(完)