2 Star 3 Fork 0

myj / Bson

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README.md 3.75 KB
一键复制 编辑 原始数据 按行查看 历史
myj 提交于 2023-11-25 15:06 . 修改

Bson

介绍

Bson是一个简单的json库,可实现java对象与json之间的相互转换,支持泛型。

概念

  • Bean: 指java对象包括MapListPOJO以及其他基础类型,如数字、字符串等
  • jsonStr: json字符串,表示字符串类型的json
  • Json: 指类Json及其子类,是Bson定义的BeanjsonStr的中间数据类型

角色转换顺序:Bean <--> Json <--> JsonStr

软件架构

Bson中存在生成器(Generator)以及解析器(Parser)。

生成器负责根据Json对象生成BeanjsonStr,解析器负责将BeanjsonStr解析为Json对象。

BsonConfig为配置类,提供在使用Bson时的一些可选项。创建时使用了构建者模式,其内属性创建后不可变。

Bson中对于Bean处理时直接使用字段,不使用gettersetter方法。

安装教程

  • 下载源码后自行打包,无任何依赖
  • 点击Bson 发行版,选择最新版下载

使用说明

入口

Bson

可使用类plus.myj.bson.Bson,其内提供了简便转换方法。

  • 转换方法用来将数据从BeanjsonStrJson中的一种形式转换为另外两种形式
  • 这三组方法中第一个参数表示数据的初始类型,最后一个参数表示配置对象,toBean拥有额外的第二个参数,表示生成bean的数据类型
  • 数据的初始类型:String表示当前为jsonStrObject表示当前为BeanJson表示当前为Json
  • toBean方法的第二个参数可以是Class或者BsonWrapper类型,不同的是BsonWrapper可以用来指定泛型
  • toJsonStr拥有特殊的toJsonStrPretty方法,简化了生成美化jsonStr的操作

示例:

String jsonStr = Bson.toJsonStr(Arrays.asList("a", "b"));
BsonActuator

新增门面类plus.myj.bson.BsonActuator,该类将配置转换来源转换目标区分开,可读性更高。

示例:

String jsonStr = BsonActuator.create().fromBean(Arrays.asList("a", "b")).toJsonStr();

配置

plus.myj.bson类为配置类,通过传入配置类对象可配置一些可选项。

  • isPretty: 是否美化
  • dateHandleType: 日期处理类型,可指定字符串或时间戳
  • readDatePatternwriteDatePattern: 读、写日期格式。在dateHandleType为 字符串 时使用,该配置用于表示什么格式的字符串将被解析为日期,或者日期在被写为字符串时的格式。
  • spaceNum: 输出美化的jsonStr时的缩进空格数
  • scale: 浮点数保留位数,负数表示不格式化,默认为负数
  • roundingMode: 浮点数格式化方式,默认为四舍五入
  • existNull: 是否存在空。表示在对象中字段为空时,生成的toJsonStr是否含有该键。

注解

  • BsonIgnore: 放在字段上,表示解析或生成Bean时忽略此字段,可指定读、写时不同
  • BsonAlias: 放在字段上,用来更改该字段名称解析与生成Bean时均有效,可以指定读写时别名不同

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

特技

  1. 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
  2. Gitee 官方博客 blog.gitee.com
  3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
  4. GVP 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
  5. Gitee 官方提供的使用手册 https://gitee.com/help
  6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/
Java
1
https://gitee.com/myj001/bson.git
git@gitee.com:myj001/bson.git
myj001
bson
Bson
master

搜索帮助