swift SDK开发遇到的问题

补充新问题

dyld: Library not loaded: @rpath/libswiftCore.dylib

在OC项目中使用时,iOS12及以下的设备会报这个错误,没有默认的swift核心库,需要在项目进行配置:

  • ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES 设置为YES
  • EMBEDDED_CONTENT_CONTAINS_SWIFT 设置为YES

两个里面搜得到哪个就配置哪个,不然会报错;如果不需要支持低版本,可以忽略

源码分离

私有的git上存放一个Framework项目,然后在公共库上传打包好的Framework文件。这样避免了代码泄露,同时也方便其它用户下载使用;

Framework架构合并

module文件复制

swift语言编写的Framework和oc不一样,swift的Framework里面包含了module信息,不能像oc那样直接用lipo -create合并架构,还需要把对应架构的module文件复制过去。这里不列代码了,后面直接提供脚本。

arm64冲突

Xcode12,使用模拟器编译生成的Framework里面,同样会包含arm64架构,这样在与真机Framework合并时,会因为冲突合并失败;

解决办法:移除模拟器Framework里面的arm64架构:

方案一:lipo -remove脚本

lipo -remove arm64 "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}" -output  "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}"

方案二: 修改Framework项目配置

Build Setting-Excluded Architectures,给Debug和Release里面分别加入Any iOS Simulator SDK = arm64,这样生成的模拟器Framework直接不包含arm64架构

051ab27685efe33280fac2d79f71678e.png

按照上诉方案修改后的Framework,其它APP使用时,也需要按照方案二配置项目,不然模拟器运行时会报错:building for iOS Simulator, but linking in object file built for iOS, for architecture arm64;

快速合并Framework

1.新建一个target,就叫universal

这个target专门用来跑脚本

64a3843fbd0b6beb6f90d2e6a5ae43a9.png

2.Build Phases 里面新增一个脚本

ca39b01fe08703aac27e13d4fcd83a46.png

脚本文件如下,步骤说明写在注释里面:

#设置输出文件夹
output_path=${PROJECT_DIR}
#设置项目文件名
xcodeproj_name=${PROJECT_NAME}.xcodeproj

# 先删除老的Framework文件,
# 如果不删除,在多次执行脚本时,MYProject.framework包里面会再出现一个MYProject.framework
rm -rf "${output_path}/Frameworks"
# 这个目录是我根据项目结构,在Cocoapod项目里放Frameworks文件的文件路径,需要根据项目文件结构的不同进行修改,不过最好都是在同一个根目录下面,这样即使移动文件夹也不会报错
rm -rf "${output_path}/MYProject_Cocoapod/MYProject/Frameworks/"

# 创建输出路径,-p递归创建目录,会把子目录也创建出来
mkdir -p "${output_path}"
# 创建用来放原始真机framework的路径
mkdir -p "${output_path}/Frameworks/device/"
# 创建用来放原始模拟器framework的路径
mkdir -p "${output_path}/Frameworks/simulator/"
# 创建用来放合并架构后的framework的路径
mkdir -p "${output_path}/Frameworks/universal/"



#编译真机版本项目
xcodebuild -project "${xcodeproj_name}" -target "${PROJECT_NAME}" -configuration ${CONFIGURATION} -sdk iphoneos ONLY_ACTIVE_ARCH=NO  BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build
 #编译模拟器版本项目
xcodebuild -project "${xcodeproj_name}" -target "${PROJECT_NAME}" -configuration ${CONFIGURATION} -sdk iphonesimulator  ONLY_ACTIVE_ARCH=NO  BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build


#复制Framework文件到创建的目录,真机Framework需要同时放到universal目录,作为后续修改使用,不直接改动原始Framework
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework" "${output_path}/Frameworks/universal/${PROJECT_NAME}.framework"
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework" "${output_path}/Frameworks/device/${PROJECT_NAME}.framework"
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework" "${output_path}/Frameworks/simulator/${PROJECT_NAME}.framework"
 

#给模拟器的Modules文件夹下的.swiftmodule文件夹赋值
simulator_modules_path="${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/Modules/${PROJECT_NAME}.swiftmodule/."
#如果.swiftmodule文件夹存在,就复制到universal目录下的真机Framework里面
if [ -d "${simulator_modules_path}" ]; then
cp -R "${simulator_modules_path}" "${output_path}/Frameworks/universal/${PROJECT_NAME}.framework/Modules/${PROJECT_NAME}.swiftmodule"
 
fi
 

