标注:本文为个人学习使用,仅做自己学习参考使用,请勿转载和转发
2018-08-14: 初稿,参考SvenWang_
2018-08-24: 二稿,更新旧项目添加JNI使用CMake编译的方法
0. 引言
- 在网上找了好几篇关于ndk开发的文章,一直没有成功,最近关于android的so的开发相关的尝试,也就是c/c++等的开发,所以准备从android的jni开始入手,以上是背景。
- 由于as不断完善的ndk的开发,所以网上的博客就有了很多都已经过时了,这个文章是从两种方式讲解as3.0 上面进行的ndk的配置。
-
主要内容
1.创建新的项目就开始进行ndk开发
2.在原有的项目的基础上进行ndk开发
3.为什么生成的jni文件关联不上
4.生成so各类库 -
参考文献
AndroidStudio3.0 NDK开发- 如何在已有项目中进行NDK开发
AndroidStudio3.0开发调试安卓NDK的C++代码
1. 准备工作
首先需要下载关于ndk的相关工具
2. 创建新项目直接进行ndk开发
- 这种指的是直接在创建新的项目的时候,在向导Configure your new project 部分,选中 Include C++ Support 复选框;
- 然后next;
- 正常填写然后next;
- 在向导的 Customize C++ Support 部分,您可以使用下列选项自定义项目:
1.C++ Standard:使用下拉列表选择您希望使用哪种 C++ 标准。选择 Toolchain Default 会使用默认的 CMake 设置。
2.Exceptions Support:如果您希望启用对 C++ 异常处理的支持,请选中此复选框。如果启用此复选框,Android Studio 会将 -fexceptions 标志添加到模块级 build.gradle 文件的 cppFlags 中,Gradle 会将其传递到 CMake。
3.Runtime Type Information Support:如果您希望支持 RTTI,请选中此复选框。如果启用此复选框,Android Studio 会将 -frtti 标志添加到模块级 build.gradle 文件的 cppFlags 中,Gradle 会将其传递到 CMake。 - 点击 Finish。
上面的操作比较简单,在配置之后,直接得到如下的界面
- 在cpp的包下,可以找到属于项目的所有的原生文件、.h文件、预构建库。对于新的项目,Android Studio 会创建一个示例 C++ 源文件 native-lib.cpp,并将其置于应用模块的 src/main/cpp/ 目录中。本示例代码提供了一个简单的 C++ 函数 stringFromJNI(),此函数可以返回字符串“Hello from C++”。
- 在 External Build Files 组中,您可以找到 CMake 或 ndk-build 的构建脚本。与 build.gradle 文件指示 Gradle 如何构建应用一样,CMake 和 ndk-build 需要一个构建脚本来了解如何构建您的原生库。对于新项目,Android Studio 会创建一个 CMake 构建脚本 CMakeLists.txt,并将其置于模块的根目录中。
下面是关于CMakeLists.txt文件
# 有关使用CMake在Android Studio的更多信息,请阅读文档:https://d.android.com/studio/projects/add-native-code.html
# 设置CMake的最低版本构建本机所需库
cmake_minimum_required(VERSION 3.4.1)
# 创建并命名库,将其设置为静态的
# 或共享,并提供其源代码的相对路径。
# 你可以定义多个library库,并使用CMake来构建。
# Gradle会自动将包共享库关联到你的apk程序。
add_library( # 设置库的名称
native-lib #这个根据库名更改
# 将库设置为共享库。
SHARED
# 为源文件提供一个相对路径。
src/main/cpp/native-lib.cpp ) #路径下的库名根据上面的库名更改
# 搜索指定预先构建的库和存储路径变量。因为CMake包括系统库搜索路径中默认情况下,只需要指定想添加公共NDK库的名称,在CMake验证库之前存在完成构建
find_library( # 设置path变量的名称
log-lib
# 在CMake定位前指定的NDK库名称
log )
# 指定库CMake应该链接到目标库中,可以链接多个库,比如定义库,构建脚本,预先构建的第三方库或者系统库
target_link_libraries( # 指定目标库
native-lib #根据上面更改库名的更改
# 目标库到日志库的链接 包含在NDK
${log-lib} )
3. 在已有的项目的基础上进行ndk开发
- 关于项目什么情况下是没有引进c++库呢,就是在创建项目的情况下没有勾选 Include C++ support。
- 还有就是老项目没有NDK,然后准备集成NDK开发,NDK开发主要有两种编译形式,一种是原来的android.mk,也就是ndk-build,另一种是CMake,CMake需要添加一个CMakeList.txt。
- 本文主要讲解对CMake编译方式进行依赖的方法。
- 举个例子,创建一个没有C++库的demo
-
然后对这个项目进行一路的next,就是正常的as项目,没有ndk的相关文件。
在MainActivity 中写上 native的代码,也可以单独建立一个类,专门用来调用底层函数的util类
public class JavaNativeUtil {
static {
// 设置依赖库,native-lib为依赖库的名称,可以自行修改
System.loadLibrary("native-lib");
}
public static native String hello();
}
- 之所以用static修饰了hello方法,是准备将该方法直接在MainActivity中调用,然后发现hello方法是红色报错的,暂时先不用处理。
- 在main文件夹下建立一个cpp的文件夹,然后在cpp文件夹下创建一个native-lib的cpp文件,这个文件就是Java2C的桥梁
- 编写c++实现方法
- 编写native-lib.cpp文件时,首先要包括头文件jni.h,其次是包含extern “C”,注意extern “C”的{}一定要将下面的方法包裹起来,extern “C”主要就是为了兼容Java2C的JNI特殊书写格式的方法。
- 编写方法的的路径一定不能写错。
- 本方法和自动添加C++的Android项目一样,直接返回了一个字符串。
#include <jni.h>
extern "C" {
// 这个路径参照上面创建的JavaNativeUtil的路径进行编写
JNIEXPORT jstring JNICALL Java_net_ankie_italker_jnitestdemo_JavaNativeUtil_hello(JNIEnv *env, jobject obj) {
// 返回字符串
return env->NewStringUTF("hello ndk");
}
}
-
创建一个CMakeLists.txt文件
- 这里的创建的名字必须是 CMakeLists.txt 然后把下面这些代码复制进去
cmake_minimum_required(VERSION 3.4.1)
add_library( # Specifies the name of the library.
# 这里是你so的名字。可以自己定义,但是在LoadLibrary的时候要对应上
native-lib
# Sets the library as a shared library.
SHARED
# Provides a relative path to your source file(s).
#这里是刚才 创建的c++ 代码的名字
src/main/cpp/Hello.cpp )
find_library( # Sets the name of the path variable.
log-lib
# Specifies the name of the NDK library that
# you want CMake to locate.
log )
target_link_libraries( # Specifies the target library.
# 这里是你so的名字。和上面的一样
native-lib
# Links the target library to the log library
# included in the NDK.
${log-lib} )
- 在配置完CMakeList.txt之后,可以配置gradle了,配置gradle时候有两种方法,一种是点击要配置的model右键,添加Link C++ Project with Gradle,然后添加对应刚才创建的CMakeList.txt,右键项目选择菜单:Link C++ Project with Gradle
- 另一种方法是直接添加在Gradle中下面增加的externalNativeBuild选项,然后更新下gradle即可。
-
然后选择我们使用的编译模式CMake进行添加CMakeList.txt文件
- 添加之后会发现Gradle文件会增加externalNativeBuild选项,这样我们就可以愉快的使用JNI了
apply plugin: 'com.android.application'
android {
compileSdkVersion 26
defaultConfig {
applicationId "net.ankie.italker.jnitestdemo"
minSdkVersion 19
targetSdkVersion 26
versionCode 1
versionName "1.0"
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
externalNativeBuild { // 这个就是刚才添加的新的关于CMakeList.txt的添加
cmake {
path 'CMakeLists.txt'
}
}
}
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation 'com.android.support:appcompat-v7:26.1.0'
implementation 'com.android.support.constraint:constraint-layout:1.1.2'
testImplementation 'junit:junit:4.12'
androidTestImplementation 'com.android.support.test:runner:1.0.2'
androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
}
- 然后编译一下就可以了,编译的时候最好的方式是先clean build,然后再编译下
- 然后会发现hello方法不红了,可以执行了,能跳转了,方法名之前可以跳转到JavaNativeUtil方法里面了!
- 这样就可以调用方法进行编译调用了,本文直接调用的JNI的hello方法,然后在MainActivity中打印的Log
public class MainActivity extends AppCompatActivity {
private static final String TAG = "MainActivity";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Log.e(TAG, "onCreate: " + JavaNativeUtil.hello());
}
}
4. 生成so文件
-
build之前应该clean build,要不不能make Module ‘app’
-
然后就会生成so文件
5. 备注
- 本文主要讲解的是关于AS中创建新的项目和在旧项目中添加NDK的CMake的编译方式的方法。
- 其中旧项目添加NDK有两种方式,网上主要介绍的是添加 .mk文件,然后使用ndk-build的方式,本文主要介绍的是添加CMakeList.txt文件CMake的编译方式。
- 主要讲述了搭建JNI的形式,其中native-lib.cpp文件和native-lib库的名称可以自行根据需求定义。
- 生成的so库可以根据需要添加到不同的平台下的AS中进行依赖。
- 其中JNI关联不上的主要原因有native-lib.cpp文件中的方法的与在Java中的路径的名不对称,或者是CMakeList.txt没有添加到Gradle中,然后更新Gradle。
- 还有可能就是没有添加extern ”C“ {},或者其作用域没有包含其他的JNI方法。