将Cocos2d-x的libcurl单独打包到Android

研究了N久+N次，终于在这一周解决了，感谢度娘。感觉第一次快要跑通时，心里真是万分紧张，感觉什么都不会再爱了。点下按钮，返回预期的值，OK。搞定，为此，放松了一个上午，现在来写写一些我是怎么搞通的吧。不敢保证，每个库都能这么搞，但是对一些刚入门者，应该有帮助。好的，开讲！

1、研究背景与意义

公司要单独封装网络库，所以，首先想到的libcurl，因为搞过半年Cocos2d-x，所以，直接找到了Cocos2d-x引擎源码的预编译第三方库里的libcurl。什么是预编译库？下面来解释解释。

1.1预编译库

所谓预编译库其实就是静态库，是一种可执行代码的二进制形式，可以被操作系统载入内存执行。在Linux或Unix下是以.a结尾的库文件。库文件首先会进行编译，当我们把库文件导入自己的动态或静态文件或工程中时，会提高代码的编译速度。静态库在代码编译的时候是已经被载入可执行程序的，体积较大，动态库是在执行程序时才载入内存，在编译的过程中简单的引用，因此代码体积较小。

这篇文章详细讲解了Linux下静态和动态库的基础知识。Linux库详解

1.2libcurl

Libcurl是一个开源免费的库文件，客户端传输库，支持FTP、FTPS、TFTP、HTTP、HTTPS、GOPHER、TELENT、DICT、FILE、LDAP等，C语言编写，跨平台，支持Windows、Unix、Linux等，线程安全，支持Ipv6，易于使用。

官网下载地址：http://curl.haxx.se/download.html

官网API详解：http://curl.haxx.se/libcurl/c/

其实主要是4个函数：1）curl_easy_init()初始化;2）curl_easy_setopt()设置属性;3）curl_easy_perform，连接。4）curl_easy_getinfo

这篇文章详细介绍了如何使用libcurl将下载内容写入内存：http://blog.163.com/xu_chao2000/blog/static/27770610200801303252802/

2、打包Android版libcurl包

关于打包libcurl包，网上有非常多的教程，由于Cocos2d-x已经为我们提供了几乎大部分平台的预编译库，即.a文件。所以，这一步我就在这省略了，虽然可能网上的教程有的比较坑爹，不过，多花些时间，综合起来，就会凑成一个完美的解决方案。

3、开始打包

在打包之前，我们可能需要学一下JNI和NDK编程的知识，不过，这些知识，也不是一篇两篇文章能解释清楚的，所以，这里也不打算讲解，有兴趣的可以翻看本人之前的博客，或者网上百度会有大篇大篇的文章。

3.1新建Android空工程

使用Eclipse新建Android工程。

1）由于Android本身新建工程并不包含jni目录，所以，我们需要自己添加该目录，并在该目录下添加两个文件。Android.mk和Application.mk这两个文件是ndk-build使用的文件。

2）拷贝Cocos2d-x的预编译库。我们需要的libcurl预编译库在Cocos2d-x引擎 cocos2d-x-3.3rc0/external/curl 目录下，将该目录下的两个文件include和prebuilt拷贝到我们上一步新建的android工程中。

3）删除include和prebuilt两个目录中android目录之外的的平台目录。因为我们用不到那些

4）更新Eclipse，可以看到，我们刚才的操作过后的目录如下：重点是jni目录下的改变（网络限制，暂时传不上来照片）

3.2先来一个简单例子，抛砖引玉

Android.mk文件可以说是本文最终要的一部分。我们先一步一步去讲一讲它。

首先阅读下这篇文章，预热一下，了解了解打包静态库和动态库的方法。

其次我们从NDK的samples的two-libs例子入手，分析mk的写法。（即搭建Android环境时，解压的NDK目录下的samples/two-libs）

先上代码

1）first文件：定义了一个加法的方法

//first.h
#ifndef FIRST_H
#define FIRST_H

extern int first(int  x,int  y);

#endif /* FIRST_H */

//first.c
#include "first.h"
int  first(int  x,int  y)
{
    return x + y;
}

2）second.c：这个文件是Jni的相关的文件。

//second.c
#include "first.h"
#include <jni.h> //添加jni头文件
//下面这个函数的意思就是com.example.twolibs包com.example.androidlibcurldemo下MainActivity.java中的add方法。
jint
Java_com_example_androidlibcurldemo_MainActivity_add( JNIEnv*  env,jobject  this,jint     x,jint     y )
{
    return first(x,y);
}

