用c#自己實作一個簡單的JSON決議器

一、JSON格式介紹

• JSON(JavaScript Object Notation) 是一種輕量級的資料交換格式，相對于另一種資料交換格式 XML，JSON 有著很多優點，例如易讀性更好，占用空間更少等，在 web 應用開發領域內，得益于 JavaScript 對 JSON 提供的良好支持，JSON 要比 XML 更受開發人員青睞，所以作為開發人員，如果有興趣的話，還是應該深入了解一下 JSON 相關的知識，本著探究 JSON 原理的目的，我將會在這篇文章中詳細向大家介紹一個簡單的JSON決議器的決議流程和實作細節，由于 JSON 本身比較簡單，決議起來也并不復雜，所以如果大家感興趣的話，在看完本文后，不妨自己動手實作一個 JSON 決議器，好了，其他的話就不多說了，接下來讓我們移步到重點章節吧，
• 在線JOSN校驗格式化工具 如果在決議字串的時候，拿不準這個是不是正確的JOSN，你可以在這個上面測驗一下，有利于對自己代碼的測驗

二、決議原理介紹

• 決議物件{}
  • 物件結構是{"Key":[值]}的格式，所以先決議到Key字串，將Key決議出來，然后在決議到值，因為值有可能是【字串、值型別、布爾型別、物件、陣列、null】所以需要根據前綴得到型別，并呼叫相應的決議方法，回圈決議到“}”物件結尾
• 決議陣列[]
  • 物件的結構是[[值],[值]]，因為值有可能是【字串、值型別、布爾型別、物件、陣列、null】所以需要根據前綴得到型別，并呼叫相應的決議方法，回圈決議到]陣列結尾
• 決議字串
  • 回圈決議，需要判斷是否遇到轉義符\如果遇到，當前字符的下一個字符將是作為普通字符存入結果，如果遇到非轉義的 " 字符則退出字串讀取方法，并回傳結果
• 決議值型別
  • 回圈拉取[0-9]包括.符號，然后呼叫轉換成double型別方法
• 決議布爾型別
  • 轉判斷是 true 還是 false
• 決議null
  • 轉判斷是否為 null

決議元素流程圖

決議方法串列

例1 決議JSON

{"Name":"張三","Age":18}

• 1.決議第一個字符{發現是JSON物件結構，呼叫AnalysisJsonObject方法來決議JSON物件格式
• 2.決議物件的方法開始回圈決議 Key-Value結構直到}物件尾部字符
  • 先決議Key結構呼叫 ReadString來進行決議出Key字串從而得到Name這個值
  • 然后決議Value因為值可能是任意結構所以呼叫ReadElement來決議出一個JSON結構
    • 讀取第一個字符得到"從而知道這個Value是一個字串，呼叫方法ReadString來讀取到這個Value的值張三
  • 讀取下一個字符發現不是JSON物件的結尾字符}是,字符代表下面還存在一個Key-Value結構，繼續讀取
  • 先決議Key結構呼叫 ReadString來進行決議出Key字串從而得到Age這個值
  • 然后決議Value因為值可能是任意結構所以呼叫ReadElement來決議出一個JSON結構
    • 讀取第一個字符發現是1是數字，代表下面的這個結構是數值型別呼叫方法ReadJsonNumber來讀取數值型別
  • 讀取下一個字符發現是}是JSON物件的結尾字符，退出JSON物件決議，回傳決議的JSON物件結構實體

例2 決議JSON

[{"科目":"語文","成績":99}]

• 1.決議第一個字符[發現是JSON陣列結構，呼叫方法AnalysisJsonArray方法來決議出JSON陣列結構
  • 決議回圈決議JSON資料結構直到遇到]陣列結構結尾字符
    • 因為陣列中每個元素都是可能是任意型別資料，所以呼叫ReadElement方法來決議值
    • 讀取值的第一個字符{發現是JSON物件型別呼叫AnalysisJsonObject方法決議JSON物件
      • 先決議Key結構呼叫 ReadString來進行決議出Key字串從而得到科目這個值
      • 然后決議Value因為值可能是任意結構所以呼叫ReadElement來決議出一個JSON結構
        • 讀取第一個字符得到"從而知道這個Value是一個字串，呼叫方法ReadString來讀取到這個Value的值語文
      • 讀取下一個字符發現不是JSON物件的結尾字符}是,字符代表下面還存在一個Key-Value結構，繼續讀取
      • 先決議Key結構呼叫 ReadString來進行決議出Key字串從而得到成績這個值
      • 然后決議Value因為值可能是任意結構所以呼叫ReadElement來決議出一個JSON結構
        • 讀取第一個字符發現是9是數字，代表下面的這個結構是數值型別呼叫方法ReadJsonNumber來讀取數值型別
      • 讀取下一個字符發現是}是JSON物件的結尾字符，退出JSON物件決議，回傳決議的JSON物件結構實體
    • 讀取下一個字符發現是]JSON陣列的結尾，退出決議JSON陣列，回傳決議的JSON陣列結構實體

