iOS Widget 及将Widget打成framework动态库给别人使用

背景:负责Widget同事需要研究其它问题,导致前期Widget项目需要找人承接。 代码熟悉了几天,就接到需求,需要把widget独立封装成framework供客户使用,下面就是抽丝化简的过程。

一、制作framework

1.在现有项目中新建framework实现打包

创建framework
  • 在项目工程中建framework的好处是不用再为切到哪个项目犯愁,另外一个方便后续打出的widget framework验证方便。

2.新建完framework之后的效果如下:

framework效果

3.新建的framework包含PateoWidgetSDK.hInfo.plist两个文件,这时候就需要把需要打包的代码拖入新建的文件夹中,(如上图PateoWidgetSDK文件夹中)。

4.将需要打包代码中使用到图片新建bundle用来存储图片,不使用Assets.xcassets,新建之后将bundle添加到Copy Bundle Resources中,这样编译之后的framework中就包含资源bundle了。

新建bundle

5.将需要打包的头文件添加到Header -->Public中,如果是生成Dynamic Library 库,这里就需要包含所有的.h文件(动态库不支持桥接文件)

暴露头文件

6.切记如果库中是OCSwiftSwiftUI混编的话,.Swift文件不需要暴露出去,需要在需要暴露的方法或者属性前声明Public,这样swift的方法或者属性就可以被外部访问到。

Swift public 声明

7.配置编译环境

a.将Mach-O Type设为Dynamic Library, framework可以是动态库也可以是静态库;
选中PateoWidgetSDK->Build Settings->Mach-O Type(搜索mach)
b.Build Active Architecture Only 修改为NO, 否则生成的库就只支持当前设备的架构;
c.iOS Deployment Target, 库需要支持的最低版本号要小于等于主项目的版本号
d.Architectures 支持的iOS的CPU架构,默认支持arms64和arms7(arms7兼容arm7s),不需要修改。

8.分别选择Any iOS Device和模拟器编译,然后切换编译环境,Debug和Release再编译一遍,这样就会生成4个包,如果需要生成通用库需要使用终端命令实现,这个过程很繁琐。

切换环境编译

切换设备编译

9..由于第(6)步很繁琐,可以新建Aggregate脚本来生成包,具体怎么新建这里就不赘述了,脚本如下:

# Type a script or drag a script file from your workspace to insert its path.
# Sets the target folders and the final framework product.
FMK_NAME=${PROJECT_NAME}

# Install dir will be the final output to the framework.
# The following line create it in the root folder of the current project.
INSTALL_BASE_DIR=${SRCROOT}/Products
INSTALL_DIR=${INSTALL_BASE_DIR}/${FMK_NAME}.framework

# Working dir will be deleted after the framework creation.
WRK_DIR=build
DEVICE_DIR=${WRK_DIR}/Release-iphoneos/${FMK_NAME}.framework
SIMULATOR_DIR=${WRK_DIR}/Release-iphonesimulator/${FMK_NAME}.framework

# -configuration ${CONFIGURATION}
# Clean and Building both architectures.
xcodebuild BITCODE_GENERATION_MODE=bitcode OTHER_CFLAGS="-fembed-bitcode" -arch "arm64" -configuration "Release" -target "${FMK_NAME}" -sdk iphoneos build
xcodebuild BITCODE_GENERATION_MODE=bitcode OTHER_CFLAGS="-fembed-bitcode" -arch "i386" -configuration "Release" -target "${FMK_NAME}" -sdk iphonesimulator build

# Cleaning the oldest.
if [ -d "${INSTALL_DIR}" ]
then
rm -rf "${INSTALL_DIR}"
fi

mkdir -p "${INSTALL_DIR}"

