利用gradle生成jar包

公司的项目主要是做sdk,之前打jar包都是通过写shell脚本手动编译生成,那样效率低而且维护起来也很麻烦。最近把项目中jar包的构建方式通过gradle进行了重构,在此简单记录下。

gradle

Gradle主要是用Groovy语言编写,如果还不太清楚gradle是什么,或者想了解gradle的一些基础知识点可以参考下面大神的文章。Groovy是一门jvm语言,如果只是为了进一步学习Gradle完成一些自动化构建,只需要学习Groovy语言的基础语法就行

Gradle使用指南
深入理解Android之Gradle
Gradle从入门到实战

通过gradle生成jar包

在相应module的build.gradle文件中编写一个task用来生成一个jar

task makeReleaseJar(type: Jar, dependsOn: ['assembleRelease']){
    archiveName = 'TestSdk.jar'
    from ('build/intermediates/classes/release')
    destinationDir = file('build/libs')
}
  • makeReleaseJar: 该task的名字,sync之后会在IDE右侧的GradleProjects里相应module的other目录下生成相应的task
  • type: Jar:相当于java的继承,表示该task继承Jar基类
  • dependsOn: ['assembleRelease']:表示当前task依赖assembleRelease这个task,直白点说就是执行该task之前会先执行assembleRelease这个task
  • archiveName:需要生成的jar包的名字
  • from('build/intermediates/classes/release'):将括号里目录下的class文件打包到目标jar包里
  • destinationDir:jar包最终生成的目录

上面的demo中重点要解释下的可能就是 from('build/intermediates/classes/release')
打jar包其实就是将需要的编译后的class文件集合在一个jar包里,所以在上面的task中,首先用到了dependsOn: ['assembleRelease'],这是因为在执行assembleRelease后,会在‘build/intermediates/classes’这个目录下生成一个release文件夹,里面就是该module编译后的所有class文件,如果是需要debug版的,就使用debug文件夹下的class文件

把module中依赖的jar或者其他module也打入目标jar中

如果需要把当前module依赖的jar或者其他公用module也一起打到一个jar中,则需要在前面的demo中做一些改变

task makeReleaseJar(type: Jar, dependsOn: ['assembleRelease']){
    archiveName = 'TestSdk.jar'
    from ('build/intermediates/classes/release')
    from ('../test-common/build/intermediates/classes/release')
    from (project.zipTree('../../../libs/test_api.jar'))
    destinationDir = file('build/libs')
}

公司的项目主要是做sdk,之前打jar包都是通过写shell脚本手动编译生成,那样效率低而且维护起来也很麻烦。最近把项目中jar包的构建方式通过gradle进行了重构,在此简单记录下。

gradle

Gradle主要是用Groovy语言编写,如果还不太清楚gradle是什么,或者想了解gradle的一些基础知识点可以参考下面大神的文章。Groovy是一门jvm语言,如果只是为了进一步学习Gradle完成一些自动化构建,只需要学习Groovy语言的基础语法就行

Gradle使用指南
深入理解Android之Gradle
Gradle从入门到实战

通过gradle生成jar包

在相应module的build.gradle文件中编写一个task用来生成一个jar

task makeReleaseJar(type: Jar, dependsOn: ['assembleRelease']){
    archiveName = 'TestSdk.jar'
    from ('build/intermediates/classes/release')
    destinationDir = file('build/libs')
}
  • makeReleaseJar: 该task的名字,sync之后会在IDE右侧的GradleProjects里相应module的other目录下生成相应的task
  • type: Jar:相当于java的继承,表示该task继承Jar基类
  • dependsOn: ['assembleRelease']:表示当前task依赖assembleRelease这个task,直白点说就是执行该task之前会先执行assembleRelease这个task
  • archiveName:需要生成的jar包的名字
  • from('build/intermediates/classes/release'):将括号里目录下的class文件打包到目标jar包里
  • destinationDir:jar包最终生成的目录

上面的demo中重点要解释下的可能就是 from('build/intermediates/classes/release')
打jar包其实就是将需要的编译后的class文件集合在一个jar包里,所以在上面的task中,首先用到了dependsOn: ['assembleRelease'],这是因为在执行assembleRelease后,会在‘build/intermediates/classes’这个目录下生成一个release文件夹,里面就是该module编译后的所有class文件,如果是需要debug版的,就使用debug文件夹下的class文件

把module中依赖的jar或者其他module也打入目标jar中

如果需要把当前module依赖的jar或者其他公用module也一起打到一个jar中,则需要在前面的demo中做一些改变

task makeReleaseJar(type: Jar, dependsOn: ['assembleRelease']){
    archiveName = 'TestSdk.jar'
    from ('build/intermediates/classes/release')
    from ('../test-common/build/intermediates/classes/release')
    from (project.zipTree('../../../libs/test_api.jar'))
    destinationDir = file('build/libs')
}

如上所示增加了两行代码

  • from('../test-common/build/intermediates/classes/release'):表示把test-common这个module的class文件也集合进来
  • from(project.zipTree('../../../libs/test_api.jar')):表示把test_apo.jar这个jar包集合进最终的jar包

把生成的jar复制到其他目录

一般生成jar之后还想要把jar复制到demo等其他模块中,这种则需要再新建一个task

task copyJarToDemo(type: Copy,dependsOn: ['makeReleaseJar']){
    from 'build/libs'
    include 'AdOttSdk.jar'
    into '../sdk-demo/libs'
}

type:copy :该task继承copy基类,用于复制任务
dependsOn: ['makeReleaseJar']: 依赖了我前面创建的makeReleaseJar 的task,因为复制jar之前肯定要先生成jar
from 'build/libs' : 要复制的文件所在文件夹路径
include 'AdOttSdk.jar' : 要复制的文件名
into '../sdk-demo/libs'' : 复制的目标文件夹

这样执行copyJarToDemo这个task就能生成jar而且把jar复制到demo的libs下

以上就是利用gradle生成jar包的过程,如果有不对的地方欢迎指正,共同学习
如上所示增加了两行代码

  • from('../test-common/build/intermediates/classes/release'):表示把test-common这个module的class文件也集合进来
  • from(project.zipTree('../../../libs/test_api.jar')):表示把test_apo.jar这个jar包集合进最终的jar包

把生成的jar复制到其他目录

一般生成jar之后还想要把jar复制到demo等其他模块中,这种则需要再新建一个task

task copyJarToDemo(type: Copy,dependsOn: ['makeReleaseJar']){
    from 'build/libs'
    include 'AdOttSdk.jar'
    into '../sdk-demo/libs'
}

type:copy :该task继承copy基类,用于复制任务
dependsOn: ['makeReleaseJar']: 依赖了我前面创建的makeReleaseJar 的task,因为复制jar之前肯定要先生成jar
from 'build/libs' : 要复制的文件所在文件夹路径
include 'AdOttSdk.jar' : 要复制的文件名
into '../sdk-demo/libs'' : 复制的目标文件夹

这样执行copyJarToDemo这个task就能生成jar而且把jar复制到demo的libs下

以上就是利用gradle生成jar包的过程,如果有不对的地方欢迎指正

推荐阅读更多精彩内容