百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

一种JSON字段转POJO的终极转换思路

wxin55 2024-11-18 17:56 10 浏览 0 评论

哈喽,各位代码战士们,我是Jensen,一个梦想着和大家一起在代码的海洋里遨游,顺便捡起那些散落的知识点的程序员小伙伴。

听说大家都不爱当“接码侠”,笔者在接盘别人代码之时也常意难平,我的心情大部分是这样的:

今天聊聊那些“骚操作”,看看数据库JSON字段是怎么映射到代码上来的。

本文涉及技术栈:类型处理器、D3Boot。

都有些什么写法

一、用String映射

这种是最简单最普遍的写法,JSON不就是字符串嘛,能存能取就行了,存数据库跟存银行没什么区别,数据库存一条,银行存一“张不够花”。

前后端要用?对不起,自己解析去吧,用Json工具类,转完七七四十九遍以后,别把这个字符串玩坏就行。

完了以后,隔壁组的数据分析狮张开了她的獠牙看向你……

二、用JSONObject映射

那我用世界500强公司的com.alibaba.fastjson.JSONObject总可以了吧。

可以是可以,但麻烦是真麻烦,取元素出来还得转换成具体的类型,只能通过字符串Key取值,还得引入个fastjson包,对于没什么阿里信仰的同学可能不是那么的友好。

Hutool包也有个同类名的cn.hutool.json.JSONObject,一不小心把两个给搞混就GG了。

要是再遇到你的同类把一个实体从头传到尾,再作为DTO提供Jar包出去就……

三、自定义类型处理器

其实,在Mybatis这个主流ORM框架中,有这么一个抽象类:

org.apache.ibatis.type.BaseTypeHandler<T>

它是 MyBatis 框架中一个非常重要的类,它提供了一个通用的基类,用于自定义类型处理器(TypeHandler)。

在 MyBatis 中,类型处理器负责在 Java 类型和 JDBC 类型之间的转换。当你想要对某种类型进行特殊的处理,或者 MyBatis 默认的类型处理器不能满足你的需求时,你可以自定义一个类型处理器。

以下是 BaseTypeHandler的一些关键点:

  1. 泛型:BaseTypeHandler<T> 使用泛型 T 来指定它所处理的 Java 类型。
  2. 继承:自定义类型处理器通常继承自 BaseTypeHandler<T>,并且重写几个核心方法。
  3. 核心方法void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType):此方法用于将 Java 类型设置到 SQL 语句的参数中。
  4. 核心方法T getResult(ResultGetter getter, Class<T> clazz):此方法用于从 SQL 查询的结果集中获取 Java 类型。
  5. 类型转换:BaseTypeHandler 的子类可以实现具体的类型转换逻辑,包括日期时间格式的转换、枚举类型的转换、复杂对象的序列化和反序列化等。
  6. 配置:自定义的类型处理器可以在 MyBatis 的映射文件中配置,与特定的字段或结果集映射相关联。
  7. 重用:由于 BaseTypeHandler 是泛型的,因此可以为不同的类型创建不同的处理器,同时重用相同的处理逻辑。

通过继承 BaseTypeHandler<T> 并实现必要的方法,你可以完全控制数据在 Java 对象和数据库之间的转换过程,这为处理复杂的业务逻辑提供了灵活性。

通过类型处理器,我们可以映射成任意类型,存取数据其实没有那么的麻烦。

不错不错,就它了。

还是先造个轮子吧

BaseTypeHandler子类已经支持挺多常见类型了,但我们要支持更多的类型,就必须自己写。继承BaseTypeHandler要覆写的方法有点多,我们先封装一轮,把核心的三个方法暴露出来:

public abstract class BaseTypeHandler<T> extends org.apache.ibatis.type.BaseTypeHandler<T> {

    /**
     * 获取实际的类型,用于后续的类型注册与类型判断
     */
    public Class<T> type() {
        return (Class<T>) ReflectionKit.getSuperClassGenericType(this.getClass(), 0);
    }

    /**
     * 把指定类型转换为字符串类型,对应写库
     */
    protected abstract String convert(T obj);

    /**
     * 把字符串类型解析成指定类型,对应读库
     */
    protected abstract T parse(String result);

    public void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
        if (parameter == null) return;
        ps.setString(i, this.convert(parameter));
    }

    public T getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String str = rs.getString(columnName);
        return str == null || str.isEmpty() ? null : this.parse(str);
    }

    public T getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String str = rs.getString(columnIndex);
        return str == null || str.isEmpty() ? null : this.parse(str);
    }

    public T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String str = cs.getString(columnIndex);
        return str == null || str.isEmpty() ? null : this.parse(str);
    }

}

