Android 使用版本控制工具时添加忽略文件方式
一、使用SVN管理项目时,添加忽略文件的方式
Android Studio 配合SVN时,添加忽略文件相对简单,首先打开项目的Settings选项,切换到Version Control下的Ignored Files目录,如下图:
image点击右上角绿色加号,出现如下对话框:
image其中
Ignore specified file选项是忽略指定的文件
Ignore all files under选项是忽略指定文件夹下的文件
Ignore all files matching选项是忽略匹配指定格式的文件
一般需要忽略的文件如下:
1、.idea文件夹
2、.gradle文件夹
3、所有的build文件夹
4、所有的.iml文件
5、local.properties文件
根据需求选择对应的选项添加要忽略的文件即可,下图是我测试项目添加的忽略文件:
image添加完成后,项目的目录结构中对应文件会变成如下样式:
image此时再提交文件会发现被忽略的文件(即黄色字体颜色的文件)不会出现在SVN的提交列表中。
二、使用Git管理项目时,添加忽略文件的方式
Android Studio创建项目后,在项目的根目录下会生成一个.gitignore文件,Android的项目.gitignore文件建议按如下方式书写:
# Built application files //
*.apk
*.ap_
# Files for the ART/Dalvik VM
*.dex
# Java class files
*.class
# Generated files
bin/
gen/
out/
# Gradle files
.gradle/
build/
# 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
# Keystore files
*.jks
也就是GitHub官方推荐的.gitignore文件书写格式:
Android.gitignore
当然我们可以根据需求继续添加,例如在# Intellij下继续添加:
*.iws
.idea/
相关过滤规则举例说明:
#:注释符号,自动被Git忽略
*.iml:过滤所有的.iml后缀的文件
.gradle/:过滤掉.gradle文件夹
local.properties:过滤掉local.properties文件
Git文件忽略正是通过编写.gitignore文件实现的。之后通过.gitignore忽略的文件则不会被提交到GitHub。
对比下本地AS的工程目录和提交到GitHub上的工程目录:
无论是通过SVN还是Git管理项目,建议在项目初创建时就做好文件忽略的工作,再提交到服务器。