# xlog-ts

**Repository Path**: ohos_port/xlog-ts

## Basic Information

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

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2024-06-04
- **Last Updated**: 2024-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# XLog
[Android XLog](https://github.com/elvishew/xLog)

### 本库为ts兼容版本，对应的[ets库](https://ohpm.openharmony.cn/#/cn/detail/@ohos-port%2Fxlog)，此为ts库请根据您的项目选择安装对应的版本！

基于OpenHarmony使用ArkTS重写的XLog日志框架库，
具备轻量、美观强大、可扩展的特性。

## 快速开始

安装

```shell
ohpm install @ohos-port/xlog-ts
```

导入

```typescript
import { XLog } from '@ohos-port/xlog-ts';
```

初始化

```typescript
XLog.init();
```

打印日志

```typescript
XLog.i("你好 xlog");
```

## 配置

`xLog` 具有高度可扩展性，几乎任何一个组件都是可配置的。

```typescript
let config = new LogConfiguration.Builder()
    .setTag("XLog")
    .build();
let printer = new FilePrinter.Builder(`${filesDir}/log`)
  .setCleanStrategy(new FileLastModifiedCleanStrategy(24 * 60 * 60 * 1000)) //24h
  .setFileNameGenerator(new DateFileNameGenerator())
  .setBackupStrategy(new FileSizeBackupStrategy(10 * 1024 * 1024)) // 10MB
  .build();
XLog.init(config, [printer, new OhPrinter()]);
```

## 注册worker
- 创建一个worker类如[XLogWorker.ets](#注册worker)
```typescript
import worker from '@ohos.worker';
import { logHandler, logErrorHandler } from '@ohos/xlog/XLogBaseWorker'

worker.workerPort.onmessage = logHandler;
worker.workerPort.onerror = logErrorHandler;
```
- 在build-profile.json5中声明worker
``` json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/workers/XLogWorker.ets"
      ]
    }
  }
```