自定义 Cordova 插件：将框架添加到“嵌入式二进制文件”

Question

在自定义 Cordova 插件中，如何在 plugin.xml 中配置特定的 .framework 文件，以便将其添加到 Xcode 的“嵌入式二进制文件”部分？ 如果目前无法直接在 plugin.xml 中实现，我愿意接受其他建议。

Answer 1

要将库添加到 Xcode 中的“嵌入式二进制文件”部分（从 cordova-ios 4.4.0 和 cordova 7.0.0 开始），请将其放入您的 plugin.xml：

<framework src="src/ios/XXX.framework"   embed="true" custom="true" />

要在 Xcode 的“Linked Frameworks and Libraries”部分添加库， 把它放在你的 plugin.xml 中：

<source-file src="src/ios/XXX.framework" target-dir="lib" framework="true" />

它们可以同时存在。例如：

<!-- iOS Sample -->
<platform name="ios">
    ....
    <source-file src="src/ios/XXX.m"/>
    <source-file src="src/ios/XXX.framework" target-dir="lib" framework="true" />
    <framework src="src/ios/XXX.framework"   embed="true" custom="true" /> 
    ....  
</platform>


<!-- Android Sample for your reference -->
<platform name="android">
    ....
    <source-file src="src/android/XXX.java"/>
    <framework src="src/android/build.gradle" custom="true" type="gradleReference" />
    <resource-file src="src/android/SDK/libs/XXX.aar" target="libs/XXX.aar" />
    ....  
</platform>

Answer 2

embed="true" 从今天发布的cordova-ios 4.4.0 和cordova 7.0.0 开始支持。 https://cordova.apache.org/docs/en/latest/plugin_ref/spec.html#framework https://issues.apache.org/jira/browse/CB-11233

Answer 3

在 Cordova 的 plugin.xml 支持之前，我已经实施了一种解决方法，希望将来，一旦此类条目中的 embed 属性将具有相同的效果：<framework embed="true" src="..." />，目前，此属性没有帮助，因此有以下解决方法。

以下解决方案使用 Cordova 版本 5.3.3 工作。

首先，确保将框架条目添加到plugin.xml：

<framework src="pointToYour/File.framework" embed="true" />

embed="true" 暂时不起作用，但还是添加它。

我们要创建一个钩子，在你的 plugin.xml 中声明它：

<hook type="after_platform_add" src="hooks/embedframework/addEmbedded.js" />

接下来，我们在钩子的代码中需要一个特定的节点模块，该模块是node-xcode。

安装node-xcode（必须是0.8.7以上版本）：

npm i xcode

最后是钩子本身的代码 -

addEmbedded.js 文件：

'use strict';

const xcode = require('xcode'),
    fs = require('fs'),
    path = require('path');

