在TypeScript中获取和设置

时间:2012-10-10 19:52:15

标签: typescript

我正在尝试为属性创建get和set方法:

private _name: string;

Name() {
    get:
    {
        return this._name;
    }
    set:
    {
        this._name = ???;
    }
}

设置值的关键字是什么?

10 个答案:

答案 0 :(得分:798)

Typescript使用与ActionScript3类似的getter / setter语法。

class foo {
    private _bar:boolean = false;
    get bar():boolean {
        return this._bar;
    }
    set bar(theBar:boolean) {
        this._bar = theBar;
    }
}

这将使用Ecmascript 5 Object.defineProperty()功能生成此Javascript。

var foo = (function () {
    function foo() {
        this._bar = false;
    }
    Object.defineProperty(foo.prototype, "bar", {
        get: function () {
            return this._bar;
        },
        set: function (theBar) {
            this._bar = theBar;
        },
        enumerable: true,
        configurable: true
    });
    return foo;
})();

所以要使用它,

var myFoo = new foo();
if(myFoo.bar) {         // calls the getter
    myFoo.bar = false;  // calls the setter and passes false
}

但是,要完全使用它,必须确保TypeScript编译器以ECMAScript5为目标。如果您正在运行命令行编译器,请使用--target标志,如下所示;

tsc - 目标ES5

如果您使用的是Visual Studio,则必须编辑项目文件,以将标志添加到TypeScriptCompile构建工具的配置中。您可以看到here

正如@DanFromGermany在下面建议的那样,如果你只是在读写一个像foo.bar = true这样的本地属性,那么拥有一个setter和getter对就是矫枉过正。如果您需要在读取或写入属性时执行某些操作(如日志记录),则可以随后添加它们。

答案 1 :(得分:80)

Ezward已经提供了一个很好的答案,但我注意到其中一条评论询问它是如何使用的。对于像我这样偶然发现这个问题的人,我认为在Typescript网站上找到关于getter和setter的官方文档的链接是有用的,因为它解释得很好,希望随时更新是最新的制作,并显示示例用法:

http://www.typescriptlang.org/docs/handbook/classes.html

特别是对于那些不熟悉它的人,请注意,你没有加入“get'调用getter(以及类似的setter):

var myBar = myFoo.getBar(); // wrong    
var myBar = myFoo.get('bar');  // wrong

你应该这样做:

var myBar = myFoo.bar;  // correct (get)
myFoo.bar = true;  // correct (set) (false is correct too obviously!)

给出一个类:

class foo {
  private _bar:boolean = false;

  get bar():boolean {
    return this._bar;
  }
  set bar(theBar:boolean) {
    this._bar = theBar;
  }
}

然后' bar'为私人' _bar'属性将被调用。

答案 2 :(得分:44)

这是一个应该指向正确方向的工作示例:

class Foo {
    _name;

    get Name() {
        return this._name;
    }

    set Name(val) {
        this._name = val;
    }
}

JavaScript中的getter和setter只是普通函数。 setter是一个函数,它接受一个参数,其值是设置的值。

答案 3 :(得分:3)

你可以写这个

class Human {
    private firstName : string;
    private lastName : string;

    constructor (
        public FirstName?:string, 
        public LastName?:string) {

    }

    get FirstName() : string {
        console.log("Get FirstName : ", this.firstName);
        return this.firstName;
    }
    set FirstName(value : string) {
        console.log("Set FirstName : ", value);
        this.firstName = value;
    } 

    get LastName() : string {
        console.log("Get LastName : ", this.lastName);
        return this.lastName;
    }
    set LastName(value : string) {
        console.log("Set LastName : ", value);
        this.lastName = value;
    } 

}

答案 4 :(得分:2)

这与创建常用方法非常相似,只需将关键字reserved getset放在开头即可。

class Name{
    private _name: string;

    getMethod(): string{
        return this._name;
    }

    setMethod(value: string){
        this._name = value
    }

    get getMethod1(): string{
        return this._name;
    }

    set setMethod1(value: string){
        this._name = value
    }
}

class HelloWorld {

    public static main(){

        let test = new Name();

        test.setMethod('test.getMethod() --- need ()');
            console.log(test.getMethod());

        test.setMethod1 = 'test.getMethod1 --- no need (), and used = for set ';
            console.log(test.getMethod1);
    }
}
HelloWorld.main();

