README_ZH.md

vrml-log

一个支持动态配置的日志记录API

Usage

Maven

<dependency>
  <groupId>group.rxcloud</groupId>
  <artifactId>vrml-log</artifactId>
  <version>1.1.4</version>
</dependency>

Log Design

Design goals

• 支持动态配置打印不同级别的日志
• 支持方便的添加日志TAG
• 支持对不同的日志基于TAG进行分类

How to do it?

• 支持多级动态配置
• 提供易于使用的API以操作TAG
• 日志对象将TAG保留为成员变量

Log specification

①Tags ②基础信息 ③具体日志内容

[[ <-- tag --> ]][ <- basic info -> ] [ content ]

[[messageId,key]][ClassName.FuncName] log content.

Log convention

1. 动态参数小于3，并列一行
2. 动态参数小于3，但表达式较长，参数作为单独一行
3. 动态参数大于等于3，参数作为单独一行

Log API

Become a Developer

Developer repository can be found here.

Maven

<dependency>
  <groupId>group.rxcloud</groupId>
  <artifactId>vrml-logs</artifactId>
  <version>1.1.4</version>
</dependency>

Contributing

A small number of users have reported problems building vrml. Read our contribution guide for details.