Android开发学习笔记(一) —— 分析Android项目结构

一、项目结构

我们创建的项目，它的项目结构是这样的：

任何一个新建的项目都会默认使用Android模式的项目结构，但这并不是项目真实的目录结构，而是被Android Studio转换过的。这种项目结构简洁明了，适合进行快速开发，但是对于新手来说可能并不易于理解。

点击上图中顶部的Android区域可以切换项目结构模式，我们将其切换成Project模式，这个就是项目的真实目录结构。

接下来，我们依次分析目录结构中的文件。

1. .gradle 和 .idea
   这两个目录下放置的都是Android Studio自动生成的一些文件，我们无须关心，也不要去手动编辑。

2. app
   项目中的代码、资源等内容几乎都是放置在这个目录下的，我们后面的开发工作也基本都是在这个目录下进行的。这个目录在下文会单独展开进行讲解。

3. build
   这个目录我们也不需要过多关心，它主要包含了一些在编译时自动生成的文件。

4. gradle
   这个目录下包含了gradle wrapper的配置文件，使用gradle wrapper的方式不需要提前将gradle下载好，而是会自动根据本地的缓存情况决定是否需要联网下载gradle。Android Studio默认没有启用gradle wrapper的方式，如果需要打开，可以点击Android Studio导航栏→File→Settings-→Build,Execution,.Deployment→Gradle，进行配置更改。

5. .gitignore

   这个文件是用来将指定的目录或文件排除在版本控制之外的

6. build.gradle
   这是项目全局的gradle构建脚本，通常这个文件中的内容是不需要修改的。这个目录在下文会单独展开进行讲解。

7. gradle.properties
   这个文件是全局的gradle配置文件，在这里配置的属性将会影响到项目中所有的gradle编译脚本。

8. gradlew和gradlew.bat
   这两个文件是用来在命令行界面中执行gradle命令的，其中gradlew是在Linux或Mac系统中使用的，gradlew.bat是在Windows系统中使用的。

9. HelloWorld.iml
   iml文件是所有IntelliJ IDEA项目都会自动生成的一个文件（Android Studio是基于IntelliJ IDEA开发的)，用于标识这是一个IntelliJ IDEA项目，我们不需要修改这个文件中的任何内容。

10. local.properties
    这个文件用于指定本机中的Android SDK路径，通常内容都是自动生成的，我们并不需要修改。除非你本机中的Android SDK位置发生了变化，那么就将这个文件中的路径改成新的位置即可。

11. settings.gradle

这个文件用于指定项目中所有引入的模块。由于HelloWorld项目中就只有一个app模块，因此该文件中也就只引入了app这一个模块。通常情况下模块的引人都是自动完成的，需要我们手动去修改这个文件的场景可能比较少。

初步分析整个项目的外层目录结构，我们会发现，除了app目录之外，大多数的文件和目录都是自动生成的，我们并不需要进行修改。

二、app目录

1. build
   这个目录主要包含了一些在编译时自动生成的文件，不过它里面的内容会更多更杂，我们不需要过多关心。
2. libs
   如果你的项目中使用到了第三方jar包，就需要把这些jar包都放在libs目录下，放在这个目录下的jar包都会被自动添加到构建路径里去。
3. androidTest
   此处是用来编写Android Test测试用例的，可以对项目进行一些自动化测试。
4. java
   java目录是放置我们所有Java代码的地方。
5. res
   这个目录下的内容就有点多了。简单点说，就是你在项目中使用到的所有图片、布局、字符串等资源都要存放在这个目录下。当然这个目录下还有很多子目录，图片放在drawable目录下，布局放在layout目录下，字符串放在values目录下，所以我们不用担心会把整个res目录弄得乱糟糟的。
6. AndroidManifest.xml
   这是你整个Android项目的配置文件，你在程序中定义的所有四大组件都需要在这个文件里注册，另外还可以在这个文件中给应用程序添加权限声明。
7. test
   此处是用来编写UnitTest测试用例的，是对项目进行自动化测试的另一种方式。
8. .gitignore
   这个文件用于将app模块内的指定的目录或文件排除在版本控制之外，作用和外层的.gitignore文件类似。
9. build.gradle
   这是app模块的gradle构建脚本，这个文件中会指定很多项目构建相关的配置，我们稍后将会详细分析gradle构建脚本中的具体内容。
10. proguard-rules.pro
    这个文件用于指定项目代码的混淆规则，当代码开发完成后打成安装包文件，如果不希望代码被别人破解，通常会将代码进行混淆，从而让破解者难以阅读。

