Mybatis 将实体中的对象属性以数据库`json`类型持久化

浅浅的花香味﹌ 2023-10-05 21:38 19阅读 0赞

### 需求 ###

`Mybatis` 将实体中的对象属性以数据库`json`类型持久化。例如 `User` 对象中有个`UserInfo` 属性，该属性是用户的一些扩展属性，结构不定，想使用`json` 保存，方便扩展。

*  `User.java`

@Data
    public class User{
        
    	private String Id;
        private String userName;
    	private UserInfo userInfo;
    }

*  `UserInfo.java`

@Data
    public class UserInfo{
        
    	private String attr1;
    	private List<Long> attr2;
    }

*  MySQL 存储结果

<table> 
 <thead> 
  <tr> 
   <th>id</th> 
   <th>user_name</th> 
   <th>user_info</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>userName1</td> 
   <td>{“attr1”:“attr1-1”,“attr2”:[1,2,3]}</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>userName2</td> 
   <td>{“attr1”:“attr1-2”,“attr2”:[2342,2,3]}</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>userName3</td> 
   <td>{“attr1”:“attr1-3”,“attr2”:[56,78,78]}</td> 
  </tr> 
 </tbody> 
</table>

### 环境 ###

*  `spring-boot 2.4.6`
 *  `mybatis`
 *  `gson 2.8.6`
 *  `MySQL 8`  
    **相关pom**

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.4.6</version>
            <relativePath/> 
        </parent>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    	    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>2.2.0</version>
            </dependency>
                    
            <dependency>
                <groupId>com.google.code.gson</groupId>
                <artifactId>gson</artifactId>
                <version>2.8.6</version>
            </dependency>
            <dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>30.1-jre</version>
            </dependency>
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
                <version>3.12.0</version>
            </dependency>
    	</dependencies>

### 分析 ###

`mybatis` 内置`MySQL`中基本数据类型的转换与映射，当`MySQL`中字段支持`json`类型后，`Mybatis`目前没有及时跟进。但是没关系，`MyBatis`考虑到了这方面需求，预留了解决方案：`BaseTypeHandler`，该类是一个抽象类，提供了一些方法可以实现，以便用户灵活地进行数据转换。`BaseTypeHandler` 类图结构如下，其中 `AbstractObjectTypeHandler` 是我们的实现。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzQ3NDA2ODMy_size_16_color_FFFFFF_t_70]

### 代码示例 ###

*  定义一个抽象处理器 `AbstractObjectTypeHandler`

/**
     * mybatis java对象 与json 类型转换处理器
     * @author xzbd 2021/5/31
     */
    public abstract class AbstractObjectTypeHandler<T> extends BaseTypeHandler<T> {
        
    
        @Override
        public void setNonNullParameter(PreparedStatement ps, int i, Object parameter,
                                        JdbcType jdbcType) throws SQLException {
        
            ps.setString(i, GsonUtils.toJsonStr(parameter));
        }
    
        @Override
        public T getNullableResult(ResultSet rs, String columnName)
                throws SQLException {
        
            String data = rs.getString(columnName);
            return StringUtils.isBlank(data) ? null : GsonUtils.fromJson(data, (Class<T>) getRawType());
        }
    
        @Override
        public T getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        
            String data = rs.getString(columnIndex);
            return StringUtils.isBlank(data) ? null : GsonUtils.fromJson(data, (Class<T>) getRawType());
        }
    
        @Override
        public T getNullableResult(CallableStatement cs, int columnIndex)
                throws SQLException {
        
            String data = cs.getString(columnIndex);
            return StringUtils.isBlank(data) ? null : GsonUtils.fromJson(data, (Class<T>) getRawType());
        }
    }

*  Gson 工具类

/**
     * Gson 工具类
     * @author xzbd 2021/5/27
     */
    public class GsonUtils {
        
        public final static Gson gsonInstance = new Gson();
    
        /**
         *  json 字符转转对象
         * @author  xzbd  2021/5/27
         * @param json: json 字符串
         * @param classOfT: 对象类型
         * @return: T
         **/
        public static <T> T fromJson(String json, Class<T> classOfT) {
        
            return gsonInstance.fromJson(json, classOfT);
        }
    
        /**
         *  对象转 json
         * @author  xzbd 2021/5/27
         * @param obj: 对象
         * @return: java.lang.String
         **/
        public static String toJsonStr(Object obj){
        
            return gsonInstance.toJson(obj);
        }
    
    }

*  定义UserInfo 转化配置器 `UserInfoHander`

public class UserInfoHander extends AbstractObjectTypeHandler<UserInfo> {
        
    }

*  配置转换器，使得MyBatis加载并使用

mybatis:
      mapper-locations: classpath:mappers/*.xml
      # 指定转换器路径
      type-handlers-package: com.xzbd.concrateHandler

### 技巧 ###

*  如果实体类中有属性不需要存储，可在相应的字段上加上`@JsonIgnore` 属性

### 结论 ###

已解决

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzQ3NDA2ODMy_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210601101545881.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzQ3NDA2ODMy,size_16,color_FFFFFF,t_70