отримати та встановити в TypeScript


657

Я намагаюся створити метод get і set для властивості:

private _name: string;

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

Яке ключове слово для встановлення значення?


12
Підкреслення та PascalCase суперечать правилам кодування Typescript
Нільс Стінбек

2
Привіт @NielsSteenbeek - дотримуючись вказівок розробників TypeScript із властивостями та полями резервного копіювання, у вас виникне конфлікт імен. Що пропонується?
Йорданія

Можливо: typescript private name: string; getName() { get: { return this.name; } set: { this.name = ???; } }
Йордан

7
Добре, що ці вказівки щодо кодування Typescript досить непривабливі. Я використовував би їх лише з примусу (наприклад, мені це заплатили).
Томас Едінг

14
@NielsSteenbeek: ти читав цей документ? "Це НЕ є розпорядчим керівництвом для спільноти TypeScript"
Джонатан Каст

Відповіді:


1083

TypeScript використовує синтаксис getter / setter, схожий на ActionScript3.

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

Це створить цей JavaScript, використовуючи функцію ECMAScript 5 Object.defineProperty().

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
Я трохи розгублений з приводу підкреслення. Змова типу машинопису говорить, що не використовувати підкреслення для приватних змінних? Але в цьому випадку ми повинні використовувати підкреслення
інакше у нас виникне

4
Використовувати підкреслення є особистим уподобанням приватних об’єктів. Однак я вважаю, що ви праві в тому, що ми хочемо, щоб властивість мала інше ім'я, ніж методи getter / setter.
Ezward

3
Чому ви використовуєте myFoo.bar = trueзамість myFoo.bar(true);або myFoo.setBar(true);??
Даніель В.

6
@DanFromGermany Властивістю є "синтаксичний цукор" для пари методів "get" і "set". Microsoft виникла концепція властивості з Visual Basic і перенесла її на мови NET, такі як C # і VB.NET. Наприклад, див. Властивості (Посібник з програмування C #) . Властивості спрощують доступ до стану об'єкта і (на мою думку) усувають "галасливість", що мають справу з парами методів "get / set". (Або іноді лише "дістати" методи, де бажана незмінність.)
DavidRR

112

Ezward вже дав хорошу відповідь, але я помітив, що один із коментарів запитує, як він використовується. Для таких людей, як я, які натрапляють на це питання, я вважав, що було б корисно мати посилання на офіційну документацію про геттери та сетери на веб-сайті Typescript, оскільки це добре пояснює, сподіваємось, завжди буде в курсі останніх змін, оскільки зміни зроблено та показує приклад використання:

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

Зокрема, для тих, хто з ним не знайомий, зауважте, що ви не включаєте слово "отримати" у дзвінок до геттера (і аналогічно для сетерів):

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' буде викликаний.


Якщо я хотів замінити загальнодоступну вару на рівні класу властивістю, чи можу я встановити пряму заміну, що впадає у систему, і не переживаю за це? Іншими словами, якщо я регрес тестую один аксесуар та один сетер, чи можу я вважати це успішним? Або бувають випадки, коли він не працюватиме точно так само, як var, і мені потрібно перевірити всі 100 місць, які використовують цей var / prop?
Адам Плочер

Мені було цікаво, чи існувало рішення щодо використання підкреслення, щоб відрізнити назву властивості від методів getter або setter. В одному курсі я робив, що вони сказали, що підкреслення не віддається перевазі, але не дають альтернативи.
ч

1
@cham Тут вам не потрібно використовувати підкреслення ... Ви можете зателефонувати приватній змінній notbar, якщо хочете.
Роберт Маккі

58

Ось робочий приклад, який повинен вказувати вам у правильному напрямку:

class Foo {
    _name;

    get Name() {
        return this._name;
    }

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

Геттери та сетери в JavaScript - це лише звичайні функції. Сеттер - це функція, яка приймає параметр, значення якого є заданим значенням.


30
Щоб було зрозуміло, немає необхідності у власність, геттер та сетер static.
Дрю Ноакс

1
посилання на змінну все ще є статичними. Foo._nameслід замінити наthis._name
Йоганнеса

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

17
Так, у цьому коді не може бути public у конструкторі. publicтут визначаються дублікати членів.
орад

2
Ви можете написати це, але це не складе збір
Джастін

3

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

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. Але ми досягаємо цього, створюючи getters та setters для незв'язаної змінної класу Name.

Врахуйте це:

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

Наведений вище код:

  1. getі setстворити getter та setter для 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
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.