Unity3D跨平臺動態庫編譯---記kcp基於CMake的各平臺構建實踐

時間 2019-11-19

標籤 unity3d unity 跨平臺動態編譯 kcp 基於 cmake 平臺構建實踐简体版

原文原文鏈接

一　　爲何須要動態庫

　　1）提供原生代碼（native code）的支持，也叫原生插件，可是我實踐的是c/cpp跨平臺動態庫，這裏不具體涉及安卓平臺java庫和ios平臺的objectc庫構建。java

　　2）某些開源庫是c/cpp編寫，沒有對應c#版本linux

　　3）或者有c#版本實現，可是效率或者gc達不到指望效果，特別是GC，通常的開源庫c#版本的做者，對gc優化得大多很差android

　　4）追求效率，好比A*尋路等開銷比較大的算法，想作下優化ios

　　5）某些模塊，如網絡模塊，須要Unity客戶端和後端跑一份相同的邏輯代碼，而不想維護兩份語言的實現git

二　　示例demo選擇

　　前陣子因爲項目須要，編譯了一下kcp庫，這裏拿kcp編譯到Unity的各平臺動態庫來作一次總結，kcp的github地址：https://github.com/skywind3000/kcp。github

　　有關這個庫的其它信息這裏不作介紹，它本質就是一個可靠UDP的網絡庫，咱們項目是用在了一款多人實時射擊類遊戲中。算法

三　　編譯工具選擇

　　這裏使用的是CMake，官網地址爲：https://cmake.org/。有關CMake的使用資料自行網絡獲取，我這裏只說一點，這是一個跨平臺的構建工具，針對不一樣的平臺，只須要一份描述文件，很方便，不須要每一個平臺去寫makefile。c#

四　　示例demo選擇

　　其中：windows

　　　　1）cmke目錄：包含CMake在安卓、iOS平臺進行構建時須要要到的兩個文件：android.toolchain.cmake、iOS.cmake後端

　　　　2）Plugins目錄：各平臺構建的輸出目錄，構建完成後能夠直接放置到Unity項目Assdets目錄下使用

　　　　3）CMakeLists.txt文件：主要要由咱們本身編寫的一個文件，cmake根據CMakeLists生成各個平臺編譯的中間文件以及makefile文件

　　　　4）目標庫源代碼：kcp.h、kcp.c

　　　　5）make_xxx：各平臺執行構建腳本文件，這些文件基本是固定的，不須要作什麼修改

五　　項目簡要說明

　　一、kcp項目須要作的調整

　　　　kcp.c不須要動，kcp.h修改部分以下：

 1 #ifdef DLL_EXPORTS
 2 #define KCPDLL _declspec(dllexport)
 3 #else
 4 #define KCPDLL
 5 #endif
 6 
 7 #ifdef __cplusplus
 8 extern "C" {
 9 #endif
10 
11     //---------------------------------------------------------------------
12     // interface
13     //---------------------------------------------------------------------
14 
15     // create a new kcp control object, 'conv' must equal in two endpoint
16     // from the same connection. 'user' will be passed to the output callback
17     // output callback can be setup like this: 'kcp->output = my_udp_output'
18     KCPDLL ikcpcb* ikcp_create(IUINT32 conv, void *user);
19     //其它導出接口省略
20 
21 #ifdef __cplusplus
22 }
23 #endif

　　二、CMakeLists文件編寫

 1 cmake_minimum_required(VERSION 2.8)
 2 
 3 if ( WIN32 AND NOT CYGWIN AND NOT ( CMAKE_SYSTEM_NAME STREQUAL "WindowsStore" ) )
 4     set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} /MT" CACHE STRING "")
 5     set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} /MTd" CACHE STRING "")
 6     set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MT" CACHE STRING "")
 7     set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MTd" CACHE STRING "")
 8 endif ()
 9 
