Flutter团队开发安装路径不一致时编译失败的问题(iOS)

从年初开始在项目中引入flutter,用其实现了部分简单的页面。团队中Pod的使用和主流有些不一样,git是不忽略Pods目录的😆。
通过pod引入Flutter module后,Pod中Flutter相关的Targrt中会写入Flutter.xcframework的绝对路径,所以不同的电脑上如果Flutter安装路径不同,就会编译报错,找不到Flutter.xcframework

有比较简单的解决方案

  1. Pods文件夹不要上传到git
  2. 确保各电脑的flutter安装路径统一,比如都是Users/flutter/

我们想学习下flutter的构建方式,因此决定通过编写脚本的方式解决这个问题

通过分析,看到路径的配置是在xxxxxx/flutter/packages/flutter_tools/bin/podhelper.rb这个脚本中(省略了无关的代码)

def flutter_additional_ios_build_settings(target)
    ...
  artifacts_dir = File.join('..', '..', '..', '..', 'bin', 'cache', 'artifacts', 'engine')
  debug_framework_dir = File.expand_path(File.join(artifacts_dir, 'ios', 'Flutter.xcframework'), __FILE__)
  release_framework_dir = File.expand_path(File.join(artifacts_dir, 'ios-release', 'Flutter.xcframework'), __FILE__)
  ...
  target.build_configurations.each do |build_configuration|
        ...
    # Skip other updates if it's not a Flutter plugin (transitive dependency).
    next unless target.dependencies.any? { |dependency| dependency.name == 'Flutter' }
    ...
    # Profile can't be derived from the CocoaPods build configuration. Use release framework (for linking only).
    configuration_engine_dir = build_configuration.type == :debug ? debug_framework_dir : release_framework_dir
    Dir.new(configuration_engine_dir).each_child do |xcframework_file|
      next if xcframework_file.start_with?('.') # Hidden file, possibly on external disk.
      if xcframework_file.end_with?('-simulator') # ios-arm64_x86_64-simulator
        build_configuration.build_settings['FRAMEWORK_SEARCH_PATHS[sdk=iphonesimulator*]'] = "\"#{configuration_engine_dir}/#{xcframework_file}\" $(inherited)"
      elsif xcframework_file.start_with?('ios-') # ios-arm64
        build_configuration.build_settings['FRAMEWORK_SEARCH_PATHS[sdk=iphoneos*]'] = "\"#{configuration_engine_dir}/#{xcframework_file}\" $(inherited)"
       # else Info.plist or another platform.
      end
    end
   ...
  end
end

如果能够修改这里脚本写入的路径,比如debug_framework_dir = File.join("$(Flutter_Install_Path)", 'bin', 'cache', 'artifacts', 'engine', 'ios', 'Flutter.xcframework'),然后只需要在xcconfig中定义不同的Flutter_Install_Path就可以解决问题了。

但是修改flutter中的脚本是比较危险的操作,因此决定通过编写脚本再次修改掉flutter写入的Flutter.xcframework路径。
方案还是比较简单的,下面直接给出步骤:

  1. 在Podfile同级目录创建一个文件Flutter_Path.xcconfig,写入自己电脑上Flutter安装路径kv (这个文件是不需要加入git的)

    Flutter_Install_Path = /Users/dadadongl/flutter
    
  2. 修改Podfile中的脚本

    # 修改前
    post_install do |installer|  
      flutter_post_install(installer) if defined?(flutter_post_install)
    end
    

    修改后

     post_install do |installer|
       # 先执行flutter正常的脚本
       flutter_post_install(installer) if defined?(flutter_post_install)
     
       # 注入环境变量 & 修改flutter默认写入的framework search path
    
       # 遍历Pod中的Targets
       installer.pods_project.targets.each do |target|
     
         # 修改flutter.xcframework的引用路径配置 (后面这段脚本基本是基于flutter的脚本修改的,做到改动最少)
         # 跳过没有依赖'Flutter'的target
         next unless target.dependencies.any? { |dependency| dependency.name == 'Flutter' }
    
         # 构造使用了环境变量$(Flutter_Install_Path)"的search path
         debug_framework_dir = File.join("$(Flutter_Install_Path)", 'bin', 'cache', 'artifacts', 'engine', 'ios', 'Flutter.xcframework')
         release_framework_dir = File.join("$(Flutter_Install_Path)", 'bin', 'cache', 'artifacts', 'engine', 'ios-release', 'Flutter.xcframework')
         # 解析自定义的xcconfig文件,为了拿到Flutter安装路径
         xcconfig = Xcodeproj::Config.new("./Flutter_Path.xcconfig")
         flutter_DIR = xcconfig.attributes["Flutter_Install_Path"]
         
         # 拿到Flutter的安装绝对路径
         full_debug_framework_dir = File.join(flutter_DIR, 'bin', 'cache', 'artifacts', 'engine', 'ios', 'Flutter.xcframework')
         full_release_framework_dir = File.join(flutter_DIR, 'bin', 'cache', 'artifacts', 'engine', 'ios-release', 'Flutter.xcframework')
         
         # 遍历Target下的配置环境(Debug 、Release)
         target.build_configurations.each do |build_configuration|
           
           # 追加自定义环境变量到 Pod 库的 .xcconfig 文件,为了编译时能够识别$(Flutter_Install_Path)
           xcconfig_path = build_configuration.base_configuration_reference.real_path
           # 这里导入时相对pod.debug.xcconfig的路径
           File.write(xcconfig_path, "#include \"../../../Flutter_Path.xcconfig\"", mode: 'a')
           
           # 修改 FRAMEWORK_SEARCH_PATHS
           configuration_engine_dir = build_configuration.type == :debug ? debug_framework_dir : release_framework_dir
           full_configuration_engine_dir = build_configuration.type == :debug ? full_debug_framework_dir : full_release_framework_dir
          
           Dir.new(full_configuration_engine_dir).each_child do |xcframework_file|
             next if xcframework_file.start_with?('.') # Hidden file, possibly on external disk.
             
             if xcframework_file.end_with?('-simulator') # ios-arm64_x86_64-simulator
               build_configuration.build_settings['FRAMEWORK_SEARCH_PATHS[sdk=iphonesimulator*]'] = "\"#{configuration_engine_dir}/#{xcframework_file}\" $(inherited)"
             elsif xcframework_file.start_with?('ios-') # ios-arm64
               build_configuration.build_settings['FRAMEWORK_SEARCH_PATHS[sdk=iphoneos*]'] = "\"#{configuration_engine_dir}/#{xcframework_file}\" $(inherited)"
               # else Info.plist or another platform.
             end
           end 
         end
       end
     end
    
  3. 重新执行Pod install

通过上述步骤后,就会把Flutter_Install_Path = /Users/dadadongl/flutter注入各Pod Target,然后修改后的framework search path就可以找到正确的路径,并成功编译。

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

推荐阅读更多精彩内容