module.exports = function(context) {
    if(process.length >=5 && process.argv[1].indexOf('cordova') == -1) {
        if(process.argv[4] != 'ios') {
            return; // plugin only meant to work for ios platform.
        }
    }

    function fromDir(startPath,filter, rec, multiple){
        if (!fs.existsSync(startPath)){
            console.log("no dir ", startPath);
            return;
        }

        const files=fs.readdirSync(startPath);
        var resultFiles = []
        for(var i=0;i<files.length;i++){
            var filename=path.join(startPath,files[i]);
            var stat = fs.lstatSync(filename);
            if (stat.isDirectory() && rec){
                fromDir(filename,filter); //recurse
            }

            if (filename.indexOf(filter)>=0) {
                if (multiple) {
                    resultFiles.push(filename);
                } else {
                    return filename;
                }
            }
        }
        if(multiple) {
            return resultFiles;
        }
    }

    function getFileIdAndRemoveFromFrameworks(myProj, fileBasename) {
        var fileId = '';
        const pbxFrameworksBuildPhaseObjFiles = myProj.pbxFrameworksBuildPhaseObj(myProj.getFirstTarget().uuid).files;
        for(var i=0; i<pbxFrameworksBuildPhaseObjFiles.length;i++) {
            var frameworkBuildPhaseFile = pbxFrameworksBuildPhaseObjFiles[i];
            if(frameworkBuildPhaseFile.comment && frameworkBuildPhaseFile.comment.indexOf(fileBasename) != -1) {
                fileId = frameworkBuildPhaseFile.value;
                pbxFrameworksBuildPhaseObjFiles.splice(i,1); // MUST remove from frameworks build phase or else CodeSignOnCopy won't do anything.
                break;
            }
        }
        return fileId;
    }

    function getFileRefFromName(myProj, fName) {
        const fileReferences = myProj.hash.project.objects['PBXFileReference'];
        var fileRef = '';
        for(var ref in fileReferences) {
            if(ref.indexOf('_comment') == -1) {
                var tmpFileRef = fileReferences[ref];
                if(tmpFileRef.name && tmpFileRef.name.indexOf(fName) != -1) {
                    fileRef = ref;
                    break;
                }
            }
        }
        return fileRef;
    }

    const xcodeProjPath = fromDir('platforms/ios','.xcodeproj', false);
    const projectPath = xcodeProjPath + '/project.pbxproj';
    const myProj = xcode.project(projectPath);

    function addRunpathSearchBuildProperty(proj, build) {
       const LD_RUNPATH_SEARCH_PATHS =  proj.getBuildProperty("LD_RUNPATH_SEARCH_PATHS", build);
       if(!LD_RUNPATH_SEARCH_PATHS) {
          proj.addBuildProperty("LD_RUNPATH_SEARCH_PATHS", "\"$(inherited) @executable_path/Frameworks\"", build);
       } else if(LD_RUNPATH_SEARCH_PATHS.indexOf("@executable_path/Frameworks") == -1) {
          var newValue = LD_RUNPATH_SEARCH_PATHS.substr(0,LD_RUNPATH_SEARCH_PATHS.length-1);
          newValue += ' @executable_path/Frameworks\"';
          proj.updateBuildProperty("LD_RUNPATH_SEARCH_PATHS", newValue, build);
       }
    }

    myProj.parseSync();
    addRunpathSearchBuildProperty(myProj, "Debug");
    addRunpathSearchBuildProperty(myProj, "Release");

    // unquote (remove trailing ")
    var projectName = myProj.getFirstTarget().firstTarget.name.substr(1);
    projectName = projectName.substr(0, projectName.length-1); //Removing the char " at beginning and the end.

    const groupName = 'Embed Frameworks ' + context.opts.plugin.id;
    const pluginPathInPlatformIosDir = projectName + '/Plugins/' + context.opts.plugin.id;

    process.chdir('./platforms/ios');
    const frameworkFilesToEmbed = fromDir(pluginPathInPlatformIosDir ,'.framework', false, true);
    process.chdir('../../');

    if(!frameworkFilesToEmbed.length) return;

    myProj.addBuildPhase(frameworkFilesToEmbed, 'PBXCopyFilesBuildPhase', groupName, myProj.getFirstTarget().uuid, 'frameworks');

    for(var frmFileFullPath of frameworkFilesToEmbed) {
        var justFrameworkFile = path.basename(frmFileFullPath);
        var fileRef = getFileRefFromName(myProj, justFrameworkFile);
        var fileId = getFileIdAndRemoveFromFrameworks(myProj, justFrameworkFile);

        // Adding PBXBuildFile for embedded frameworks
        var file = {
            uuid: fileId,
            basename: justFrameworkFile,
            settings: {
                ATTRIBUTES: ["CodeSignOnCopy", "RemoveHeadersOnCopy"]
            },

            fileRef:fileRef,
            group:groupName
        };
        myProj.addToPbxBuildFileSection(file);


        // Adding to Frameworks as well (separate PBXBuildFile)
        var newFrameworkFileEntry = {
            uuid: myProj.generateUuid(),
            basename: justFrameworkFile,

            fileRef:fileRef,
            group: "Frameworks"
        };
        myProj.addToPbxBuildFileSection(newFrameworkFileEntry);
        myProj.addToPbxFrameworksBuildPhase(newFrameworkFileEntry);
    }

    fs.writeFileSync(projectPath, myProj.writeSync());
    console.log('Embedded Frameworks In ' + context.opts.plugin.id);
};

