# 数据模型生成工具

**Repository Path**: lirenmeng/data-model-generation-tool

## Basic Information

- **Project Name**: 数据模型生成工具
- **Description**: 快捷生成数据模型的工具
涵盖
Swift语言配合HandyJSON、SwiftyJSON、系统方案
OC语言配合YYModel、MJExtension、系统方案
Dart语言配合json_serializable、系统方案

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-23
- **Last Updated**: 2025-07-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 数据模型生成工具

#### 介绍
快捷生成数据模型的工具
涵盖
Swift语言配合HandyJSON、SwiftyJSON、系统方案
OC语言配合YYModel、MJExtension、系统方案
Dart语言配合json_serializable、系统方案


#### 注意事项
1. 目前此工具可以完成大部分数据模型需求，但是有一些属性推断不是很准确，例如有一些属性可能会推断为id类型，生成之后需要注意，有不对的需要手动修改，后期可能会完善
2. 可以使用node.js环境安装，然后在线是用App.js文件，也可以直接使用HTML文件，本地使用


#### 安装教程

1.安装 Node.js 和 npm (或 yarn)
React 开发需要 Node.js 和 npm（Node 包管理器）或 yarn。如果你还没有安装，可以访问 Node.js 官网 (nodejs.org) 下载并安装最新版本。安装 Node.js 后，npm 也会随之安装。

2.创建新的 React 项目
打开你的终端或命令行工具，然后运行以下命令来创建一个新的 React 项目。这里我们使用 create-react-app，它是一个方便的工具，可以快速设置 React 项目：

```
npx create-react-app model-generator-tool
```

```
cd model-generator-tool
```

3.替换项目代码
cd model-generator-tool 命令会让你进入新创建的项目目录。在这个目录里，你会找到一个 src 文件夹。
打开 src/App.js 文件。
将下载的文件替换你本地的App.js

4.运行项目
在终端中，确保你还在 model-generator-tool 目录下，然后运行：

```
npm start
```
或

```
yarn start
```

这会启动一个开发服务器，通常会在你的浏览器中自动打开 http://localhost:3000（如果端口被占用，可能会是其他端口）。你现在就可以在本地浏览器中使用这个 JSON 模型生成工具了。

这样，你就可以完全在自己的电脑上离线使用这个工具了。




#### 使用说明

1. Flutter/Dart (使用 json_serializable 框架)
所需环境： Flutter SDK，Dart SDK。
安装依赖： 在您的 pubspec.yaml 文件中，添加以下依赖（请替换为最新版本）：

```
dependencies:
  flutter:
    sdk: flutter
  json_annotation: ^<latest_version> # 例如: ^4.8.1

dev_dependencies:
  flutter_test:
    sdk: flutter
  build_runner: ^<latest_version> # 例如: ^2.4.6
  json_serializable: ^<latest_version> # 例如: ^6.7.1
```
运行命令生成文件： 在您的 Flutter 项目根目录下，运行以下命令来安装依赖并生成 .g.dart 文件：

```
flutter pub get
flutter pub run build_runner build
```
如果您修改了模型类，需要重新运行 flutter pub run build_runner build 命令来更新生成的文件。
使用方式： 在您的 Dart 代码中，导入生成的模型文件（例如 import 'package:your_project_name/models/your_model_name.dart';），然后使用 YourModel.fromJson(jsonMap) 和 modelInstance.toJson() 进行序列化和反序列化。


2. Swift (使用 HandyJSON 或 Codable / SwiftyJSON 框架)
HandyJSON / SwiftyJSON (以 CocoaPods 为例)： 在您的 Podfile 文件中，添加对应依赖


3. Objective-C (使用 MJExtension 或 YYModel / 系统生成方式)
MJExtension / YYModel (以 CocoaPods 为例)： 在您的 Podfile 文件中，添加对应依赖