![上传到公司公网仓库中.png](https://upload-images.jianshu.io/upload_images/3346949-2150764d01d386eb.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
cp -R "${DEVICE_DIR}/" "${INSTALL_DIR}/"

# Uses the Lipo Tool to merge both binary files (i386 + armv6/armv7) into one Universal final product.
lipo -create "${DEVICE_DIR}/${FMK_NAME}" "${SIMULATOR_DIR}/${FMK_NAME}" -output "${INSTALL_DIR}/${FMK_NAME}"

rm -r "${WRK_DIR}"

# Open product dir
open "${INSTALL_BASE_DIR}"

10.还有个重要的点,framework动态库打包不支持-Bridge桥接文件,编译生成的framework中你会发现多了一个PateoWidgetSDK-Swift.h,这个文件就是编译动态库PateoWidgetSDK.framework时系统生成的桥接文件。

编译生成的framework多了一个PateoWidgetSDK-Swift.h

二、使用framework

方式一:本地集成framework

新建target,直接使用framework

-这里就能体现在同一个项目中新建framework编译库的方便之处了,可以直接link到Product中的PateoWidgetSDK.framework,这样就省去拖动framework到其他项目的过程,而且还可以做到快速编译,查找问题。

方式二:pod集成framework

-1.新建PateoWidgetSDK.podspec文件

#
#  Be sure to run `pod spec lint PateoWidget.podspec' to ensure this is a
#  valid spec and to remove all comments including this before submitting the spec.
#
#  To learn more about Podspec attributes see https://guides.cocoapods.org/syntax/podspec.html
#  To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
#

Pod::Spec.new do |spec|

  # ―――  Spec Metadata  ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  These will help people to find your library, and whilst it
  #  can feel like a chore to fill in it's definitely to your advantage. The
  #  summary should be tweet-length, and the description more in depth.
  #

  spec.name         = "PateoWidgetSDK"
  spec.version      = "0.0.1"
  spec.summary      = "Pateo Widget aodi SDK"

  # This description is used to generate tags and improve search results.
  #   * Think: What does it do? Why did you write it? What is the focus?
  #   * Try to keep it short, snappy and to the point.
  #   * Write the description between the DESC delimiters below.
  #   * Finally, don't worry about the indent, CocoaPods strips it!

  spec.description  = "Pateo Widget aodi SDK"

  spec.homepage     = "http://www.xiafanty.com:37990/scm/pateo/pateowidgetsdk"
  # spec.screenshots  = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"


  # ―――  Spec License  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Licensing your code is important. See https://choosealicense.com for more info.
  #  CocoaPods will detect a license file if there is a named LICENSE*
  #  Popular ones are 'MIT', 'BSD' and 'Apache License, Version 2.0'.
  #

  spec.license      = "MIT"
  # spec.license      = { :type => "MIT", :file => "FILE_LICENSE" }


  # ――― Author Metadata  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the authors of the library, with email addresses. Email addresses
  #  of the authors are extracted from the SCM log. E.g. $ git log. CocoaPods also
  #  accepts just a name if you'd rather not provide an email address.
  #
  #  Specify a social_media_url where others can refer to, for example a twitter
  #  profile URL.
  #

  spec.author             = { "xxx" => "输入邮箱" }
  # spec.social_media_url   = "https://twitter.com/Simon"

  # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If this Pod runs only on iOS or OS X, then specify the platform and
  #  the deployment target. You can optionally include the target after the platform.
  #

  # spec.platform     = :ios
  # spec.platform     = :ios, "9.0"

  #  When using multiple platforms
  # spec.ios.deployment_target = "5.0"
  # spec.osx.deployment_target = "10.7"
  # spec.watchos.deployment_target = "2.0"
  # spec.tvos.deployment_target = "9.0"


  # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the location from where the source should be retrieved.
  #  Supports git, hg, bzr, svn and HTTP.
  #

  spec.source       = { :git => "http://www.xiafanty.com:37990/scm/pateo/pateowidgetsdk.git", :tag => "#{spec.version}" }


  # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  CocoaPods is smart about how it includes source code. For source files
  #  giving a folder will include any swift, h, m, mm, c & cpp files.
  #  For header files it will include any header in the folder.
  #  Not including the public_header_files will make all headers public.
  #

  #spec.source_files  = "PateoWidgetSDK/**/*.{h,m}"
  # spec.exclude_files = "PateoWidgetSDK/Exclude"

  # spec.public_header_files = "PateoWidgetSDK/**/*.{h,m}"
  # spec.prefix_header_file = 'prefix.pch'

  # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  A list of resources included with the Pod. These are copied into the
  #  target bundle with a build phase script. Anything else will be cleaned.
  #  You can preserve files from being cleaned, please don't preserve
  #  non-essential files like tests, examples and documentation.
  #

   #spec.resource  = "./PateoWidgetSDK.framework/PateoWidgetSDK.bundle"
  
  spec.resource_bundle = { 'ResourceBundle' => ['PateoWidgetSDK.framework/PateoWidgetSDK.bundle'] }
  # spec.resources = "Resources/*.png"

  # spec.preserve_paths = "FilesToSave", "MoreFilesToSave"


  # ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Link your library with frameworks, or libraries. Libraries do not include
  #  the lib prefix of their name.
  #

  # spec.framework  = "SomeFramework"
  # spec.frameworks = "SomeFramework", "AnotherFramework"

  # spec.library   = "iconv"
  # spec.libraries = "iconv", "xml2"
  
  spec.vendored_frameworks = 'PateoWidgetSDK.framework'
 

  # ――― Project Settings ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If your library depends on compiler flags you can set them in the xcconfig hash
  #  where they will only apply to your library. If you depend on other Podspecs
  #  you can include multiple dependencies to ensure it works.

  # spec.requires_arc = true

  spec.xcconfig = {
  'ENABLE_BITCODE' => 'NO',
  'VALID_ARCHS' => 'arm64 arm64e'
  }
end

-2.书写PateoWidgetSDK集成.md集成文档
-3.上传framework到公司公网仓库,这样别人就可以直接通过pod集成

上传到公司公网仓库中

-4.pod集成后使用如下:
pod集成后使用

注意头文件使用方式,导入的PateoWidgetSDK其实就是上面系统生成的PateoWidgetSDK-Swift.h桥接文件

三、注意事项:

1.bundle资源文件获取,打包生成的framework添加到项目中并没有把bundle文件添加到Copy Bundle Resources中,这就导致使用[UIBundle mainBundle]获取不到framework中的PateoWidgetSDK.Bundle,我使用了很多方法都不能同时兼容本地集成和pod集成,网上也很多方式,最终我使用如下方式实现了,这里仅供参考:

// 读取Bundle中的图片路径
#define QG_IMAGE_PATH(name,type) [[NSBundle bundleWithPath:[[NSBundle bundleForClass:[self class]] pathForResource:@"PateoWidgetSDK" ofType:@"bundle"]] pathForResource:name ofType:type]
//定义UIImage对象 需要显示全称,包括.png
#define QG_IMAGE(imageName) [UIImage imageNamed:QG_IMAGE_PATH(imageName,@"png")]

时间紧促,由于我只使用到png文件,我就写死了,还可以写个方法兼容一下

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容