需要在 ExtendScript 中对对象进行 JSON 字符串化

Question

我正在使用 ExtentdScript 处理我的 Indesign 文档链接的元数据信息。

我想使用将对象转换为字符串，JSON.stringify但是当我使用它时，我收到错误消息：

can't execute script in target engine.

如果我linkObjStr = JSON.stringify(linksInfObj); 从下面的代码中删除，那么一切正常。

与JSON.stringifyExtendScript 中的等价物是什么，或者是否有任何其他可能性来显示linksInfObj其正确的内容[object object]？

for (var i = 0, len = doc.links.length; i < len; i++) {

    var linkFilepath = File(doc.links[i].filePath).fsName;
    var linkFileName = doc.links[i].name;

    var xmpFile = new XMPFile(linkFilepath, XMPConst.FILE_INDESIGN, XMPConst.OPEN_FOR_READ);
    var allXMP = xmpFile.getXMP();

    // Retrieve values from external links XMP.
    var documentID = allXMP.getProperty(XMPConst.NS_XMP_MM, 'DocumentID', XMPConst.STRING);
    var instanceID = allXMP.getProperty(XMPConst.NS_XMP_MM, 'InstanceID', XMPConst.STRING);
    linksInfObj[linkFileName] = {'docId': documentID, 'insId': instanceID};
    linkObjStr = JSON.stringify(linksInfObj);

    alert('Object' + linksInfObj, true); // I am getting [Object Object] here
    alert('String' + linkObjStr, true);

}

Answer 1

ExtendScript 不包含具有相关解析方法的 JSON 对象，即JSON.parse()和JSON.stringify()。它也不提供用于解析 JSON 的任何其他内置功能。

解决方案：

考虑使用polyfill来提供 JSON 功能，例如Douglas Crockford 创建的JSON-js。

你需要做什么：

1. 从 Github 存储库下载名为json2.js的 JavaScript 文件，并将其保存在与文件相同的位置/文件夹中.jsx。

   注意如果您愿意，您可以从同一个 Github 存储库中复制并粘贴原始版本的 json2.js以手动创建json2.js文件。

2. 那么在当前的顶部.jsx文件，您需要#include在json2.js文件中加入以下代码行：

    #include "json2.js";
   

   这类似于您如何利用该import语句在现代 JavaScript (ES6) 中包含一个模块。

   一个路径名来的位置json2.js，如果你决定将文件保存在不同的位置/文件夹不是您可以提供.jsx文件。

3. 通过包含json2.js在您的.jsx文件中，您现在将拥有可用的 JSON 方法；JSON.parse()和JSON.stringify()。

例子：

以下 ExtendScript ( .jsx) 是一个工作示例，它生成 JSON 以指示与当前 InDesign 文档 ( .indd)关联的所有链接。

例子.jsx

#include "json2.js";

$.level=0;

var doc = app.activeDocument;

/**
 * Loads the AdobeXMPScript library.
 * @returns {Boolean} True if the library loaded successfully, otherwise false.
 */
function loadXMPLibrary() {
  if (!ExternalObject.AdobeXMPScript) {
    try {
      ExternalObject.AdobeXMPScript = new ExternalObject('lib:AdobeXMPScript');
    } catch (e) {
      alert('Failed loading AdobeXMPScript library\n' + e.message, 'Error', true);
      return false;
    }
  }
  return true;
}

/**
 * Obtains the values f XMP properties for `DocumentID` and `instanceID` in
 * each linked file associated with an InDesign document (.indd). A returns the
 * information formatted as JSON,
 * @param {Object} doc - A reference to the .indd to check.
 * @returns {String} - The information formatted as JSON.
 */
function getLinksInfoAsJson(doc) {
  var linksInfObj = {};

  linksInfObj['indd-name'] = doc.name;
  linksInfObj.location = doc.filePath.fsName;
  linksInfObj.links = [];

  for (var i = 0, len = doc.links.length; i < len; i++) {
    var linkFilepath = File(doc.links[i].filePath).fsName;
    var linkFileName = doc.links[i].name;

    var xmpFile = new XMPFile(linkFilepath, XMPConst.FILE_INDESIGN, XMPConst.OPEN_FOR_READ);
    var allXMP = xmpFile.getXMP();

    // Retrieve values from external links XMP.
    var documentID = allXMP.getProperty(XMPConst.NS_XMP_MM, 'DocumentID', XMPConst.STRING);
    var instanceID = allXMP.getProperty(XMPConst.NS_XMP_MM, 'InstanceID', XMPConst.STRING);

    // Ensure we produce valid JSON...
    // - When `instanceID` or `documentID` values equal `undefined` change to `null`.
    // - When `instanceID` or `documentID` exist ensure it's a String.
    instanceID = instanceID ? String(instanceID) : null;
    documentID = documentID ? String(documentID) : null;

    linksInfObj.links.push({
      'name': linkFileName,
      'path': linkFilepath,
      'docId': documentID,
      'insId': instanceID
    });
  }

  return JSON.stringify(linksInfObj, null, 2);
}

