Android 应用程序的典型 .gitignore 文件

作者:编程家 分类: android 时间:2025-07-29

Android 应用程序的典型 .gitignore 文件是为了在使用 Git 进行版本控制时,忽略一些不需要提交到代码仓库的文件或文件夹。这些文件或文件夹可能是编译生成的临时文件、日志文件、本地配置文件等。在开发 Android 应用时,使用合适的 .gitignore 文件能够帮助我们更好地管理代码库,并避免不必要的提交和冲突。

下面是一个典型的 Android 应用程序的 .gitignore 文件的例子:

plaintext

# Built application files

*.apk

*.ap_

# Files for the Dalvik VM

*.dex

# Java class files

*.class

# Generated files

bin/

gen/

# Gradle files

.gradle/

build/

/*/build/

out/

# Local configuration file (sdk path, etc)

local.properties

# ProGuard folder generated by Eclipse

proguard/

# Log Files

*.log

# Android Studio Navigation editor temp files

.navigation/

# Android Studio captures folder

captures/

# Intellij

*.iml

.idea/workspace.xml

.idea/tasks.xml

.idea/gradle.xml

.idea/assetWizardSettings.xml

.idea/dictionaries

.idea/libraries

# Keystore files

*.jks

# External native build folder generated in Android Studio 2.2 and later

.externalNativeBuild

# Google Services (e.g. API key files)

google-services.json

# Freeline

freeline.py

freeline/

freeline_project_description.json

# Fastlane

fastlane/report.xml

fastlane/Preview.html

fastlane/screenshots

fastlane/test_output

fastlane/readme.md

忽略的文件类型

在这个 .gitignore 文件中,我们可以看到有许多不同的文件类型被忽略。这些文件类型包括:

- `*.apk` 和 `*.ap_`:这些是 Android 应用的安装包文件,不应该提交到代码仓库中。

- `*.dex`:这些是 Dalvik 虚拟机所需的文件,不需要提交。

- `*.class`:这些是 Java 类文件,不需要提交。

- `bin/` 和 `gen/`:这些是编译过程中生成的文件夹,也不需要提交。

- `.gradle/`、`build/`、`/*/build/` 和 `out/`:这些是 Gradle 构建过程中生成的文件夹,同样不需要提交。

- `local.properties`:这是本地配置文件,包含了 SDK 路径等信息,不需要提交。

- `proguard/`:这是 Eclipse 自动生成的 ProGuard 代码混淆配置文件夹。

- `*.log`:这些是日志文件,不需要提交。

- `.navigation/`:这是 Android Studio 的导航编辑器生成的临时文件夹。

- `captures/`:这是 Android Studio 的截屏文件夹。

- `*.iml`、`.idea/workspace.xml`、`.idea/tasks.xml`、`.idea/gradle.xml` 和 `.idea/assetWizardSettings.xml`:这些是 IntelliJ IDEA 或 Android Studio 自动生成的配置文件,不需要提交。

- `*.jks`:这些是 Keystore 文件,包含了应用的签名信息,不需要提交。

- `.externalNativeBuild`:这是 Android Studio 2.2 及更高版本中生成的外部原生构建文件夹。

- `google-services.json`:这是 Google Services 相关的配置文件,包含了 API 密钥等信息,不需要提交。

- `freeline.py`、`freeline/` 和 `freeline_project_description.json`:这些是 Freeline 构建工具生成的文件和文件夹。

- `fastlane/report.xml`、`fastlane/Preview.html`、`fastlane/screenshots`、`fastlane/test_output` 和 `fastlane/readme.md`:这些是 Fastlane 自动化构建工具生成的文件和文件夹。

通过使用合适的 .gitignore 文件,我们可以确保只提交必要的代码文件,避免将一些临时文件和配置文件提交到代码仓库中,从而保持代码仓库的整洁和可维护性。