需求描述
实体类中属性的数据类型为List类型，在数据库表中希望该字段以VARCHAR类型创建表字段。
遇到的问题
- Hibernate自动建表失败
- 集合类型如何以字符串的形式入库
自动建表失败解决方式
自定义转换器StringListConverter实现`AttributeConverter，代码如下。
import cn.hutool.core.util.StrUtil;
import javax.persistence.AttributeConverter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* <p>描述: 字符串集合转换器 </p>
*
* @author wxf
* @version 1.0
* @date 2023/6/8 下午3:08
*/
public class StringListConverter implements AttributeConverter<List<String>, String> {
@Override
public String convertToDatabaseColumn(List<String> attribute) {
if (attribute == null || attribute.isEmpty()) {
return null;
}
return String.join(StrUtil.COMMA, attribute);
}
@Override
public List<String> convertToEntityAttribute(String dbData) {
if (dbData == null || dbData.isEmpty()) {
return new ArrayList<>();
}
return Arrays.asList(dbData.split(StrUtil.COMMA));
}
}
该转换类将List<String>转换为String，在自动建表时，表字段的数据类型为VARCHAR。
以字符串类型入库，以集合类型返回
自定义StringListTypeHandler继承BaseTypeHandler，实现BaseTypeHandler中的setNonNullParameter、getNullableResult、getNullableResult、getNullableResult方法，入库是将List转换为字符串，返回时将字符串转换为List，示例代码如下。
import cn.hutool.core.util.StrUtil;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedJdbcTypes;
import org.apache.ibatis.type.MappedTypes;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
/**
* <p>描述: 字符串集合 类型处理器 </p>
*
* @author wxf
* @version 1.0
* @date 2023/6/8 下午3:09
*/
@MappedTypes(List.class)
@MappedJdbcTypes({JdbcType.VARCHAR})
public class StringListTypeHandler extends BaseTypeHandler<List<String>> {
@Override
public void setNonNullParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {
ps.setString(i, StrUtil.join(StrUtil.COMMA, parameter));
}
@Override
public List<String> getNullableResult(ResultSet rs, String columnName) throws SQLException {
String value = rs.getString(columnName);
if (null != value) {
return StrUtil.split(value, StrUtil.COMMA);
}
return new ArrayList<>();
}
@Override
public List<String> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
String value = rs.getString(columnIndex);
if (null != value) {
return StrUtil.split(value, StrUtil.COMMA);
}
return new ArrayList<>();
}
@Override
public List<String> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
String value = cs.getString(columnIndex);
if (null != value) {
return StrUtil.split(value, StrUtil.COMMA);
}
return new ArrayList<>();
}
}
## 实体类代码
在实体类中需要注意以下几点：
- 首先需要在TableName注解中将autoResultMap置为true；
- 然后需要再数据类型为List的属性上面添加注解@Convert(converter =
StringListConverter.class)和注解@TableField(value = “class_name”, typeHandler =StringListTypeHandler.class)。
import cn.flydiy.cloud.data.mybatis.pojo.po.BasePO;
import com.baomidou.mybatisplus.annotation.*;
import com.flydiy.example.auto.pojo.converter.ListConverter;
import com.flydiy.example.auto.pojo.handler.ListHandler;
import org.springframework.data.annotation.CreatedBy;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedBy;
import org.springframework.data.annotation.LastModifiedDate;
import org.hibernate.annotations.Table;
import org.hibernate.annotations.Comment;
import lombok.Data;
import lombok.EqualsAndHashCode;
import javax.persistence.*;
import java.util.*;
/**
* ClassInfoPO对象
*
* @author wxf
* @link
* @version 1.0
*/
@Data
@EqualsAndHashCode(callSuper = true)
@Entity(name = "t_class_info")
@Table(appliesTo = "t_class_info", comment = "班级信息")
@TableName(value = "t_class_info", autoResultMap = true)
public class ClassInfoPO extends BasePO<Long> {
/** default serialVersionUID */
private static final long serialVersionUID = 1L;
/**
* 主键
*/
@Id
@TableId(type = IdType.ASSIGN_ID, value = "id")
@Comment("主键")
@Column(name ="id", nullable = true, length = 0, scale = 0)
private Long id;
/**
* 创建人
*/
@CreatedBy
@TableField(value = "created_by", fill = FieldFill.INSERT)
@Comment("创建人")
@Column(name ="created_by", nullable = true, length = 64, scale = 0)
private String createdBy;
/**
* 创建时间
*/
@CreatedDate
@TableField(value = "created_date", fill = FieldFill.INSERT)
@Temporal(TemporalType.TIMESTAMP)
@Comment("创建时间")
@Column(name ="created_date", nullable = true, length = 0, scale = 0)
private Date createdDate;
/**
* 最后更新人
*/
@LastModifiedBy
@TableField(value = "last_modified_by", fill = FieldFill.INSERT_UPDATE)
@Comment("最后更新人")
@Column(name ="last_modified_by", nullable = true, length = 64, scale = 0)
private String lastModifiedBy;
/**
* 最后更新时间
*/
@LastModifiedDate
@TableField(value = "last_modified_date", fill = FieldFill.INSERT_UPDATE)
@Temporal(TemporalType.TIMESTAMP)
@Comment("最后更新时间")
@Column(name ="last_modified_date", nullable = true, length = 0, scale = 0)
private Date lastModifiedDate;
/**
* 班级名称
*/
@Comment("班级名称")
@Convert(converter = ListConverter.class)
@TableField(value = "class_name", typeHandler = ListHandler.class)
@Column(name ="class_name", nullable = true, length = 255, scale = 0)
private List<String> className;
public ClassInfoPO() {
super(null);
}
public ClassInfoPO(Long id) {
super(id);
}
}
通过以上操作便可以实现实体类属性数据类型为List，以VARCHAR类型自动建表。
结果展示
create table t_class_info (
id bigint not null comment '主键',
created_by varchar(64) comment '创建人',
created_date datetime(6) comment '创建时间',
last_modified_by varchar(64) comment '最后更新人',
last_modified_date datetime(6) comment '最后更新时间',
class_name varchar(255) comment '班级名称',
primary key (id)
) comment='班级信息' engine=InnoDB
表中插入数据展示：
返回结果展示：
{
"statusCode": 200,
"message": "请求成功",
"data": {
"id": 1666698152239927297,
"createdBy": "xxx",
"createdDate": 1686206779905,
"lastModifiedBy": "xxx",
"lastModifiedDate": 1686206779908,
"className": [
"one",
"two",
"three"
]
},
"timestamp": 1686206801.689000000
}
© 版权声明
文章版权归作者所有，未经允许请勿转载，侵权请联系 admin@trc20.tw 删除。
THE END
