使用Git版本控制 .gitignore 忽略不需要提交的文件

Posted 2022-08-01 CodingForAndroid

团队协作开发的时候，每个人都要提交文件，为了避免不必要的文件提交，我们要进行一个简单的配置来忽略一些文件，只提交必要的文件。

https://segmentfault.com/a/1190000002963895

 

应各位朋友的要求，写这篇文章，让我们来简单了解下android Studio中不同目录（文件）的位置和用途。
首先看下一个App的最简单的目录结构

【= = 好复杂的样子】

OK，我们这么看，第一，把这么多文件先分成这么三块
1. 编译系统（Gradle）
2. 配置文件
3. 应用模块

Gradle是Google推荐使用的一套基于Groovy的编译系统脚本（当然，你也可以使用ant），具体的介绍和文档可以参考这个传送门：https://developer.android.com/tools/building/plugin-for-gradle.html
如果你学会之后，会对Android项目的编译了如指掌（总之非常爽~），它的缺点目前是效率不高，然后因为有功夫网的存在，所以在bintray上下载依赖会比较慢。

上面那个图中出现gradle字眼的就是gradle相关的一些文件。
Android中使用Gradle Wrapper对Gradle进行了一层包装，我猜测这么做的原因是因为gradle更新速度实在太快，为了兼容性着想，才出了这么一套方案。（如果觉得这个猜想有问题请指正）
gradlew相关的文件就是和Gradle Wrapper有关。我们对除了app文件夹以外的文件列一下。

文件（夹）名	用途
.gradle	Gradle编译系统，版本由wrapper指定
.idea	Android Studio IDE所需要的文件
build	代码编译后生成的文件存放的位置
gradle	wrapper的jar和配置文件所在的位置
.gitignore	git使用的ignore文件
build.gradle	gradle编译的相关配置文件（相当于Makefile）
gradle.properties	gradle相关的全局属性设置
gradlew	*nix下的gradle wrapper可执行文件
graldew.bat	windows下的gradle wrapper可执行文件
local.properties	本地属性设置（key设置，android sdk位置等属性），这个文件是不推荐上传到VCS中去的
settings.gradle	和设置相关的gradle脚本

这些就是外部文件相关的一些文件的介绍。我们来看下更重要的app模块里的文件

这是app模块下的文件目录结构，介绍下他们的用途

文件（夹）名	用途
build	编译后的文件存在的位置（包括最终生成的apk也在这里面）
libs	依赖的库所在的位置（jar和aar)
src	源代码所在的目录
src/main	主要代码所在位置（src/androidTest)就是测试代码所在位置了
src/main/assets	android中附带的一些文件
src/main/java	最最重要的，我们的java代码所在的位置
src/main/jniLibs	jni的一些动态库所在的默认位置(.so文件)
src/main/res	android资源文件所在位置
src/main/AndroidManifest.xml	AndroidManifest不用介绍了吧~
build.gradle	和这个项目有关的gradle配置，相当于这个项目的Makefile，一些项目的依赖就写在这里面
proguard.pro	代码混淆配置文件

以上就是对Android Studio目录结构的简单介绍~

这样我们可以看出有些文件是不需要提交到远程仓库的，

 

比如项目根目录下的:
.iml              这个文件是自动生成的，一般是项目的配置 这些每个人本地环境不一样，可能具体内容也不一样，所以不需要VCS。
local.properties　这个在android 项目中是 关联的 sdk路径 。
.gradle 文件夹    这个是Gradle 编译系统  这个也不需要提交。
.idea  文件夹     这个是IDE（集成开发环境） 的一些配置  也不需要提交。
build 文件夹      这个是编译后存放文件的地方 也不需要提交
而在我们的每一个module 目录下：
只需要忽略
build文件夹 和 .iml 文件即可

 

 

 

 

 

接下来 我们就对着目录 配置我们的gitignore 文件就可以了。

在项目的根目录下的 .gitignore 文件我们一般配置如下：

 

# Created by .ignore support plugin (hsz.mobi)

.gradle
/local.properties
/.idea/workspace.xml
/.idea/libraries
.DS_Store
/build
/captures

# Built application files
*.apk
*.ap_

# Files for the Dalvik VM
*.dex

# Java class files
*.class

# Generated files
bin/
gen/

# Gradle files
.gradle/
build/

# Local configuration file (sdk path, etc)
local.properties

# Proguard folder generated by Eclipse
proguard/

# Log Files
*.log

# Others
.idea/
*.iml

在我们每一个module 下面的 .gitignore  则比较简单 一般如下所示：

 

 

/build
*.iml

 

配置好这些后，以后我们提交文件 就不会提示那么多没用的文件了。

 

 

再上传一个忽略规则：

当然 .gitignore 要生效的前提是 要忽略的文件 没有被加入到VCS 中，如果远程仓库已经有了这些文件，我们在用.gitignore去忽略是不会生效的。

https://segmentfault.com/q/1010000000430426 这是对于已经在远程仓库 上的 解决办法。

当然这是有缺陷的，最好的办法还是：

 

 谢谢认真观读本文的每一位小伙伴，衷心欢迎小伙伴给我指出文中的错误，也欢迎小伙伴与我交流学习。

[点击链接加入群聊【编程之美】： https://jq.qq.com/?_wv=1027&k=h75BfFCg](https://jq.qq.com/?_wv=1027&k=h75BfFCg)