接着,继承这个抽象类再写一个子抽象类:

/**
 * 自定义POJO类型转换器父类:json/varchar <-> T
 * 继承该类并加@Component注解,放在entity下的typehandlers目录,PO类无需在@TableField注解上加类型处理器,能自动转换
 *
 * @param <T> 自定义POJO,一般以VO命名,与Model同目录,注意T不能是List集合或Map类型,但可以是数组类型(以实现对对象数组的互转)
 * @author Jensen
 * @公众号 架构师修行录
 */
@Slf4j(topic = "### BASE-DATA : TypeHandlers ###")
public abstract class JsonStringTypeHandler<T> extends BaseTypeHandler<T> {
    private Class<?> componentType;
    private Object[] componentArray;

    public JsonStringTypeHandler() {
        Class<T> tClass = type();
        // 判断具体的类型是否为数组
        if (tClass.isArray()) {
            Class<Object[]> arrayClass = (Class<Object[]>) tClass;
            this.componentType = arrayClass.getComponentType();
            this.componentArray = (Object[]) Array.newInstance(componentType, 0);
        }
        log.info("Loading {}, type: {}", this.getClass().getSimpleName(), type().getSimpleName());
    }

    @Override
    protected String convert(T obj) {
        // 转换为Json字符串
        return JsonKit.toJson(obj);
    }

    @Override
    protected T parse(String json) {
        if (this.componentType != null) {
            // Json解析为对象数组
            List<?> list = JsonKit.toList(json, this.componentType);
            if (list == null) return null;
            return (T) list.toArray(this.componentArray);
        }
        // Json解析为对象
        return JsonKit.toObject(json, type());
    }

}

这个JsonString类型解析器,既可以转换对象,也可以转换对象数组(注意是Array不是List),不需要再分开记了。

不要心急,还没完成,我们还需要把所有实现它的类型处理器注册到类型处理器注册器内:

/**
 * Mybatis 配置
 *
 * @author Jensen
 * @公众号 架构师修行录
 **/
@Configuration(proxyBeanMethods = false)
@ConditionalOnBean(DataSource.class)
@AllArgsConstructor
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisConfiguration.class})
public class MybatisPlusConfig implements InitializingBean {
    final MybatisPlusProperties mybatisPlusProperties;
    // 把所有实现了BaseTypeHandler的子类都注入进来
    final List<BaseTypeHandler> jsonStringTypeHandlers;

    @Override
    public void afterPropertiesSet() {
        MybatisConfiguration configuration = mybatisPlusProperties.getConfiguration();
        if (configuration == null) {
            configuration = new MybatisConfiguration();
            mybatisPlusProperties.setConfiguration(configuration);
        }
        // 核心的注册逻辑
        TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
        // JavaObject、JavaArray
        if (jsonStringTypeHandlers != null && !jsonStringTypeHandlers.isEmpty()) {
            for (BaseTypeHandler baseTypeHandler : jsonStringTypeHandlers) {
                typeHandlerRegistry.register(baseTypeHandler.type(), baseTypeHandler);
            }
        }
    }

}

这里用到了Spring的依赖注入,一次注入多个Bean,又是一个解耦神器,后续实现的自定义类型处理器只需要受Spring管理就行了。

至此,大功告成!

看看怎么用吧

比如订单表存了用户快照和商品列表快照:

@Data
@TableName("order_info")
public class OrderInfo {
    // 用户快照
    private UserInfoVO userInfo;
    // 商品列表快照
    private GoodsSpuVO[] goodsSpus;
}

没错,就是这么定义,实体类啥都不用加了~

但我们还是要另外针对性加两个类型处理器,只是这个类型处理器是不需要被实体类依赖的,随便你放哪儿都行,我把它们安放在entity.typehandlers目录下:

@Component
public class UserInfoTypeHandler extends JsonStringTypeHandler<UserInfoVO> {
  // 类名随便起,啥都不用写,加个@Component受Spring管理就行了
}

@Component
public class GoodsSpusTypeHandler extends JsonStringTypeHandler<GoodsSpuVO[]> {
  // 类名随便起,啥都不用写,加个@Component受Spring管理就行了
}

好了,咱就是说,以后再也不需要烦怎么存取的问题了,有头发谁要吃咖喱?

写在最后

以上是笔者研究了一段时间磨出来的方案,遗憾的是JSON对象数组的解析只能通过数组的方式,研究了很久都没能映射到List<T>类型,大概是Mybatis的锅,大家如果有思路可以在评论区告诉我,我一定往厚里谢。

