給mybatis添加自動(dòng)建表，自動(dòng)加字段的功能

以前項(xiàng)目用慣了hibernate,jpa,它有個(gè)自動(dòng)建表功能，只要在PO里加上配置就可以了，感覺(jué)很爽.
但現(xiàn)在用mybatis,發(fā)現(xiàn)沒(méi)有該功能，每次都加個(gè)字段，還是要重新改表結(jié)構(gòu)，我個(gè)人認(rèn)為很麻煩.
上網(wǎng)找了一下，發(fā)現(xiàn)有個(gè)開(kāi)源的actable，但是這個(gè)不好用，不符合實(shí)際項(xiàng)目要求。
開(kāi)源的actable會(huì)自動(dòng)刪除表字段，更改表類型，更改表長(zhǎng)度，但實(shí)際項(xiàng)目中，只允許自動(dòng)創(chuàng)建表，加表字段即可，改長(zhǎng)度，刪字段這些都會(huì)有風(fēng)險(xiǎn)，不符合實(shí)際意義的,而且該開(kāi)源庫(kù)使用其來(lái)比較復(fù)雜
沒(méi)辦法，唯有自己拿過(guò)來(lái)改造。

  • 首先定義字段的通用類
@Data
public  abstract class CommonColumn implements ICommonColumn {

    /**
     * 字段類型
     */
    private String type;

    /**
     * 字段長(zhǎng)度
     */
    private int length=0;

    /**
     *  字段名
     */
    private String name;
    /**
     * decimalLength
     */
    private  int decimalLength=0;

    /**
     * 是否為可以為null，true是可以，false是不可以，默認(rèn)為true
     */
    private boolean nullValue=true;


    /**
     * 是否是主鍵，默認(rèn)false
     */
    private boolean key=false;


    /**
     * 是否自動(dòng)遞增，默認(rèn)false 只有主鍵才能使用
     */
    private boolean autoIncrement=false;

    /**
     * 默認(rèn)值，默認(rèn)為“”
     */
    private String defaultValue="";
 
}

上述類，注冊(cè)了字段的通用類型，繼承該類，我們生成StringColumn,LongColumn等類型

@Data
public class LongColumn extends CommonColumn {


    public LongColumn() {
        this.setType("bigint");
        this.setLength(16);
    }

 
}

該類限定了String 對(duì)應(yīng)的數(shù)據(jù)庫(kù)類型及長(zhǎng)度，將上述所有字段類注冊(cè)到工廠中

public class ColumnFactory {
    public static Map<String, Class<CommonColumn>> columnMap = new HashMap<>();

    static {
        add(Date.class.getName(), DateColumn.class);
        add(Double.class.getName(), DoubleColumn.class);
        add(Integer.class.getName(), IntegerColumn.class);
        add(int.class.getName(), IntegerColumn.class);
        add(Long.class.getName(), LongColumn.class);
        add(long.class.getName(), LongColumn.class);
        add(boolean.class.getName(), BooleanColumn.class);
        add(Boolean.class.getName(), BooleanColumn.class);
        add(String.class.getName(), StringColumn.class);


    }

    /**
     * 增加字段類型
     *
     * @param javaType
     * @param columnClass
     */
    public static void add(String javaType, Class columnClass) {
        columnMap.put(javaType, columnClass);
    }

    public static Class<CommonColumn> getCommonColumn(
            String javaType) {

        return columnMap.get(javaType);
    }
}

-生成建表，加字段的mapper

public interface CreateMysqlTablesMapper {

    /**
     * 根據(jù)結(jié)構(gòu)注解解析出來(lái)的信息創(chuàng)建表
     * @param tableSql
     */
    public void createTable(TableSql tableSql);

    /**
     * 根據(jù)表名查詢表在庫(kù)中是否存在，存在返回1，不存在返回0
     * @param tableName 表結(jié)構(gòu)的map
     * @return 存在返回1，不存在返回0
     */
    public int findTableCountByTableName(@Param("tableName") String tableName);
    
