C# 索引器的理解和使用

来源:https://www.cnblogs.com/Hope-forever/archive/2019/12/29/12113842.html
-Advertisement-
Play Games

概述 此部分內容引用自 "MSDN文檔" 使用索引器可以用類似於數組的方式為對象建立索引。 取值函數返回值。 取值函數分配值。 關鍵字用於定義索引器。 關鍵字用於定義 索引器所賦的值。 索引器不必根據整數值進行索引；由你決定如何定義特定的查找機制。 索引器可被重載。 索引器可以有多個形參，例如當訪問 ...


概述

此部分內容引用自MSDN文檔

  • 使用索引器可以用類似於數組的方式為對象建立索引。

  • get 取值函數返回值。 set 取值函數分配值。

  • this 關鍵字用於定義索引器。

  • value 關鍵字用於定義 set 索引器所賦的值。

  • 索引器不必根據整數值進行索引；由你決定如何定義特定的查找機制。

  • 索引器可被重載。

  • 索引器可以有多個形參，例如當訪問二維數組時。

我對索引器的理解就是，他是一個讀寫自定義類中的數據集合的介面，連接自定義類中的數據集合，並可對其進行讀寫操作

通過該介面簡化或者豐富對自定義類中數據集合的操作方式

索引器實際上相當於一個方法，支持多個及多種類型的參數，不同的是，其返回值不可為void，並且索引器除可傳入參數外，還可對其進行賦值，即it[0] = "測試數據0"

創建索引器時，其返回值類型亦為其value關鍵字所使用的類型，即定義了返回值類型的同時，也定義了其可接受的值類型

索引器使用要素

    創建索引器時有幾部分內容是必須的：

  1. 必須先創建索引器所需要的容器（我把它稱為容器，暫時還沒看到有對它的具體定義）

  2. 創建索引器需要使用this關鍵字

  3. 索引器中必須要包含get和set訪問器，在C#7.0可以使用表達式主體（=>）簡化

  4. 在使用表達式主體成員實現索引器時，必須額外提供容器的修改介面，因為通過表達式主體實現的索引器是不包含set關鍵字的

單參數索引器

    此索引器使用簡單的string數組作為容器，此索引器使用int類型的i進行索引，返回值為string類型。

class SampleIndxer
{
    //可供索引器使用的容器，暫用數組
    private string[] sampleStrArr = new string[10];
    //創建索引器
    public string this[int i]
    {
        get { return sampleStrArr[i]; }
        set { sampleStrArr[i] = value; }
    }
}
class Test
{
    public static void test()
    {
        //簡單索引器測試
        SampleIndxer it = new SampleIndxer();
        it[0] = "測試數據0";
        it[1] = "測試數據1";
        Console.WriteLine("it[0]:" + it[0]);
        Console.WriteLine("it[1]:" + it[1]);
        Console.ReadLine();
    }

}

    索引器中同時也可以使用泛型作為參數

class SampleGenericIndexer<T>
{
    //可供索引器使用的主體變數，暫用泛型數組代替
    private T[] sampleGenericStrArr = new T[10];
    public T this[int i]
    {
        get { return sampleGenericStrArr[i]; }
        set { sampleGenericStrArr[i] = value; }
    }
}


class Test
{
    public static void test()
    {
        //泛型索引器測試
        SampleGenericIndexer<string> it = new SampleGenericIndexer<string>();
        it[0] = "測試數據0";
        it[1] = "測試數據1";
        Console.WriteLine("it[0]:" + it[0]);
        Console.WriteLine("it[1]:" + it[1]);
        Console.ReadLine();
    }
}

    在C#7.0之後可以通過表達式主體實現索引器，需要註意的是，通過表達式主體實現索引器時，必須提供數據修改的介面，因為通過表達式主體實現索引時僅提供了get訪問器，並未提供set訪問器。或者將容器的可訪問性設置為使用該類的地方可以訪問，直接對容器進行數據操作，僅使用索引器進行數據的讀取。

class ExpressionBodyIndexer<T>
{
    //可供索引器使用的主體變數，暫用泛型數組代替
    private T[] expressionBodyStrArr = new T[10];

