# FuckJSON

**Repository Path**: ASCIPHX/FuckJSON

## Basic Information

- **Project Name**: FuckJSON
- **Description**: 序列化与反序列化JSON工具，支持结构体直接转为JSON格式字符串、嵌套box指针对象的反序列化。
- **Primary Language**: C++
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2022-01-26
- **Last Updated**: 2023-11-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: serialization, reflection, JSON, Cpp

## README

# FuckJSON[v2.3]
> 元宇宙的c++的序列化与反序列化JSON工具

## 优势
- [x] 基于最现代化的JSON库，nlohman JSON。
- [x] 只需要原生的结构体，简单的两句宏即可搞定。
- [x] 强大静态反射，最高性能(相对于其他语言)，最低开销，最迅速的反应，最容易维护，以及最少代码。
- [x] 解决模块化与互相依赖，循环依赖的问题。
- [x] 纯头文件无需cmake即可直接编译。
- [x] 序列化对象或者vector对象到字符串，序列化对象得到JSON，反序列化Json格式字符串到对象。
- [x] 宽松的布尔类型反序列化，包含但不仅限于true、false，还有0，1;
- [x] 支持class或者struct直接转json字符串
- [x] 允许数据库的varchar类型，采用text<>方案并精确到每个字符，保证在最大长度范围内和数据安全
- [x] 支持rust的box，无需使用裸指针，且速度极快
- [x] 能够反序列化json格式字符串，其中包括互相嵌套的对象，理论可以无限嵌套

## 模型层
```c++
class Tab;
class Type;

Class(Tab)
uint32_t id;
bool ok;
text<15> name;
tm date;
vector<Type> types;
box<Type> type;
Tab(uint32_t a = 0, bool b = false, const char* c = "", tm d = now(), vector<Type> e = {}, box<Type> f = nullptr) :
  id(a), ok(b), name(c), date(d), types(e), type(f) {}
FUCKJSON(Tab, id, ok, name, date, types, type)

Class(Type)
uint8_t id;
text<10> language;
double bigBlob;
vector<Tab> tabs;
box<Tab> tab;
Type(uint8_t a = 0, const char* b = "", double c = 0, vector<Tab> d = {}, box<Tab> e = nullptr) :
  id(a), language(b), bigBlob(c), tabs(d), tab(e) {}
FUCKJSON(Type, id, language, bigBlob, tabs, tab)
```

## 例子
> 假设存在一个上面的对象Tab
```c++
Tab t{ 1, true, "reflect", now() };
```

### 将对象序列化为JSON的字符串
```c++
std::string s; s << &t;
```
### 将对象序列化为JSON
```c++
json(t);
```
### 将JSON字符串反序列化为对象
```c++
json::parse(t, R"(
{
  "id": 3,
  "ok": false,
  "name": "干杯🍻🍺!",
  "date": "2021-09-08 01:04:30",
  "type":  {
    "bigBlob": 0.1,
    "id": 1,
    "language": "元宇宙🌀🌌🪐!"
  }
}
)");
```

## 特征
 - 模块化
 - 仅头文件
 - 低代码
 - 高性能

## 前提
```shell
g++ -std=c++17 main.cc -o main -I./ -O3
g++ -std=c++17 *.cpp -o o2o -I./ -O3
g++ -std=c++17 benchmark.cc -o benchmark -I./ -O3
g++ -std=c++17 text.cc -o text -I./ -O3
```
# 支持的编译器（最低版本）:
    - Linux: G++ 9.2, Clang++ 9.0
    - MacOS: Apple clang version 12.0.0 
    - Windows: MSVC C++ compiler version 1930.

### Attributions
    uses the following libraries.

	json 

    https://github.com/nlohmann/json

    Copyright (c) 2013-2021 Niels Lohmann
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.