# 移除模拟器framework里面的arm64架构
lipo -remove arm64 "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}" -output  "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}"
#合并framework文件
lipo -create "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${PROJECT_NAME}.framework/${PROJECT_NAME}" -output "${output_path}/Frameworks/universal/${PROJECT_NAME}.framework/${PROJECT_NAME}"


#删除build文件夹
rm -rf "${PROJECT_DIR}/build"

#此时生成的混合Framework,在模拟器使用时还是会报错,因为Framework里面的${PROJECT_NAME}-Swift.h文件#if判断时只有一个架构作为条件,需要修改此文件来支持其他架构,如下

#拼接项目名.framework/Headers/项目名-Swift.h 文件名
fileSwift="${output_path}/Frameworks/universal/${PROJECT_NAME}.framework/Headers/${PROJECT_NAME}-Swift.h"

echo "file-Swift.h==============$fileSwift"


#在 项目名.framework/Headers/项目名-Swift.h里面修改内容内容

str1="#if 0"
str2="#elif defined(__arm64__) && __arm64__"
str3="#if defined(__x86_64__) && __x86_64__ || (__arm64__) && __arm64__"
#修改
#查找#if 0替换成空
sed -i '' 's/#if 0//g' $fileSwift
#查找#elif defined(__arm64__) && __arm64__替换成空
sed -i '' 's/#elif defined(__arm64__) && __arm64__//g' $fileSwift
#在1第一行添加字符串#if defined( __x86_64__ ) && __x86_64__ || (__arm64__) && __arm64__
sed -i '' "1 a\\
$str3" $fileSwift

#复制生成的Frameworks文件夹到对外的cocoaPod的文件夹里面,省的手动复制
cp -R "${output_path}/Frameworks/" "${output_path}/MYProject_Cocoapod/MYProject/Frameworks/"

# cp -R "${output_path}/Frameworks/device/MYProject.framework" "${output_path}/MYProject_Cocoapod/MYProject/Frameworks/device/MYProject.framework"
# cp -R "${output_path}/Frameworks/simulator/MYProject.framework" "${output_path}/MYProject_Cocoapod/MYProject/Frameworks/simulator/MYProject.framework"
# cp -R "${output_path}/Frameworks/universal/MYProject.framework" "${output_path}/MYProject_Cocoapod/MYProject/Frameworks/universal/MYProject.framework"

# 打开项目目录,项目名.framework文件就是我们要用的静态库
open "${PROJECT_DIR}"

这样就拿到了合并的Framework;

合并脚本替换header-swift.h文件的头部#if条件时;如果iOS支持版本改到12.3,脚本修改的文件会报错,因为12.3生成的header-swift.h文件头部没有#if...

如果遇到这种情况,需要手动修改header-swift.h


使用合并Framework

dyld: Library not loaded:......Reason: image not found

这里因为制作的是动态库,手动把Framework拖到项目时,Framework文件默认是不嵌入:

68d12ab7dd79ac1cbc07b2c40e04833a.png

手动改成Embed & Sign,然后就遇到下一个问题了:

Building for iOS, but the linked and embedded framework 'MYProject.framework' was built for iOS + iOS Simulator.

使用合并后的Framework,项目就会报错,寻找解决方案良久:

方案一:Validate WorkSpace配置修改

Build Setting-Build Options-Validate WorkSpace改为Yes,即可解决这个错误

0b7d7f6135c292dda2254693f8d383c0.png
方案二:XCFramework,最优解
方案三:使用CocoaPod管理合并后的Framework

需要用Framework制作成Pod库,需要熟悉Pod的制作流程,在.podspec文件里如下指定:

  s.vendored_frameworks = 'XXX/Frameworks/universal/*.framework'
#    s.vendored_frameworks = 'YKBuryPoint/Framework_XC/*.xcframework'
  s.user_target_xcconfig = { 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'arm64' }

通过pod install安装的项目,不会报错。

XCFramework


XCode12.3 开始, iOS + iOS Simulator 这种合并的胖子包,强制使用 XCFramework 架构;其它的解决方案,最后可能都无法支持。

XCFramework 是由 Xcode 创建的一个可分发的二进制包,里面可以包含多个平台的Framework或library,Xcode会根据编译平台的不同,自动选择对应的Framework指令集,不用手动去合并Framework或者移除模拟器架构。

XCFramework创建

如何创建呢?同样我们可以使用合并Framework那样的方式,通过另一个脚本来创建:

#设置输出文件夹
output_path=${PROJECT_DIR}
#设置项目文件名
xcodeproj_name=${PROJECT_NAME}.xcodeproj

# 创建输出路径,-p递归创建目录,会把子目录也创建出来
mkdir -p "${output_path}"

