給mybatis新增自動建表，自動加欄位的功能
以前專案用慣了hibernate,jpa,它有個自動建表功能，只要在PO里加上配置就可以了，感覺很爽.
但現在用mybatis,發現沒有該功能，每次都加個欄位，還是要重新改表結構，我個人認為很麻煩.
上網找了一下，發現有個開源的actable，但是這個不好用，不符合實際專案要求。
開源的actable會自動刪除表欄位，更改表型別，更改表長度，但實際專案中，只允許自動建立表，加表欄位即可，改長度，刪欄位這些都會有風險，不符合實際意義的,而且該開源庫使用其來比較複雜
沒辦法，唯有自己拿過來改造。
- 首先定義欄位的通用類
@Data
public abstract class CommonColumn implements ICommonColumn {
/**
* 欄位型別
*/
private String type;
/**
* 欄位長度
*/
private int length=0;
/**
* 欄位名
*/
private String name;
/**
* decimalLength
*/
private int decimalLength=0;
/**
* 是否為可以為null，true是可以，false是不可以，預設為true
*/
private boolean nullValue=true;
/**
* 是否是主鍵，預設false
*/
private boolean key=false;
/**
* 是否自動遞增，預設false 只有主鍵才能使用
*/
private boolean autoIncrement=false;
/**
* 預設值，預設為“”
*/
private String defaultValue="";
}
上述類，註冊了欄位的通用型別，繼承該類，我們生成StringColumn,LongColumn等型別
@Data
public class LongColumn extends CommonColumn {
public LongColumn() {
this.setType("bigint");
this.setLength(16);
}
}
該類限定了String 對應的資料庫型別及長度，將上述所有欄位類註冊到工廠中
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 {
/**
* 根據結構註解解析出來的資訊建立表
* @param tableSql
*/
public void createTable(TableSql tableSql);
/**
* 根據表名查詢表在庫中是否存在，存在返回1，不存在返回0
* @param tableName 表結構的map
* @return 存在返回1，不存在返回0
*/
public int findTableCountByTableName(@Param("tableName") String tableName);
/**
* 根據表名查詢庫中該表的欄位結構等資訊
* @param tableName 表結構的map
* @return 表的欄位結構等資訊
*/
public List<String> findTableEnsembleByTableName(@Param("tableName") String tableName);
/**
* 增加欄位
* @param tableSql
*/
public void addTableField(TableSql tableSql);
/**
* 根據表名刪除表
* @param tableName 表結構的map
*/
public void dorpTableByName(@Param("tableName") String tableName);
}
處理表與欄位的SQL如下
<mapper namespace="com.starmark.actable.mapper.CreateMysqlTablesMapper">
<!-- 抽取出來的公共部分 -->
<sql id="commonSql">
`${fields.fieldName}` ${fields.fieldType}
</sql>
<!-- 建立表的 -->
<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>
<!-- 驗證表是否存在 -->
<select id="findTableCountByTableName" resultType="int" parameterType="String">
select count(1) from information_schema.tables
where table_name = #{tableName} and table_schema = (select database())
</select>
<!-- 根據表名查詢表的結構 -->
<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>
<!-- 驗證表是否存在 -->
<select id="dorpTableByName" parameterType="String">
DROP TABLE IF EXISTS `${tableName}`;
</select>
</mapper>
- 核心處理類方法如下：
先查出要新增表的記錄或加欄位的表
/**
* 構建出全部表的增刪改的map
*
* @param classes 從包package中獲取所有的Class
* @param newTableMap 用於存需要建立的表名+結構
* @param addTableMap 用於存需要增加欄位的表名+結構
*/
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，表示將所有的表刪掉重新建立
if ("create".equals(actableConfig.getTableAuto())) {
createMysqlTablesMapper.dorpTableByName(tableName);
}
// 先查該表是否以存在
int exist = createMysqlTablesMapper.findTableCountByTableName(tableName);
// 不存在時
if (exist == 0) {
newTableMap.put(tableName, newFieldList);
} else {
// 已存在時理論上做修改的操作，這裡查出該表的結構
List<String> columnNames = createMysqlTablesMapper
.findTableEnsembleByTableName(tableName);
// 驗證對比從model中解析的fieldList與從資料庫查出來的columnList
// 1. 找出增加的欄位
buildAddFields(
newFieldList, addFieldList,
columnNames);
if(addFieldList.size()>0) {
addTableMap.put(tableName, addFieldList);
}
}
}
}
/**
* 構建增加的刪除的修改的欄位
*
* @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);
}
}
}
/**
* 判斷欄位是否已經存在了
*
* @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 準備做為建立表依據的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();
//設定欄位
if(column!=null&&StringUtils.isNoneEmpty(column.name())){
commonColumn.setName(column.name());
} else {
//獲取欄位名稱
String fieldName = CamelCaseUtil.humpToLine2(field.getName());
commonColumn.setName(fieldName);
}
//設定欄位型別
if(column!=null&&StringUtils.isNoneEmpty(column.type())){
commonColumn.setType(column.type());
}
//設定長度
if(column!=null&&column.length()>0){
commonColumn.setLength(column.length());
}
//設定長度
if(column!=null&&column.length()>0){
commonColumn.setDecimalLength(column.decimalLength());
}
//設定自增
if(column!=null&&column.isAutoIncrement()){
commonColumn.setAutoIncrement(column.isAutoIncrement());
}
//設定自增
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());
}
//設定欄位型別
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;
}
/**
* 根據傳入的map建立或修改表結構
*
* @param newTableMap 用於存需要建立的表名+結構
* @param addTableMap 用於存需要增加欄位的表名+結構
*/
private void createOrModifyTableConstruct(Map<String, List<CommonColumn>> newTableMap,
Map<String, List<CommonColumn>> addTableMap) {
// 1. 建立表
createTableByMap(newTableMap);
// 2. 新增新的欄位
addFieldsByMap(addTableMap);
}
/**
* 根據map結構對錶中新增新的欄位
*
* @param addTableMap 用於存需要增加欄位的表名+結構
*/
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) {
//因為mysql一次只能執行一條sql
List<CommonColumn> fieldList=new ArrayList<CommonColumn>();
fieldList.add(column);
TableSql tableSql = this.getTableSql(entry.getKey(), fieldList);
log.info("開始為表" + entry.getKey() + "增加欄位"+column.getName());
createMysqlTablesMapper.addTableField(tableSql);
log.info("完成為表" + entry.getKey() + "增加欄位"+column.getName());
}
}
}
}
/**
* 根據map結構建立表
*
* @param newTableMap 用於存需要建立的表名+結構
*/
private void createTableByMap(Map<String, List<CommonColumn>> newTableMap) {
// 做建立表操作
if (newTableMap.size() > 0) {
for (Entry<String, List<CommonColumn>> entry : newTableMap.entrySet()) {
TableSql tableSql = this.getTableSql(entry.getKey(), entry.getValue());
log.info("開始建立表：" + entry.getKey());
createMysqlTablesMapper.createTable(tableSql);
log.info("完成建立表：" + entry.getKey());
}
}
}
/**
* 構造執行的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;
}
上述程式碼為相關核心程式碼，如開源的actable一樣，支技自動建表，自動加欄位，有hiberate的created,update,none三種處理。
該程式碼因為限定了各種欄位對應的資料庫欄位，可以不在PO上加任何資訊，自動根據PO生成相關表。
真正使用時，我也自定義了註解類，讓特殊情況時，可以自動定義物件的長度及資料為欄位型別。
`// 該註解用於方法宣告
@Target(ElementType.FIELD)
// VM將在執行期也保留註釋，因此可以通過反射機制讀取註解的資訊
@Retention(RetentionPolicy.RUNTIME)
// 將此註解包含在javadoc中
@Documented
// 允許子類繼承父類中的註解
@Inherited
public @interface Column {
/**
* 欄位名
*
* @return 欄位名
*/
public String name() default "";
/**
* 欄位型別
*
* @return 欄位型別
*/
public String type() default "";
/**
* 欄位長度，預設是255
*
* @return 欄位長度，預設是255
*/
public int length() default 0 ;
/**
* 小數點長度，預設是0
*
* @return 小數點長度，預設是0
*/
public int decimalLength() default 0 ;
/**
* 是否為可以為null，true是可以，false是不可以，預設為true
*
* @return 是否為可以為null，true是可以，false是不可以，預設為true
*/
public boolean isNull() default true ;
/**
* 是否是主鍵，預設false
*
* @return 是否是主鍵，預設false
*/
public boolean isKey() default false ;
/**
* 是否自動遞增，預設false 只有主鍵才能使用
*
* @return 是否自動遞增，預設false 只有主鍵才能使用
*/
public boolean isAutoIncrement() default false ;
/**
* 預設值，預設為null
*
* @return 預設值，預設為null
*/
public String defaultValue() default "";
/**忽略該欄位，不自動生成資料庫欄位
* @return
*/
public boolean isIgnore() default false ;
}
真正使用時，只需要一個PO就能生成想要的表，這個配合mybtais plus ,用，真的爽歪歪了。
示例PO如下：
@Data
public class Person {
/** 唯一標識 */
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;
/**
* 該欄位不自動生成
*/
@Column(isIgnore = true)
private String loginName;
}
如果想要完整的程式碼，請打賞一注彩票錢再聯絡我。
相關文章
- MyBatis-Plus-實用的功能自動填充欄位MyBatis
- mybatis自動填充時間欄位MyBatis
- Mybatis加入JPA的自動建表功能MyBatis
- MyBatis實現MySQL表欄位及結構的自動增刪MyBatisMySql
- mybatis自動填充多個表相同欄位的值MyBatis
- EF Core3.1 CodeFirst動態自動新增表和欄位的描述資訊
- 【mybatis-plus】主鍵id生成、欄位自動填充MyBatis
- Mybatis plus通用欄位自動填充的最佳實踐總結MyBatis
- 欄位管理，為什麼只有新增的時候才自動匹配欄位型別型別
- 怎麼給模型中的欄位增加自動完成規則模型
- 【EF Core】自動生成的欄位值
- ThinkPHP3.2.3 欄位對映/自動驗證/自動完成PHP
- mybatisplus欄位值自動填充MyBatis
- mybatis動態呼叫表名和欄位名MyBatis
- mybatis新增物件自動生成uuid方案MyBatis物件UI
- pl/sql dev建表加欄位時建的欄位名都帶了“”SQLdev
- MySQL多個timestamp欄位自動新增預設值的問題MySql
- beego自動建表失敗Go
- 如何自動填充SQL語句中的公共欄位SQL
- Python SqlAlchemy動態新增資料表欄位PythonSQL
- 如何在水晶報表中動態新增欄位
- 【功能建議】社交網站自動分享功能網站
- SpringBoot-Mybatis_Plus學習記錄之公共欄位自動填充Spring BootMyBatis
- 介面自動化全量欄位校驗
- 在 Laravel 中自動維護 slug 欄位Laravel
- oracle 時間欄位自動更新問題Oracle
- springboot~jpa審計欄位的自動填充Spring Boot
- 如何給Infopath表單儲存時自動命名和自動關閉
- MySQL 表的自增欄位 預判功能innodb_autoinc_lock_modeMySql
- 自動生成Sql--基於Mybatis的單表SqlSQLMyBatis
- SQL新增表欄位SQL
- ubuntu新增自啟動Ubuntu
- SQL Server中根據某個欄位，ID欄位自動增長的實現SQLServer
- Mybatis框架：foreach迴圈遍歷欄位(為了解決動態表、動態欄位查詢資料)MyBatis框架
- mybatis根據表逆向自動化生成程式碼MyBatis
- oracle中如何指定表欄位自增Oracle
- 動態給表新增刪除欄位並同時修改它的插入更新儲存過程儲存過程
- Laravel- 圖片上傳新增自動裁剪功能Laravel