Hawk 开源项目使用教程

1. 项目的目录结构及介绍

Hawk 项目的目录结构如下：

hawk/
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   ├── com/
│   │   │   │   │   ├── orhanobut/
│   │   │   │   │   │   ├── hawk/
│   │   │   │   │   │   │   ├── Hawk.java
│   │   │   │   │   │   │   ├── ...
│   │   │   │   │   │   │   └── ...
│   │   │   │   │   │   └── ...
│   │   │   │   │   └── ...
│   │   │   │   └── ...
│   │   │   └── ...
│   │   └── ...
│   └── ...
├── gradle/
│   └── wrapper/
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
├── LICENSE
├── README.md
└── settings.gradle

目录结构介绍

• app/: 包含项目的主要代码。
  • src/: 源代码目录。
    • main/: 主代码目录。
      • java/: Java 源代码目录。
        • com/orhanobut/hawk/: Hawk 库的主要代码。
          • Hawk.java: Hawk 库的入口类。
          • 其他相关类和接口。
• gradle/: Gradle 构建工具的配置文件。
  • wrapper/: Gradle 包装器文件。
    • gradle-wrapper.jar: Gradle 包装器 JAR 文件。
    • gradle-wrapper.properties: Gradle 包装器属性文件。
• build.gradle: 项目的 Gradle 构建脚本。
• gradle.properties: Gradle 属性文件。
• gradlew: Gradle 包装器脚本（Unix）。
• gradlew.bat: Gradle 包装器脚本（Windows）。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• settings.gradle: Gradle 项目设置文件。

2. 项目的启动文件介绍

Hawk 项目的启动文件是 Hawk.java，位于 app/src/main/java/com/orhanobut/hawk/ 目录下。

Hawk.java 介绍

Hawk.java 是 Hawk 库的入口类，提供了初始化和使用 Hawk 库的方法。主要功能包括：

• 初始化 Hawk 库。
• 存储和获取数据。
• 删除数据。
• 检查数据是否存在。

示例代码：

import com.orhanobut.hawk.Hawk;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 初始化 Hawk
        Hawk.init(this).build();

        // 存储数据
        Hawk.put("key", "value");

        // 获取数据
        String value = Hawk.get("key");

        // 删除数据
        Hawk.delete("key");

        // 检查数据是否存在
        boolean isExist = Hawk.contains("key");
    }
}

3. 项目的配置文件介绍

Hawk 项目的配置文件主要包括 build.gradle 和 gradle.properties。

build.gradle 介绍

build.gradle 是项目的 Gradle 构建脚本，定义了项目的依赖、插件和其他构建配置。

示例内容：

plugins {
    id 'com.android.library'
    id 'kotlin-android'
}

android {
    compileSdkVersion 30
    buildToolsVersion "30.0.3"

    defaultConfig {
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test