您现在的位置：程式碼之家 >> 編程語言 > >> .NET 網頁程式設計 >> ASP.NET 基礎 >> ASP.NET 基礎

.NET 索引器完整指南：語法、特性、重載與實戰模式

編輯：ASP.NET 基礎

什麼是索引器

索引器讓類或結構體像陣列一樣通過下標訪問內部數據，語法形式為 this[參數列表]。它是「屬性」的參數化泛化，本質是 get/set 訪問器的語法糖。

核心語法結構

public class SampleCollection
{
    private T[] _items = new T[100];

    // 索引器聲明
    public T this[int index]
    {
        get => _items[index];
        set => _items[index] = value;
    }
}

七大核心特性

特性	說明	示例
語法糖	編譯為 `get_Item`/`set_Item` 方法	IL 可見 `get_Item(Int32)`
this 關鍵字	標識索引器，非實例引用	`this[int i]`
value 隱式參數	set 訪問器自動可用	`set { _arr[i] = value; }`
參數靈活	可為任意類型、多參數	`this[string key]`、`this[int x, int y]`
支援重載	同類多個索引器，參數簽名不同	按 int 索引 / 按 string 鍵並存
可多維	模擬多維陣列/矩陣訪問	`matrix[x, y]`
介面實現	介面可聲明索引器，類實現隱式/顯式	`interface IRepo { T this[string id] { get; } }`

進階實戰模式

1. 字符串鍵索引器（字典語義）

public class ConfigStore
{
    private readonly Dictionary _data = new Dictionary();

    public string this[string key]
    {
        get => _data.TryGetValue(key, out var v) ? v : null;
        set => _data[key] = value ?? throw new ArgumentNullException(nameof(value));
    }
    
    // 唯讀索引器（僅 get）
    public string this[string key, bool readOnly]
    {
        get => this[key];
    }
}

2. 多維索引器（矩陣/棋盤）

public class Matrix
{
    private readonly T[,] _grid;
    public int Rows { get; }
    public int Cols { get; }

    public Matrix(int rows, int cols)
    {
        Rows = rows; Cols = cols;
        _grid = new T[rows, cols];
    }

    public T this[int row, int col]
    {
        get
        {
            Validate(row, col);
            return _grid[row, col];
        }
        set
        {
            Validate(row, col);
            _grid[row, col] = value;
        }
    }

    private void Validate(int r, int c)
    {
        if (r < 0 || r >= Rows || c < 0 || c >= Cols)
            throw new IndexOutOfRangeException($"({r},{c}) 超出範圍 [{Rows}x{Cols}]");
    }
}

3. 介面索引器與顯式實現

public interface IRepository
{
    T this[string id] { get; set; }
    IEnumerable All { get; }
}

public class UserRepository : IRepository
{
    private readonly Dictionary _users = new Dictionary();

    // 隱式實現
    public User this[string id]
    {
        get => _users.TryGetValue(id, out var u) ? u : null;
        set => _users[id] = value;
    }

    public IEnumerable All => _users.Values;
}

4. 只讀索引器（C# 6+ 表達式體）

public class ReadOnlyList
{
    private readonly T[] _items;
    public ReadOnlyList(params T[] items) => _items = items;
    
    public T this[int i] => _items[i]; // 僅 get
    public int Count => _items.Length;
}

索引器 vs 屬性 vs 方法

維度	屬性	索引器	方法
參數	無	有（至少一個）	任意
調用語法	`obj.Prop`	`obj[index]`	`obj.Method(arg)`
適用場景	單一值特徵	集合/映射訪問	行為/計算/副作用
重載	不可	可	可
介面聲明	可	可	可

最佳實踐與避坑指南

邊界檢查：get/set 內部務必驗證索引合法性，拋出 IndexOutOfRangeException 或 ArgumentOutOfRangeException
避免副作用：get 應為純查詢，不修改狀態；複雜計算改用方法
命名清晰：多參數索引器參數名要有語義 this[int row, int column] 而非 this[int a, int b]
考慮 TryGet 模式：高頻失敗場景提供 bool TryGet(int index, out T value) 避免異常開銷
文檔註釋：/// 零基索引 明確語義