Wjybxx.Dson.Core
2.2.0
See the version list below for details.
dotnet add package Wjybxx.Dson.Core --version 2.2.0
NuGet\Install-Package Wjybxx.Dson.Core -Version 2.2.0
<PackageReference Include="Wjybxx.Dson.Core" Version="2.2.0" />
paket add Wjybxx.Dson.Core --version 2.2.0
#r "nuget: Wjybxx.Dson.Core, 2.2.0"
// Install Wjybxx.Dson.Core as a Cake Addin #addin nuget:?package=Wjybxx.Dson.Core&version=2.2.0 // Install Wjybxx.Dson.Core as a Cake Tool #tool nuget:?package=Wjybxx.Dson.Core&version=2.2.0
Dson Csharp
模块说明
- Dson.Core: Core模块提供了Dson的文本和二进制流编解码实现。
- Dson.Codec: Codec模块提供了基于Dson的对象序列化实现(ORM)。
- Dson.Apt: Apt模块处理Codec模块约定的注解,为目标类生成编解码类(Codec)。
简单使用指南
这里只介绍Dson-Core模块的功能,有关对象序列化的说明请跳转Dson.Codec模块。
Dsons工具类
为方便用户使用,我提供了Dsons工具类,提供了大量的读写Dson的快捷API。
注意:FromDson默认只读取第一个对象。
DsonObject<String> dsonObject = Dsons.FromDson(dsonString).AsObject();
String dsonString1 = Dsons.ToDson(dsonObject, ObjectStyle.Indent);
Console.WriteLine(dsonString1);
解析引用(DsonRepository)
Dsons中的方法默认不解析引用,库提供了简单解析引用的工具类DsonRepository。
方式1:FromDson的时候解析引用。
DsonRepository repository = DsonRepository.FromDson(reader, true);
方式2:需要的时候解析引用。该方式支持手动构建repository。
DsonRepository repository = DsonRepository.FromDson(reader);
repository.ResolveReference();
C#库特性
解析规则不分语言,因此reader的实现应该保持一致,也就不存在特别的特性。
但书写格式各个库的实现可能并不相同,因此writer可能有所差异;不过Csharp的代码也由我编写,因此具备与Java相同的特性。
Reader
投影(Projection)
我在V1.4版本为Java和C#增加了投影功能;一开始仅仅是想截取Dson文本中的某块,避免全量解析,后来想起了MongoDB的投影功能, 投影是比获取分块更完备的功能,花了2天工夫实现了一版,不过没做语法简化。
Writer
全局设置
- 支持行长度限制,自动换行
- 支持关闭纯文本模式
- 支持ASCII不可见字符转unicode字符输出
- 支持无行首打印,即打印为类json模式
一般不建议开启unicode字符输出,我设计它的目的仅仅是考虑到可能有跨语言移植的需求。 支持关闭纯文本模式,是为了与ASCII不可见字符打印为unicode字符兼容。
NumberStyle
Number提供了9种默认格式输出:
- SIMPLE 简单模式 —— 普通整数和小数格式,科学计数法
- TYPED 简单类型模式 —— 在简单模式的基础上打印类型
- UNSIGNED 将整数打印为普通无符号数 -- 不支持浮点数
- TYPED_UNSIGNED 将整数打印为普通无符号数,同时打印类型 -- 不支持浮点数
- SignedHex 有符号16进制,负数会输出负号 -- 不支持浮点数
- UnsignedHex 无符号16进制,负数将打印所有位 -- 不支持浮点数
- SignedBinary 有符号2进制,负数会输出负号 -- 不支持浮点数
- UnsignedBinary 无符号2进制,负数将打印所有位 -- 不支持浮点数
- FixedBinary 固定位数2进制,int32打印为32位,int64打印为64位
注意:
- 浮点数不支持二进制格式
- 浮点数是NaN、Infinite或科学计数法格式时,简单模式下也会打印类型
- 浮点数的16进制需要小心使用,需先了解规范
- 因为数字的默认解析类型是double,因此int64的值大于double的精确区间时,将自动添加类型
- 允许用户添加自己的Style
StringStyle
字符串支持以下格式:
- AUTO 自动判别
- 当内容较短且无特殊字符,且不是特殊值时不加引号
- 当内容长度中等时,打印为双引号字符串
- 当内容较长时,打印为文本模式
- AUTO_QUOTE —— 与AUTO模式相似,但不启用文本模式
- QUOTE 双引号模式
- UNQUOTE 无引号模式 —— 常用于输出一些简单格式字符串
- TEXT 文本模式 —— 常用于输出长字符串
- SIMPLE_TEXT 简单文本模式 —— 输出常量字符串,保持原始格式
- STRING_LINE 单行字符串 —— 输出不含换行符,但含其它特殊字符的短字符串
ObjectStyle
对象(object/array/header)支持两种格式:
- INDENT 缩进模式(换行)
- FLOW 流模式
属性较少的对象适合使用Flow模式简化书写和减少行数,同时数据量较大的Array也很适合Flow模式, 可以很好的减少行数。
PS:其实Writer的目标就是尽可能和我们的书写格式一致。
文本左对齐
在新的版本中,我增加行首缩进和纯文本左对齐功能,运行DsonTextReaderTest2
测试用力,我们得到以下文本。
{@{clsName: MyClassInfo, guid: 10001, flags: 0}
name: wjybxx,
age: 28,
pos: {@{Vector3}
x: 0,
y: 0,
z: 0
},
address: [
beijing,
chengdu
],
intro:
@"""
@- 我是wjybxx,是一个游戏开发者,Dson是我设计的文档型数据表达法,你可以通过gi
@- thub联系到我。
@| thanks
""",
url: "https://www.github.com/hl845740757",
time: {@dt date: 2023-06-17, time: 18:37:00, millis: 100,
offset: +08:00}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net5.0
- Wjybxx.Commons.Core (>= 1.1.0)
-
net6.0
- Wjybxx.Commons.Core (>= 1.1.0)
-
net7.0
- Wjybxx.Commons.Core (>= 1.1.0)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Wjybxx.Dson.Core:
Package | Downloads |
---|---|
Wjybxx.Dson.Codec
Dson对象序列化组件 |
|
Wjybxx.Dson.Apt
Dson注解处理器,代码生成工具 |
|
Wjybxx.BTree.Codec
行为树Codec包 |
GitHub repositories
This package is not used by any popular GitHub repositories.