这个add方法，是在我们上一步创建工程的src目录下的MainActivity.java中声明的两个native方法，说白了，second.c的作用就是，定义java中的native方法，并在实现中调用C的代码，如first.c中的first函数。相当于一个中介的样子。
3）Android.mk：例子中的Android.mk文件

#定义变量LOCAL_PATH指向mk所在的路径，如Android.mk文件在/usr/lib/curl/Android.mk
#那么LOCAL_PATH代表的值就是：/usr/lib/curl
#注意，这个变量没有清理，如果在后面引入其他mk文件，这个变量是可以传递到引入的mk文件中的

LOCAL_PATH:= $(call my-dir)

# first lib,which will be built statically
#CLEAR_VARS清理变量，因为这些变量都是静态全局的，如果不清了，下次编译时用到这些变量就会造成错误的
include $(CLEAR_VARS)
#本地静态库模块名字，如果在别处导入库文件时，会用到这个名字
#此处名字的使用是libXXX.so或libXXX.a中的XXX的名字，也可以libXXX，不过，这两种在使用上还是有点区别的，
#使用XXX或libXXX最后打包库后都是libXXX.a/so,在导入库模块时要使用LOCAL_LDLIBS := -lz来指明导入的是本地库
#否则会报找不到库的错误
LOCAL_MODULE    := libtwolib-first
LOCAL_SRC_FILES := first.c
#创建静态库，注意，这个库是我们第一次创建，所以使用BUILD_STATIC_LIBRARY
#如果LOCAL_SRC_FILES（即源码文件）使用的是.a则使用include $(PREBUILT_STATIC_LIBRARY)，见下面代码
#如果使用的是.so文件，则使用include $(PREBUILT_SHARED_LIBRARY)，PREBUILT表示使用的是预编译库里的源文件
include $(BUILD_STATIC_LIBRARY)

# second lib,which will depend on and include the first one
#清理变量
include $(CLEAR_VARS)
#模块名称
LOCAL_MODULE    := libtwolib-second
#源码文件
LOCAL_SRC_FILES := second.c
#导入关联的静态库，如果还有其它静态库，直接在后面添加即可，注意空格隔开
LOCAL_STATIC_LIBRARIES := libtwolib-first
#最终创建动态库文件，libtwolib-second.so
#如果最终创建静态库文件，是需要把SHARED改为STATIC即可，如libtwolib-first
include $(BUILD_SHARED_LIBRARY)

4）Application.mk

我们在这个mk文件中只添加APP_ABI := allNDK就会为我们自动打包对应不同平台ABI的库文件，不同平台的库文件还是有区别的。

不过现在的Android手机大部分都是armeabi的，所以，如果不添加这句话，NDK默认的就会生成armeabi目录，并编译这个平台下使用的库文件。

5）编译库文件

我们进入到创建的Android工程，根目录即可，打开终端，如我使用的mac，打开终端后输入：

$ cd/Users/yuxikuo/Android_WorkPlace/AndroidLibcurlDemo

$ ndk-build

Android NDK: WARNING: APP_PLATFORM android-19 is larger than android:minSdkVersion 8 in ./AndroidManifest.xml    
[armeabi] Compile thumb  : twolib-second <= second.c
[armeabi] Compile thumb  : twolib-first <= first.c
[armeabi] StaticLibrary  : libtwolib-first.a
[armeabi] SharedLibrary  : libtwolib-second.so
[armeabi] Install        : libtwolib-second.so => libs/armeabi/libtwolib-second.so

打包后的结果如上：Android中NDK将打包后的包文件拷贝到1）工程目录下的libs/下对应ABI目录下面，ABI表示当前机器的操作系统，一共有4类，不同的目标系统ABI有不同的打包方式和兼容性。2）同时还会在工程目录新建obj/local目录，该目录下同样根据不同的ABI拷贝对应的库文件。不过，不同的ABI目录是需要自己新建的，默认下是armeabi，因为大部分Android使用的是这个，并且它可以运行在所有ARM CPU上。

armeabi => ARMv5TE以上

armeabi-v7a => ARMv7以上

x86 => x86平台

mips => mips

由于根据不同的ABI进行打包，那么我们每次都会生成4个包，打包过程见下面代码。

