Object.defineProperty用于覆盖只读属性

时间:2015-09-28 11:26:04

标签: javascript node.js properties ecmascript-6 prototype

在我们的NodeJS应用程序中,我们通过扩展默认的Error对象来定义自定义错误类:

"use strict";
const util = require("util");

function CustomError(message) {
    Error.call(this);
    Error.captureStackTrace(this, CustomError);
    this.message = message;
}

util.inherits(CustomError, Error);

这使我们能够throw CustomError("Something");正确显示堆栈跟踪,并且instanceof Errorinstanceof CustomError都能正常工作。

但是,为了在我们的API(通过HTTP)中返回错误,我们希望将错误转换为JSON。在错误上调用JSON.stringify()会导致"{}",这对消费者来说显然不具有描述性。

为了解决这个问题,我想到了覆盖CustomError.prototype.toJSON(),以返回带有错误名称和消息的对象文字。然后JSON.stringify()只会对此对象进行字符串化,并且一切都会很好用:

// after util.inherits call

CustomError.prototype.toJSON = () => ({
    name    : "CustomError",
    message : this.message
});

然而,我很快发现这会引发TypeError: Cannot assign to read only property 'toJSON' of Error。当我试图写入原型时,这可能是有意义的。所以我更改了构造函数:

function CustomError(message) {
    Error.call(this);
    Error.captureStackTrace(this, CustomError);
    this.message = message;
    this.toJSON = () => ({
        name    : "CustomError",
        message : this.message
    });
}

这种方式(我预期),将使用CustomError.toJSON函数,并且将忽略CustomError.prototype.toJSON(来自Error)。

不幸的是,这只会在对象构造时抛出错误:Cannot assign to read only property 'toJSON' of CustomError

接下来我尝试从文件中删除"use strict";,其中排序解决了问题,因为没有错误被抛出,尽管toJSON()函数没有被使用完全JSON.stringify()

此时我只是绝望,只是尝试随机的事情。最终,我最终使用Object.defineProperty()而不是直接分配到this.toJSON

function CustomError(message) {
    Error.call(this);
    Error.captureStackTrace(this, CustomError);
    this.message = message;
    Object.defineProperty(this, "toJSON", {
        value: () => ({
            name    : "CustomError",
            message : this.message
        })
    });

这完美无缺。在严格模式下,不会调用任何错误,JSON.stringify()会像我想要的那样返回{"name:" CustomError", "message": "Something"}

所以尽管它现在按照我想要的方式工作,但我仍然想知道:

  1. 为什么这完全奏效?我希望它相当于this.toJSON = ...,但显然不是。{/ li>
  2. 它应该像这样工作吗?即依赖这种行为是否安全?
  3. 如果没有,我应该如何正确覆盖toJSON方法? (如果可能的话)

2 个答案:

答案 0 :(得分:1)

由于我注意到您使用箭头功能,我将假设您可以访问ES6,这意味着您也可以访问类。

您只需扩展@Id @GeneratedValue(strategy=GenerationType.IDENTITY) @Column(name ="PERSON_ID") private int personId; 课程即可。例如:

答案 1 :(得分:1)

  

为什么这确切地起作用?

Object.defineProperty只定义一个属性(或改变其属性,如果它已经存在且可配置)。与赋值this.toJSON = …不同,它不关心任何继承,也不检查是否存在可能是setter或不可写的继承属性。

  

它应该像这样工作吗?即依赖这种行为是否安全?

是的,是的。可能你甚至可以在原型上使用它。

对于您的实际用例,给定最近的node.js版本,请使用extends Error的ES6类以获得最佳结果。