三、代碼實作

    /// <summary>
    /// JSON決議型別
    /// </summary>
    public static class JsonConvert
    {
        /// <summary>
        /// 決議JSON
        /// </summary>
        /// <param name="text">待決議的JSON字串</param>
        /// <returns>決議完成的JSON結構物件</returns>
        public static JsonElement AnalysisJson(string text)
        {
            var index = 0;
            //讀取到非空白字符
            ReadToNonBlankIndex(text, ref index);
            if (text[index++] == '[')
                //決議陣列
                return AnalysisJsonArray(text, ref index);
            //決議物件
            return AnalysisJsonObject(text, ref index);
        }

        /// <summary>
        /// 決議JSON物件
        /// </summary>
        /// <param name="text">JSON字串</param>
        /// <param name="index">開始索引位置</param>
        /// <returns>JSON物件</returns>
        private static JsonObject AnalysisJsonObject(string text, ref int index)
        {
            var jsonArray = new JsonObject();
            do
            {
                ReadToNonBlankIndex(text, ref index);
                if (text[index] != '"') throw new JsonAnalysisException($"不能識別的字符“{text[index]}”！應為“\"”", index);
                index++;
                //讀取字串
                var name = ReadString(text, ref index);
                if (jsonArray.ContainsKey(name)) throw new JsonAnalysisException($"已經添加鍵值：“{name}”", index);
                ReadToNonBlankIndex(text, ref index);
                if (text[index] != ':') throw new JsonAnalysisException($"不能識別的字符“{text[index]}”！", index);
                index++;
                ReadToNonBlankIndex(text, ref index);
                //讀取下一個Element
                jsonArray.Add(name, ReadElement(text, ref index));
                //讀取到非空白字符
                ReadToNonBlankIndex(text, ref index);
                var ch = text[index++];
                if (ch == '}') break;
                if (ch != ',') throw new JsonAnalysisException($"不能識別的字符“{text[index - 1]}”！", index - 1);
            } while (true);

            return jsonArray;
        }

        /// <summary>
        /// 決議JSON陣列
        /// </summary>
        /// <param name="text">JSON字串</param>
        /// <param name="index">開始索引位置</param>
        /// <returns>JSON陣列</returns>
        private static JsonArray AnalysisJsonArray(string text, ref int index)
        {
            var jsonArray = new JsonArray();
            do
            {
                ReadToNonBlankIndex(text, ref index);
                //讀取下一個Element
                jsonArray.Add(ReadElement(text, ref index));
                //讀取到非空白字符
                ReadToNonBlankIndex(text, ref index);
                var ch = text[index++];
                if (ch == ']') break;
                if (ch != ',') throw new JsonAnalysisException($"不能識別的字符“{text[index - 1]}”！", index - 1);
            } while (true);

            return jsonArray;
        }

        /// <summary>
        /// 讀取JSONElement
        /// </summary>
        /// <param name="text">字串</param>
        /// <param name="index">開始下標</param>
        /// <returns>下一個Element</returns>
        private static JsonElement ReadElement(string text, ref int index)
        {
            switch (text[index++])
            {
                case '[':
                    return AnalysisJsonArray(text, ref index);
                case '{':
                    return AnalysisJsonObject(text, ref index);
                case '"':
                    return new JsonString(ReadString(text, ref index));
                case 't':
                    return ReadJsonTrue(text, ref index);
                case 'f':
                    return ReadJsonFalse(text, ref index);
                case 'n':
                    return ReadJsonNull(text, ref index);
                case '0':
                case '1':
                case '2':
                case '3':
                case '4':
                case '5':
                case '6':
                case '7':
                case '8':
                case '9':
                    return ReadJsonNumber(text, ref index);
                default:
                    throw new JsonAnalysisException($"未知Element“{text[index - 1]}”應該為【[、{{、\"、true、false、null】",
                        index - 1);
            }
        }

        /// <summary>
        /// 讀取值型別
        /// </summary>
        /// <param name="text">JSON字串</param>
        /// <param name="index">開始索引</param>
        /// <returns>JSON數值型別</returns>
        private static JsonNumber ReadJsonNumber(string text, ref int index)
        {
            var i = index;
            while (i < text.Length && char.IsNumber(text[i]) || text[i] == '.') i++;
            if (double.TryParse(text.Substring(index - 1, i - index + 1), out var value))
            {
                index = i;
                return new JsonNumber(value);
            }

            throw new JsonAnalysisException("不能識別的數字型別！", i);
        }

        /// <summary>
        /// 讀取NULL
        /// </summary>
        /// <param name="text">JSON字串</param>
        /// <param name="index">開始索引</param>
        /// <returns>讀取NULL</returns>
        private static JsonNull ReadJsonNull(string text, ref int index)
        {
            if (text[index++] == 'u' &&
                text[index++] == 'l' &&
                text[index++] == 'l')
            {
                return new JsonNull();
            }

            throw new JsonAnalysisException("讀取null出錯！", index - 1);
        }

        /// <summary>
        /// 讀取FALSE
        /// </summary>
        /// <param name="text">JSON字串</param>
        /// <param name="index">開始索引</param>
        /// <returns>布林值-假</returns>
        private static JsonBoolean ReadJsonFalse(string text, ref int index)
        {
            if (text[index++] == 'a' &&
                text[index++] == 'l' &&
                text[index++] == 's' &&
                text[index++] == 'e')
            {
                return new JsonBoolean(false);
            }

            throw new JsonAnalysisException("讀取布林值出錯！", index - 1);
        }

        /// <summary>
        /// 讀取TRUE
        /// </summary>
        /// <param name="text">JSON字串</param>
        /// <param name="index">開始索引</param>
        /// <returns>布林值-真</returns>
        private static JsonBoolean ReadJsonTrue(string text, ref int index)
        {
            if (text[index++] == 'r' &&
                text[index++] == 'u' &&
                text[index++] == 'e')
            {
                return new JsonBoolean(true);
            }

            throw new JsonAnalysisException("讀取布林值出錯！", index - 1);
        }

        /// <summary>
        /// 讀取字串
        /// </summary>
        /// <param name="text">JSON字串</param>
        /// <param name="index">開始索引</param>
        /// <returns>字串值</returns>
        private static string ReadString(string text, ref int index)
        {
            var value = https://www.cnblogs.com/liuzhenliang/p/new StringBuilder();
            while (index < text.Length)
            {
                var c = text[index++];
                //判斷是否是轉義字符
                if (c =='\\')
                {
                    value.Append('\\');
                    if (index >= text.Length)
                        throw new JsonAnalysisException("未知的結尾！", index - 1);
                    c = text[index++];
                    value.Append(c);
                    if (c == 'u')
                    {
                        for (int i = 0; i < 4; i++)
                        {
                            c = text[index++];
                            if (IsHex(c))
                            {
                                value.Append(c);
                            }
                            else
                            {
                                throw new JsonAnalysisException("不是有效的Unicode字符！", index - 1);
                            }
                        }
                    }
                }
                else if (c == '"')
                {
                    break;
                }
                else if (c == '\r' || c == '\n')
                {
                    throw new JsonAnalysisException("傳入的JSON字串內容中不允許有換行！", index - 1);
                }
                else
                {
                    value.Append(c);
                }
            }

            return value.ToString();
        }

        /// <summary>
        /// 判斷是否為16進制字符
        /// </summary>
        private static bool IsHex(char c)
        {
            return c >= '0' && c <= '9' || c >= 'a' && c <= 'f' || c >= 'A' && c <= 'F';
        }

        /// <summary>
        /// 讀取到非空白字符
        /// </summary>
        /// <param name="text">字串</param>
        /// <param name="index">開始下標</param>
        /// <returns>非空白字符下標</returns>
        private static void ReadToNonBlankIndex(string text, ref int index)
        {
            while (index < text.Length && char.IsWhiteSpace(text[index])) index++;
        }
    }

完整DEMO代碼下載

Github專案地址（會持續更新）：DEMO代碼

標籤：C#

上一篇：7. 云停車 (原始碼篇)

下一篇：WebClient,DownloadFileAsync,DownloadProgressChanged