@private注释在 Google Closure JavaScript 代码中实际上做了什么

What does the @private annotation actually do in Google Closure JavaScript code?

本文关键字：实际上 什么 代码 JavaScript 注释 Google Closure @private      更新时间：2023-09-26

当我在我的变量或函数上方添加注释时，其中包含@private，它实际上在做什么？我已经查看了文档，但仍然不确定。

goog.provide('myproject');
/** @private */
myproject.foo = "bar";

当我打开chrome的开发工具（myproject.foo）时，我仍然可以访问它。 而且...

goog.require('myproject');
window.addEventListener('load', function() {
    //this works.
    document.body.textContent = myproject.foo;
});

上面的代码仍然将正文 textContent 设置为等于"bar"，即使在编译时也是如此。那么@private到底是做什么的呢？

访问控制

注释@private、@protected和@public是闭包编译器的指令，可帮助开发人员强制执行属性和函数所需的可见性级别。

若要发出访问冲突警告，请使用编译器标志：

    -
  • -jscomp_warning=可见性

若要发出访问冲突的错误，请使用编译器标志：

    -
  • -jscomp_error=可见性

访问控制注释基于每个文件强制执行，这意味着任何注释@private或@protected的属性可能是在同一文件中的任何位置访问。另请注意，编译器会删除这些来自编译代码的注释，因为它们不是JavaScript 语言。

例

文件1.js

goog.provide('ns1');
/**
 * Global private variable.
 * @private
 */
ns1.global = 'foo';
alert('ns1.global = ' + ns1.global); // OK in same file.

/** @constructor */
ns1.Constructor = function() {
  /** @private */
  this.secret_ = ns1.global;
};
ns1.instance = new ns1.Constructor();
alert(ns1.instance.secret_); // No warning in same file.

文件2.js

goog.provide('ns2');
goog.require('ns1');
alert('ns1.global = ' + ns1.global); // Not allowed.
ns2.instance2 = new ns1.Constructor();
alert(ns2.instance2.secret_); // Not allowed.

设置标志--jscomp_error=visibility后，闭包编译器发出以下错误。

ERROR - Access to private property global of ns1 not allowed here.
alert('ns1.global = ' + ns1.global);
                        ^
ERROR - Access to private property secret_ of ns1.Constructor not allowed here.
alert(ns2.instance2.secret_);
      ^

请参阅 Google JavaScript 中的可见性（私有和受保护字段）风格指南。

> cpeisert 在他的回答中暗示了这一点，但只是为了明确一点：这些可见性注释根本不会修改您的输出。

将函数标记为 @private 不会隐藏它，也不会使其在生成的代码中的可访问性低于编译器通常的可访问性，并且在运行时引入的任何第三方代码都可以调用此类函数。

这些注释提供的唯一访问保护是针对使用它们编译的代码。

相关文章：