骨干和打字稿,不幸的婚姻:构建类型安全“搞定”?(Backbone and TypeScript,

2019-08-17 09:36发布

我试图用打字稿与Backbone.js的。 它“作品”,但许多类型的安全是由骨干的get()和()设置丢失。 我想写这将恢复类型安全的辅助方法。 事情是这样的:

我把这个在我的模型:

object() : IMyModel  {
    return attributes; // except I should use get(), not attributes, per documentation
}

这在消费者: var myVar = this.model.object().MyProperty;

有了这个语法,我得到myProperty的存在,是布尔打字稿的知识,这是真棒。 然而, Backbone.js的文档告诉我使用get和set,而不是直接的属性乱码。 那么,有没有通过get和set正确任何魔法的Javascript方式到该对象的管道用法?

Answer 1:

我们使用的骨干与打字稿巨资,并想出了一个新的解决方案。
考虑下面的代码:

interface IListItem {
    Id: number;
    Name: string;
    Description: string;
}

class ListItem extends Backbone.Model implements IListItem {
    get Id(): number {
        return this.get('Id');
    }
    set Id(value: number) {
        this.set('Id', value);
    }
    set Name(value: string) {
        this.set('Name', value);
    }
    get Name(): string {
        return this.get('Name');
    }
    set Description(value: string) {
        this.set('Description', value);
    }
    get Description(): string {
        return this.get('Description');
    }

    constructor(input: IListItem) {
        super();
        for (var key in input) {
            if (key) {
                //this.set(key, input[key]);
                this[key] = input[key];
            }
        }
    }
}

需要注意的是,接口定义模型的属性,构造确保传递的任何物体都会有标识,名称和描述特性。 for语句只是调用每个属性骨干集。 使得下面的测试将通过:

describe("SampleApp : tests : models : ListItem_tests.ts ", () => {
    it("can construct a ListItem model", () => {
        var listItem = new ListItem(
            {
                Id: 1,
                Name: "TestName",
                Description: "TestDescription"
            });
        expect(listItem.get("Id")).toEqual(1);
        expect(listItem.get("Name")).toEqual("TestName");
        expect(listItem.get("Description")).toEqual("TestDescription");

        expect(listItem.Id).toEqual(1);

        listItem.Id = 5;
        expect(listItem.get("Id")).toEqual(5);

        listItem.set("Id", 20);
        expect(listItem.Id).toEqual(20);
    });
});

更新:我已经更新了代码库使用ES5 get和set语法,以及构造。 基本上,你可以使用骨干不用彷徨和.SET内部变量。



Answer 2:

我想出了以下使用泛型和ES5 getter / setter方法,构建关中/ U / blorkfish答案。

class TypedModel<t> extends Backbone.Model {
    constructor(attributes?: t, options?: any) {
        super(attributes, options);

        var defaults = this.defaults();
        for (var key in defaults) {
            var value = defaults[key];

            ((k: any) => {
                Object.defineProperty(this, k, {
                    get: (): typeof value => {
                        return this.get(k);
                    },
                    set: (value: any) => {
                        this.set(k, value);
                    },
                    enumerable: true,
                    configurable: true
                });
            })(key);
        }
    }

    public defaults(): t {
        throw new Error('You must implement this');
        return <t>{};
    }
}

注:Backbone.Model默认值是可选的,但由于我们用它来构建getter和setter,现在是强制性的。 时引发强迫你这样做的错误。 也许我们可以想到更好的办法?

并使用它:

interface IFoo {
    name: string;
    bar?: number;
}

class FooModel extends TypedModel<IFoo> implements IFoo {
    public name: string;
    public bar: number;

    public defaults(): IFoo {
        return {
            name: null,
            bar: null
        };
    }
}

var m = new FooModel();
m.name = 'Chris';
m.get('name'); // Chris
m.set({name: 'Ben', bar: 12});
m.bar; // 12
m.name; // Ben

var m2 = new FooModel({name: 'Calvin'});
m2.name; // Calvin

这是稍微比理想更详细的,它要求你使用默认值,但它工作得很好。



Answer 3:

下面是使用装饰,创建一个基类这样的方式:

export class Model<TProps extends {}> extends Backbone.Model {

    static Property(fieldName: string) {
        return (target, member, descriptor) => {
            descriptor.get = function() {
                return this.get(fieldName);
            };
            descriptor.set = function(value) {
                this.set(fieldName, value);
            };
        };
    }

    attributes: TProps;
}

然后创建自己的类是这样的:

class User extends Model<{id: string, email: string}> {
    @Model.Property('id')        set Id(): string { return null; }
    @Model.Property('email')     set Email(): string { return null; }
}

并使用它:

var user = new User;
user.Email = 'email@me.ok';
console.log(user.Email);


Answer 4:

我有同样的问题挣扎,但我想我找到了,并与来自打字稿chatgroup有趣的解决方案。 该解决方案似乎相当有希望的,我想在这里分享。 所以,我的代码现在看起来像这样

//Define model structure
interface IMarkerStyle{
    Shape:string;
    Fill:string;
    Icon:string;
    Stroke:string;
};

export class MarkerStyle extends StrongModel<IMarkerStyle>{  
//Usage
let style=new MarkerStyle();

//Most interesting part. Oddly enough thease lines check for type
style.s("Fill","#F00"); //setter OK:  Fill is defined as string
style.s("Fill",12.3);   //setter ERROR: because of type mismatch

我得到的另一个好处是它会检查和默认构造函数的参数与接口complience。 所以,静态类型检查不会让你为不存在的属性指定一个默认值

let style=new MarkerStyle(
  {
    Shape:"circle", //OK 
    Phill:"#F00",   //ERROR typo in field name
    Icon:"car"      //OK
                    //ERROR Stroke is not optional in interface and not specified here
  }
);



文章来源: Backbone and TypeScript, an unhappy marriage: Building a type-safe “get”?