除了{"k","v"}、[{"k","v"}]这两种常用存储形式,我们还会经常用到别的自定义存储格式,如["xxx","xxx"]、[12.3, 45.6]、aaa,bbb等,并不能用上面的类型处理器,我把其他的类型处理器集成到了D3Boot框架的BASE-DATA组件内,大家需要的话可以移步Gitee抄作业。

Gitee源码地址(差1个?到10k Stars):
https://gitee.com/jensvn/d3boot

今天又是干货满满的一天,果然在程序员的眼里,对象是最好处理的

本文作者:Jensen

Java老兵一枚,曾涉猎航空/电信/IoT/电商/AI等多领域SaaS+PaaS产品研发,现任职SaaS软件架构师。

D3Boot开源基础框架作者,技术公众号【架构师修行录】博主,专注于分享程序员日常/架构技术/职场干货,关注回复“DDD”免费领取DDD学习大礼包一份。

相关推荐

ES6中 Promise的使用场景?(es6promise用法例子)

一、介绍Promise,译为承诺,是异步编程的一种解决方案,比传统的解决方案(回调函数)更加合理和更加强大在以往我们如果处理多层异步操作,我们往往会像下面那样编写我们的代码doSomething(f...

JavaScript 对 Promise 并发的处理方法

Promise对象代表一个未来的值,它有三种状态:pending待定,这是Promise的初始状态,它可能成功,也可能失败,前途未卜fulfilled已完成,这是一种成功的状态,此时可以获取...

Promise的九大方法(promise的实例方法)

1、promise.resolv静态方法Promise.resolve(value)可以认为是newPromise方法的语法糖,比如Promise.resolve(42)可以认为是以下代码的语...

360前端一面~面试题解析(360前端开发面试题)

1.组件库按需加载怎么做的,具体打包配了什么-按需加载实现:借助打包工具(如Webpack的require.context或ES模块动态导入),在使用组件时才引入对应的代码。例如在V...

前端面试-Promise 的 finally 怎么实现的?如何在工作中使用?

Promise的finally方法是一个非常有用的工具,它无论Promise是成功(fulfilled)还是失败(rejected)都会执行,且不改变Promise的最终结果。它的实现原...

最简单手写Promise,30行代码理解Promise核心原理和发布订阅模式

看了全网手写Promise的,大部分对于新手还是比较难理解的,其中几个比较难的点:状态还未改变时通过发布订阅模式去收集事件实例化的时候通过调用构造函数里传出来的方法去修改类里面的状态,这个叫Re...

前端分享-Promise可以中途取消啦(promise可以取消吗)

传统Promise就像一台需要手动组装的设备,每次使用都要重新接线。而Promise.withResolvers的出现,相当于给开发者发了一个智能遥控器,可以随时随地控制异步操作。它解决了三大...

手写 Promise(手写输入法 中文)

前言都2020年了,Promise大家肯定都在用了,但是估计很多人对其原理还是一知半解,今天就让我们一起实现一个符合PromiseA+规范的Promise。附PromiseA+规范地址...

什么是 Promise.allSettled()!新手老手都要会?

Promise.allSettled()方法返回一个在所有给定的promise都已经fulfilled或rejected后的promise,并带有一个对象数组,每个对象表示对应的pr...

前端面试-关于Promise解析与高频面试题示范

Promise是啥,直接上图:Promise就是处理异步函数的API,它可以包裹一个异步函数,在异步函数完成时抛出完成状态,让代码结束远古时无限回掉的窘境。配合async/await语法糖,可...

宇宙厂:为什么前端离不开 Promise.withResolvers() ?

大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发。1.为什么需要Promise.with...

Promise 新增了一个超实用的 API!

在JavaScript的世界里,Promise一直是处理异步操作的神器。而现在,随着ES2025的发布,Promise又迎来了一个超实用的新成员——Promise.try()!这个新方法简...

一次搞懂 Promise 异步处理(promise 异步顺序执行)

PromisePromise就像这个词的表面意识一样,表示一种承诺、许诺,会在后面给出一个结果,成功或者失败。现在已经成为了主流的异步编程的操作方式,写进了标准里面。状态Promise有且仅有...

Promise 核心机制详解(promise机制的实现原理)

一、Promise的核心状态机Promise本质上是一个状态机,其行为由内部状态严格管控。每个Promise实例在创建时处于Pending(等待)状态,此时异步操作尚未完成。当异步操作成功...

javascript——Promise(js实现promise)

1.PromiseES6开始支持,Promise对象用于一个异步操作的最终完成(包括成功和失败)及结果值的表示。简单说就是处理异步请求的。之所以叫Promise,就是我承诺,如果成功则怎么处理,失败怎...

取消回复欢迎 发表评论: