# KtPref

**Repository Path**: liang_dh/KtPref

## Basic Information

- **Project Name**: KtPref
- **Description**: kotlin代码实现以纯文件作为基础的用户偏好数据持久化库，旨在用于解决跨平台jvm代码实现用户偏好储存。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-10-27
- **Last Updated**: 2023-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">Kt Pref</h1>

### 以文件为单位的jvm平台本地持久化库
[![](https://jitpack.io/v/com.gitee.liang_dh/KtPref.svg)](https://jitpack.io/#com.gitee.liang_dh/KtPref) ![](https://img.shields.io/badge/kotlin-orange.svg) ![](https://img.shields.io/badge/compose-multiplatform-blue.svg)

你可以在java或者kotlin项目中导入此依赖

请在项目根 build.gradle 中添加以下代码

Step 1. Add the JitPack repository to your build file

```
allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
```

Step 2. Add the dependency

```
dependencies {
    implementation 'com.gitee.liang_dh:KtPref:$lastVersion'
}
```

### 使用示例

1.首先需要申明KtPref对象并进行初始化，有如下两种方法：

```kotlin
KtPref.initialize(file)
val ktPre = KtPref.default
```

```kotlin
val ktPref = KtPref("foo")
ktPref.initialize(file)

val ktPref2 = KtPref("bar", file)
```

2.使用

```kotlin
KtPref.default.put("hhh", 123)
ktPref2.put("key", "blue")

val a: Int = KtPref.default.getInt("hhh", 0)
val b: String? = ktPref2.getString("key")
```

最后，写这个项目出发点是在做compose跨平台开发的时候发现需要一个纯kotlin的模块来进行本地数据持久化的管理。
Android端特有的SharedPreference等并不能用于跨平台应用开发，不过在jvm上File类是相通的，因此基于File来实现统一的本地数据持久化管理。