1# 使用命令行CMake构建NDK工程 2<!--Kit: NDK--> 3<!--Subsystem: arkcompiler--> 4<!--Owner: @huang_huijin--> 5<!--Designer: @huang_huijin--> 6<!--Tester: @zsw_zhushiwei--> 7<!--Adviser: @fang-jinxu--> 8 9在很多复杂应用工程中，C++代码工程是通过CMake等构建系统以命令行方式来编译构建的，接下来介绍如何把已有的CMake工程切换到OpenHarmony工具链中，从而使用命令行CMake构建该工程。 10 11 12## 下载NDK开发包 13<!--RP1--> 141. 推荐使用OpenHarmony正式发布的SDK包。下载链接请从OpenHarmony正式发布版本的 **版本说明** 中获取。 15 16在Release Notes 对应正式版本的“从镜像站点获取” 章节下载。 17 18根据系统的操作类型，下载对应的 SDK 包。 19 20 212. 从DevEco Studio的OpenHarmony SDK Manager中下载。 22<!--RP1End--> 23 24## 解压NDK开发包 25 26下载完成后，将压缩包放入创建好的文件夹下解压。 27 28windows/linux 使用 SDK 包解压完成效果如下图所示： 29 30 31 32mac使用 SDK 包解压完成效果如下图所示： 33 34 35 36### 配置环境变量 37如果只是在DevEco Studio中使用，跳过以下步骤： 381. 将NDK自带的CMake编译工具添加到环境变量中。 39+ 配置 linux 系统下环境变量 40 41 ``` 42 # 打开.bashrc文件 43 vim ~/.bashrc 44 # 在文件最后添加cmake路径，该路径是自己的放置文件的路径，之后保存退出 45 export PATH=${实际SDK路径}/native/build-tools/cmake/bin:$PATH 46 # 在命令行执行source ~/.bashrc使环境变量生效 47 source ~/.bashrc 48 ``` 49 50+ 配置 mac 系统下环境变量 51 52 ``` 53 #在当前用户目录下，打开 .bash_profile 文件，文件如果不存在，创建即可 54 vim ~/.bash_profile 55 #在文件最后添加 cmake 路径，该路径是自己的放置文件的路径，之后保存退出 56 export PATH=${实际SDK路径}/native/build-tools/cmake/bin:$PATH 57 #在命令行执行 source ~/.bash_profile 使环境变量生效 58 source ~/.bash_profile 59 ``` 60 61+ 配置 windows 下的环境变量 62 63 右键点击我的电脑，在下拉框中选择我的电脑，点击高级系统设置，点击环境变量，点击Path后点编辑，点击新建，将路径添加进去，之后保存退出，打开cmd（若下一步不能够实现，请重启电脑尝试）。 64 65  66 67 打开命令框，输入{cmake实际安装路径}\cmake.exe -version，命令行正确回显cmake的版本号，说明环境变量配置完成。 68 69  70 71 722. 查看CMake默认路径。 73 + linux 和 mac 系统环境下 74 ``` 75 #在命令行输入which命令查询当前CMake所在路径 76 which cmake 77 #结果路径与.bashrc中设置一致 78 ~/ohos-sdk/ohos-sdk/linux/native/build-tools/cmake/bin/cmake 79 ``` 80 + windows 系统环境下，cmake 安装路径为自己所配置的环境变量路径 81 82 通过 我的电脑->高级系统设置->环境变量->在 Path 对象中查看 83 84 85## 使用NDK开发包编译Native程序 86 87应用开发者可以通过NDK开发包快速的开发出Native动态库、静态库与可执行文件。NDK开发包提供CMake编译构建工具脚本，下面通过编写一个C/C++ demo工程来演示适配过程。 88 89 90### demo工程内容 91 92下面是一个CMake的demo工程内容，此工程包含两个目录，include目录包含此库的头文件，src目录包含全部源码；src目录包含两个文件，sum.cpp的算法文件，以及main.cpp的调用算法的主入口文件，目标是编译成一个可执行程序，以及一个算法动态库。 93 94**demo目录图** 95 96``` 97demo 98 ├── CMakeLists.txt 99 ├── include 100 └── sum.h 101 └── src 102 ├── CMakeLists.txt 103 ├── sum.cpp 104 └── hello.cpp 105``` 106 107**根目录CMakeLists.txt内容** 108 109``` 110# 指定CMake的最小版本 111CMAKE_MINIMUM_REQUIRED(VERSION 3.16) 112 113# 工程名称，这里我们就叫HELLO 114PROJECT(HELLO) 115 116#添加一个子目录并构建该子目录。 117ADD_SUBDIRECTORY(src) 118``` 119 120**内部CMakeLists.txt内容** 121 122``` 123SET(LIBHELLO_SRC hello.cpp) 124 125# 设置编译参数 126SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O0") 127 128# 设置链接参数，具体参数可以忽略，纯粹为了举例 129SET(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--emit-relocs --verbose") 130 131# 添加一个libsum动态库目标，编译成功会生成一个libsum.so 132ADD_LIBRARY(sum SHARED sum.cpp) 133 134# 生成可执行程序，添加一个Hello的可执行程序目标，编译成功会生成一个Hello可执行程序 135ADD_EXECUTABLE(Hello ${LIBHELLO_SRC}) 136 137# 指定Hello目标include目录路径 138TARGET_INCLUDE_DIRECTORIES(Hello PUBLIC ../include) 139 140# 指定Hello目标需要链接的库名字 141TARGET_LINK_LIBRARIES(Hello PUBLIC sum) 142``` 143 144**源码内容** 145 146hello.cpp源码 147 148``` 149#include <iostream> 150#include "sum.h" 151 152int main(int argc,const char **argv) 153{ 154 std::cout<< "hello world!" <<std::endl; 155 int total = sum(1, 100); 156 std::cout<< "Sum 1 + 100=" << total << std::endl; 157 return 0; 158} 159``` 160 161sum.h源码 162 163``` 164int sum(int a, int b); 165``` 166 167sum.cpp源码 168 169``` 170#include <iostream> 171 172int sum(int a, int b) 173{ 174 return a + b; 175} 176``` 177 178 179### 编译构建demo工程 180 181**linux 和 mac 系统环境下** 182 183在工程目录下，创建build目录，用来放置CMake构建时产生的中间文件。注意: ohos-sdk是下载下来的SDK的根目录，开发者需要自行替换成实际的下载目录。 184 1851. 采用OHOS_STL=c++_shared动态链接c++库方式构建工程，如不指定，默认采用c++_shared；DOHOS_ARCH参数可根据系统架构来决定具体值，例如当DOHOS_ARCH=armeabi-v7a会编译32位动态库，而当DOHOS_ARCH=arm64-v8a会编译64位动态库。 186 187 ``` 188 >mkdir build && cd build 189 >cmake -DOHOS_STL=c++_shared -DOHOS_ARCH=arm64-v8a -DOHOS_PLATFORM=OHOS -DCMAKE_TOOLCHAIN_FILE={ohos-sdk}/linux/native/build/cmake/ohos.toolchain.cmake .. 190 >cmake --build . 191 ``` 192 1932. 采用OHOS_STL=c++_static静态链接c++库方式构建工程，当DOHOS_ARCH=armeabi-v7a会编译32位静态库，而当DOHOS_ARCH=arm64-v8a会编译64位静态库。 194 195 ``` 196 >mkdir build && cd build 197 >cmake -DOHOS_STL=c++_static -DOHOS_ARCH=arm64-v8a -DOHOS_PLATFORM=OHOS -DCMAKE_TOOLCHAIN_FILE={ohos-sdk}/linux/native/build/cmake/ohos.toolchain.cmake .. 198 >cmake --build . 199 ``` 200 201 命令中，OHOS_ARCH与OHOS_PLATFORM两个变量最终会生成clang++的--target命令参数，在此例子中就是--target=arm-linux-ohos --march=armv7a两个参数。 202 203 CMAKE_TOOLCHAIN_FILE指定了toolchain文件，在此文件中默认给clang++设置了--sysroot={ndk_sysroot目录}，告诉编译器查找系统头文件的根目录。 204 205**windows系统环境下** 206 207在windows下使用cmake进行编译，与linux下不同的是，使用cmake要加入参数 -G 选择使用的生成器，直接回车会列出下面的生成器。 208 209 210 211这里使用的是cmake .. -G "Ninja" 引号里面跟的参数就是上图查看的环境所支持的生成器，这里ndk中自带的生成器是Ninja。 212 213 214 215Step 1. 同样在工程目录下创建 build 文件夹并执行以下指令： 216``` 217 F:\windows\native\build-tools\cmake\bin\cmake.exe -G "Ninja" -D OHOS_STL=c++_shared -D OHOS_ARCH=arm64-v8a -D OHOS_PLATFORM=OHOS -D CMAKE_TOOLCHAIN_FILE=F:\windows\native\build\cmake\ohos.toolchain.cmake .. 218``` 219**注意**：如需debug调试，增加参数 -D CMAKE_BUILD_TYPE=normal；cmake路径和编译工具链ohos.toolchain.cmake路径都是下载好的ndk路径。 220执行结果如下图： 221 222 223 224这里生成的build.ninja文件就是我们需要的 。 225 226Step 2. 让我们用ninja指令来编译生成目标文件，其位置如下图所示： 227 228 229 230ninja -f build.ninja 或者用 cmake --build . 执行结果如下： 231 232