2.1 详解资源目录

所有以drawable开头的文件夹都是用来放图片的，所有以mipmap开头的文件夹都是用来放应用图标的，所有以values开头的文件夹都是用来放字符串、样式、颜色等配置的，layout文件夹是用来放布局文件的。

除此之外，我们开可以创建color文件夹和anim文件夹，前者用于存放颜色选择器（控件不同状态时显示不同颜色），后者用于存放动画资源。

之所以有这么多mipmap开头的文件夹，其实主要是为了让程序能够更好地兼容各种设备（设备屏幕原因，因此分辨率不同）。drawable文件夹也是相同的道理，虽然Android Studio没有帮我们自动生成，但是我们应该自己创建drawable-hdpi、drawable-xhdpi、drawable–xxhdpi等文件夹。

2.2 详解build.gradle文件

2.2.1 最外层目录下的build.gradle文件

plugins {
    id 'com.android.application' version '8.0.2' apply false
    id 'com.android.library' version '8.0.2' apply false
}

在这个例子中，plugins声明了两个插件：com.android.application（用于构建 Android 应用程序模块）和com.android.library（用于构建 Android 库模块），它们的版本号都是8.0.2，并且apply false表示这些插件不会自动应用到项目中。

（应用程序模块和库模块的最大区别在于，前者是可以直接运行的，而后者只能作为代码库依附于别的应用程序模块来运行。）

如果需要使用这些插件，可以在项目的其他构建脚本中显式地应用它们。通常情况下我们并不需要修改这个文件的内容，除非我们想添加一些全局的项目构建配置。

2.2.2 app目录下的build.gradle文件

plugins {
	//意思同最外层的build.gradle一样
    id 'com.android.application'
}

android {
	//指定应用程序的命名空间，也就是应用程序的包名
    namespace 'com.example.forcelogout'
    //SDK编译版本为33,根据这个可以查找Android系统版本
    compileSdk 33
	
    defaultConfig {
    	//指定项目的包名，在创建项目的时候其实已经指定过包名（当然也可以修改）
        applicationId "com.example.forcelogout"
        //项目最低兼容的SDK版本（或最低兼容的Android系统版本）
        minSdk 29
        //表示在该目标版本上已经做过了充分的测试
        targetSdk 33
        //指定项目的版本号
        versionCode 1
        //指定项目的版本名
        versionName "1.0"
		//指定Android单元测试运行器的属性，这里是基于JUnit的Android测试运行器
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
        	//指定是否对项目的代码进行混淆
            minifyEnabled false
            /*指定混淆时使用的规则文件
            *第一个proguard-android.txt是在Android SDK目录下的
            *里面是所有项目通用的混淆规则
            *第二个proguard-rules.pro是在当前项目的根目录下的
            *里面可以编写当前项目特有的混淆规则。
            */
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    //用于指定编译选项
    compileOptions {
    	//指定了源代码的兼容性要求，表示编译器将按照 Java 1.8 的规范来处理源代码文件
        sourceCompatibility JavaVersion.VERSION_1_8
        //指定了生成的字节码的兼容性要求，表示编译器将生成与 Java 1.8 兼容的字节码文件
        targetCompatibility JavaVersion.VERSION_1_8
    }
    buildFeatures {
    	//true表示允许您以类型安全的方式访问布局文件中的视图
        viewBinding true
    }
}
//依赖配置，当缺少依赖的时候可以手动添加
dependencies {
    implementation 'androidx.appcompat:appcompat:1.4.1'
    implementation 'com.google.android.material:material:1.5.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
    implementation 'androidx.annotation:annotation:1.3.0'
    implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.4.1'
    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.1'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

android闭包用来配置项目构建的各种属性。

在android闭包中嵌套的defaultConfig闭包用来对项目的更多细节进行配置。

buildTypes闭包中用于指定生成安装文件的相关配置，通常只会有两个子闭包，一个是debug,一个是release。debug闭包用于指定生成测试版安装文件的配置，release闭包用于指定生成正式版安装文件的配置。另外，debug闭包是可以忽略不写的，因此我们看到上面的代码中就只有一个release闭包。

dependencies闭包。这个闭包的功能非常强大，它可以指定当前项目所有的依赖关系。通常Android Studio项目一共有3种依赖方式：本地依赖、库依赖和远程依赖。本地依赖可以对本地的 Jar 包或目录添加依赖关系，库依赖可以对项目中的库模块添加依赖关系，远程依赖则可以对 jcenter 库上的开源项目添加依赖关系。