随着Android系统的日益发展和日渐成熟,各种平台的合作就日渐频繁。现在主要互联网公司,都退出了各种各样的插件功能。如第三方支付,第三方联合登陆和微博分享等等功能。
近期由于业务的需要,公司提出将项目的功能打成jar包,提供给其它客户调用。经过一段时间的调查研究和实践,先将解决办法总结如下。
一、原理介绍
在每个Android项目中,都会有一个R.java文件,该文件由ADT维护的,只要你将资源文件放到工程里,或者声明新的控件标识,ADT就会监测到,自动在R.java里注册一个ID方便使用。
- public final class R {
- public static final class anim {
- public static final int cycle_7=0x7f040000;
- … …
- }
- public static final class array {
- public static final int bank_type=0x7f050001;
- … …
- }
- public static final class id{
- public static final int account_warning_text_color=0x7f060027;
- public static final int account_withdraw_text_color=0x7f060026;
- … ...
- }
- … ...
- }
Android布局文件中的组件被调用时需要定义组件的android:id属性,android:id属性只能接受资源类型的值,就是必须以@开头的值。我们声明一个控件的ID有如下几种方式:
方式一@+id:当我们保存布局文件后,系统会自动的在R.java中生成一个int类型的16进制值的变量。public static final int noteInfo=0x7f070007;
- <TextView
- android:id="@+id/noteInfo"
- android:layout_width="match_parent"
- android:layout_height="wrap_content"/>
方式二@id:使用固定id值(可在ids.xml文件和public.xml文件中指定),不自动生成。
- <FrameLayout
- android:id="@android:id/tabcontent"
- android:layout_width="fill_parent"
- android:layout_height="fill_parent" >
- </FrameLayout>
方式三@android:id:通过该系统定义好的id值,引用Android系统内部资源。
- <?xml version="1.0" encoding="utf-8">
- <TabHost xmlns:android="http://schemas.android.com/apk/res/android"
- android:id="@android:id/tabhost"
- android:layout_width="fill_parent"
- android:layout_height="fill_parent" >
- <LinearLayout
- android:orientation="vertical"
- android:layout_width="fill_parent"
- android:layout_height="fill_parent" >
- <TabWidget
- android:id="@android:id/tabs"
- android:layout_width="fill_parent"
- android:layout_height="wrap_content" />
- <FrameLayout
- android:id="@android:id/tabcontent"
- android:layout_width="fill_parent"
- android:layout_height="fill_parent" >
- </FrameLayout>
- </LinearLayout>
- </TabHost>
TabHost的id必须是tabHost,TabWidget的id必须是tabs,FrameLayout的id必须是tabcontent。这些id都是直接引用的系统的值。
在项目的/res/values目录下,我们可以定义如下两个文件,分别介绍它的作用:
ids.xml文件:为 应用相关的资源提供唯一的资源id,id是为了获得xml中的对象而需要的参数,也就是Object = findViewById(R.id.id_name)中的id_name。这些值可以在代码中用android.R.id引用到。
- <resources>
- <item name="HorizontalScrollView01" type="id"/>
- <item name="LinearLayout0000" type="id"/>
- <item name="LinearLayout01" type="id"/>
- </resources>
public.xml文件:描述attr、id、drawable等所指定的一个32的id值,即id值。
- <resources>
- <public id="0x7f040000" name="cycle_7" type="anim" />
- <public id="0x7f040002" name="layout_animation_image" type="id" />
- <public id="0x7f040003" name="layout_animation_linear" type="color" />
- </resources>
基础的知识已经准备完毕,现在我们来描述原理。当我们将src目录下的源码通过Eclipse打出Jar后,源码代码中的如Object = findViewById(R.id.id_name)中的R.id.id_name部分,都会被替换成此时在R文件中生成的id_name对应的ID值(如果有兴趣的话,可以用反编译软件可以查看到)。但是由于R文件中的ID值是由系统自动生成的,而且在不同的系统环境和不同的时间,id_name对应的ID可能不一样。
故我们就出现了如下问题:假设在生成Jar包的时候,@+id/id_name在R文件中自动生成的ID值为public static final int action_settings=0x7f080001。当时当你将Jar提供给第三方的时候,在它的机器上生成的ID值可能就不是0x7f080001,就会出现由于Jar中固定的ID值与当前R文件中生成的ID值不一致,导致Object = findViewById(R.id.id_name)无法找到控件的对象的问题。
通过对上面只是的了解,我们可以用如下方式解决问题:通过使用ids.xml文件和public.xml文件,定义好固定的ID值,将声明控件的方式由@+id改为@id形式,这样引用控件和资源的id根据ids.xml和public.xml的声明,在R文件中声明为固定的值。一直与Jar中的ID值保持一致。
二、操作步骤
这里我们就以一个简单的项目v_main_plug演示操作步骤:
1.重新编译项目,生成R文件。
2.将R文件拷贝,根据R文件中的信息,获得ids.xml和public.xml文件中的内容。
ids.xml文件格式:只需声明@id的对应的R文件中id类型
public.xml文件格式:需要声明R文件中所有资源的类型
可能由于项目中的资源比较多,实际工作中可以使用文本工具自动替换,或写程序自动替换。
3.将项目布局文件中@+id的形式转换成@id形式。
这个可以使用Eclipse的搜索和替换功能很快的实现。
4.使用Eclipse的Export功能,将项目src目录下的源码(注仅仅是src目录下的源码,其它资源我们将以库项目的形式提供给用户)导出Jar包,提供给用户调用。
这里我补充解释一下,此时导出的Jar,里面的Object = findViewById(R.id.id_name)的R.id.id_name等部分,是从public.xml文件中设置的固定值替换,所以一直保持一致。
5.我们删除该项目src下的源代码,将该项目设置为库项目,以供客户引入或许Jar包中的布局,图片等资源。
到这里我们为客户准备的东西已经完毕,1.srcjar.jar包,2.plugin资源库项目。
6.将srcjar.jar包加入客户的项目中(我们以jardemo项目简单模拟),并引入我们的plugin资源库项目(注客户项目一定要和资源项目在同一个目录下)。
7.将plugin资源库项目的AndroidManifest.xml中的内容,添加到客户项目中,并在客户端项目中调用srcjar.jar包中的入口Activity即可。
注意:如果在你的项目中存在调用本项目目录调用资源,如assets下的apk或者mp3等文件,可以拷贝到客户端相应的目录即可。
三、最后总结
当你将原来的工程设置为library的时候,不能直接新建一个工程把资源文件拷贝进去,一定记得只有两种方式
1. 将原工程的src文件夹内文件删除干净。
2. 或者将该工程复制一份,然后删除src内的内容。
否则的话会出现如自定义title报错,两个title的问题等等。
好了,基本的原理和操作步骤已经介绍完毕。希望大家能明白和看懂。
三、具体的方法一: (有点类似appcompat_v7 引用方式)
1, 把你要封装jar包的工程先设置为库文件(Is Library)
右键项目名称——properties——勾选下图的checkbox即可。
2、最关键的一步,Clean一次项目!!!
Eclipse点击上面工具栏的Project——Clean——选择项目,确定
3、使用Eclipse的Export功能,将项目src目录下的源码(注仅仅是src目录下的源码,如果需要还可以加上assets目录,其它资源我们将以库项目的形式提供给用户)导出Jar包,并把该jar包放到原工程的libs目录下,刷新。
这里我补充解释一下,此时导出的Jar,里面的Object = findViewById(R.id.id_name)的R.id.id_name等部分,是不会变的,如果你没做第一步和第二步直接导出,那么R.id.id_name部分会变成R文件里的id值,如:Object = findViewById(2114243567).
4、删除该项目src下的源代码
5、将srcjar.jar包加入客户的项目中(我们以jardemo项目简单模拟),并引入我们的plugin资源库项目(注客户项目一定要和资源项目在同一个目录下)。
6.将plugin资源库项目的AndroidManifest.xml中的内容,添加到客户项目中,大功告成!
注意:如果在你的项目中存在调用本项目目录调用资源,如assets下的apk或者mp3等文件,可以拷贝到客户端相应的目录即可。
1.新建一个Android工程,取名为ActivityLibrary,这个就是等下需要打包成Jar的工程
注:MResource这个类很重要,主要是它的作用,利用反射根据资源名字获取资源ID(其实系统也自带了根据资源名字获取资源ID的方法getResources().getIdentifier("main_activity", "layout", getPackageName());第一个参数是资源的名字,第二个参数是资源的类型,例如layout, string等,第三个是包名字)
import android.content.Context;
/**
* 根据资源的名字获取其ID值
* @author mining
*
*/
public class MResource {
public static int getIdByName(Context context, String className, String name) {
String packageName = context.getPackageName();
Class r = null;
int id = 0;
try {
r = Class.forName(packageName + ".R");
Class[] classes = r.getClasses();
Class desireClass = null;
for (int i = 0; i < classes.length; ++i) {
if (classes[i].getName().split("\\$")[1].equals(className)) {
desireClass = classes[i];
break;
}
}
if (desireClass != null)
id = desireClass.getField(name).getInt(desireClass);
} catch (ClassNotFoundException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (SecurityException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (NoSuchFieldException e) {
e.printStackTrace();
}
return id;
}
// 直接根据资源名称获取相应的ID (eg: class=R.string.class)
public static int getResId(String variableName, Class<?> c) {
try {
Field idField = c.getDeclaredField(variableName);
return idField.getInt(idField);
} catch (Exception e) {
e.printStackTrace();
return -1;
}
}
}
当我们的资源Id是一个数组的时候,我们要用下面的方法
- public static int[] getIdsByName(Context context, String className, String name) {
- String packageName = context.getPackageName();
- Class r = null;
- int[] ids = null;
- try {
- r = Class.forName(packageName + ".R");
- Class[] classes = r.getClasses();
- Class desireClass = null;
- for (int i = 0; i < classes.length; ++i) {
- if (classes[i].getName().split("\\$")[1].equals(className)) {
- desireClass = classes[i];
- break;
- }
- }
- if ((desireClass != null) && (desireClass.getField(name).get(desireClass) != null) && (desireClass.getField(name).get(desireClass).getClass().isArray()))
- ids = (int[])desireClass.getField(name).get(desireClass);
- }
- catch (ClassNotFoundException e) {
- e.printStackTrace();
- } catch (IllegalArgumentException e) {
- e.printStackTrace();
- } catch (SecurityException e) {
- e.printStackTrace();
- } catch (IllegalAccessException e) {
- e.printStackTrace();
- } catch (NoSuchFieldException e) {
- e.printStackTrace();
- }
- return ids;
- }
LibraryActivity这里面比较简单,一个Button,一个TextView,一个ImageView
- package com.example.activitylibrary;
- import android.app.Activity;
- import android.os.Bundle;
- import android.view.View;
- import android.view.View.OnClickListener;
- import android.widget.Button;
- import android.widget.TextView;
- import android.widget.Toast;
- public class LibraryActivity extends Activity {
- String msg = "我是来自Jar中的Activity";
- @Override
- protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- setContentView(MResource.getIdByName(getApplication(), "layout", "activity_main"));
- TextView mTextView = (TextView) findViewById(MResource.getIdByName(getApplication(), "id", "textView1"));
- mTextView.setText(msg);
- Button mButton = (Button) findViewById(MResource.getIdByName(getApplication(), "id", "button1"));
- mButton.setText(msg);
- mButton.setOnClickListener(new OnClickListener() {
- @Override
- public void onClick(View v) {
- Toast.makeText(getApplication(), msg, Toast.LENGTH_SHORT).show();
- }
- });
- }
- }
- <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
- xmlns:tools="http://schemas.android.com/tools"
- android:layout_width="match_parent"
- android:layout_height="match_parent"
- tools:context=".MainActivity" >
- <Button
- android:id="@+id/button1"
- android:layout_width="wrap_content"
- android:layout_height="wrap_content"
- android:layout_alignParentLeft="true"
- android:layout_alignParentRight="true"
- android:layout_alignParentTop="true" />
- <TextView
- android:id="@+id/textView1"
- android:layout_width="wrap_content"
- android:layout_height="wrap_content"
- android:layout_alignParentLeft="true"
- android:layout_alignParentRight="true"
- android:layout_below="@+id/button1" />
- <ImageView
- android:id="@+id/imageView1"
- android:layout_width="wrap_content"
- android:layout_height="wrap_content"
- android:layout_alignParentBottom="true"
- android:layout_alignParentLeft="true"
- android:layout_alignParentRight="true"
- android:layout_below="@+id/textView1"
- android:layout_marginTop="28dp"
- android:src="@drawable/ic_launcher" />
- </RelativeLayout>
只勾选src目录,其他的都不勾选,如图
通过上面这几步我们就将Android工程打包好了
3.我们来使用刚刚打包好的Activity,我们还需要刚刚那个工程的资源文件,因为我们刚刚只打包了src,资源文件不能打包,因此我们需要自己拿出来,我们需要吧Library.jar加入到libs里面去,然后用到的资源文件,如果layout,string之类的拷贝到对应工程的地方去
这个工程一个MainActivity,里面一个按钮,点击按钮跳转到Library中的Activity中,比较简单我直接把代码贴上
- package com.example.androidlibraryinvoke;
- import android.app.Activity;
- import android.content.Intent;
- import android.os.Bundle;
- import android.view.View;
- import android.view.View.OnClickListener;
- import android.widget.Button;
- public class MainActivity extends Activity {
- @Override
- protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- setContentView(R.layout.main);
- Button mButton = (Button) findViewById(R.id.button1);
- mButton.setOnClickListener(new OnClickListener() {
- @Override
- public void onClick(View v) {
- Intent intent = new Intent();
- intent.setClassName(getApplication(), "com.example.activitylibrary.LibraryActivity");
- startActivity(intent);
- }
- });
- }
- }