    //標記當前索引器的中已初始化數據的索引位置
    int nextIndex = 0;
    // 使用表達式主體(ExpressionBody)定義簡化定義索引器
    public T this[int i] => expressionBodyStrArr[i];

    /// <summary>
    /// 表達式主體方式定義的索引器無法通過索引值設置其中的值
    /// 因為此狀態下，索引器的數據為只讀狀態
    /// 必須向外提供賦值的方法
    /// </summary>
    /// <param name="value"></param>
    public void Add(T value)
    {
        if(nextIndex >= expressionBodyStrArr.Length)
        {
            throw new IndexOutOfRangeException($"當前集合數據已滿，共{expressionBodyStrArr.Length}組數據");
        }
        expressionBodyStrArr[nextIndex++] = value;
    }
}
class Test
{
    public static void test()
    {
        //泛型索引器測試
        ExpressionBodyIndexer<string> it = new ExpressionBodyIndexer<string>();
        //此條件下不可通過it[0]索引方式進行數據添加，因為他是只讀的
        //必須通過提供的Add方法添加數據
        it.Add("測試數據0");
        it.Add("測試數據1");
        it.Add("測試數據2");
        Console.WriteLine("it[0]:" + it[0]);
        Console.WriteLine("it[1]:" + it[1]);
        Console.WriteLine("it[2]:" + it[2]);
        Console.ReadLine();
    }
}

    索引器既然是可以簡化或者豐富對自定義類中數據集合的操作方式，那麼自然也可以使用稍微複雜點的數據集合作為索引器的容器。本例中使用Dictionary作為容器。

class VariableLengthIndexer
{
    /// <summary>
    /// 可供索引器使用的容器，此處使用Dictionary代替，

    /// 實現使用string類型數據當作索引器的指針，同時實現索引器的可變長度
    /// </summary>
    private Dictionary<string, string> dic = new Dictionary<string, string>();

    /// <summary>
    /// 使用表達式主體創建索引器
    /// </summary>
    /// <param name="s"></param>
    /// <returns></returns>
    public string this[string s] => dic[s];
    
    public void Add(string key,string value)
    {
        if (dic.ContainsKey(key))
        {
            dic[key] = value;
        }
        else
        {
            dic.Add(key, value);
        }
    }
}
class Test
{
    public static void test()
    {
        //泛型索引器測試
        VariableLengthIndexer it = new VariableLengthIndexer();
        //此條件下不可通過it[0]索引方式進行數據添加，因為他是只讀的
        //必須通過提供的Add方法添加數據
        it.Add("數據0", "測試數據0");
        it.Add("數據1", "測試數據1");
        it.Add("數據2", "測試數據2");
        Console.WriteLine("it[數據1]:" + it["數據1"]);
        Console.WriteLine("it[數據2]:" + it["數據2"]);
        Console.WriteLine("it[數據3]:" + it["數據3"]);
        Console.ReadLine();
    }
}

    前面的幾個例子中，僅僅是對於索引器的認識，實際工作中並沒有使用價值，因為所作的操作完全可以使用 .NET 中預定義的數據集合完成。個人覺得C#7.0之後提供的表達式主體實際作用並不大，甚至沒有必要。個人認為索引器最大價值存在於get和set訪問器中對於數據操作的自定義處理，可以在訪問器中對數據進行修正或者過濾，這才是其比較好的價值體現。

    通過在索引器中對數據處理做封裝，可以簡化平常大部分的操作，此類也可根據實際情況嵌入到資料庫訪問實體類中。

/// <summary>
/// 本實例通過考試成績的處理演示索引器對數據處理的過程
/// </summary>
class TestScore
{
    private Dictionary<string, int> scores = new Dictionary<string, int>();

