Свойства get и set в C#: private set, value и проверка значения

Иногда, когда мы создавали свои типы данных, Visual Studio предлагала нам напротив переменных подставить get и set. Пришло время узнать, что это такое, и как это использовать.

Если кратко — get и set — свойства, которые отвечают за чтение данных из переменных (get — получить), и установку значения в переменную (set — установить). По умолчанию, у переменной и так есть свойства get и set — мы в любом случае можем получить или установить значение в переменную.

Эти свойства мы можем настраивать. Например, мы можем сказать, что взять значение из переменной мы можем откуда угодно (так как переменная у нас public, ее так можно взять откуда угодно), а установить значение можно только в этом классе. Тогда перед свойством set нужно поставить модификатор доступа private.

1
internal class Human
2
{
3
    public string Name { get; private set; }
4
}

Понадобиться нам это может в случае, если мы устанавливаем значение для этой переменной из конструктора — дать значение этой переменной нужно, но другие классы должны только читать значение, которое мы ей задали.

value и return #

Также мы можем сразу же настроить условия для установки или взятия значения. В блоке get выполняются действия по получению значения свойства. В этом блоке с помощью оператора return возвращаем некоторое значение. В блоке set устанавливается значение свойства. В этом блоке с помощью параметра value мы можем получить значение, которое передано свойству.

Однако для того, чтобы выставлять условия, нам нужна еще одна переменная, где мы будем хранить уже отформатированное значение. Для этого сделаю приватную переменную name.

1
internal class Human
2
{
3
    private string name;
4

5
    public string Name
6
    {
7
        get { return name; }      // возвращаем значение свойства
8
        set { name = value; }     // устанавливаем значение свойства
9
    }
10
}

По умолчанию, наша переменная так и работает. Однако теперь, когда мы имеем value и return, мы можем сделать либо какие-то условия при установке значения, либо отформатировать текст перед его взятием.

Например, если я хочу, чтобы перед содержимым переменной всегда ставился текст «Имя:», мне необходимо перед return добавить этот текст, а уже потом вернуть его с помощью return.

И при выводе этого свойства, у нас всегда впереди будет стоять слово «Имя».

1
Human sofia = new Human("София Алексеевна");
2
MessageBox.Show(sofia.Name);

Проверка в set #

Для свойства set мы можем ставить всякие условия. Например, если имя не равно «София Алексеевна», тогда нам такое имя не нужно, и об этом пользователя нужно уведомить. Сделаем это также через MessageBox. Проверять на условие мы будем value, так как внутри него будет хранится передаваемое в свойство значение (то, которое мы кинули после равно).

И теперь, чтобы проверить, я создам две переменных — с правильным именем и с неправильным. В правильном случае у нас имя запишется в переменную и все будет хорошо. А в неправильном, выведется сообщение о том, что такое имя не нужно, а также значение в переменную не запишется.

1
Human sofia   = new Human("София Алексеевна");     // все ок
2
MessageBox.Show(sofia.Name);                       // Имя: София Алексеевна
3

4
Human nikolay = new Human("Николай Васильевич");   // выведется сообщение
5
MessageBox.Show(nikolay.Name);                     // пусто

Полный код примера #

Human.cs с настроенным свойством Name — get форматирует текст, set проверяет значение:

1
using System.Windows;
2

3
namespace WpfApp1
4
{
5
    internal class Human
6
    {
7
        private string name;
8

9
        public string Name
10
        {
11
            get
12
            {
13
                name = "Имя: " + name;
14
                return name;
15
            }
16
            set
17
            {
18
                if (value != "София Алексеевна")
19
                    MessageBox.Show("Такое имя не нужно");
20
                else
21
                    name = value;
22
            }
23
        }
24

25
        public Human(string name)
26
        {
27
            Name = name;
28
        }
29
    }
30
}

MainWindow.xaml.cs с проверкой работы свойства:

1
using System.Windows;
2

3
namespace WpfApp1
4
{
5
    public partial class MainWindow : Window
6
    {
7
        public MainWindow()
8
        {
9
            InitializeComponent();
10

11
            Human sofia = new Human("София Алексеевна");
12
            MessageBox.Show(sofia.Name);
13

14
            Human nikolay = new Human("Николай Васильевич");
15
            MessageBox.Show(nikolay.Name);
16
        }
17
    }
18
}