    /**
     * 根據(jù)表名查詢庫(kù)中該表的字段結(jié)構(gòu)等信息
     * @param tableName 表結(jié)構(gòu)的map
     * @return 表的字段結(jié)構(gòu)等信息
     */
    public List<String> findTableEnsembleByTableName(@Param("tableName") String tableName);
    
    /**
     * 增加字段
     * @param tableSql
     */
    public void addTableField(TableSql tableSql);
    
    /**
     * 根據(jù)表名刪除表
     * @param tableName 表結(jié)構(gòu)的map
     */
    public void dorpTableByName(@Param("tableName") String tableName);
}

處理表與字段的SQL如下

<mapper namespace="com.starmark.actable.mapper.CreateMysqlTablesMapper">
    <!-- 抽取出來(lái)的公共部分 -->
    <sql id="commonSql">
            `${fields.fieldName}` ${fields.fieldType}
    </sql>
    <!-- 創(chuàng)建表的 -->
    <select id="createTable" parameterType="com.starmark.actable.table.TableSql">
            create table `${name}`(
            <foreach collection="columnSqls" item="fields" separator=",">
                <include refid="commonSql"></include>
            </foreach>
            <if test="primaryKey">
                ,PRIMARY KEY (`${primaryKey}`)
            </if>
            );
    </select>
    
    <!-- 驗(yàn)證表是否存在 -->
    <select id="findTableCountByTableName" resultType="int" parameterType="String">
        select count(1) from information_schema.tables
        where table_name = #{tableName} and table_schema = (select database())
    </select>
    
    <!-- 根據(jù)表名查詢表的結(jié)構(gòu) -->
    <select id="findTableEnsembleByTableName"    resultType="java.lang.String" parameterType="String">
        select column_name  from information_schema.columns where table_name = #{tableName} and table_schema = (select database())
    </select>
    
    <!-- 增加字段 -->
    <select id="addTableField" parameterType="com.starmark.actable.table.TableSql">
        <foreach collection="columnSqls" index="key" item="fields" separator=";" close=";">
                alter table `${name}` add
                <include refid="commonSql"></include>
        </foreach>
    </select>
    
    <!-- 驗(yàn)證表是否存在 -->
    <select id="dorpTableByName" parameterType="String">
        DROP TABLE IF EXISTS `${tableName}`;
    </select>
    