而且现在其他的平台并不常见，而且armeabi对其他平台也有兼容，所以，我们这里暂时只考虑armeabi平台下库文件的打包。

Android NDK: WARNING: APP_PLATFORM android-19 is larger than android:minSdkVersion 8 in ./AndroidManifest.xml    
[armeabi-v7a] Compile thumb  : twolib-second <= second.c
[armeabi-v7a] Compile thumb  : twolib-first <= first.c
[armeabi-v7a] StaticLibrary  : libtwolib-first.a
[armeabi-v7a] SharedLibrary  : libtwolib-second.so
[armeabi-v7a] Install        : libtwolib-second.so => libs/armeabi-v7a/libtwolib-second.so //armeabi-v7a
[armeabi] Compile thumb  : twolib-second <= second.c
[armeabi] Compile thumb  : twolib-first <= first.c
[armeabi] StaticLibrary  : libtwolib-first.a
[armeabi] SharedLibrary  : libtwolib-second.so
[armeabi] Install        : libtwolib-second.so => libs/armeabi/libtwolib-second.so  //armeabi
[x86] Compile        : twolib-second <= second.c
[x86] Compile        : twolib-first <= first.c
[x86] StaticLibrary  : libtwolib-first.a
[x86] SharedLibrary  : libtwolib-second.so
[x86] Install        : libtwolib-second.so => libs/x86/libtwolib-second.so  //x86
[mips] Compile        : twolib-second <= second.c
[mips] Compile        : twolib-first <= first.c
[mips] StaticLibrary  : libtwolib-first.a
[mips] SharedLibrary  : libtwolib-second.so
[mips] Install        : libtwolib-second.so => libs/mips/libtwolib-second.so   //mips

6）在Java代码中调用。

在MainActivity.java中添加如下代码

 @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        
        //super.onCreate(savedInstanceState);

        TextView  tv = new TextView(this);
        int       x  = 1000;
        int       y  = 42;

        // here,we dynamically load the library at runtime
        // before calling the native method.
        //把生成的库load进来，注意去掉libXXX.so中的lib和so。只保留XXX
        System.loadLibrary("twolib-second");

        int  z = add(x,y);

        tv.setText( "The sum of " + x + " and " + y + " is " + z );
        setContentView(tv);
    }

    public native int add(int  x,int  y);//native函数声明，在我们的second.c文件中定义，并使用了first.c中的first函数，实现加法

注意，如果出现错误或崩溃，看看second.c的函数包名是不是错误，然后看看有没有在java中声明native的add方法
截图稍后上传。

3.3重头戏:使用libcurl.a打包的so库到Android

1）首先，看看我们之前拷贝到jni目录下的两个文件夹include和prebuilt。对了，这两个目录是我阉割的，把其它无关平台的目录删除了。

2）include目录下是libcurl.a库中源文件的头文件。我们也需要将它打包进包里面，才能在涉及到包时，自动引入头文件。

3）prebuilt目录是存放libcurl.a的目录，我们暂时保存Cocos2d-x的目录结构，这样，我们就免得修改下面的Android.mk文件了

4）/prebuilt/android目录下的Android.mk分析：

注意为了减少路径上的问题，我将include文件夹拷贝到了和该Android.mk文件相同的路径下了

LOCAL_PATHA:=$(call my-dir)//当前路径变量，注意，我在该处设置的变量名是LOCAL_PATHA，因为后面需要导入这个mk文件，防止变量冲突
include $(CLEAR_VARS)//清理变量
LOCAL_MODULE := cocos_curl_static //模块名称
LOCAL_MODULE_FILENAME := curl  //生成的包名
LOCAL_SRC_FILES := prebuilt/android/$(TARGET_ARCH_ABI)/libcurl.a  //依赖的源文件，注意：路径一定要为相对路径，这一块比较容易出错
LOCAL_EXPORT_C_INCLUDES := $(LOCAL_PATHA)/include/android  //为了能在库外面使用库的方法，需要引入头文件
include $(PREBUILT_STATIC_LIBRARY)//预编译成静态库

4）目录下的Android.mk分析：

LOCAL_PATH:=$(call my-dir)
#修改1
include $(LOCAL_PATH)/prebuilt/android/Android.mk
# first lib,which will be built statically
#
include $(CLEAR_VARS)

LOCAL_MODULE    := libtwolib-first
LOCAL_SRC_FILES := first.c

