Once Android 库使用教程

Once Android 库使用教程

Once A small Android library to manage one-off operations. 项目地址: https://gitcode.com/gh_mirrors/onc/Once

1. 项目目录结构及介绍

Once 是一个用于管理一次性操作的小型 Android 库。以下是项目的目录结构及其介绍：

Once/
├── gradle/
│   └── wrapper/
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── once-example/
│   ├── src/
│   └── build.gradle
├── once/
│   ├── src/
│   └── build.gradle
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE.txt
├── README.md
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
└── settings.gradle

目录结构说明

• gradle/wrapper/: 包含 Gradle Wrapper 的相关文件，用于确保项目使用一致的 Gradle 版本。
• once-example/: 示例项目，展示了 Once 库的基本使用方法。
• once/: Once 库的核心代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• .travis.yml: Travis CI 配置文件，用于持续集成。
• CHANGELOG.md: 项目更新日志。
• LICENSE.txt: 项目许可证文件，采用 Apache 2.0 许可证。
• README.md: 项目说明文档。
• build.gradle: 项目的构建脚本。
• gradle.properties: Gradle 属性配置文件。
• gradlew: Gradle Wrapper 的 Unix 脚本。
• gradlew.bat: Gradle Wrapper 的 Windows 脚本。
• settings.gradle: Gradle 设置文件，定义项目结构。

2. 项目启动文件介绍

Once 库的启动文件主要涉及初始化操作。以下是启动文件的介绍：

初始化 Once

在应用启动时，需要在 Application 类的 onCreate() 方法中初始化 Once 库：

import com.jonathanfinerty.once.Once;

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Once.initialise(this);
    }
}

检查操作是否已完成

Once 库提供了多种方式来检查某个操作是否已经完成。例如，检查某个操作是否在当前应用版本中已经完成：

String showWhatsNew = "showWhatsNewTag";
if (!Once.beenDone(Once.THIS_APP_VERSION, showWhatsNew)) {
    startActivity(new Intent(this, WhatsNewActivity.class));
    Once.markDone(showWhatsNew);
}

3. 项目配置文件介绍

Once 库的配置文件主要包括 Gradle 构建脚本和属性文件。以下是配置文件的介绍：

build.gradle

项目的根目录下的 build.gradle 文件定义了项目的构建配置：

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.0'
    }
}

allprojects {
    repositories {
        mavenCentral()
    }
}

gradle.properties

gradle.properties 文件用于配置 Gradle 构建的属性：

org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
android.useAndroidX=true
android.enableJetifier=true

settings.gradle

settings.gradle 文件定义了项目的模块结构：

include ':app', ':once', ':once-example'

通过以上配置，Once 库可以被正确地集成到 Android 项目中，并用于管理一次性操作。

Once A small Android library to manage one-off operations. 项目地址: https://gitcode.com/gh_mirrors/onc/Once