</mapper>
  • 核心處理類方法如下：
    先查出要添加表的記錄或加字段的表
  /**
     * 構(gòu)建出全部表的增刪改的map
     *
     * @param classes     從包package中獲取所有的Class
     * @param newTableMap 用于存需要?jiǎng)?chuàng)建的表名+結(jié)構(gòu)
     * @param addTableMap 用于存需要增加字段的表名+結(jié)構(gòu)
     */
    private void allTableMapConstruct(Set<Class<?>> classes,
                                      Map<String, List<CommonColumn>> newTableMap,
                                      Map<String, List<CommonColumn>> addTableMap) throws InstantiationException, IllegalAccessException {
        for (Class<?> clas : classes) {

            String tableName = this.getTableName(clas);
            // 用于存新增表的字段
            List<CommonColumn> newFieldList = new ArrayList<CommonColumn>();
            // 用于存新增的字段
            List<CommonColumn> addFieldList = new ArrayList<CommonColumn>();
            // 迭代出所有model的所有fields存到newFieldList中
            tableFieldsConstruct(clas, newFieldList);

            // 如果配置文件配置的是create，表示將所有的表刪掉重新創(chuàng)建
            if ("create".equals(actableConfig.getTableAuto())) {
                createMysqlTablesMapper.dorpTableByName(tableName);
            }
            // 先查該表是否以存在
            int exist = createMysqlTablesMapper.findTableCountByTableName(tableName);
            // 不存在時(shí)
            if (exist == 0) {
                newTableMap.put(tableName, newFieldList);
            } else {
                // 已存在時(shí)理論上做修改的操作，這里查出該表的結(jié)構(gòu)
                List<String> columnNames = createMysqlTablesMapper
                        .findTableEnsembleByTableName(tableName);

                // 驗(yàn)證對(duì)比從model中解析的fieldList與從數(shù)據(jù)庫(kù)查出來(lái)的columnList
                // 1. 找出增加的字段

                buildAddFields(
                        newFieldList, addFieldList,
                        columnNames);
                if(addFieldList.size()>0) {
                    addTableMap.put(tableName, addFieldList);
                }
            }
        }
    }

    /**
     * 構(gòu)建增加的刪除的修改的字段
     *
     * @param newFieldList 用于存新增表的字段
     * @param addFieldList 用于存新增的字段
     * @param columnNames  從sysColumns中取出我們需要比較的列的List
     */
    private void buildAddFields(List<CommonColumn> newFieldList, List<CommonColumn> addFieldList,
                                List<String> columnNames) {
        for (CommonColumn commonColumn : newFieldList) {
            if (!this.isExistField(columnNames, commonColumn)) {
                addFieldList.add(commonColumn);
            }
        }
    }

    /**
     * 判斷字段是否已經(jīng)存在了
     *
     * @param columnNames
     * @param commonColumn
     * @return
     */
    private boolean isExistField(List<String> columnNames, CommonColumn commonColumn) {
        for (String columnName : columnNames) {
            if (commonColumn.getName().equalsIgnoreCase(columnName)) {
                return true;
            }
        }

        return false;
    }


    /**
     * 迭代出所有model的所有fields存到newFieldList中
     *
     * @param clas         準(zhǔn)備做為創(chuàng)建表依據(jù)的class
     * @param newFieldList 用于存新增表的字段
     * @throws IllegalAccessException
     * @throws InstantiationException
     */
    private void tableFieldsConstruct(Class<?> clas,
                                      List<CommonColumn> newFieldList) throws IllegalAccessException, InstantiationException {
        Field[] fields = clas.getDeclaredFields();
        // 判斷是否有父類，如果有拉取父類的field，這里只支持多層繼承
        fields = recursionParents(clas, fields);
        for (Field field : fields) {
            Column column = field.getAnnotation(Column.class);
            // 注解，不需要的字段
            if (column!=null&&column.isIgnore()) {
                continue;
            }
            Class<CommonColumn> commonColumnClass = ColumnFactory.getCommonColumn(field.getType().getName());
            CommonColumn commonColumn =   commonColumnClass.newInstance();
            //設(shè)置字段
            if(column!=null&&StringUtils.isNoneEmpty(column.name())){
                commonColumn.setName(column.name());
            } else {
                //獲取字段名稱
                String fieldName = CamelCaseUtil.humpToLine2(field.getName());
                commonColumn.setName(fieldName);
            }
            //設(shè)置字段類型
            if(column!=null&&StringUtils.isNoneEmpty(column.type())){
                commonColumn.setType(column.type());
            }

            //設(shè)置長(zhǎng)度
            if(column!=null&&column.length()>0){
                commonColumn.setLength(column.length());
            }
            //設(shè)置長(zhǎng)度
            if(column!=null&&column.length()>0){
                commonColumn.setDecimalLength(column.decimalLength());
            }
            //設(shè)置自增
            if(column!=null&&column.isAutoIncrement()){
                commonColumn.setAutoIncrement(column.isAutoIncrement());
            }
            //設(shè)置自增
            if(column!=null&&column.isAutoIncrement()){
                commonColumn.setAutoIncrement(column.isAutoIncrement());
            }
            //是否為空
            if(column!=null&&!column.isNull()){
                commonColumn.setNullValue(column.isNull());
            }
            //是否主鍵
            if(column!=null&&!column.isKey()){
                commonColumn.setKey(column.isKey());
            }
            //設(shè)置字段類型
            if(column!=null&&StringUtils.isNoneEmpty(column.defaultValue())){
                commonColumn.setDefaultValue(column.defaultValue());
            }
            newFieldList.add(commonColumn);

        }
    }

    /**
     * 遞歸掃描父類的fields
     *
     * @param clas   類
     * @param fields 屬性
     */
    @SuppressWarnings("rawtypes")
    private Field[] recursionParents(Class<?> clas, Field[] fields) {
        if (clas.getSuperclass() != null) {
            Class clsSup = clas.getSuperclass();
            fields = (Field[]) ArrayUtils.addAll(fields, clsSup.getDeclaredFields());
            fields = recursionParents(clsSup, fields);
        }
        return fields;
    }

    /**
     * 根據(jù)傳入的map創(chuàng)建或修改表結(jié)構(gòu)
     *
     * @param newTableMap 用于存需要?jiǎng)?chuàng)建的表名+結(jié)構(gòu)
     * @param addTableMap 用于存需要增加字段的表名+結(jié)構(gòu)
     */
    private void createOrModifyTableConstruct(Map<String, List<CommonColumn>> newTableMap,
                                              Map<String, List<CommonColumn>> addTableMap) {
        // 1. 創(chuàng)建表
        createTableByMap(newTableMap);
        // 2. 添加新的字段
        addFieldsByMap(addTableMap);
    }


    /**
     * 根據(jù)map結(jié)構(gòu)對(duì)表中添加新的字段
     *
     * @param addTableMap 用于存需要增加字段的表名+結(jié)構(gòu)
     */
    private void addFieldsByMap(Map<String, List<CommonColumn>> addTableMap) {
        // 做增加字段操作
        if (addTableMap.size() > 0) {
            for (Entry<String, List<CommonColumn>> entry : addTableMap.entrySet()) {
                List<CommonColumn> columnList= entry.getValue();
                for(CommonColumn column:columnList) {
                    //因?yàn)閙ysql一次只能執(zhí)行一條sql
                    List<CommonColumn> fieldList=new ArrayList<CommonColumn>();
                    fieldList.add(column);
                    TableSql tableSql = this.getTableSql(entry.getKey(), fieldList);

                    log.info("開(kāi)始為表" + entry.getKey() + "增加字段"+column.getName());
                    createMysqlTablesMapper.addTableField(tableSql);
                    log.info("完成為表" + entry.getKey() + "增加字段"+column.getName());
                }
            }
        }
    }


    /**
     * 根據(jù)map結(jié)構(gòu)創(chuàng)建表
     *
     * @param newTableMap 用于存需要?jiǎng)?chuàng)建的表名+結(jié)構(gòu)
     */
    private void createTableByMap(Map<String, List<CommonColumn>> newTableMap) {
        // 做創(chuàng)建表操作
        if (newTableMap.size() > 0) {
            for (Entry<String, List<CommonColumn>> entry : newTableMap.entrySet()) {
                TableSql tableSql = this.getTableSql(entry.getKey(), entry.getValue());
                log.info("開(kāi)始創(chuàng)建表：" + entry.getKey());
                createMysqlTablesMapper.createTable(tableSql);
                log.info("完成創(chuàng)建表：" + entry.getKey());
            }
        }
    }

    /**
     * 構(gòu)造執(zhí)行的SQL
     *
     * @param tableName
     * @param columns
     * @return
     */
    private TableSql getTableSql(String tableName, List<CommonColumn> columns) {
        TableSql tableSql = new TableSql();
        tableSql.setName(tableName);
        List<String> primaryKeys =this.getPrimaryKey(columns);
        List<ColumnSql> columnSqls = new ArrayList<ColumnSql>();
        for (CommonColumn column : columns) {
            columnSqls.add(new ColumnSql(column,primaryKeys));
        }
        tableSql.setPrimaryKey(StringUtils.join(primaryKeys,","));
        tableSql.setColumnSqls(columnSqls);
        return tableSql;
    }

