Android 公共库的建立方法

本文主要介绍在android工程中如何将共用代码建成公共包方便其他工程引用、引用后的工程结构分析、library引入方式的优缺点。

 

我的公共库已开源，可见TrineaAndroidCommon@Github，包含图片缓存、下拉刷新、静默安装及其他Android开发常用工具类，欢迎star和fork^_^。示例APK地址：TrineaAndroidDemo

 

1、java中公共库的创建和引入

熟悉java的朋友都知道在java中可以将公用代码提取出来新建工程，打包成jar包，然后通过外部依赖或是maven依赖加入其他工程使用。

 

2、android中公共库的创建和引入

使用android提供的is library功能创建公共库，android adt提供了公共库的创建方法，下面逐一介绍

a. 新建android工程

这一步同一般的android工程创建方法，如下

 

b. 设置工程属性为library

右击工程->properties->Android，将工程设置为是library，如下

 

c. android公共库的引入方法

右击需要引入library的工程->properties->Android，在library中添加之前新建的common，如下

这样我们就成功引入library了，对于引入后的工程结构分析可以参见本文下面第三部分介绍。引入后我们可以正常的引入java类，对于资源可以像在同一个工程中引入即可，因为library的资源被并入了工程中。

 

PS：如果这个时候工程编译出错，则可能是因为工程和公用library中资源的冲突问题，在后面的分析中我们可以知道引入library后，对于工程的资源会进行合并。比如library中现在含有icon.png的drawable资源，若调用者资源中也含有icon.png则会编译报错，这个时候我们可以将library中的icon资源删除，对于library来说尽量不要放这些drawable资源，我们甚至可以如下图红圈所示删除所有drawable资源文件夹，防止冲突发生。

当然删除icon后同时需要修改相应的引用资源的文件，如这里AndroidManifest.xml中的android:icon

 

3、引用后的工程结构分析

引入library的工程目录结构如下

从上图三个黄色标记的地方我们可以发现library的资源被并入了工程中，同时生成了两个一样的资源文件R.java。这样做的话，对于工程来说可以方便的调用library中的资源，跟在同一个工程中调用资源无甚区别。

a、library的资源被并入调用者工程中，并且相同资源值被覆盖

library中存在strings.xml内容如下

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="hello">Hello World, AndroidCommon!</string>
    <string name="app_name">AndroidCommon</string>
</resources>

调用者同样存在strings.xml，内容如下

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="app_name">TESTPROJECT</string>
    <string name="string2">testString</string>
</resources>

最终R.java中的string我们可以看到同时存在hello、app_name、string2三个变量，即资源被合并。并且app_name的值为TESTPROJECT，即资源值被覆盖。

b. 资源一致性

修改上面红色标记的AndroidCommon_src中的AndroidCommon的内容，会发现library中的内容也会被相应修改

c. 编译一致性

修改library的资源进行编译会发现调用者工程也会同时被编译。 

 

 

4. library引入方式的优缺点

通过library方式成功引入了公用库

a. 提高了代码的复用率减少了开发量

b. 可以使得项目模块化以及更好的扩展

 

同时对于这种工程方式的引入还是觉得有一些不妥的地方

a. 通过源码引入，而不是通过类似jar包引入，从而对于library的修改导致所有引入该library都需要同时编译过于麻烦

 

Android 开发进阶：

• 我的微博 Trinea，更及时全面的技术分享！
• Android 插件化
• Android 开源库获取途径整理
• VPN云梯推荐，合买每月仅5元，全平台支持
• Java Annotation 及几个常用开源项目注解原理简析
• Android自动轮播 无限循环的ViewPager
• Android开源项目汇总
• Android性能优化总结
• Android公共库(缓存 下拉ListView 静默安装等)
• Android ImageCache图片缓存
• 下拉刷新及滚动到底部加载更多的Listview使用

 

 

评论

13 楼 u010244357 2014-06-30  

Trinea 写道

u010244357 写道

尼壕,请问引入其他项目后,是否意味着是应用变为多进程

八竿子打不着的两件事情

嗯,我知道我出现的问题了.是之前的应用没删干净

12 楼 Trinea 2014-03-24  