10 project(kcp)
11 
12 if ( IOS )
13         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fembed-bitcode")
14         set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fembed-bitcode")
15 endif ()
16 
17 find_path(KCP_PROJECT_DIR NAMES SConstruct
18     PATHS 
19     ${CMAKE_SOURCE_DIR}
20     NO_DEFAULT_PATH
21     )
22 
23 MARK_AS_ADVANCED(KCP_PROJECT_DIR)
24 
25 set ( KCP_CORE
26     kcp.c
27 )
28 
29 macro(source_group_by_dir proj_dir source_files)
30     if(MSVC OR APPLE)
31         get_filename_component(sgbd_cur_dir ${proj_dir} ABSOLUTE)
32         foreach(sgbd_file ${${source_files}})
33             get_filename_component(sgbd_abs_file ${sgbd_file} ABSOLUTE)
34             file(RELATIVE_PATH sgbd_fpath ${sgbd_cur_dir} ${sgbd_abs_file})
35             string(REGEX REPLACE "\(.*\)/.*" \\1 sgbd_group_name ${sgbd_fpath})
36             string(COMPARE EQUAL ${sgbd_fpath} ${sgbd_group_name} sgbd_nogroup)
37             string(REPLACE "/" "\\" sgbd_group_name ${sgbd_group_name})
38             if(sgbd_nogroup)
39                 set(sgbd_group_name "\\")
40             endif(sgbd_nogroup)
41             source_group(${sgbd_group_name} FILES ${sgbd_file})
42         endforeach(sgbd_file)
43     endif(MSVC OR APPLE)
44 endmacro(source_group_by_dir)
45 
46 source_group_by_dir(${CMAKE_CURRENT_SOURCE_DIR} KCP_CORE)
47 
48 if (APPLE)
49     if (IOS)
50         set(CMAKE_OSX_ARCHITECTURES "$(ARCHS_STANDARD)")
51         add_library(kcp STATIC
52            ${KCP_CORE}
53         )
54     else ()
55         set(CMAKE_OSX_ARCHITECTURES "$(ARCHS_STANDARD_32_64_BIT)")
56         add_library(kcp MODULE
57             ${KCP_CORE}
58         )
59         set_target_properties ( kcp PROPERTIES BUNDLE TRUE )
60         #set_target_properties ( kcp PROPERTIES FRAMEWORK TRUE )
61         #set_target_properties ( kcp PROPERTIES MACOSX_RPATH TRUE )
62     endif ()
63 else ( )
64     add_library(kcp SHARED
65         ${KCP_CORE}
66     )
67 endif ( )
68 
69 if ( WIN32 AND NOT CYGWIN )
70     target_compile_definitions (kcp PRIVATE DLL_EXPORTS)
71 endif ( )

　　　　1）第10行：指定項目名稱爲kcp

　　　　2）第26行：指定要編譯的c/cpp文件

　　　　3）第70行：指定預約義宏DLL_EXPORTS，這個宏只有在window平臺編譯dll動態庫才須要，其它平臺不須要

　　　　4）其它沒什麼好說的，在構建你本身的項目時，只須要注意的帶有「kcp」字樣的地方替換爲你本身對應的項目名稱便可。

　　三、各平臺構建腳本

　　　　1）window32位系統：make_win32.bat

1 mkdir build32 & pushd build32
2 cmake -G "Visual Studio 14 2015" ..
3 popd
4 cmake --build build32 --config Release
5 md Plugins\x86
6 copy /Y build32\Release\kcp.dll Plugins\x86\kcp.dll
7 rmdir /S /Q build32
8 pause

　　　　2）windows64位系統：make_win64.bat

1 mkdir build64 & pushd build64
2 cmake -G "Visual Studio 14 2015 Win64" ..
3 popd
4 cmake --build build64 --config Release
5 md Plugins\x86_64
6 copy /Y build64\Release\kcp.dll Plugins\x86_64\kcp.dll
7 rmdir /S /Q build64
8 pause

　　　　3）linux32位系統：make_linux32.sh