上述代碼為相關(guān)核心代碼，如開(kāi)源的actable一樣，支技自動(dòng)建表，自動(dòng)加字段，有hiberate的created,update,none三種處理。
該代碼因?yàn)橄薅烁鞣N字段對(duì)應(yīng)的數(shù)據(jù)庫(kù)字段，可以不在PO上加任何信息，自動(dòng)根據(jù)PO生成相關(guān)表。
真正使用時(shí)，我也自定義了注解類，讓特殊情況時(shí)，可以自動(dòng)定義對(duì)象的長(zhǎng)度及數(shù)據(jù)為字段類型。

`// 該注解用于方法聲明
@Target(ElementType.FIELD)
// VM將在運(yùn)行期也保留注釋，因此可以通過(guò)反射機(jī)制讀取注解的信息
@Retention(RetentionPolicy.RUNTIME)
// 將此注解包含在javadoc中
@Documented
// 允許子類繼承父類中的注解
@Inherited
public @interface Column {


    /**
     * 字段名
     * 
     * @return 字段名
     */
    public String name()  default  "";

    /**
     * 字段類型
     * 
     * @return 字段類型
     */
    public String type() default  "";

    /**
     * 字段長(zhǎng)度，默認(rèn)是255
     * 
     * @return 字段長(zhǎng)度，默認(rèn)是255
     */
    public int length() default 0 ;

    /**
     * 小數(shù)點(diǎn)長(zhǎng)度，默認(rèn)是0
     * 
     * @return 小數(shù)點(diǎn)長(zhǎng)度，默認(rèn)是0
     */
    public int decimalLength()  default 0  ;

    /**
     * 是否為可以為null，true是可以，false是不可以，默認(rèn)為true
     * 
     * @return 是否為可以為null，true是可以，false是不可以，默認(rèn)為true
     */
    public boolean isNull()  default true  ;

    /**
     * 是否是主鍵，默認(rèn)false
     * 
     * @return 是否是主鍵，默認(rèn)false
     */
    public boolean isKey() default false  ;

    /**
     * 是否自動(dòng)遞增，默認(rèn)false 只有主鍵才能使用
     * 
     * @return 是否自動(dòng)遞增，默認(rèn)false 只有主鍵才能使用
     */
    public boolean isAutoIncrement() default  false ;

    /**
     * 默認(rèn)值，默認(rèn)為null
     * 
     * @return 默認(rèn)值，默認(rèn)為null
     */
    public String defaultValue() default "";


    /**忽略該字段，不自動(dòng)生成數(shù)據(jù)庫(kù)字段
     * @return
     */
    public boolean isIgnore() default false ;
}

真正使用時(shí)，只需要一個(gè)PO就能生成想要的表，這個(gè)配合mybtais plus ,用，真的爽歪歪了。
示例PO如下：

@Data
public class Person {
    /** 唯一標(biāo)識(shí) */
    private Long id;

    /** 姓名 */
    private String name;

    /** 年齡 */
    private int age;

    /** 描述 */
    private String description;

    private Date birthDate;

    private boolean valid;

    /**
     * 自定義字段
     */
    @Column(name="larget_text",type="text")
    private String textContent;

    /**
     * 該字段不自動(dòng)生成
     */
    @Column(isIgnore = true)
    private String loginName;
}

如果想要完整的代碼，請(qǐng)打賞一注彩票錢再聯(lián)系我。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 178,802評(píng)論 25贊 709
  • 假期快要結(jié)束了，抓住假期的尾巴，再好好玩玩。 早上起床洗漱完畢后，我們便回家了。老媽昨天囑咐想寶貝...
    小軒仔0808閱讀 221評(píng)論 0贊 0
  • 周周已經(jīng)結(jié)婚了，但是打算先享受兩年二人世界，她說(shuō)：“看了太多育兒以后面臨的各種問(wèn)題，都有點(diǎn)不敢生孩子了?！?生孩子...
    青春當(dāng)鋪閱讀 265評(píng)論 0贊 0
  • 一個(gè)人的生命中或許有很多人駐足過(guò)，而那些擦肩卻未曾匆匆離開(kāi)的人，或許改變了我們一生的軌跡，或許給了我們意想不到的勇...
    碎時(shí)光景閱讀 142評(píng)論 0贊 0
  • 早上，被《羅一笑，你給我站住》這篇文章刷屏，剛開(kāi)始我并沒(méi)有在意。 但很快刷的人多了，我也就點(diǎn)進(jìn)去看了。寫得情真意切...
    土川兄一終身建設(shè)閱讀 648評(píng)論 0贊 0

友情鏈接更多精彩內(nèi)容