    public string this[string s]
    {
        get
        {
            if (!scores.ContainsKey(s))
            {
                return $"非常抱歉，{s}的成績尚未錄入";
            }
            switch (scores[s])
            {
                case 10:
                case 20:
                case 30:
                case 40:
                case 50:
                    return $"很遺憾，{s}不及格，分數僅為{scores[s]}";
                case 60:
                case 70:
                    return $"考的不錯，{s}已及格，分數為{scores[s]}";
                case 80:
                case 90:
                    return $"成績優秀，{s}成績優秀，分數為{scores[s]}";
                case 100:
                    return $"非常優秀，{s}獲取滿分{scores[s]}分";
                default:
                    return $"{s}的成績可能存在異常，分數為{scores[s]}";
            }
        }
        set
        {
            if (int.TryParse(value, out int v))
            {
                //對分數做四捨五入處理
                v = (int)Math.Round(v * 0.1) * 10;

                if (!scores.ContainsKey(s))
                {
                    scores.Add(s, v);
                }
                else
                {
                    scores[s] = v;
                }
            }
        }
    }
}

class Test
{
    public static void test()
    {
        TestScore ts = new TestScore();
        ts["張三"] = "23";
        ts["李四"] = "54";
        ts["王二"] = "66";
        ts["麻子"] = "89";
        ts["王朝"] = "100";
        ts["馬漢"] = "5";
        ts["老王"] = "";

        Console.WriteLine(ts["張三"]);
        Console.WriteLine(ts["李四"]);
        Console.WriteLine(ts["王二"]);
        Console.WriteLine(ts["麻子"]);
        Console.WriteLine(ts["王朝"]);
        Console.WriteLine(ts["馬漢"]);
        Console.WriteLine(ts["老王"]);
        Console.ReadLine();

    }
}

多參數索引器

    前面通過單參數所以其的實現分析了索引器的使用方式即可能的使用範圍，下麵進行下簡單的拓展，分析多參數索引器的使用方式，依舊使用上面分數的例子做演示。

struct Student
{
    public string Name;
    public string Classes;
    public string Grade;
    public int Score;
        
    public override string ToString()
    {
        return $"{this.Grade}\t{this.Classes}\t{this.Name}\t{this.Score}";
    }
}

public class ArrayList1 : ArrayList
{
    public override bool Contains(object item)
    {
        if (item.GetType().ToString() == "Student")
        {
            foreach (var a in this)
            {
                if (a.GetType().ToString() == "Student")
                {
                    var s1 = (Student)a;
                    var s2 = (Student)item;
                    if (s1.Name == s2.Name && s1.Classes == s2.Classes && s1.Grade == s2.Grade)
                    {
                        return true;
                    }
                    return false;
                }
            }
        }
        return base.Contains(item);
    }
}

class TestScore
{
    public ArrayList1 ArrList = new ArrayList1();

    public string this[string name, string grade, string classes]
    {
        get
        {
            string rtn = "";
            foreach (Student a in ArrList)
            {
                if (a.Name == name && a.Classes == classes && a.Grade == grade)
                {
                    switch (a.Score)
                    {
                        case 10:
                        case 20:
                        case 30:
                        case 40:
                        case 50:
                            rtn = $"很遺憾，{name}不及格，分數僅為{a.Score}";
                            break;
                        case 60:
                        case 70:
                            rtn = $"考的不錯，{name}已及格，分數為{a.Score}";
                            break;
                        case 80:
                        case 90:
                            rtn = $"成績優秀，{name}成績優秀，分數為{a.Score}";
                            break;
                        case 100:
                            rtn = $"非常優秀，{name}獲取滿分{a.Score}分";
                            break;
                        default:
                            rtn = $"{name}的成績可能存在異常，分數為{a.Score}";
                            break;
                    }
                }
            }
            if (rtn == "")
            {
                return $"非常抱歉，{name}的成績尚未錄入";
            }
            return rtn;
        }
        set
        {
            if (int.TryParse(value, out int v))
            {
                //對分數做四捨五入處理
                v = (int)Math.Round(v * 0.1) * 10;

                Student st = new Student
                {
                    Name = name,
                    Grade = grade,
                    Classes = classes,
                    Score = v
                };
                //重覆項，不再插入，避免查找時出現重覆
                if (!ArrList.Contains(st))
                {
                    ArrList.Add(st);
                }
            }
        }
    }
}

