JSON(JavaScript Object Notation) 是一種輕量級的數據交換格式。相對於另一種數據交換格式 XML,JSON 有著很多優點。例如易讀性更好,占用空間更少等。在 web 應用開發領域內,得益於 JavaScript 對 JSON 提供的良好支持,JSON 要比 XML 更受... ...
一、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
- 轉判斷是否為
解析元素流程圖
解析方法列表
方法名 | 方法作用 |
---|---|
AnalysisJson |
解析JSON字元串為C#數據結構 |
AnalysisJsonObject |
解析JSON字元串為對象結構 |
AnalysisJsonArray |
解析JSON字元串為數組結構 |
ReadElement |
讀取出一個JSON結構 |
ReadJsonNumber |
讀取出一個值類型結構 |
ReadJsonNull |
讀取出一個null 結構 |
ReadJsonFalse |
讀取出一個false 結構 |
ReadJsonTrue |
讀取出一個true 結構 |
ReadString |
讀取出一個字元串結構 |
ReadToNonBlankIndex |
讀取到非空白字元下標位置 |
例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對象結構實例
- 先解析Key結構調用
例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對象結構實例
- 先解析Key結構調用
- 讀取下一個字元發現是
]
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 = 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代碼