#编译真机版本项目
xcodebuild archive -scheme ${PROJECT_NAME} -destination="iOS" -archivePath "${output_path}/tmp/xcf/ios.xcarchive" -derivedDataPath "${output_path}/tmp/iphoneos" -sdk iphoneos SKIP_INSTALL=NO BUILD_LIBRARIES_FOR_DISTRIBUTION=YES
#编译模拟器版本项目
xcodebuild archive -scheme ${PROJECT_NAME} -destination="iOS Simulator"  -archivePath "${output_path}/tmp/xcf/iossimulator.xcarchive" -derivedDataPath "${output_path}/tmp/iphoneos" -sdk iphonesimulator SKIP_INSTALL=NO BUILD_LIBRARIES_FOR_DISTRIBUTION=YES 
 
xcodebuild -create-xcframework \
-framework "${output_path}/tmp/xcf/ios.xcarchive/Products/Library/Frameworks/${PROJECT_NAME}.framework" \
-framework "${output_path}/tmp/xcf/iossimulator.xcarchive/Products/Library/Frameworks/${PROJECT_NAME}.framework" \
-output "${output_path}/${PROJECT_NAME}.xcframework"

rm -rf "${output_path}/tmp/"

# 打开项目目录,项目名.framework文件就是我们要用的静态库
open "${PROJECT_DIR}"

执行上诉脚本之后,发现生成的xcframework文件,里面只有一个info.plist文件,查找资料发现:

xcodebuild archive -scheme ${PROJECT_NAME} -destination="iOS" -archivePath "${output_path}/tmp/xcf/ios.xcarchive" -derivedDataPath "${output_path}/tmp/iphoneos" -sdk iphoneos SKIP_INSTALL=NO BUILD_LIBRARIES_FOR_DISTRIBUTION=YES

脚本里BUILD_LIBRARIES_FOR_DISTRIBUTION=YES在实际运行时没有生效,解决方案是直接把项目主target里面Build Setting- BUILD_LIBRARIES_FOR_DISTRIBUTION 改为Yes,要注意是主target,不是专门运行脚本的target

最终,在项目${output_path}目录也就是根目录下,拿到了最终的xcframework文件。

XCFramework使用

XCFramework的使用方式和Framework一致,拖入项目即可,需要Xcode11以上支持;

XCFramework遇到的问题

拖入项目后,.swiftinterface文件编译无法通过,XXX is not a member type of XXX...

75276b544692f06420b16a0765ebcbf1.png

这是swift的一个bug,如果Framework里面有类型名称和module名一致,那么swiftinterface文件默认会把该名称指定为该类型,就会导致报错,

方案一: 修改swiftinterface文件使其编译通过

cd 到xcframework目录里面;执行删除脚本。

cd XXX.xcframework
find . -name "*.swiftinterface" -exec sed -i -e 's/XXX\.//g' {} \;

弊端:有可能误删什么不该删的代码,不用脚本手动去改又太麻烦。

方案二:修改module名或者修改与module重名的文件及类型

只需要修改到两者不一致,就能解决问题,方便快捷,不会出错。

弊端:如果是已发布的Framework,使用该Framework的开发者也需要进行相应的修改。

参考链接:

https://developer.apple.com/forums/thread/123253;

https://forums.swift.org/t/frameworkname-is-not-a-member-type-of-frameworkname-errors-inside-swiftinterface/28962

XCFramework制作Pod库

XCFramework制作pod库和Framework制作pod库没有本质的区别:

s.vendored_frameworks = 'YKBuryPoint/Framework_XC/*.xcframework'
#  s.user_target_xcconfig = { 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'arm64' }

因为XCFramework不需要删除模拟器Framework里面的arm64架构,所以也不需要加上

'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'arm64'这句。

XCFramework制作Pod库遇到的问题

使用环境:pod v1.10.1; Xcode v12.5;

module not found

直接安装本地开发库时,会提示这个,可以先看看pod有没有给什么错误提示,运行pod 验证命令:

 pod lib lint --verbose

会提示错误,根据错误进行修改;我的podspec文件配置的iOS版本是9.0,

  s.ios.deployment_target = '9.0'

但是我的XCFramework指定的版本是12.3:

IPHONEOS_DEPLOYMENT_TARGET = 12.3

打包出来的XCFramework,里面包含的架构会比pod需要的少,改为IPHONEOS_DEPLOYMENT_TARGET = 9.0,重新生成XCFramework,再去验证,就能通过了。

你可能感兴趣的:(swift SDK开发遇到的问题)