使用装饰器

时间:2015-11-25 11:16:16

标签: javascript typescript decorator ecmascript-next

我正在构建前端/后端数据结构之间的简单映射。为了做到这一点,我创建了一个类似于以下内容的装饰器:

function ApiField(
    apiKey: string,
    setFn: (any) => any = (ret) => ret,
    getFn: (any) => any = (ret) => ret
) {
    return function (target: AbstractModel, propertyKey: string) {
        target.apiFieldsBag = target.apiFieldsBag || {};
        _.assign(
            target.apiFieldsBag,
            {
                [propertyKey]: {
                    apiKey: apiKey,
                    setFn: setFn,
                    getFn: getFn
                }
            }
        );
    };
}

这就是我使用它的方式:

class AbstractCar {
    @ApiField('id')
    public id: string = undefined;
}

class BMW extends AbstractCar {
    @ApiField('cylinders')
    public cylinderCount: number;
}

class VW extends AbstractCar {
    @ApiField('yearCompanyFounded')
    public yearEstablished: number;
}

我所看到的问题是,不是将实际对象传递给装饰器,而是它始终是原型:

__decorate([
    ApiField('yearCompanyFounded')
], VW.prototype, "yearEstablished", void 0);

这意味着当我将东西分配给装饰器中的实例时,它总是附加到原型,这反过来意味着我想要仅定义VW实例的属性也可以在{ {1}}和AbstractCar类(在此示例中,这将是BMW)。这使得不可能在两个不同的类中具有两个具有相同名称但不同API字段的属性。

有没有办法规避这种行为?

2 个答案:

答案 0 :(得分:4)

问题是类中的public不是标准的JavaScript,它只是TypeScript所做的事情。因此,你必须要小心,因为你所做的任何事情都可能在将来破裂。

一种可能性是使用Object.assign()添加实例属性(IINM,apiFieldsBag应该从对象文字创建的对象转移到this):

class AbstractCar {
    constructor() {
        Object.assign(this, {
            @ApiField('id')
            id: undefined,
        });
    }
}

答案 1 :(得分:4)

现在,所有三个类都在向同一个对象添加属性。解决此问题的关键是克隆 target.data上的对象,以便每个类使用不同的对象,而不是所有对象引用同一个对象。

这是一个更简单的例子,演示了一种方法:

function ApiField(str: string) {
    return function (target: any, propertyKey: string) {
        // I tested with Object.assign, but it should work with _.assign the same way
        target.data = _.assign({}, target.data, {
            [propertyKey]: str
        });
    };
}

class AbstractCar {
    @ApiField("car")
    public carID;
}

class BMW extends AbstractCar {
    @ApiField("bmw")
    public bmwID;
}

class VW extends AbstractCar {
    @ApiField("vw")
    public vwID;
}

AbstractCar.prototype.data; // Object {carID: "car"}
BMW.prototype.data;         // Object {carID: "car", bmwID: "bmw"}
VW.prototype.data;          // Object {carID: "car", vwID: "vw"}