if (loadXMPLibrary()) {
 var linksJson = getLinksInfoAsJson(doc);
 $.writeln(linksJson);
}

输出：

运行上面的脚本会将类似于以下示例的 JSON 格式记录到您的控制台：

#include "json2.js";

$.level=0;

var doc = app.activeDocument;

/**
 * Loads the AdobeXMPScript library.
 * @returns {Boolean} True if the library loaded successfully, otherwise false.
 */
function loadXMPLibrary() {
  if (!ExternalObject.AdobeXMPScript) {
    try {
      ExternalObject.AdobeXMPScript = new ExternalObject('lib:AdobeXMPScript');
    } catch (e) {
      alert('Failed loading AdobeXMPScript library\n' + e.message, 'Error', true);
      return false;
    }
  }
  return true;
}

/**
 * Obtains the values f XMP properties for `DocumentID` and `instanceID` in
 * each linked file associated with an InDesign document (.indd). A returns the
 * information formatted as JSON,
 * @param {Object} doc - A reference to the .indd to check.
 * @returns {String} - The information formatted as JSON.
 */
function getLinksInfoAsJson(doc) {
  var linksInfObj = {};

  linksInfObj['indd-name'] = doc.name;
  linksInfObj.location = doc.filePath.fsName;
  linksInfObj.links = [];

  for (var i = 0, len = doc.links.length; i < len; i++) {
    var linkFilepath = File(doc.links[i].filePath).fsName;
    var linkFileName = doc.links[i].name;

    var xmpFile = new XMPFile(linkFilepath, XMPConst.FILE_INDESIGN, XMPConst.OPEN_FOR_READ);
    var allXMP = xmpFile.getXMP();

    // Retrieve values from external links XMP.
    var documentID = allXMP.getProperty(XMPConst.NS_XMP_MM, 'DocumentID', XMPConst.STRING);
    var instanceID = allXMP.getProperty(XMPConst.NS_XMP_MM, 'InstanceID', XMPConst.STRING);

    // Ensure we produce valid JSON...
    // - When `instanceID` or `documentID` values equal `undefined` change to `null`.
    // - When `instanceID` or `documentID` exist ensure it's a String.
    instanceID = instanceID ? String(instanceID) : null;
    documentID = documentID ? String(documentID) : null;

    linksInfObj.links.push({
      'name': linkFileName,
      'path': linkFilepath,
      'docId': documentID,
      'insId': instanceID
    });
  }

  return JSON.stringify(linksInfObj, null, 2);
}

if (loadXMPLibrary()) {
 var linksJson = getLinksInfoAsJson(doc);
 $.writeln(linksJson);
}

旁注：建模您的 JSON：

您会注意到 JSON 输出（上面）的结构与您在给定示例中尝试构建它的方式不同。主要区别在于您使用链接文件名作为属性/键名，例如以下示例：

有问题的 JSON 结构示例

{
  "indd-name": "foobar.indd",
  "location": "/path/to/the/document",
  "links":[
    {
      "name": "one.psd",
      "path": "/path/to/the/document/links/one.psd",
      "docId": "5E3AE91C0E2AD0A57A0318E078A125D6",
      "insId": "xmp.iid:0480117407206811AFFD9EEDCD311C32"
    },
    {
      "name": "two.jpg",
      "path": "/path/to/the/document/links/two.jpg",
      "docId": "EDC4CCF902ED087F654B6AB54C57A833",
      "insId": "xmp.iid:FE7F117407206811A61394AAF02B0DD6"
    },
    {
      "name": "three.png",
      "path": "/path/to/the/document/links/three.png",
      "docId": null,
      "insId": null
    }
  ]
}

像这个例子一样生成 JSON 并不理想，因为如果你有两个链接，它们都具有相同的名称，你只会报告其中一个。在一个对象中不能有两个具有相同名称的属性/键。

编辑：

作为对 OP 评论的回应：

嗨，RobC，除了使用之外#include 'json2.js'，还有其他方法可以在 JSX 文件中包含外部 js 文件吗？

有以下几种替代方法：

1. 你可以利用$.evalFile(). 例如替换#include "json2.js";为以下两行：

   {
     "one.psd": {
       "docId": "5E3AE91C0E2AD0A57A0318E078A125D6",
       "insId": "xmp.iid:0480117407206811AFFD9EEDCD311C32"
     },
     "two.jpg": {
       "docId": "EDC4CCF902ED087F654B6AB54C57A833",
       "insId": "xmp.iid:FE7F117407206811A61394AAF02B0DD6"
     }
     ...
   }
   

   注意：此示例假定json2.js与您的文件夹位于同一文件夹中.jsx

2. 或者，如果您想完全避免附加json2.js文件的存在。您可以在文件顶部添加IIFE（立即调用函数表达式）.jsx。然后将json2.js文件的内容复制粘贴进去。例如：

    var json2 = File($.fileName).path + "/" + "json2.js";
    $.evalFile(json2);
   

   注意：如果代码大小是一个问题，那么在将其粘贴到 IIFE 之前考虑缩小的内容json2.js。