使用 Google Closure 定义配置对象的最佳方法

Question

我喜欢 Google Closure 编译器如何优化代码中的符号。但是，我还没有找到一种好方法来定义将配置对象作为参数的公共导出函数。考虑以下代码片段：

goog.provide('foo');
goog.require('goog.dom');

/** @typedef {{
 *              id : string,
 *              clazz : string
 *           }}
 */
foo.config;

/**
 * Does some neat stuff
 * @param {foo.config} config
 */    
foo.myFoo = function(config) {
    var el = goog.dom.getElement(config.id);
    goog.dom.classes.add(el, config.clazz);
} 
goog.exportSymbol('foo.myFoo', foo.myFoo);

现在假设我们加载此脚本，并希望按如下方式调用 myFoo：

<script type="text/javascript">
foo.myFoo({
    id: 'unique-id',
    clazz: 'pretty'
});
</script>

如果编译，这将失败，因为 id 和 clazz 属性被压缩。

有谁知道使用 Google Closure 编译器实现和导出配置对象的优雅方法？

Answer 1

我的建议是简单地将参数注释为 {Object} 并引用键，如下所示：

foo.myFoo({
    'id': 'unique-id',
    'clazz': 'pretty'
});

...

/**
 * Does some neat stuff
 * @param {Object} config
 */    
foo.myFoo = function(config) {
    var el = goog.dom.getElement(config['id']);
    goog.dom.classes.add(el, config['clazz']);
} 

Answer 2

关于损坏的属性名称和原始属性名称的冲突

您必须执行以下任一操作：

• “外部”属性名称（以便它们不会被重命名）
• 使用“括号符号”来访问属性

关于配置对象

根据 Closure Compiler 文档，目前你还不能这样做。您必须将参数标记为对象。

您可以定义一个类型，但这对您没有帮助，因为类型需要所有属性都存在，但您只能在配置对象中设置几个参数。

Closure Compiler 文档建议您将参数标记为对象，但在注释中记录字段。