Android开发:《Gradle Recipes for Android》阅读笔记(翻译)4.4——自定义代码集合
问题:
你想要在项目中使用非标准的代码目录。
解决方案:
在gradle的build配置里面使用sourceSets属性。
讨论:
Android分发的samples里面使用多个代码目录,使得通用的文件从主代码里面分离。
考虑一个武断的API23,叫做Basic Gesture Detect的例子,在input/BasicGestureDetext目录下找到。应用本身的细节不重要,可以看到Gradle build演示了代码集合的修改。
下面显示应用子目录的Gradle 配置文件,注意samples礼貌经常使用Application来代替app作为主要的子项目。
// The sample build uses multiple directories to // keep boilerplate and common code separate from // the main sample code. List<String> dirs = [ 'main', // main sample code; look here for the interesting stuff. 'common', // components that are reused by multiple samples 'template'] // boilerplate code that is generated by the sample template process android { // ... code omitted ...
sourceSets { main { dirs.each { dir -> java.srcDirs "src/${dir}/java" res.srcDirs "src/${dir}/res" }
} androidTest.setRoot('tests') androidTest.java.srcDirs = ['tests/src'] }
}
配置文件定义了一个叫做dirs的List<String>来表示代码目录。Groovy支持一个原生的lists语法,使用方括号里面包含用逗号分隔的值。上面显示的值是main,common,template。
在android块下面,sourcesSets属性用来在classpath里面增加相关的代码目录。注意main块里面,Groovy的each提供给list里面每个入口一个闭包,如下:
dirs.each { dir -> java.srcDirs "src/${dir}/java" res.srcDirs "src/${dir}/res" }
each方法来自于Groovy。它遍历collection的每个元素,将他们传递给闭包参数。这里的闭包给所有元素都贴上dir的标签,并且将它转化为Groovy的字符串。
标准的项目结构定义了一个默认的代码树src/main/java和一个资源树src/main/res。在这样的情况下,使用srcDirs属性将额外的目录添加到这些集合中。这样的结果就是目录src/main/java,src/common/java,src/template/java都被添加到编译的classpath里,src/main/res,src/common/res,src/template/res被认为是资源目录。
讽刺的是,这个sample里面没有任何额外的目录。所有java代码都在src/main/java下面,所有资源都在src/main/res下面。实际上,没有一个sample实际使用了定义的结构。他们都将java代码和资源文件限制到标准的目录下面。定义这样的结构是为了一些未来计划的事情,或者一些事情的延期,或者只是证明Google的android开发者的幽默。
有一部分sourceSets属性被使用。代替将所有的测试都放在事先定义好的src/androidTest/java目录下面,Gradle配置改变了位置,如下:
测试的根目录现在是tests文件夹,tests本身放在tests/srcs文件夹下面。每个sample项目在Application下面都有两个文件夹,src和tests。ActivityInstrumentation的基础项目布局包含了一个应用目录,如下:
就像你看到的,java代码在src/main/java下面,资源文件在src/main/res下面,测试在tests/src下面。
哪里可以使用sourceSet属性。在Android apps没有转到Gradle项目之前的项目使用了不同的项目结构。Android Studio可以导入那些app,但是会重写项目结构。