在 post_install Podfile 挂钩中删除链接的 Pods_framework

Posted 2023-02-23

【中文标题】在 post_install Podfile 挂钩中删除链接的 Pods_framework

【英文标题】：Removing linked Pods_framework in post_install Podfile hook

【发布时间】：2021-04-09 02:57:59

【问题描述】：

我目前在flutter ios/android开发过程中遇到以下情况：

每次flutter build 运行时，它都会执行pod install，它会安装常规的 Flutter Podfile

# Uncomment this line to define a global platform for your project
platform :ios, '10.0'

# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
ENV['COCOAPODS_DISABLE_STATS'] = 'false'

project 'Runner', 
  'Debug' => :debug,
  'Profile' => :release,
  'Release' => :release,


def parse_KV_file(file, separator='=')
  file_abs_path = File.expand_path(file)
  if !File.exists? file_abs_path
    return [];
  end
  generated_key_values = 
  skip_line_start_symbols = ["#", "/"]
  File.foreach(file_abs_path) do |line|
    next if skip_line_start_symbols.any?  |symbol| line =~ /^\s*#symbol/ 
    plugin = line.split(pattern=separator)
    if plugin.length == 2
      podname = plugin[0].strip()
      path = plugin[1].strip()
      podpath = File.expand_path("#path", file_abs_path)
      generated_key_values[podname] = podpath
    else
      puts "Invalid plugin specification: #line"
    end
  end
  generated_key_values
end

target 'Runner' do
  use_frameworks!
  use_modular_headers!

  # Flutter Pod

  copied_flutter_dir = File.join(__dir__, 'Flutter')
  copied_framework_path = File.join(copied_flutter_dir, 'Flutter.framework')
  copied_podspec_path = File.join(copied_flutter_dir, 'Flutter.podspec')
  unless File.exist?(copied_framework_path) && File.exist?(copied_podspec_path)
    # Copy Flutter.framework and Flutter.podspec to Flutter/ to have something to link against if the xcode backend script has not run yet.
    # That script will copy the correct debug/profile/release version of the framework based on the currently selected Xcode configuration.
    # CocoaPods will not embed the framework on pod install (before any build phases can generate) if the dylib does not exist.

    generated_xcode_build_settings_path = File.join(copied_flutter_dir, 'Generated.xcconfig')
    unless File.exist?(generated_xcode_build_settings_path)
      raise "Generated.xcconfig must exist. If you're running pod install manually, make sure flutter pub get is executed first"
    end
    generated_xcode_build_settings = parse_KV_file(generated_xcode_build_settings_path)
    cached_framework_dir = generated_xcode_build_settings['FLUTTER_FRAMEWORK_DIR'];

    unless File.exist?(copied_framework_path)
      FileUtils.cp_r(File.join(cached_framework_dir, 'Flutter.framework'), copied_flutter_dir)
    end
    unless File.exist?(copied_podspec_path)
      FileUtils.cp(File.join(cached_framework_dir, 'Flutter.podspec'), copied_flutter_dir)
    end
  end

  # Keep pod path relative so it can be checked into Podfile.lock.
  pod 'Flutter', :path => 'Flutter'

  # Plugin Pods

  # Prepare symlinks folder. We use symlinks to avoid having Podfile.lock
  # referring to absolute paths on developers' machines.
  system('rm -rf .symlinks')
  system('mkdir -p .symlinks/plugins')
  plugin_pods = parse_KV_file('../.flutter-plugins')
  plugin_pods.each do |name, path|
    symlink = File.join('.symlinks', 'plugins', name)
    File.symlink(path, symlink)
    pod name, :path => File.join(symlink, 'ios')
  end
end

target 'OneSignalNotificationServiceExtension' do
  use_frameworks!
  pod 'OneSignal', '>= 2.9.3', '< 3.0'
end

如在最后看到的在我的应用程序中启用 OneSignal 推送通知，我添加了 OneSignalNotificationServiceExtension。由于 Flutter Runner 需要 use_frameworks!，所以我也必须将此行添加到 OneSignal Extension 目标中。

这会导致在我的 OneSignal 目标（“Pods_OneSignalNotificationServiceExtension.framework”）上的“常规”>“框架和库”下包含以下文件： wrongly linked file

但是这个文件可能不存在所以构建失败。

如果我从 XCode 中手动删除此文件，则构建工作正常。

但是由于从我的 IDE 以调试模式运行 Flutter 再次运行 pod install，我无法删除此链接，所以我的想法是在 Podfile 内的 post_install 挂钩中自动删除。

但由于我对 Ruby 不是很熟悉，也似乎无法在此回调中找到有关方法/属性的良好文档，所以我无法让它工作。

