Android 最全Ignore文件 : 解决部分不必要文件上传到Git的问题

末蓝、 2023-10-09 14:54 22阅读 0赞

### 1. 背景 ###

我们新建一个Android项目，默认会生成一个`.ignore`文件

*.iml
    .gradle
    /local.properties
    /.idea/caches
    /.idea/libraries
    /.idea/modules.xml
    /.idea/workspace.xml
    /.idea/navEditor.xml
    /.idea/assetWizardSettings.xml
    .DS_Store
    /build
    /captures
    .externalNativeBuild
    .cxx
    local.properties

但是，我们如果平时使用的时候会发现，这个`.ignore`文件是不全的，还是会有部分不必要的文件被上传到`git`上

### 2. 方案一 : Github ###

我们可以在`Github`上新建一个Android 项目，然后选择`Ignore`文件的时候，选择`Android`  
![在这里插入图片描述][0d8f0a1f420545f484f903db260aa147.png]  
生成的`Ignore`文件如下

# Built application files
    *.apk
    *.aar
    *.ap_
    *.aab
    
    # Files for the ART/Dalvik VM
    *.dex
    
    # Java class files
    *.class
    
    # Generated files
    bin/
    gen/
    out/
    #  Uncomment the following line in case you need and you don't have the release build type files in your app
    # release/
    
    # 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
    .idea/tasks.xml
    .idea/gradle.xml
    .idea/assetWizardSettings.xml
    .idea/dictionaries
    .idea/libraries
    # Android Studio 3 in .gitignore file.
    .idea/caches
    .idea/modules.xml
    # Comment next line if keeping position of elements in Navigation Editor is relevant for you
    .idea/navEditor.xml
    
    # Keystore files
    # Uncomment the following lines if you do not want to check your keystore files in.
    #*.jks
    #*.keystore
    
    # External native build folder generated in Android Studio 2.2 and later
    .externalNativeBuild
    .cxx/
    
    # Google Services (e.g. APIs or Firebase)
    # 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
    
    # Version control
    vcs.xml
    
    # lint
    lint/intermediates/
    lint/generated/
    lint/outputs/
    lint/tmp/
    # lint/reports/

> 我新建的Github的Ignore文件在这里 [Github/Android-Ignore-File][Github_Android-Ignore-File]

### 3. 方案二 : Gitee ###

我们也可以在`Gitee`上新建一个Android 项目，然后选择`Ignore`文件的时候，选择`Android`  
![在这里插入图片描述][035bd2e2a28242458fbbff2790f69691.png]  
生成的`Ignore`文件如下

可以发现，`Github`和`Gitee`新建的`ignore`文件，区别就在于`Gitee`多了这两行

# Android Profiling
    *.hprof

> 我新建Gitee Ignore文件在这里 [gitee/Android-Ignore-File][gitee_Android-Ignore-File]

### 4. 方案三 : 最终方式 ###

我们可以把项目中新建的`Ignore`文件和`Gitee`中新建的`Ignore`文件进行合并，然后剔除重复部分，形成最终的`Ignore`文件

.gradle
    /local.properties
    /.idea/caches
    /.idea/libraries
    /.idea/modules.xml
    /.idea/workspace.xml
    /.idea/navEditor.xml
    /.idea/assetWizardSettings.xml
    .DS_Store
    /build
    /captures
    .cxx
    /.idea
    
    # Built application files
    *.apk
    *.aar
    *.ap_
    *.aab
    
    # Files for the ART/Dalvik VM
    *.dex
    
    # Java class files
    *.class
    
    # Generated files
    bin/
    gen/
    out/
    #  Uncomment the following line in case you need and you don't have the release build type files in your app
    # release/
    
    # 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
    .idea/tasks.xml
    .idea/gradle.xml
    .idea/assetWizardSettings.xml
    .idea/dictionaries
    .idea/libraries
    # Android Studio 3 in .gitignore file.
    .idea/caches
    .idea/modules.xml
    # Comment next line if keeping position of elements in Navigation Editor is relevant for you
    .idea/navEditor.xml
    
    # Keystore files
    # Uncomment the following lines if you do not want to check your keystore files in.
    #*.jks
    #*.keystore
    
    # External native build folder generated in Android Studio 2.2 and later
    .externalNativeBuild
    .cxx/
    
    # Google Services (e.g. APIs or Firebase)
    # 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
    
    # Version control
    vcs.xml
    
    # lint
    lint/intermediates/
    lint/generated/
    lint/outputs/
    lint/tmp/
    # lint/reports/
    
    # Android Profiling
    *.hprof

### 5. 在现有项目中修改 ###

如果是新建的项目，把`Ignore`文件修改为上面的就可以了。  
但是如果是现有的项目，只修改`Ignore`文件是不够的，因为一些不需要上传的文件已经被上传过了，所以如果这些文件有修改，那么还是会被上传的。  
那么要怎么让这些文件不再上传呢 ?  
需要先将这些文件删除，然后上传到`git`，这样`git`上就没有这些文件了  
然后再修改`Ignore`文件，这样再次上传的时候，就不会把不需要的文件上传到`git`上了

[0d8f0a1f420545f484f903db260aa147.png]: https://img-blog.csdnimg.cn/0d8f0a1f420545f484f903db260aa147.png
[Github_Android-Ignore-File]: https://github.com/EthanCo/Android-Ignore-File/blob/main/.gitignore
[035bd2e2a28242458fbbff2790f69691.png]: https://img-blog.csdnimg.cn/035bd2e2a28242458fbbff2790f69691.png
[gitee_Android-Ignore-File]: https://gitee.com/EthanCo/ignore/blob/master/.gitignore#