include $(BUILD_STATIC_LIBRARY)

# second lib,which will depend on and include the first one
#
include $(CLEAR_VARS)

LOCAL_MODULE    := libtwolib-second
LOCAL_SRC_FILES := second.c
#修改2，尤其是-lz的作用，非常大 			
LOCAL_C_INCLUDES := $(LOCAL_PATH)
LOCAL_LDLIBS := -llog \
		-lz
#修改3，增加cocos_curl_static库的导入，这就是我们在上面mk定义的
LOCAL_STATIC_LIBRARIES := libtwolib-first cocos_curl_static

include $(BUILD_SHARED_LIBRARY)

5）重写second.c，调用libcurl中的方法，进行网络请求

#include "first.h"
#include <jni.h>
#include <curl/curl.h>

jint
Java_com_example_androidlibcurldemo_MainActivity_add( JNIEnv*  env,jint     y )
{
	CURL* curl;
	CURLcode res;
	curl = curl_easy_init();
	if(NULL == curl)//如果初始化失败，返回1000
	{
		return first(1,999);
	}
    curl_easy_setopt(curl,CURLOPT_URL,"http://www.baidu.com");//以get请求www.baidu.com
    curl_easy_setopt(curl,CURLOPT_READFUNCTION,NULL);
    curl_easy_setopt(curl,CURLOPT_NOSIGNAL,1);
    curl_easy_setopt(curl,CURLOPT_CONNECTTIMEOUT,20);//连接时间，由于网络不好，为了达到测试效果，我设置的时间较长
    curl_easy_setopt(curl,CURLOPT_TIMEOUT,20);
    res = curl_easy_perform(curl);//执行
    curl_easy_cleanup(curl);//清除
<span style="white-space:pre">	</span>
    return first(res,res);//根据res值返回到Android中的TextView中，如果res是0，表示请求成功，如果是6表示无法解析主机，即没联网
}

6）编译库文件

同样还是在终端中，先进入到Android工程目录，然后执行ndk-build。最终在obj和libs目录下生成了我们的libtwolib-second库

3.4如何使用库

1）首先，还是要修改我们的MainActivity.java类，修改如下：

private Button button;
	private TextView tv;
	private int x  = 123;
    private int y  = 456;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        // here,we dynamically load the library at runtime
        // before calling the native method.
        //
        System.loadLibrary("twolib-second");

        tv = (TextView)findViewById(R.id.textView2);
        button = (Button) this.findViewById(R.id.button1);
        this.button.setOnClickListener(new OnClickListener() {
			
			@Override
			public void onClick(View arg0) {				
				 int  z = add(x,y);
			     tv.setText( "网络请求结果" + z );
			}
		});
    }

    public native int add(int  x,int  y);

我们要在activity_main布局中，添加一个按钮和一个TextView，按钮用于出发网络请求，TextView用于显示请求结果。

显示0表示请求成功。显示12表示无法解析主机，没联网。

2）在AndroidManifest.xml中添加网络权限。否则会在TextView显示12

<uses-permission android:name="android.permission.INTERNET"/>

至此，我们就完成了库的编译和使用。

Ctrl+R 打包APK到手机，点击button测试吧。不过这是同步请求，异步暂时还未研究。

以上步骤是经过真机测试，截图如下：网络限制，稍后上传。

疑惑：打包时，如果我没有在second.c中引用<curl/curl.h>进行打包，包只有几十kb，引用后就1.2MB了，但是，我看了下libcurl.a的库本身就4点几MB，不知道什么原因，如有知道，烦请告知。

参考资料：

1）http://blog.csdn.net/sozell/article/details/10551309

2）http://www.2cto.com/kf/201204/125939.html

3）http://jingyan.baidu.com/article/c910274bffa502cd361d2da0.html

4）http://blog.csdn.net/smfwuxiao/article/details/6591927

5）http://www.cnblogs.com/lyout/archive/2013/06/03/3115799.html

6）http://www.linuxidc.com/Linux/2012-07/66105.htm

7）http://blog.csdn.net/smfwuxiao/article/details/8523479

8）http://blog.csdn.net/yuxikuo_1/article/details/39577257

9）http://bbs.csdn.net/topics/370006153

10）http://blog.csdn.net/huyiyang2010/article/details/7664201

11）http://blog.csdn.net/cjj198561/article/details/33417965

12）http://bbs.chinaunix.net/thread-4096875-1-1.html