1 mkdir -p build_linux32 && cd build_linux32
2 cmake -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_SHARED_LINKER_FLAGS=-m32 ../
3 cd ..
4 cmake --build build_linux32 --config Release
5 cp build_linux32/kcp.so Plugins/x86/kcp.so
6 rm -rf build_linux32

　　　　4）linux64位系統：make_linux64.sh

1 mkdir -p build_linux64 && cd build_linux64
2 cmake ../
3 cd ..
4 cmake --build build_linux64 --config Release
5 cp build_linux64/kcp.so Plugins/x86_64/kcp.so
6 rm -rf build_linux64

　　　　5）Mac系統：make_osx.sh

1 mkdir -p build_osx && cd build_osx
2 cmake -GXcode ../
3 cd ..
4 cmake --build build_osx --config Release
5 mkdir -p Plugins/kcp.bundle/Contents/MacOS/
6 cp build_osx/Release/kcp.bundle/Contents/MacOS/kcp Plugins/kcp.bundle/Contents/MacOS/kcp
7 rm -rf build_osx

　　　　6）android系統：make_android.sh

 1 if [ -z "$ANDROID_NDK" ]; then
 2     export ANDROID_NDK=~/android-ndk-r10e
 3 fi
 4 
 5 mkdir -p build_v7a && cd build_v7a
 6 cmake -DANDROID_ABI=armeabi-v7a -DCMAKE_TOOLCHAIN_FILE=../cmake/android.toolchain.cmake -DANDROID_TOOLCHAIN_NAME=arm-linux-androideabi-clang3.6 -DANDROID_NATIVE_API_LEVEL=android-9 ../
 7 cd ..
 8 cmake --build build_v7a --config Release
 9 mkdir -p Plugins/Android/libs/armeabi-v7a/
10 cp build_v7a/libkcp.so Plugins/Android/libs/armeabi-v7a/libkcp.so
11 rm -rf build_v7a
12 
13 mkdir -p build_x86 && cd build_x86
14 cmake -DANDROID_ABI=x86 -DCMAKE_TOOLCHAIN_FILE=../cmake/android.toolchain.cmake -DANDROID_TOOLCHAIN_NAME=x86-clang3.5 -DANDROID_NATIVE_API_LEVEL=android-9 ../
15 cd ..
16 cmake --build build_x86 --config Release
17 mkdir -p Plugins/Android/libs/x86/
18 cp build_x86/libkcp.so Plugins/Android/libs/x86/libkcp.so
19 rm -rf build_x86

　　　　7）iOS系統：make_ios.sh

 1 mkdir -p build_ios && cd build_ios
 2 cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/iOS.cmake  -GXcode ../
 3 cd ..
 4 cmake --build build_ios --config Release
 5 mkdir -p Plugins/iOS/
 6 exist_armv7=`lipo -info build_ios/Release-iphoneos/libkcp.a | grep armv7 | wc -l`
 7 exist_arm64=`lipo -info build_ios/Release-iphoneos/libkcp.a | grep arm64 | wc -l`
 8 if [ $[exist_armv7] -eq 0 ]; then
 9     echo "** ERROR **: No support for armv7, maybe XCode version is to high, use manual_build_ios instead!"
10 elif [ $[exist_arm64] -eq 0 ]; then
11     echo "** ERROR ** : No support for arm64, maybe XCode version is to high, use manual_build_ios instead!"
12 else
13     cp build_ios/Release-iphoneos/libkcp.a Plugins/iOS/libkcp.a
14     rm -rf build_io
15 fi

　　　　8）Windows Phone系統：make_uwp.bat

 1 mkdir build_uwp & pushd build_uwp
 2 cmake -G "Visual Studio 14 2015" -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION=10.0 ..
 3 popd
 4 cmake --build build_uwp --config Release
 5 md Plugins\WSA\x86
 6 copy /Y build_uwp\Release\kcp.dll Plugins\WSA\x86\kcp.dll
 7 rmdir /S /Q build_uwp
 8 
 9 mkdir build_uwp64 & pushd build_uwp64
