| mybatis&plus系列 | 您所在的位置：网站首页 › field怎么用英语怎么读出来的呢 › mybatis&plus系列 |
mybatis&plus系列
|
mybatis&plus系列------Mysql的JSON字段的读取和转换
一. 背景
在平常的开发中,我们可能会有这样的需求: 业务数据在存储的时候,并不是以mysql中的varchar丶int等格式来存储的,而是使用json格式. 这样做的好处是当数据结构有变化或者需求变化时,我们不用再添加字段,方便扩展. 那么mysql中json格式的数据我们使用mybatis或者mybatisplus读取以后,肯定是希望转换成对象或者对象集合的,本篇博文就记录一下使用mybatis读取json格式的数据转换为对象的方法 二. 数据准备 1. json字段的添加首先我们如果要使用sql语句来在表中添加一个json格式的字段,可以使用以下脚本: ALTER TABLE a ADD COLUMN alert_up_config json DEFAULT NULL COMMENT '注释' AFTER id以上sql执行以后,会在a表的id字段之后,添加一个字段alert_up_config,它的格式就是json 添加完成以后,我们可以在这个字段中保存json对象或者json数组格式的字符串. 当前的业务场景是: alert_up_config字段中,是个jsonArr,保存的是告警的升级规则,比如持续时间,次数等. 模拟数据如下: [{"alertNum": 100, "alertLevel": "P1", "durationTime": 100, "resourceInfoId": "123456"}] 注意,使用json类型有2点需要注意: 存储数据必须是json格式,否则会报错json数据类型没有默认值 三. 数据处理 1. 使用sql语句获取json数据首先我们可以使用sql语句来提取我们需要的json字段,语法如下: #json对象类型处理 JSON_EXTRACT(json列, '$.键') #jsonArray类型处理, index从0开始计算 JSON_EXTRACT(json列, '$[index].键')比如对于我们上面的示例数据,我们要查询出alert_up_config字段中的alertNum的值,可以使用如下语句: select JSON_EXTRACT(alert_up_config, '$[0].alertNum') from a;查询结果如下:
首先我们需要知道的是,mybatis提供了一个接口org.apache.ibatis.type.TypeHandler来对数据库中各种类型数据的处理,它主要有四个方法: public interface TypeHandler { //保存数据到数据库之前的处理 void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException; //下面三个时候拿到数据以后的处理 T getResult(ResultSet rs, String columnName) throws SQLException; T getResult(ResultSet rs, int columnIndex) throws SQLException; T getResult(CallableStatement cs, int columnIndex) throws SQLException; }也就是说,如果我们要处理从mysql中取出的数据,就可以实现这个接口,来自定义我们的数据处理逻辑,得到我们想要的数据. 现在对于我们来说,我们的源数据是这样的: [{"alertNum": 100, "alertLevel": "P1", "durationTime": 100, "resourceInfoId": "123456"}]也有可能是这样的: {"alertNum": 100, "alertLevel": "P1", "durationTime": 100, "resourceInfoId": "123456"}前者是JSONArray,后者是JSONObject 对于前面的数据,我们可能会用List这种格式来接收,如果是后者,我们可以使用AlertUpConfig这种对象来直接接收数据. 现在,我们的需要mybatis或者mybatisplus帮助我们将数据库中的json数据自动转换为相应的格式,一起来看下怎么实现吧! 3. 使用mybatisplus实现json转java对象/集合在mybatisplus中,已经为我们提供了一系列的TypeHandler 有一个抽象类为: com.baomidou.mybatisplus.extension.handlers.AbstractJsonTypeHandler 它抽象了json处理的方法: public void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException { ps.setString(i, this.toJson(parameter)); } public T getNullableResult(ResultSet rs, String columnName) throws SQLException { String json = rs.getString(columnName); return StringUtils.isBlank(json) ? null : this.parse(json); } public T getNullableResult(ResultSet rs, int columnIndex) throws SQLException { String json = rs.getString(columnIndex); return StringUtils.isBlank(json) ? null : this.parse(json); } public T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { String json = cs.getString(columnIndex); return StringUtils.isBlank(json) ? null : this.parse(json); }同时,它提供两个抽象方法,用于提供给不同的json包: protected abstract T parse(String json); protected abstract String toJson(T obj);我们看一下AbstractJsonTypeHandler的实现类,可以发现有我们想要的东西:
很明显,mybatisplus已经提供了FastJson、Gson和JackSon的typehandler给我们使用. 下面是使用方法: json转java对象 如果不用xml文件(xml的方式在mybatis部分说明),在实体对象相应的字段上,用typeHandler参数指定我们要使用的typeHandler 同时,在实体类上使用注解: @TableName(value = "a", autoResultMap = true) autoResultMap参数表明字段在查询处理的时候自动转换为对象 @TableField(value = "alert_up_config", typeHandler = FastjsonTypeHandler.class) private AlertUpConfig alertUpConfig;配置好以后,使用mapper查询,可以发现alert_up_config字段直接被转换成了java对象 json转List 这里需要注意一个坑:如果你直接用FastjsonTypeHandler去接收List是会报错的,我们可以看一下它的源码: protected Object parse(String json) { return JSON.parseObject(json, this.type); }可以看到,默认的FastjsonTypeHandler的parse方法,在转换的时候,会使用JSON.parseObject去处理数据,而该方法转换后,我们并不会得到List这种格式,而是会得到List这种数据. 之前看到有网友说,可以在TableField注解中使用javaType来指定需要转换的java对象,这个方式我试过了,会直接报错,原因就在于JSON.parseObject(json, this.type)方法在执行的时候,this.type传进来是List,FastJson在转换的时候,直接报错List不能转换为Object 所以我们需要修改一下parse这个方法 自定义一个TypeHandlr,继承mybatisPlus的FastjsonTypeHandler,重写parse方法: public class AlertUpConfigHandler extends FastjsonTypeHandler { private final Class type; public AlertUpConfigHandler(Class type) { super(type); this.type = type; } @Override protected Object parse(String json) { return JSON.parseArray(json, this.type); } @Override protected String toJson(Object obj) { return super.toJson(obj); } }这样在实体类的TableField注解的typeHandler中,指定handler为我们自定义的handler,就可以处理JSONArray自动转换成List. 4. 使用mybatis在xml中实现json转java对象/集合在xml中实现json和对象的转换也比较简单 同样的handler,只是配置方式从注解改成xml中的属性了. 需要注意的是,FastjsonTypeHandler是mybatisplus提供的处理器,如果你的项目中没有引入mp,那么可以自己参照它写一个. 结语:在本篇博文中,介绍了数据库json字段和java对象,以及集合对象的相关转换,记录在这里,以后有需要的时候可以及时查阅 个人公众号日前已经开通,后续博主发布的文章都会一并更新到公众号,如有需要,自行查阅. 关于橙耘自留地,是我个人聚焦互联网技术栈学习分享的一个平台,创立之初是因为目前业内各种技术课程资料层次不齐,褒贬不一,有时候一门课花费高价买入,其实内含草包,有时偶尔低价得之,却又大有干货.因此我会根据大家的意见和评价,选择不同的技术栈去学习,一为提升我自己的技术,二为大家梳理出质量比较好的课程,以作参考.同时,相关的学习心得也会一并更新到博客和公众号.
|
【本文地址】