# logback

**Repository Path**: zhangjun93/logback

## Basic Information

- **Project Name**: logback
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 22
- **Created**: 2022-06-15
- **Last Updated**: 2022-07-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# logback

## 简介
> 日志记录框架

![preview.gif](preview.gif)

## 下载安装
```shell
npm install @ohos/logback --save
```
OpenHarmony npm环境配置等更多内容，请参考 [如何安装OpenHarmony npm包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_npm_usage.md) 。

## 使用说明
1. 引入依赖

 ```
   import  { Level }  from '@ohos/logback/'
   import  { Appender }  from '@ohos/logback/'
   import  { FilterEnum }  from '@ohos/logback/'
   import  { Configuration }  from '@ohos/logback/'
   import  { Logger }  from '@ohos/logback/'
   import  { LoggerFactory }  from '@ohos/logback/'
 ```
2. 在MainAbility的onWindowStageCreate中添加全局配置文件

 ```
   let configuration: Configuration = {
    file: '123.log',
    scan: true,
    appender: [{
                   name: 'STDOUT',
                   className: Appender.CONSOLE,
                   encoder: {
                       pattern: {
                           msg: '%date %level %logger %msg'
                       }
                   },
                   /*filter: { //LevelFilter
                       className: FilterEnum.LEVEL,
                       level: Level.WARN,
                       onMatch: Match.ACCEPT,
                       onMismatch: Match.DENY
                   }*/
                   filter: { //ThresholdFilter
                       className: FilterEnum.THRESHOLD,
                       level: Level.INFO,
                   }
               },
               {
                   name: 'LOGFILE',
                   className: Appender.FILE,
                   encoder: {
                       pattern: {
                           msg: '%level %logger %msg'
                       }
                   }
               }],
    logger: [{
                 name: 'com.log.hello',
                 additivity: true,
                 level: Level.WARN,
                 appenderRef: {
                     ref: 'STDOUT'
                 }
             },
             {
                 name: 'com.log.file',
                 additivity: true,
                 level: Level.WARN,
                 appenderRef: {
                     ref: 'LOGFILE'
                 }
             }],
    root: {
        level: Level.INFO,
        appenderRef: {
            ref: 'STDOUT'
        }
    }
}
 globalThis.configure = configuration
 ```
3. 日志打印

 ```
   let logger: Logger = LoggerFactory.getLogger("com.log.hello")
   logger.debug("=====debug=====")
   logger.info("=====info=====")
   logger.warn("=====warn=====")
   logger.error("=====error=====")
   logger.fatal("=====fatal=====")
 ```
4. 日志写入到文件

 ```
   let logger: Logger = LoggerFactory.getLogger("com.log.file")
   logger.info("=====info=====")
   logger.warn("=====warn=====")
   logger.error("=====error=====")
 ```

## 接口说明
1. debug类型打印日志
   `Logger.debug()`
2. 设置日志级别
   `Logger.setLevel(level: Level)`

## 兼容性
支持 OpenHarmony API version 9 及以上版本。

## 目录结构
````
|---- logback
|     |---- entry  # 示例代码文件夹
|     |---- logback  # logback库文件夹
|	    |----src
          |----main
              |----ets
                  |----components
                      |----config #日志配置文件
                      |----format #日期格式化文件
                      |----slf4j #slf4j日志打印类文件
                      |----Appender.ts #日志打印类型枚举
                      |----FilterEnum.ts #日志过滤类型枚举
                      |----Level.ts #日志级别枚举
                      |----Logger.ts #日志打印输出类
|           |---- index.ts  # 对外接口
|     |---- README.md  # 安装使用方法                    
````

## 贡献代码
使用过程中发现任何问题都可以提 [Issue](https://gitee.com/openharmony-sig/logback/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://gitee.com/openharmony-sig/logback/pulls) 。

## 开源协议
本项目基于 [Apache License 2.0](https://gitee.com/openharmony-sig/logback/blob/master/LICENSE) ，请自由地享受和参与开源。