这是我迄今为止尝试过的一些方法：

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['ENABLE_BITCODE'] = 'NO'
    end
    
    if target.name == 'Pods-OneSignalNotificationServiceExtension'
      all_filerefs = installer.pods_project.files
      all_filerefs.each do |fileref|
        #puts(fileref.path)
        if fileref.path.end_with? "Pods_OneSignalNotificationServiceExtension.framework"
         puts("Found Pods_OneSignalNotificationServiceExtension.framework fileref.")
         build_phase = target.frameworks_build_phase
         #puts("Determining if build phase needs correction.")
         
         #all_filerefs.delete(fileref)
         build_phase.remove_file_reference(fileref)
         puts("Removing Pods_OneSignalNotificationServiceExtension.framework from OneSignalNotificationServiceExtension target")
        end
      end
    end
  end
end

但是从all_filerefs 和build_phase.remove_file_reference 中删除它都不是很有效。有谁知道我如何从 XCode 的“框架和库”部分访问链接文件以及如何删除所述 .framework-file？

非常感谢！

【参考方案1】：

通过正确的谷歌搜索，我设法找到了关于此主题的单个结果：https://titanwolf.org/Network/Articles/Article?AID=18711f19-4d55-49b9-a49e-8c4652dc0262#gsc.tab=0

我已经从“第四，添加或删除框架到目标”中获取了他的功能

def updateCustomFramework(project,target,path,name,command)

    # Get useful variables
    frameworks_group = project.groups.find  |group| group.display_name == 'Frameworks' 
    frameworks_build_phase = target.build_phases.find  |build_phase| build_phase.to_s == 'FrameworksBuildPhase' 
    embed_frameworks_build_phase = nil
    target.build_phases.each do |phase|
        if phase.display_name == 'Embed Frameworks'
            embed_frameworks_build_phase = phase
        end
        # puts phase
    end

    if command == :add
        # Add new "Embed Frameworks" build phase to target
        if embed_frameworks_build_phase.nil?
            embed_frameworks_build_phase = project.new(Xcodeproj::Project::Object::PBXCopyFilesBuildPhase)
            embed_frameworks_build_phase.name = 'Embed Frameworks'
            embed_frameworks_build_phase.symbol_dst_subfolder_spec = :frameworks
            target.build_phases << embed_frameworks_build_phase
        end

        # Add framework search path to target
        ['Debug', 'Release'].each do |config|
            paths = ['$(inherited)', path]
            orgpath = target.build_settings(config)['FRAMEWORK_SEARCH_PATHS']
            if orgpath.nil?
                puts "path is empty----------"
                target.build_settings(config)['FRAMEWORK_SEARCH_PATHS'] = paths
        else
                puts "path is not empty----------"
                paths.each do |p|
                    if !orgpath.include?(p)
                        orgpath << p
                    end
                end
            end
        end

        # Add framework to target as "Embedded Frameworks"
        framework_ref = frameworks_group.new_file("#path#name")
        exsit = false
        embed_frameworks_build_phase.files_references.each do |ref|
            if ref.name = name
                exsit = true
            end
        end
        if !exsit
            build_file = embed_frameworks_build_phase.add_file_reference(framework_ref)
            frameworks_build_phase.add_file_reference(framework_ref)
            build_file.settings =  'ATTRIBUTES' => ['CodeSignOnCopy'] 
        end
    else
        frameworks_build_phase.files_references.each do |ref|
            #puts(ref.path)
            if ref.path == "#name"
                puts "delete #name"
                frameworks_build_phase.remove_file_reference(ref)
                #embed_frameworks_build_phase.remove_file_reference(ref)
                break
            end
        end
        
    end

end

并且仅将if ref.name == "#name" 更改为if ref.path == "#name"。 我还意识到我不能使用installer 中的pods_projects，但需要自己打开xcodeproj 文件。这是我最终的post_install 脚​​本：

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['ENABLE_BITCODE'] = 'NO'
    end
  end
  
  project_path = 'Runner.xcodeproj'
  project = Xcodeproj::Project.open(project_path) # Opening the Runner.xcodeproj in the same folder as the Podfile
  project.targets.each do |target|
    if target.name == "OneSignalNotificationServiceExtension" # Find the OneSignal Target
      updateCustomFramework(project, target, '', 'Pods_OneSignalNotificationServiceExtension.framework', ':remove') # Run the function on the target with the framework name
    end
  end
  project.save() # Don't forget to save the project, or the changes won't stay
end

之后flutter clean 是必要的，然后flutter build 就像一个魅力。希望将来这可以为某人节省 6 个小时的时间。