u010244357 写道

尼壕,请问引入其他项目后,是否意味着是应用变为多进程

八竿子打不着的两件事情

11 楼 u010244357 2014-03-23  

尼壕,请问引入其他项目后,是否意味着是应用变为多进程

10 楼 Trinea 2013-06-20  

z390174504 写道

Trinea 写道

z390174504 写道

楼主，您好，想问下，我在编译的时候，没有错误，但是运行时候，发现库项目访问不到库项目中资源文件的id，
我在库项目中使用如下方法
    this.findViewById(R.id.relativelayout)

怎么解决呢?

你是跟android系统一起编译还是eclipse编译

和android一起编译，直接运行在手机上，没提出诚library时候没问题，提出来就访问不到id

这个问题我也碰到了，目前除了把library java及resource源码都拷贝到工程里面，并且修改library的R为工程的R外，没有好的方法。

系统是可以的，我也在靠framework层怎么做到的

9 楼 z390174504 2013-06-15  

Trinea 写道

z390174504 写道

楼主，您好，想问下，我在编译的时候，没有错误，但是运行时候，发现库项目访问不到库项目中资源文件的id，
我在库项目中使用如下方法
    this.findViewById(R.id.relativelayout)

怎么解决呢?

你是跟android系统一起编译还是eclipse编译

和android一起编译，直接运行在手机上，没提出诚library时候没问题，提出来就访问不到id

8 楼 Trinea 2013-06-14  

z390174504 写道

楼主，您好，想问下，我在编译的时候，没有错误，但是运行时候，发现库项目访问不到库项目中资源文件的id，
我在库项目中使用如下方法
    this.findViewById(R.id.relativelayout)

怎么解决呢?

你是跟android系统一起编译还是eclipse编译

7 楼 z390174504 2013-06-14  

楼主，您好，想问下，我在编译的时候，没有错误，但是运行时候，发现库项目访问不到库项目中资源文件的id，
我在库项目中使用如下方法
    this.findViewById(R.id.relativelayout)

怎么解决呢?

6 楼 Trinea 2013-05-07  

sgjsdf5944 写道

楼主你好，如果库工程处理完了需要向引用库项目某界面传递参数该怎么实现呀，因为业务通过startActivityForResult不能实现业务的需求，请问楼主有没有其他的方式实现，谢谢！

没明白你的意思？公共库传递参数给引入库项目？

5 楼 sgjsdf5944 2013-05-07  

楼主你好，如果库工程处理完了需要向引用库项目某界面传递参数该怎么实现呀，因为业务通过startActivityForResult不能实现业务的需求，请问楼主有没有其他的方式实现，谢谢！

4 楼 Trinea 2013-04-03  

scliu0718 写道

Trinea 写道

scliu0718 写道

LZ,你好， 请问一下，如果使用maven打包的话Is Library项目怎么打包到apk中呢？

什么意思，用libs文件夹的话adt是自动会打包到apk中的

恩， 但是用你文中的方式“Is Library”的方式却不会被打包到apk中呢？
（另外，用“Is Library”的方式引入另一个Android项目，貌似会自动引入该项目Bin目录下生成该项目的jar包）

这个问题我暂时也不知道怎么解决，你要是有好的方式麻烦搞我一下，嘿嘿

3 楼 scliu0718 2013-04-03  

Trinea 写道

scliu0718 写道

LZ,你好， 请问一下，如果使用maven打包的话Is Library项目怎么打包到apk中呢？

什么意思，用libs文件夹的话adt是自动会打包到apk中的

恩， 但是用你文中的方式“Is Library”的方式却不会被打包到apk中呢？
（另外，用“Is Library”的方式引入另一个Android项目，貌似会自动引入该项目Bin目录下生成该项目的jar包）

2 楼 Trinea 2013-04-02  

scliu0718 写道

LZ,你好， 请问一下，如果使用maven打包的话Is Library项目怎么打包到apk中呢？

什么意思，用libs文件夹的话adt是自动会打包到apk中的

1 楼 scliu0718 2013-04-02  

LZ,你好， 请问一下，如果使用maven打包的话Is Library项目怎么打包到apk中呢？