# logback

**Repository Path**: tian-pan/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-04-18
- **Last Updated**: 2022-04-25

## 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  { Logger }  from '@ohos/logback/'
 ```
2. 日志打印

 ```
   LoggerFactory.setServiceProvider(LoggerFactory.LOGBACK_SERVICE)
   let logger: Logger = LoggerFactory.getLogger("chapters.introduction.HelloWorld1") as Logger;
   logger.debug("Hello world.");
 ```
3. 日志写入到文件

 ```
   let le: LoggingEvent = new LoggingEvent(localFQCN, this, level, msg, t, params);
   le.addMarker(marker);
   let appender = new FileAppender<Object>();
   appender.setFile("logback.txt");
   appender.setName("test");
   appender.setEvent(event)
   appender.start();
 ```

## 接口说明
1. debug类型打印日志
   `Logger.debug()`
2. 设置保存日志的文件
   `FileAppender.setFile()`
3. 开启日志保存
   `FileAppender..start()`

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

## 目录结构
````
|---- logback
|     |---- entry  # 示例代码文件夹
|     |---- logback  # logback库文件夹
|	    |----src
          |----main
              |----ets
                  |----base #基类文件
                  |----classic #slf4j到logback的桥梁
                  |----core #打印日志核心类文件
                  |----minlog #minlog日志打印类文件
                  |----slf4j #slf4j日志打印类文件
                  |----workers #线程处理文件
|           |---- index.ets  # 对外接口
|     |---- README.md  # 安装使用方法                    
````

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

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