TypeScriptで取得および設定する


660

プロパティのgetおよびsetメソッドを作成しようとしています:

private _name: string;

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

値を設定するためのキーワードは何ですか?


12
アンダースコアとPascalCaseはTypescriptコーディングガイドラインと競合します:github.com/Microsoft/TypeScript/wiki/Coding-guidelines
Niels Steenbeek

2
こんにちは@NielsSteenbeek-プロパティとバッキングフィールドのTypeScriptコントリビューターガイドラインに従って、名前が競合することになります。推奨されるアプローチは何ですか?
ジョーダン

おそらく: typescript private name: string; getName() { get: { return this.name; } set: { this.name = ???; } }
ジョーダン

7
Typescriptコーディングガイドラインが魅力的でないのは良いことです。私はそれらを強制的にのみ使用します(たとえば、私はそうするために支払われました)。
Thomas Eding 2017年

14
@NielsSteenbeek:そのドキュメントを読みましたか?「これはTypeScriptコミュニティの規範的なガイドラインではありません」
ジョナサンキャスト

回答:


1084

TypeScriptは、ActionScript3のようなゲッター/セッター構文​​を使用します。

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

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 (value) {
            this._bar = value;
        },
        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 --target ES5

Visual Studioを使用している場合は、プロジェクトファイルを編集して、TypeScriptCompileビルドツールの構成にフラグを追加する必要があります。あなたはそれをここで見ることができます

@DanFromGermanyが以下に示すように、単純にのようなローカルプロパティを読み書きしているfoo.bar = true場合は、セッターとゲッターのペアを持つのはやりすぎです。プロパティの読み取りまたは書き込みが行われるたびに、ロギングなどの必要な場合は、いつでも追加できます。


59
いい答えだ。また、C#とは異なり、プロパティは現在TypeScript(v0.9.5)で仮想化されていないことに注意してください。派生クラスで「get bar()」を実装すると、親の「get bar()」が置き換えられます。これには、派生アクセサーから基本クラスアクセサーを呼び出せないことが含まれます。これはプロパティにのみ当てはまります-メソッドは期待どおりに動作します。ここSteveFentonによって答えを参照してください。stackoverflow.com/questions/13121431/...
デヴィッドCuccia

14
アンダースコアについて少し混乱しています。Typescriptの慣習では、プライベート変数にアンダースコアを使用しないと言っていますか?しかし、この場合には、我々は、アンダースコアを使用する必要があります-または私たちは、プライベートとパブリックの「バー」との間に矛盾を取得します
Kokodoko

4
下線を使用するのは、プライベートプロパティの個人的な好みです。ただし、プロパティにはgetter / setterメソッドとは異なる名前を付ける必要があるという点で、あなたは正しいと思います。
Ezward 2016

3
なぜorのmyFoo.bar = true代わりに使用するのですmyFoo.bar(true);myFoo.setBar(true);
ダニエルW.

6
@DanFromGermanyプロパティは、「get」メソッドと「set」メソッドのペアの「構文糖」です。MicrosoftはVisual Basicでプロパティの概念を考案し、C#やVB.NETなどの.NET言語に継承しました。たとえば、「プロパティ(C#プログラミングガイド)」を参照してください。プロパティはオブジェクトの状態へのアクセスを簡素化し、(私の意見では)「get / set」メソッドのペアを処理する必要のある「騒々しさ」を排除します。(または、不変が望まれる場合は、「get」メソッドのみが使用されることがあります。)
DavidRR

113

Ezwardはすでに良い答えを提供していますが、コメントの1つがそれがどのように使用されるかを尋ねていることに気付きました。私のようにこの質問に出くわした人にとって、TypescriptのWebサイトにゲッターとセッターの公式ドキュメントへのリンクがあると便利だと思いました。作成し、使用例を示します。

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

特に、それに慣れていない場合は、「get」という単語をゲッターの呼び出しに組み込まないことに注意してください(セッターの場合も同様)。

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'ゲッターが呼び出されます。


パブリッククラスレベルのvarをプロパティに置き換えたい場合、それは私が配置でき、それについて心配することができない直接ドロップイン置き換えですか?つまり、1つのアクセサーと1つのセッターを回帰テストした場合、それを成功と見なすことができますか?それとも、varとまったく同じように機能せず、このvar / propを使用する100か所すべてをテストする必要がある場合はありますか?
Adam Plocher、

アンダースコアを使用してプロパティ名をゲッターまたはセッターメソッドと区別するための回避策があるかどうか疑問に思っていました。あるコースでは、アンダースコアは優先されなかったが代替案は与えられなかったと彼らは言っていました。
チャム

1
@chamここではアンダースコアを使用する必要はありません...必要に応じてプライベート変数notbarを呼び出すことができます。
Robert McKee

59

これは正しい方向にあなたを向けるべき実用的な例です:

class Foo {
    _name;

    get Name() {
        return this._name;
    }

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

JavaScriptのゲッターとセッターは通常の関数です。セッターは、値が設定されている値であるパラメーターを取る関数です。


30
明確にするために、プロパティ、ゲッター、セッターをにする必要はありませんstatic
Drew Noakes 2013年

1
ただし、変数参照はまだ静的です。Foo._name置き換える必要がありますthis._name
Johannes

6

あなたはこれを書くことができます

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;
    } 

}

2
なぜコンストラクターでパブリックなのか?
MuriloKunze 2012年

17
はい、このコードではコンストラクターでパブリックを使用できません。publicここでは重複メンバーを定義しています。
orad 2013

2
あなたはそれを書くことはできますが、コンパイルされません
Justin

3

TSは、オブジェクトのプロパティがオブジェクトの外部でアクセス(取得)または更新(設定)される方法をより詳細に制御できるゲッターとセッターを提供します。プロパティに直接アクセスまたは更新する代わりに、プロキシ関数が呼び出されます。

例:

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';  

1

これは一般的なメソッドの作成と非常に似ており、キーワードを予約済みgetまたはset先頭に置くだけです。

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;
    }

1

なぜそれがそんなに混乱するのか、おそらく私は理解していると思います。あなたの例では、のゲッターとセッターが必要でした_name。しかし、関係のないクラス変数のゲッターとセッターを作成することでそれを実現しますName

このことを考慮:

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

上記のコードは次のことを行います:

  1. getsetためのyourCarTiresCountではなくtiresCount)のゲッターとセッターを作成します。

ゲッターは:

function() {
    return this.tiresCount ;
}

そしてセッターは:

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

つまり、毎回new Car().yourCarTiresCount、ゲッターが実行されます。そして、すべてのnew Car().yourCarTiresCount('7')セッターが実行されます。

  1. プライベート用のゲッターを間接的に作成しますが、セッターは作成しませんtireCount

0

クラスではなく任意のオブジェクトで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

TypeScriptモジュールを使用していて、エクスポートされるゲッターを追加しようとしている場合は、次のようなことができます。

// 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"

8
それはひどいアドバイスです。特に、thisモジュールの最上位スコープでは未定義でなければなりません。exports代わりに使用することもできますが、実際には互換性の問題が発生することが保証されているため、まったく使用しないでください
Aluan Haddad
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.