记录一下 Android sdk 开发中的一些问题,虽然不难但是对于第一次开发 sdk 的人来说还是有不少要注意的地方的。
前段时间由于要和外部公司合作,需要我们提供一个 sdk 能够加载我们自己的 h5 页面,调用起我们的 app,跳转到指定页面等等功能。然后这个封装一个 webview 的“简单 sdk 任务”就落到我的头上了,用 webview 加载页面还好,但是封装 sdk 还真没做过。 当然还有交付个 aar 过去之后,对方说他们用的是 eclipse 开发的,导入的问题,因为我自己用的工具是 AndroidStudio。
需求
简单分析一下那么需求也就出来了:
- 需要 webview 那么就有 js 的交互,那么混淆就要注意了(其实里面的业务逻辑比较简单,奈何要给出去显得高大上,所以要求混淆,手动滑稽);
- 有自己的页面,也就涉及到资源的问题;
- 支持 AndroidStudio 和 Eclipse 的导入。
混淆
除了一些通用的混淆规则,我们还要注意引用了的 jar 包的混淆规则,还有 JsInterface,以及我们需要开放出去的 api 的混淆规则。
资源
对于提供出去的 sdk 在资源命名的时候最好加上自己的前缀,以防和使用方的资源名重复。对于 AndroidStudio 来说可以在 module 的 build 里面加上 resourcePrefix,当我们的资源没有加前缀的时候就能得到提醒。
apply plugin: 'com.android.library'
android {
//... 省略
resourcePrefix 'dt_'
}
对于 AndroidStudio 来说我们可以提供 arr,里面自带资源;对于 Eclipse 来说我们除了提供 jar 包之外,还要提供所用到的资源文件。
对于希望自己能修改一些资源文件起到自定义作用的 AndroidStudio 用户也可以和 Eclipse 一样依赖 jar 包。
采用 jar 包依赖的方式,我们不能直接将所有资源文件拷贝到将要用到的工程里,而要新建一个项目然后保证包名与我们的 sdk 包名一致,然后把资源拷贝进来,保证 R 文件能正确引用到。
但是 jar 如果不进行混淆的话 BuildConfig 就需要我们在打 jar 包的时候去除了,因为我们为了正确引用到资源要求导入的时候建立了一个和 sdk 包名一致的项目,所以这个时候就会有两个 BuildConfig 类而且它们包名一致(一个在 jar 里面,一个在新建的 module 里面)。
因为我采用了混淆所以可以忽略两个 BuildConfig 的问题,不用在打 jar 包的时候处理 BuildConfig,因为使用的时候 jar 包里的可能已经被混淆成 a 了。
至于我上面所说的 jar 包,就是 assembleRelease 之后在 build-outputs-aar 里面的 aar 解压出来的 classes.jar,也就是要提供的 aar 里面直接解压出来的。
Eclipse 导入
Eclipse 不能依赖 aar,在写 sdk 的时候要尽量避免用到 v7 包,因为里面带了资源。我在知道合作方公司用Eclipse 的时候特地又去下载了一个,发现 v7 包的引入比较麻烦,原谅我太久没接触这个工具了!所以连夜把我的 sdk 用到 v7 的地方都给修改了。
尽量使用 23 以上的 v4 包,因为有权限管理适配,这个指不定你会不会用到。
下边看下提供给 Eclipse 导入的文件:
sdk
├── libs
│ ├── sdk.jar
│ └── android-support-v4.jar
├── res
│ └── ***
├── assets
│ └── ***
├── .classpath
├── .project
├── AndroidManifest.xml
└── project.properties
- sdk.jar 就是我们要提供的 jar 包
- res 就是我们需要的资源文件
- .classpath
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry exported="true" kind="con" path="com.android.ide.eclipse.adt.ANDROID_FRAMEWORK"/>
<classpathentry exported="true" kind="con" path="com.android.ide.eclipse.adt.LIBRARIES"/>
<classpathentry exported="true" kind="con" path="com.android.ide.eclipse.adt.DEPENDENCIES"/>
<classpathentry kind="src" path="src"/>
<classpathentry kind="src" path="gen"/>
<classpathentry kind="output" path="bin/classes"/>
</classpath>
- .project 中 name 节点改成需要的 sdk 名称
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>sdklib</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>com.android.ide.eclipse.adt.ResourceManagerBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>com.android.ide.eclipse.adt.PreCompilerBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>com.android.ide.eclipse.adt.ApkBuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>com.android.ide.eclipse.adt.AndroidNature</nature>
<nature>org.eclipse.jdt.core.javanature</nature>
</natures>
</projectDescription>
- project.properties
target=android-23
android.library=true
将得到的 sdk 文件夹作为库工程模块导入到工程中,并添加模块依赖。然后将 assets 文件夹的内容拷贝到主工程的 assets 目录中,将 AndroidManifest 文件中的内容拷贝到你的主工程的 manifest 文件中。
最后
期间参考了市面上一些 sdk 的导入方法,还特意搭建了 eclipse 的环境导入了一下。完成后,想想两个工具只是目录结构不太一样,所以只要解决了混淆和资源引用的问题后稍微调整下结构就通用了,最后还是感慨下 gradle 解决依赖问题真的太舒服了。