CAPCOM-TD-OSS/REDox

选用指南

AI 根据 README 整理 · 2026/10/14 13:50:39

使用方式

通过 NuGet 包安装，使用 C# API 进行序列化、反序列化、解析和编辑。

查看 README 依据

* **Compatibility layers** for System.Text.Json, Newtonsoft.Json, and DataContractJsonSerializer. * **Apache-2.0 licensed.** ## 3. 30-second example Install the core package: ```bash dotnet add package CAPCOM.REDox ``` Serialize, deserialize, parse, and edit through the same API surface: ```csharp using REDox.Json; var player = new Player { Name = "Leon", Level = 42, Items = ["Handgun", "Green Herb"] }; // Serialize / deserialize var json = JsonSerializer.Serialize(player); var restored = JsonSerializer.Deserialize<Player>(json);

// Parse into a token DOM and edit it in place using var doc = JsonDocument.Parse(json); var root = doc.RootElement.AsObject(); root["Name"] = "Claire"; // replace root.Add("Hp", 100); // add root.Remove("Level"); // remove var items = root["Items"].AsArray(); items.Add("First Aid Spray"); // append items.Insert(0, "Knife"); // insert items.RemoveAt(1); // remove by index var edited = doc.RootElement.ToJsonString(); public sealed class Player { public string? Name { get; set; } public int Level { get; set; }

部署要求

需要 .NET 10 或更高版本。

查看 README 依据

### Thread safety * **`DElement`**: The API is read-only, so a `DElement` can be referenced from multiple threads concurrently. * **`DValue` / `DObject` / `DMap` / `DArray`**: These must **not** be used from multiple threads at the same time. Their internal state can change even for operations that look read-only, such as getting a value or calling `GetPath`. Synchronize access externally, or give each thread its own instance (for example, via deep clone). --- ## Requirements * .NET 10 or later. ## How to build ### 1. Clone with submodules

已知限制

DOX 格式仅适用于可信输入，不应反序列化来自不受信任来源的数据。

查看 README 依据

var dcjSettings = new DataContractJsonSerializerSettings( new System.Runtime.Serialization.Json.DataContractJsonSerializerSettings()); ``` --- ## Security ### Trusted input only for DOX The DOX format handled by `DoxDocument` is a binary layout that mirrors the in-memory token array. It is designed for speed and is not intended to be a defensive parser for hostile data. Accept DOX data **only from trusted sources**. Do not deserialize DOX received from untrusted or unauthenticated origins (network clients, user uploads, etc.). Use a text format such as JSON for untrusted input.