在 JavaScript 中实现 Ruby 的方法 Method

php中文网 2024-10-15 11:23:03

突然觉得ruby的methods方法是不是很方便呢？编写代码时，它会列出对象可用的所有方法和属性，并允许您搜索它们，这对于调试非常有用。

除此之外，它对于检查 rails 等框架特有的方法也很有效，有助于代码阅读和理解库。虽然参考官方文档或源代码是一种很好的做法，但当您不需要深入研究或对方法名称有模糊记忆时，methods 方法对于库非常有帮助。

ruby 的方法 method

简单介绍一下ruby的methods方法，长这样：

对象#方法

立即学习“Java免费学习笔记（深入）”；

返回 obj 的公共方法和受保护方法的名称列表。这将包括 obj 祖先中可访问的所有方法。如果可选参数为 false，则返回 obj 的公共和受保护单例方法的数组，该数组将不包含 obj 包含的模块中的方法。

换句话说，它返回一个由接收者可访问的属性和方法的数组对象。

该方法是在object类中实现的，object类是所有继承自object的类的祖先，因此可以在任何继承自object的类中使用。

示例代码

class hoge
  attr_accessor :fuga

  def bar
    puts ''
  end
end

puts hoge.new.methods     // =&gt; [:bar, :fuga=, :fuga, :hash, :singleton_class, :dup, ...]
puts hoge.new.grep /fuga/ // =&gt; [:fuga=, :fuga]

如示例所示，它返回一个array对象，所以你也可以使用grep方法搜索方法列表，非常方便。

所以，我就想是否可以用js来实现，并尝试了一下。

执行

下面是实际代码。

类名可以是任何名称，但我现在将其命名为 propertyfinder。

class propertyfinder {
    constructor(receiver) {
      this.receiver = receiver
    }

    grep(regexp, options = {}) {
      let res = []
      if (typeof regexp === 'string') {
        return this.find((name) =&gt; name.includes(regexp))
      }
      if (regexp instanceof regexp) {
        return this.find((name) =&gt; regexp.test(name))
      }
      return []
    }

    tostring() {
      return this.find(() =&gt; true)
    }

    find(detect) {
      const list = object.getownpropertynames(this.receiver).filter(it =&gt; detect(it))
      if (!this.receiver.__proto__) {
        return list
      }
      const ancestors = new propertyfinder(this.receiver.__proto__).find(detect)
      return [...list, ...ancestors]
    }
}

我稍后会解释代码，但让我们先从如何使用它开始。

定义类后，您可以向 object 类的属性添加方法，如下所示：

object.prototype.methods = function () {
    return new propertyfinder(this)
}

通过这样做，您可以在继承自object的类的实例上使用methods方法。但是，请注意下面的注意事项，并自行承担使用风险。

以下是一些执行示例：

class hoge {
  fuga() {
    console.log('fuga')
  }
}

console.log(new object().methods().tostring()) // =&gt; ['constructor', 'constructor', '__definegetter__', '__definesetter__', 'hasownproperty' ...]
console.log([].methods().tostring())           // =&gt; ['length', 'length', 'constructor', 'at', 'concat', ...]
console.log(new hoge().methods().grep(/fuga/)  // =&gt; ['fuga']

安全介绍

*此代码不建议在生产环境使用*

通过猴子修补向更高级别的类添加属性是一种反模式，可能会导致未来 js 规范的变化出现问题。请谨慎使用并自行承担风险。

参考：猴子补丁的缺点

代码说明

现在，让我们继续解释代码。

propertyfinder 中最重要的方法是 find 方法。该方法遍历给定对象的原型链，搜索可访问的属性，并将它们作为列表返回。

tostring 和 grep 方法只是使用 find，因此不需要进一步解释。

原型链

原型链可能有些人不熟悉，但它是object类属性的继承。

继承与原型链 | mdn

mdn 文档中有详细介绍，但 javascript 的继承机制是通过原型链来支持的。

虽然并不总是显而易见，但当提到某些属性时，该过程涉及：

检查接收者本身是否有属性。
检查父类实例是否有该属性。
检查父类实例的父类中是否存在该属性。

此过程沿着链向上继续，直到找到匹配项，然后将其返回。

find 方法的作用

鉴于上述情况，propertyfinder 中的 find 方法实现了这种机制，允许您通过递归探索 __proto__ 来获取属性列表。

这是通过递归探索 __proto__ 来获取列表来实现此目的的实现：

    find(detect) {
      const list = Object.getOwnPropertyNames(this.receiver).filter(it =&gt; detect(it))
      if (!this.receiver.__proto__) {
        return list
      }
      const ancestors = new PropertyFinder(this.receiver.__proto__).find(detect)
      return [...list, ...ancestors]
    }

propertyfinder 的说明就到此结束了。