10 cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION=10.0 ..
11 popd
12 cmake --build build_uwp64 --config Release
13 md Plugins\WSA\x64
14 copy /Y build_uwp64\Release\kcp.dll Plugins\WSA\x64\kcp.dll
15 rmdir /S /Q build_uwp64
16 
17 mkdir build_uwp_arm & pushd build_uwp_arm
18 cmake -G "Visual Studio 14 2015 ARM" -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION=10.0 ..
19 popd
20 cmake --build build_uwp_arm --config Release
21 md Plugins\WSA\ARM
22 copy /Y build_uwp_arm\Release\kcp.dll Plugins\WSA\ARM\kcp.dll
23 rmdir /S /Q build_uwp_arm
24 
25 pause

　　　　9）這些腳本都很簡單明瞭，像須要的VS版本、安卓的NDK版本等等，一看便知。要移植到你本身的構建項目也很簡單，基本只須要修改項目名稱便可。

六　　各平臺構建環境簡要說明

　　1）如下各平臺，均須要安裝CMake，安裝教程，包括各平臺環境變量等的配置自行谷歌，不少相關帖子。

　　2）window系統和windows phone系統：在window系統中執行對應的.bat腳本便可，windows phone的編譯須要相關SDK。本帖使用VS2015，windows phone暫時不須要，因此沒有構建測試過。

　　3）linux系統：在linux系統中執行對應的.sh腳本便可

　　4）mac系統：在mac系統中執行對應的.sh腳本便可

　　5）iOS系統：在mack系統中執行對應的.sh腳本便可。須要xcode版本8.1，版本過高會有問題，能夠進行手動構建，參考博文：iOS代碼封裝成.a文件(封裝SDK)。真機上的.a動態庫須要同時支持armv7,ram64架構，查看你編譯出來的.a是不是正確架構可以使用lipo -info kcp.a

　　6）android系統：安卓系統能夠在各個平臺編譯，我這裏是在linux系統中編譯的，執行對應的.sh腳本便可，andorid SDK版本爲：android-ndk-r10e。關於SDK安裝以及環境變量配置自行谷歌。

　　7）可能根據各位本身的狀況，編譯過程會遇到各類小問題，可是這些問題幾乎都是出在環境上，如環境變量、SDK版本、xcode版本等，我這裏已經對環境信息給了足夠的說明，若是你實踐當中問題解決不了，能夠參考我這裏列舉的環境。

　　8）.sh文件在window下編輯可能會存在文件結束符問題，使用doc2unix命令轉換就好，遇到權限問題使用chmod命令就好，其它可能遇到的細節問題本身耐心多多摸索，問題都不大。

七　　Unity項目動態庫配置簡要說明

　　一、輸出目錄結構

　　　　因爲咱們公司所有在window下開發，因此沒有編譯linux下的動態庫，若是大家須要，將在x8六、x86_64目錄下存在libkcp.so文件。一樣，window phone平臺也沒實測。

　　二、window平臺

　　　　x8六、x86_64下的.dll文件：

　　三、Mac平臺

　　　　kcp.bundle，配置時選擇osx系統，任意cpu

　　四、linux平臺

　　　　x8六、x86_64下的.so文件，相應配置

　　五、andorid平臺

　　　　Android子目錄下的.so文件，選擇Android Platform，cpu架構作對應勾選，很簡單，再也不截圖

　　六、iOS平臺

　　　　選擇iOS Platform

八　　動態庫項目使用

　　編寫對應kcp.cs文件，聲明外部函數，腳本以下：

 1 namespace KCP
 2 {
 3     using System;
 4     using System.Runtime.InteropServices;
 5 
 6     public class kcp
 7     {
 8 #if UNITY_IPHONE && !UNITY_EDITOR
 9         const string KcpDLL = "__Internal";
10 #else
11         const string KcpDLL = "kcp";
12 #endif
13 
14         [DllImport(KcpDLL, CallingConvention=CallingConvention.Cdecl)]
15         public static extern uint ikcp_check(IntPtr kcp, uint current);、
16         //其它接口省略
17     }
18 }