class Test
{
    public static void test()
    {
        TestScore ts = new TestScore();
        ts["張三", "三年級", "二班"] = "23";
        ts["李四", "三年級", "二班"] = "54";
        ts["王二", "三年級", "二班"] = "66";
        ts["麻子", "三年級", "二班"] = "89";
        ts["王朝", "三年級", "二班"] = "100";
        ts["馬漢", "三年級", "二班"] = "5";
        ts["老王", "三年級", "二班"] = "";
        Console.WriteLine("查看存入的數據：");
        Console.WriteLine($"共存入了：{ts.ArrList.Count}組數據");
        Console.WriteLine();
        //不使用索引器，直接訪問實例中的容器

        foreach (Student s in ts.ArrList)
        {
            Console.WriteLine(s.ToString());
        }
        Console.WriteLine();

        Console.WriteLine(ts["張三", "三年級", "二班"]);
        Console.WriteLine(ts["李四", "三年級", "二班"]);
        Console.WriteLine(ts["王二", "三年級", "二班"]);
        Console.WriteLine(ts["麻子", "三年級", "二班"]);
        Console.WriteLine(ts["王朝", "三年級", "二班"]);
        Console.WriteLine(ts["馬漢", "三年級", "二班"]);
        Console.WriteLine(ts["老王", "三年級", "二班"]);
        Console.ReadLine();

    }
}

    同時二維數組中多個參數的實現方式，同樣也支持二維數組

public string[,] sampleStrArr = new string[10,10];
public string this[int x,int y]
{
    get { return sampleStrArr[x, y]; }
    set { sampleStrArr[x, y] = value; }
}

public static void test()
{
    SampleIndxer it = new SampleIndxer();
    it[0, 0] = "測試數據0,0";
    it[0, 1] = "測試數據0,1";
    it[1, 1] = "測試數據1,1";
    it[1, 2] = "測試數據1,2";
    it[3, 3] = "測試數據3,3";

    Console.WriteLine("it[0,0]:" + it[0, 0]);
    Console.WriteLine("it[0,1]:" + it[0, 1]);
    Console.WriteLine("it[1,1]:" + it[1, 1]);
    Console.WriteLine("it[1,2]:" + it[1, 2]);
    Console.WriteLine("it[3,3]:" + it[3, 3]);

    Console.ReadLine();
}

索引器的重載

    前面說過，索引器相當於一個方法，他們同樣都支持重載。與方法不同的是，索引器沒有獨立的名稱，只能通過返回值的不同和參數的不同來區分不同的簽名，從而實現重載。

class VariableLengthIndexer
{
    private Dictionary<string, int> dic = new Dictionary<string, int>();

    //通過Key，查找Value
    public int this[string s]
    {
        get { return dic[s]; }
    }
    //通過Value查找Key
    public string this[int num]
    {
        get { return dic.Where(x => x.Value == num).Last().Key; }
    }
    //通過Value查找Key，添加無效參數num1演示重載
    public string this[int num, int num1]
    {
        get { return dic.Where(x => x.Value == num).Last().Key; }
    }

    public void Add(string key, int value)
    {
        if (dic.ContainsKey(key))
        {
            dic[key] = value;
        }
        else
        {
            dic.Add(key, value);
        }
    }
}
class Test
{
    public static void test()
    {
        //泛型索引器測試
        VariableLengthIndexer it = new VariableLengthIndexer();
        it.Add("測試數據1", 1);
        it.Add("測試數據2", 2);
        it.Add("測試數據3", 3);
        it.Add("測試數據4", 4);
        //通過Key查找Value
        Console.WriteLine("通過Key查找Value");
        Console.WriteLine("Key:測試數據1,Value:" + it["測試數據1"]);
        Console.WriteLine("Key:測試數據2,Value:" + it["測試數據2"]);
        Console.WriteLine("Key:測試數據3,Value:" + it["測試數據3"]);
        Console.WriteLine("Key:測試數據4,Value:" + it["測試數據4"]);
        //通過Value查找Key
        Console.WriteLine("通過Value查找Key");
        Console.WriteLine("Value:1,Key:" + it[1]);
        Console.WriteLine("Value:2,Key:" + it[2]);
        Console.WriteLine("Value:3,Key:" + it[3]);
        Console.WriteLine("Value:4,Key:" + it[4]);
        //通過Value查找Key，並添加無效參數傳入
        Console.WriteLine("通過Value查找Key，並添加無效參數傳入");
        Console.WriteLine("Value:1,Key:" + it[1, 1]);
        Console.WriteLine("Value:2,Key:" + it[2, 2]);
        Console.WriteLine("Value:3,Key:" + it[3, 3]);
        Console.WriteLine("Value:4,Key:" + it[4, 4]);

        Console.ReadLine();
    }
}

