实体类JSON字段的终极转换思路
哈喽,各位代码战士们,我是Jensen,一个梦想着和大家一起在代码的海洋里遨游,顺便捡起那些散落的知识点的程序员小伙伴。
听说大家都不爱当“接码侠”,笔者在接盘别人代码之时也常意难平,我的心情大部分是这样的:
今天聊聊那些“骚操作”,看看数据库JSON字段是怎么映射到代码上来的。
本文涉及技术栈:类型处理器、D3Boot。
0x1
都有些什么写法
这种是最简单最普遍的写法,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的一些关键点:
泛型:BaseTypeHandler<T> 使用泛型 T 来指定它所处理的 Java 类型。
继承:自定义类型处理器通常继承自 BaseTypeHandler<T>,并且重写几个核心方法。
核心方法——void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType):此方法用于将 Java 类型设置到 SQL 语句的参数中。
核心方法——T getResult(ResultGetter getter, Class<T> clazz):此方法用于从 SQL 查询的结果集中获取 Java 类型。
类型转换:BaseTypeHandler 的子类可以实现具体的类型转换逻辑,包括日期时间格式的转换、枚举类型的转换、复杂对象的序列化和反序列化等。
配置:自定义的类型处理器可以在 MyBatis 的映射文件中配置,与特定的字段或结果集映射相关联。
重用:由于 BaseTypeHandler 是泛型的,因此可以为不同的类型创建不同的处理器,同时重用相同的处理逻辑。
通过类型处理器,我们可以映射成任意类型,存取数据其实没有那么的麻烦。
不错不错,就它了。
0x2
还是先造个轮子吧
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());}@Overrideprotected String convert(T obj) {// 转换为Json字符串return JsonKit.toJson(obj);}@Overrideprotected 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;@Overridepublic void afterPropertiesSet() {MybatisConfiguration configuration = mybatisPlusProperties.getConfiguration();if (configuration == null) {configuration = new MybatisConfiguration();mybatisPlusProperties.setConfiguration(configuration);}// 核心的注册逻辑TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();// JavaObject、JavaArrayif (jsonStringTypeHandlers != null && !jsonStringTypeHandlers.isEmpty()) {for (BaseTypeHandler baseTypeHandler : jsonStringTypeHandlers) {typeHandlerRegistry.register(baseTypeHandler.type(), baseTypeHandler);}}}}
这里用到了Spring的依赖注入,一次注入多个Bean(记笔记,又是一个解耦神器),后续实现的自定义类型处理器只需要受Spring管理就行了。
至此,大功告成!
0x3
看看怎么用吧
比如订单表存了用户快照和商品列表快照:
@Data@TableName("order_info")public class OrderInfo {// 用户快照private UserInfoVO userInfo;// 商品列表快照private GoodsSpuVO[] goodsSpus;}
没错,就是这么定义,实体类啥都不用加了~
但我们还是要另外针对性加两个类型处理器,只是这个类型处理器是不需要被实体类依赖的,随便你放哪儿都行,我把它们安放在entity.typehandlers目录下:
@Componentpublic class UserInfoTypeHandler extends JsonStringTypeHandler<UserInfoVO> {// 类名随便起,啥都不用写,加个@Component受Spring管理就行了}@Componentpublic class GoodsSpusTypeHandler extends JsonStringTypeHandler<GoodsSpuVO[]> {// 类名随便起,啥都不用写,加个@Component受Spring管理就行了}
好了,咱就是说,以后再也不需要烦怎么存取的问题了,有道是,有头发谁要吃咖喱?
0x4
OneMoreThing
以上是笔者研究了一段时间磨出来的方案,遗憾的是JSON对象数组的解析只能通过数组的方式,研究了很久都没能映射到List<T>类型,大概是Mybatis的锅,大家如果有思路可以在评论区告诉我,我一定往厚里谢。
除了{"k","v"}、[{"k","v"}]这两种常用存储形式,我们还会经常用到别的自定义存储格式,如["xxx","xxx"]、[12.3, 45.6]、aaa,bbb等,并不能用上面的类型处理器,我把其他的类型处理器集成到了D3Boot框架的BASE-DATA组件内,大家需要的话可以移步Gitee抄作业。
https://gitee.com/jensvn/d3boot
今天又是干货满满的一天,果然在程序员的眼里,对象是最好处理的。
EOF
作者:Jensen
专注分享程序员日常/架构技术/职场干货
Java老兵一枚,曾涉猎航空/电信/IoT/电商/AI等多领域SaaS产品研发。
D3Boot开源框架作者,现任职SaaS软件架构师。
关注回复“DDD”,免费领取DDD学习大礼包。
关注回复“进群”,我拉你进架构技术交流群。