# ohos_gson

**Repository Path**: openharmony-sig/ohos_gson

## Basic Information

- **Project Name**: ohos_gson
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 11
- **Forks**: 11
- **Created**: 2022-09-05
- **Last Updated**: 2025-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🚨 **重要提示 | IMPORTANT**
>
> **⚠️ 此代码仓已归档。新地址请访问 [ohos_gson](https://gitcode.com/openharmony-sig/ohos_gson)。| ⚠️ This repository has been archived. For the new address, please visit [ohos_gson](https://gitcode.com/openharmony-sig/ohos_gson).**
>
---
>
# Gson

## 说明

该库停止维护，建议使用JSON。

## 简介

Gson用于对象与JSON字符串之间的互相转换，并支持JsonElement对象类型，使JSON字符串与对象之间的转换更高效、灵活，并且易于使用。

## 下载安装

````
ohpm install @ohos/gson-ts
````

OpenHarmony ohpm 环境配置等更多内容，请参考[如何安装 OpenHarmony ohpm 包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_har_usage.md)

## 使用说明

#### 1、JSON字符串转Object。

```typescript
// 引入Gson
import { Gson } from '@ohos/gson-ts'
// JSON字符串
let str = '{"name":"张三"}'
// JSON字符串转对象
let obj1 = new Gson().fromJson(str);
// { name:"张三" }
```

#### 2、Object转JSON字符串。

```typescript
// 引入Gson
import { Gson } from '@ohos/gson-ts'
// 对象
let str = { name: "张三" }
// 对象转JSON字符串
let obj1 = new Gson().toJson(str);
// '{"name":"张三"}'
```

#### 3、JSON字符串转JsonElement对象。

```typescript
// 引入parseString和JsonElement
import { parseString, JsonElement } from '@ohos/gson-ts'
// JSON字符串
let str = '{"name":"张三"}'
// JSON字符串转JsonElement对象
let jsonElement:JsonElement = parseString(str)
// 类型是JsonElement的对象 { name:"张三" }
```

#### 4、Object转JsonElement对象。

```typescript
// 引入Gson和JsonElement
import { Gson, JsonElement } from '@ohos/gson-ts'
// 对象
let str = { name: "张三" }
// Object转JsonElement对象
let jsonElement:JsonElement = new Gson().toJsonTree(str)
// 类型是JsonElement的对象 { name:"张三" }
```

#### 5、Object转JsonElement对象再转JSON字符串。

```typescript
// 引入Gson和JsonElement
import { Gson, JsonElement } from '@ohos/gson-ts'
// 对象
let str = { name: "张三" }
// Object转JsonElement对象
let jsonElement:JsonElement = new Gson().toJsonTree(str)
// JsonElement对象转JSON字符串
let str2 = new Gson().toJson(jsonElement)
// '{"name":"张三"}'
```

#### 6、JSON字符串转JsonElement对象再转Object。

```typescript
// 引入Gson、parseString和JsonElement
import { Gson, JsonElement, parseString } from '@ohos/gson-ts'
// JSON字符串
let str = '{"name":"张三"}'
// JSON字符串转JsonElement对象
let jsonElement:JsonElement = parseString(str)
// JsonElement对象转Object
let str2 = new Gson().fromJson(jsonElement)
// 类型是JsonElement的对象 { name:"张三" }
```

## 接口说明

### Gson
|方法名|入参|接口描述|
|:---:|:---:|:---:|
|fromJson|string|JSON字符串转对象|
|toJson|object|对象转JSON字符串|
|toJsonTree|object|对象转JsonElement|
|parseString|string|字符串转JsonElement|
## 约束与限制

在下述版本验证通过：
- DevEco Studio: NEXT Beta1-5.0.3.806,SDK:API12 Release(5.0.0.66)
- DevEco Studio 版本： 4.1 Canary(4.1.3.317)

- OpenHarmony SDK:API11 (4.1.0.36)

## 目录结构

````
|---- Gson 
|     |---- entry  # 示例代码文件夹
|     |---- library   # gson库文件夹
|           |---- index.ets  # 对外接口
|     |---- README.md  # 安装使用方法      
````

## 贡献代码
使用过程中发现任何问题都可以提 [Issue](https://gitee.com/openharmony-sig/ohos_gson/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://gitee.com/openharmony-sig/ohos_gson/pulls) 。

## 开源协议
本项目基于 [Apache License 2.0](https://gitee.com/openharmony-sig/ohos_gson/blob/master/LICENSE) ，请自由地享受和参与开源。