在这种情况下,您可以跳过get getMethod1() {

中的返回类型
    get getMethod1() {
        return this._name;
    }

答案 5 :(得分:2)

如果您正在寻找在任何对象(不是类)上使用get和set方法,Proxy可能会有用: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy

const target = {
  message1: "hello",
  message2: "everyone"
};

const handler3 = {
  get: function (target, prop, receiver) {
    if (prop === "message2") {
      return "world";
    }
    return Reflect.get(...arguments);
  },
};

const proxy3 = new Proxy(target, handler3);

console.log(proxy3.message1); // hello
console.log(proxy3.message2); // world

请注意:请注意,这是不支持的新api,并且对于较旧的浏览器来说是必需的策略填充

答案 6 :(得分:1)

基于显示的示例,您想要传递数据对象并通过get()获得该对象的属性。为此,您需要使用通用类型,因为数据对象是通用的,所以可以是任何对象。

export class Attributes<T> {
    constructor(private data: T) {}
    get = <K extends keyof T>(key: K): T[K] => {
      return this.data[key];
    };
    set = (update: T): void => {
      //   this is like spread operator. it will take this.data obj and will overwrite with the update obj
      // ins tsconfig.json change target to Es6 to be able to use Object.assign()
      Object.assign(this.data, update);
    };
    getAll(): T {
      return this.data;
    }
  }

是指泛型类型。让我们初始化一个实例

 const myAttributes=new Attributes({name:"something",age:32})

 myAttributes.get("name")="something"

注意此语法

<K extends keyof T>

为了能够使用它,我们应该注意两件事:

1-类型字符串中的字符串可以是一种类型。

2- JavaScript中的所有对象属性本质上都是字符串。

当我们使用get()时,它接收到的参数类型是传递给构造函数的对象的属性,并且由于对象属性是字符串,并且字符串是打字稿中的类型,因此我们可以使用此{{1 }}

答案 7 :(得分:0)

我想我可能会明白为什么会这么混乱。在您的示例中,我们想要_name的getter和setter。但是我们通过为不相关的类变量Name创建getter和setter来实现这一点。

考虑一下:

class Car{
    private tiresCount = 4;
    get yourCarTiresCount(){
        return this.tiresCount ;
    }
    set yourCarTiresCount(count) {
        alert('You shouldn't change car tire count')
    }
}

以上代码确实如下:

  1. getsetyourCarTiresCount创建了getter和setter(不是tiresCount )。
  2. 吸气者是:

    function() {
        return this.tiresCount ;
    }
    

    并且设置者是:

    function(count) {
        alert('You shouldn't change car tire count');
    }
    

    意思是,每次我们new Car().yourCarTiresCount,getter都会运行。对于每个new Car().yourCarTiresCount('7') setter运行。

    1. 间接为私人tireCount创建getter,而不是setter。

答案 8 :(得分:0)

TS提供了getter和setter,它们允许对象属性对对象外部的访问(获取)或更新(设置)方式有更多的控制。代替直接访问或更新属性,而是调用代理函数。

示例:

class Person {
    constructor(name: string) {
        this._name = name;
    }

    private _name: string;

    get name() {
        return this._name;
    }

    // first checks the length of the name and then updates the name.
    set name(name: string) {
        if (name.length > 10) {
            throw new Error("Name has a max length of 10");
        }

        this._name = name;  
    }

    doStuff () {
        this._name = 'foofooooooofoooo';
    }


}

const person = new Person('Willem');

// doesn't throw error, setter function not called within the object method when this._name is changed
person.doStuff();  

// throws error because setter is called and name is longer than 10 characters
person.name = 'barbarbarbarbarbar';  

答案 9 :(得分:-5)

如果您正在使用TypeScript模块并尝试添加导出的getter,则可以执行以下操作:

// dataStore.ts
export const myData: string = undefined;  // just for typing support
let _myData: string;  // for memoizing the getter results

Object.defineProperty(this, "myData", {
    get: (): string => {
        if (_myData === undefined) {
            _myData = "my data";  // pretend this took a long time
        }

        return _myData;
    },
});

然后,在另一个文件中:

import * as dataStore from "./dataStore"
console.log(dataStore.myData); // "my data"