欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

c# 如何实现一个简单的json解析器

程序员文章站 2022-08-30 12:38:09
一、json格式介绍 json(javascript object notation) 是一种轻量级的数据交换格式。相对于另一种数据交换格式 xml,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

解析元素流程图

c# 如何实现一个简单的json解析器

解析方法列表

方法名 方法作用
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对象结构实例

例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);
        readtononblankindex(text, ref index);
        if (text[index] != ':') throw new jsonanalysisexception($"不能识别的字符“{text[index]}”!",index);
        index++;
        readtononblankindex(text, ref index);
        if (jsonarray.containskey(name)) throw new jsonanalysisexception($"已经添加键值:“{name}”",index);
        //读取下一个element
        jsonarray.add(name, readelement(text, ref index));
        //读取到非空白字符
        readtononblankindex(text, ref index);
      } while (text[index++] != '}');

      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);
      } while (text[index++] != ']');

      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]}”应该为【[、{{、\"、true、false、null】", index);
      }
    }

    /// <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);
    }

    /// <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);
    }

    /// <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);
    }

    /// <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);
          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);
              }
            }
          }
        }
        else if (c == '"')
        {
          break;
        }
        else if (c == '\r' || c == '\n')
        {
          throw new jsonanalysisexception("传入的json字符串内容中不允许有换行!",index);
        }
        else
        {
          value.append(c);
        }
      }

      return value.tostring();
    }

    /// <summary>
    /// 判断是否为16进制字符
    /// </summary>
    private static bool ishex(char c)
    {
      return c >= '0' && c <= '9' || c >= 'a' && c <= 'z' || c >= 'a' && c <= 'z';
    }

    /// <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# 如何实现一个简单的json解析器的详细内容,更多关于c# 实现json解析器的资料请关注其它相关文章!