这个钩子实际上做了什么：

1. 创建一个以您的插件 ID 命名的“构建阶段”，配置为“复制文件”，该副本的目标是“框架”。
2. 查找您的 .framework 文件并将其添加到上述构建阶段，然后将其嵌入。
3. 设置一个名为 LD_RUNPATH_SEARCH_PATHS 的 Xcode 构建属性以在 "@executable_path/Frameworks" 中查找嵌入式框架（这是嵌入式框架将在“复制文件”->“框架”构建阶段之后被复制到的位置
4. 通过为您的 .framework 文件设置“CodeSignOnCopy”和“RemoveHeadersOnCopy”来配置 ATTRIBUTES 键。
5. 从 FrameworksBuildPhase 中删除您的 .framework 文件并将它们重新添加到 FrameworksBuildPhase 作为新的分离的 PBXBuildFiles（相同的 PBXFileReference），必须这样做才能使“CodeSignOnCopy”具有任何含义，而不是删除它，如果您用 Xcode 打开项目，在构建阶段你不会发现它会签名的复选标记。

更新1：钩子代码，修改：

1. 挂钩会自动查找您的 .framework 文件，无需编辑挂钩。
2. 添加了一项重要修改，为您的 .framework 文件设置 ATTRIBUTES "CodeSignOnCopy" 和 "RemoveHeadersOnCopy"。
3. 改进了钩子，使其能够在多个插件使用此钩子的情况下工作。

更新 2

1. 由于我的pull request 已被接受，我不再需要安装我自己的 fork。
2. 改进的挂钩代码。

更新 3 (19/09/2016)

根据 Max Whaler 的建议修改了钩子脚本，因为我在 Xcode 8 上遇到了同样的问题。

最后说明

将应用上传到 AppStore 后，如果由于不支持的架构（i386 等...）而导致验证失败，请尝试以下 Cordova 插件（仅挂钩，无本机代码）：zcordova-plugin-archtrim

Answer 4

要让我的插件在 XCode 8.0 和 cordova-ios 4.2 上构建项目，我必须在 after_build 阶段运行挂钩。另外，请确保 node 环境使用的是最新版本的 xcode-node (^0.8.9)，否则您将在复制文件阶段遇到错误。

<framework src="lib/myCustom.framework" custom="true" embed="true" /> <hook type="after_build" src="hooks/add_embedded.js" />

plugin.xml 需要custom="true" 以便 Cordova 复制框架文件，当此挂钩在 after_platform add 甚至 after_prepare 中运行时，最终与对 .pbxproj 所做的更改发生冲突。

Answer 5

@Alon Amir，感谢分享，效果很好！虽然，我的应用程序在调试模式下运行完美，但在发布模式下却没有。我发现 LD_RUNPATH_SEARCH_PATHS 仅添加到调试模式，因为没有构建参数的 proj.getBuildProperty 采用第一个结果。我稍微修改了您的代码，使其在调试和发布模式下都可以工作：

function addRunpathSearchBuildProperty(proj, build) {
   const LD_RUNPATH_SEARCH_PATHS =  proj.getBuildProperty("LD_RUNPATH_SEARCH_PATHS", build);
   if(!LD_RUNPATH_SEARCH_PATHS) {
      proj.addBuildProperty("LD_RUNPATH_SEARCH_PATHS", "\"$(inherited) @executable_path/Frameworks\"", build);
   } else if(LD_RUNPATH_SEARCH_PATHS.indexOf("@executable_path/Frameworks") == -1) {
      var newValue = LD_RUNPATH_SEARCH_PATHS.substr(0,LD_RUNPATH_SEARCH_PATHS.length-1);
      newValue += ' @executable_path/Frameworks\"';
      proj.updateBuildProperty("LD_RUNPATH_SEARCH_PATHS", newValue, build);
   }
}

myProj.parseSync();
addRunpathSearchBuildProperty(myProj, "Debug");
addRunpathSearchBuildProperty(myProj, "Release");