Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yutopp/vjson
A JSON serializer/deserializer (with JsonSchema support) library written in pure C#
https://github.com/yutopp/vjson
csharp json json-schema serialization unity
Last synced: about 3 hours ago
JSON representation
A JSON serializer/deserializer (with JsonSchema support) library written in pure C#
- Host: GitHub
- URL: https://github.com/yutopp/vjson
- Owner: yutopp
- License: bsl-1.0
- Created: 2019-02-05T17:16:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-14T05:23:20.000Z (about 2 years ago)
- Last Synced: 2024-12-14T06:00:18.275Z (about 1 month ago)
- Topics: csharp, json, json-schema, serialization, unity
- Language: C#
- Homepage:
- Size: 298 KB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE_1_0.txt
Awesome Lists containing this project
README
# VJson 🍣
> A JSON serializer/deserializer (with JsonSchema support) library written in pure C#.
[](https://github.com/yutopp/VJson/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/net.yutopp.vjson)
[](https://www.nuget.org/packages/VJson/)
[](https://codecov.io/gh/yutopp/VJson)
[](https://github.com/yutopp/VJson/blob/master/LICENSE_1_0.txt)
`VJson` is a JSON serializer/deserializer (with JsonSchema support) library written in pure C#. Supported versions are `.NET Standard 2.0` or higher.
This library is developed as a purely C# project, however it also supports that be build with `Unity 2019.4.22f1` or higher.
## Installation
### For standard C# projects
You can use [Nuget/VJson](https://www.nuget.org/packages/VJson/).
```bash
dotnet add package VJson
```
### For Unity projects
#### stable
Add scoped registry information shown below to your `Packages/manifest.json` if not exists.
```json
{
"scopedRegistries": [
{
"name": "yutopp.net",
"url": "https://registry.npmjs.com",
"scopes": [
"net.yutopp"
]
}
]
}
```
And add `net.yutopp.vjson` to your `Packages/manifest.json` like below.
```json
{
"dependencies": {
"net.yutopp.vjson": "*"
}
}
```
#### nightly
Add a url for VJson git repository to your `Packages/manifest.json` like below.
```json
{
"dependencies": {
"net.yutopp.vjson": "https://github.com/yutopp/VJson.git?path=Packages/net.yutopp.vjson"
}
}
```
(TODO: Provide unity packages)
## Usage example
### Serialize/Deserialize
```csharp
//
// For serialization
//
var serializer = new VJson.JsonSerializer(typeof(int));
// You can get JSON strings,
var json = serializer.Serialize(42);
// OR write json data(UTF-8) to streams directly.
using (var s = new MemoryStream())
{
serializer.Serialize(s, 42);
}
```
```csharp
//
// For deserialization
//
var serializer = new VJson.JsonSerializer(typeof(int));
// You can get Object from strings,
var value = serializer.Deserialize(json);
// OR read json data(UTF-8) from streams directly.
using (var s = new MemoryStream(Encoding.UTF8.GetBytes(json)))
{
var value = serializer.Deserialize(s);
}
```
`VJson` supports serializing/deserializing of some `System.Collections(.Generics)` classes listed below,
- List
- Dictionary
- Array
and user defined classes. For user defined classes, converting only all public fields are supported.
e.g.
(It is strongly recommended to always add VJson attributes such as [JsonField] to fields that you want to treat as Json. This will avoid problems with IL2CPP, especially when using Unity.)
```csharp
class SomeObject
{
private float _p = 3.14f; // Fields which are non-public will not be exported by default.
[JsonField] long _p2 = 4; // Fields which are non-public BUT having [JsonField] (+etc) attributes will BE exported!
public int X; // Fields which are public will be exported by default, but we strongly recommended to add [JsonField] attributes like below.
[JsonField] public string Y;
}
var obj = new SomeObject {
X = 10,
Y = "abab",
},
var serializer = new VJson.JsonSerializer(typeof(SomeObject));
var json = serializer.Serialize(obj);
// > {"_p2": 4,"X":10,"Y":"abab"}
var v = serializer.Deserialize("{\"X\":10,\"Y\":\"abab\"}");
// > v becomes same as obj.
```
#### Attributes
...
### JSON Schema and validation
`VJson` supports JSON Schema draft7.
(TODO: Write examples)
#### Attributes
(TODO: Write examples)
Other use cases are available at [here](https://github.com/yutopp/VJson/tree/master/Assets/VJson/Editor/Tests).
## Tasks
- [ ] Performance tuning
## License
[Boost Software License - Version 1.0](./LICENSE_1_0.txt)
## References
- [JSON](https://www.json.org/)
- [JSON Schema Specification](https://json-schema.org/specification.html)
## Author
- [@yutopp](https://github.com/yutopp)