mybatis字段映射枚举类型

Posted 2020-09-05 growth of monkey

在底层使用mybatis的时候，我们可能会需要把表里的字段映射到Java里面的枚举类，现总结下工作中的用法：

sku表里一个status_type字段为int类型。(这里是postgresql的脚本)

status_type int4 NULL

Java里面对应生成的枚举类为：

　

public enum SkuStatusType implements DbEnum, LocalString {

    PRODUCT(0, false, "masterdata.skuStatus.product"), 
    BUYING(1, false, "masterdata.skuStatus.buying"), 
    SALE(2, false, "masterdata.skuStatus.sale");


    private int dbConstant;
    private String messageKey;

    private OrderState(int dbConstant, boolean hasBeenDispatched, String messageKey) {
        this.dbConstant = dbConstant;
        this.hasBeenDispatched = hasBeenDispatched;
        this.messageKey = messageKey;
    }

    @Override
    public Integer getConstant() {
        return this.dbConstant;
    }

    @Override
    public String messageKey() {
        return this.messageKey;
    }
}

在配置xml文件之前我们需要为自己的项目建一个工具类：

package com.lcc.util;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;

import com.lcc.api.domain.DbEnum;

public class DbEnumTypeHandler extends BaseTypeHandler<DbEnum> {
    
    private Class<DbEnum> type; 
    
    public DbEnumTypeHandler(Class<DbEnum> type){
        this.type = type;
    }
    
    
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i,
            DbEnum parameter, JdbcType jdbcType) throws SQLException {
        ps.setInt(i, parameter.getConstant());
    }

    @Override
    public DbEnum getNullableResult(ResultSet rs, String columnName)
            throws SQLException {
        int constant = rs.getInt(columnName);
        if(rs.wasNull()){    
            return null;
        }
        else{
            return convert(constant);
        }
    }

    @Override
    public DbEnum getNullableResult(ResultSet rs, int columnIndex)
            throws SQLException {
        int constant = rs.getInt(columnIndex);
        if(rs.wasNull()){    
            return null;
        }
        else{
            return convert(constant);
        }
    }

    @Override
    public DbEnum getNullableResult(CallableStatement cs, int columnIndex)
            throws SQLException {
        int constant = cs.getInt(columnIndex);
        if(cs.wasNull()){    
            return null;
        }
        else{
            return convert(constant);
        }
    }
    
    private DbEnum convert(int constant) {
        DbEnum[] dbEnums = type.getEnumConstants();
        for (DbEnum dbEnum : dbEnums) {
            if(dbEnum.getConstant().equals(constant)){
                return dbEnum;
            }
        }
        return null;
    }
    
    
}

util class里面的DbEnum domain 和 Localisable domain:（一般项目里的枚举实现这两个domain interface）

package com.lcc.api.domain;

import java.io.Serializable;

public interface DbEnum extends Serializable {

    public Integer getConstant();
}

package com.lcc.api.domain;

public interface Localisable {

    String messageKey();
}

 

看下mybatis的xml文件配置：

<result column="status_type" property="statusType"
                typeHandler="com.lcc.util.StringEnumTypeHandler" />

 

此时表字段映射枚举类就大功告成了，看完之后你可以自己上手试一下。

这只是其中的一种方法，还有其他的方法可以在度娘和谷哥上面搜索一下。