參考文獻：

1 C# 中常用的索引器 https://www.cnblogs.com/daimajun/p/6819081.html

2 索引器（C# 編程指南）https://docs.microsoft.com/zh-cn/dotnet/csharp/programming-guide/indexers/


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • pip換源
    將pip的下載源換成國內的，速度會有很大的提升。 下麵是一些國內常用鏡像： 阿裡雲 http://mirrors.aliyun.com/pypi/simple/ 中國科技大學 https://pypi.mirrors.ustc.edu.cn/simple/ 豆瓣(douban) http://pyp ...
  • Java自學-集合框架 ArrayList和LinkedList的區別
    ArrayList和LinkedList的區別 步驟 1 : ArrayList和LinkedList的區別 ArrayList ， 插入，刪除數據慢 LinkedList， 插入，刪除數據快 ArrayList是順序結構，所以 定位很快 ，指哪找哪。 就像電影院位置一樣，有了電影票，一下就找到位置 ...
  • Web基礎瞭解版09-Cookie-Session
    Cookie Cookie 是一種伺服器發送給瀏覽器以鍵值對形式存儲小量信息的技術。 當瀏覽器首次請求伺服器時，伺服器會將一條信息封裝成一個Cookie發送給瀏覽器，瀏覽器收到Cookie，會將它保存在記憶體中（註意這裡的記憶體是本機記憶體，而不是伺服器記憶體）或者本地文件，那之後每次向伺服器發送請求，瀏覽 ...
  • Java自學-集合框架 ArrayList和HashSet的區別
    Java ArrayList和HashSet的區別 示例 1 : 是否有順序 ArrayList: 有順序 HashSet: 無順序 HashSet的具體順序，既不是按照插入順序，也不是按照hashcode的順序。 以下是 HasetSet源代碼 中的部分註釋 / It makes no guara ...
  • Elasticsearch 6.8.4 啟動報錯解決方法
    運行環境：centos 7，jdk 1.8 問題一： 原因：無法創建本地文件問題,用戶最大可創建文件數太小 解決方案：切換到root用戶，編輯limits.conf配置文件， 添加類似如下內容： vim /etc/security/limits.conf 添加如下內容:* soft nofile 6 ...
  • 在Spring Boot中使用Docker在測試中進行高級功能測試
    最近又學到了很多新知識，感謝優銳課老師細緻地講解，這篇博客記錄下自己所學所想。 想更多地瞭解Spring Boot項目中的功能測試嗎？這篇文章帶你瞭解有關在測試中使用Docker容器的更多信息。 本文重點介紹在Spring Boot應用程式的功能測試期間應用一些最佳實踐。我們將演示一種高級方法，該方 ...
  • SpringBoot如何優雅的使用RocketMQ
    [TOC] SpringBoot如何優雅的使用RocketMQ MQ，是一種跨進程的通信機制，用於上下游傳遞消息。在傳統的互聯網架構中通常使用MQ來對上下游來做解耦合。 舉例：當A系統對B系統進行消息通訊，如A系統發佈一條系統公告，B系統可以訂閱該頻道進行系統公告同步，整個過程中A系統並不關係B系統 ...
  • Python經典排序演算法
    https://www.cnblogs.com/onepixel/p/7674659.html這個文章很nicehttps://www.bilibili.com/video/av685670?from=search&seid=1637373535603658338這個動圖優秀https://www.... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類