【C#】基础之 属性的 `get` 和 `set` 方法讲解

C# 属性的 get 和 set 方法讲解

在 C# 中，属性（Property） 是封装类字段的一种机制，它通常通过 get 和 set 方法来定义。get 用于获取属性值，set 用于设置属性值。使用属性时，代码会更加简洁且可控，特别是当你需要在获取或设置数据时加入一些额外的逻辑。

基本语法

public type PropertyName
{
    get
    {
        return fieldName; // 返回字段值
    }
    set
    {
        fieldName = value; // 设置字段值
    }
}

1. 自动实现的属性（Auto-Implemented Properties）

在大多数情况下，C# 提供了简洁的自动实现属性的方式，当你不需要在 get 或 set 中添加额外的逻辑时，可以直接写成简洁的一行：

public int MyProperty { get; set; }

解释：

• C# 会自动为这个属性创建一个私有的字段（通常叫做 k__BackingField），并且在 get 和 set 中实现对该字段的访问。
• get 方法返回字段的值，set 方法将值赋给字段。

注意：

• 自动属性背后依赖编译器自动生成字段，你无法直接访问这个字段。
• 自动属性通常适用于简单的获取和设置操作，如果需要更复杂的逻辑（比如验证、事件触发等），则需要手动定义 get 和 set。

2. 完整实现的属性

如果需要在 get 或 set 中添加逻辑，比如验证输入、触发事件等，可以显式定义 get 和 set。

private int _myField;
public int MyProperty
{
    get
    {
        return _myField; // 返回私有字段的值
    }
    set
    {
        if (value >= 0) // 设置逻辑，例如不允许负值
        {
            _myField = value;
        }
        else
        {
            throw new ArgumentOutOfRangeException("value", "Value cannot be negative.");
        }
    }
}

解释：

• get 方法从私有字段 _myField 获取值。
• set 方法先对值进行检查（确保其大于等于 0），如果检查通过则将 value 赋给 _myField，否则抛出异常。

3. 只读属性

如果只需要获取属性的值而不允许设置，可以定义只读属性。只需要 get 方法，不需要 set 方法。

public int ReadOnlyProperty { get; } = 10; // 默认初始化

// 或者手动实现：
private int _myField;
public int ReadOnlyProperty
{
    get
    {
        return _myField; // 只能读取
    }
}

解释：

• 只读属性只能通过 get 获取值，不能修改。
• 也可以在构造函数中设置只读属性的值。

4. 只写属性

如果只需要设置属性的值而不需要读取，可以只定义 set 方法。

private int _writeOnlyField;
public int WriteOnlyProperty
{
    set
    {
        _writeOnlyField = value; // 只能设置
    }
}

解释：

• WriteOnlyProperty 只允许设置，无法读取。

5. 使用 value 关键字

在 set 访问器中，value 是一个隐式参数，它表示正在被赋给属性的新值。value 关键字仅在 set 访问器中使用，代表传递给属性的值。

private int _age;
public int Age
{
    get { return _age; }
    set 
    {
        if (value < 0) 
            throw new ArgumentOutOfRangeException("Age cannot be negative.");
        _age = value;  // 使用 value 赋值
    }
}

解释：

• value 在 set 访问器中代表传递进来的新值（例如：Age = 25 中的 25 就是 value）。
• get 返回字段的值。

6. get 和 set 中使用其他逻辑

你可以在 get 和 set 方法中添加复杂的逻辑，下面是一个通过属性访问触发事件的例子：

private int _temperature;
public int Temperature
{
    get { return _temperature; }
    set
    {
        if (_temperature != value)
        {
            _temperature = value;
            OnTemperatureChanged(); // 触发温度变化的事件
        }
    }
}

public event Action TemperatureChanged;

private void OnTemperatureChanged()
{
    TemperatureChanged?.Invoke();
}

解释：

• set 触发 OnTemperatureChanged 事件，当温度发生变化时执行。
• get 返回温度值。

7. 自定义访问器的属性（Indexed Properties）

属性不仅仅可以是简单的字段，还可以是具有索引器的属性。索引器允许对象像数组一样进行访问。

public class MyClass
{
    private int[] _numbers = new int[10];

    public int this[int index]
    {
        get { return _numbers[index]; }
        set { _numbers[index] = value; }
    }
}

解释：

• 通过 this[int index] 可以像数组一样访问和修改对象的元素。
• get 和 set 方法分别定义如何访问和修改 numbers 数组的元素。

8. 属性的访问修饰符

属性的 get 和 set 方法可以有不同的访问修饰符，以控制访问权限：

public class MyClass
{
    private int _value;

    public int MyProperty { get; private set; } // 只有获取权限，不能直接设置

    public int AnotherProperty { get; set; } // 默认公有读写
}

解释：

• MyProperty 只能读取，不能外部设置（set 是 private）。
• AnotherProperty 可以外部读取和设置（默认是公有的）。

小结

• 自动实现的属性：简洁的属性定义，编译器自动创建字段。
• 手动实现的属性：定义 get 和 set 方法，可以添加逻辑。
• 只读属性：只有 get 方法，不能外部设置。
• 只写属性：只有 set 方法，不能外部读取。
• get 和 set 中的 value：value 是 set 访问器的隐式参数，代表赋给属性的新值。
• 属性的访问修饰符：可以根据需要设置 get 和 set 的访问权限。

属性是 C# 中封装字段的一种方式，使得代码更简洁、可读且易于维护。当需要在获取或设置字段时加入逻辑、验证或事件触发时，使用手动实现的属性非常有用。