通過反射注解批量插入數據到DB的實現方法

2024-07-14 08:43:31

字體：大中小

來源：轉載

供稿：網友

批量導入思路

最近遇到一個需要批量導入數據問題。后來考慮運用反射做成一個工具類，思路是首先定義注解接口，在bean類上加注解，運行時通過反射獲取傳入Bean的注解，自動生成需要插入DB的SQL，根據設置的參數值批量提交。不需要寫具體的SQL，也沒有DAO的實現，這樣一來批量導入的實現就和具體的數據庫表徹底解耦。實際批量執行的SQL如下：

insert into company_candidate(company_id,user_id,card_id,facebook_id,type,create_time,weight,score) VALUES (?,?,?,?,?,?,?,?) ON DUPLICATE KEY UPDATE type=?,weight=?,score=?

第一步，定義注解接口

注解接口Table中定義了數據庫名和表名。RetentionPolicy.RUNTIME表示該注解保存到運行時，因為我們需要在運行時，去讀取注解參數來生成具體的SQL。

@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)public @interface Table {  /**   * 表名   * @return   */  String tableName() default "";  /**   * 數據庫名稱   * @return   */  String dbName();}

注解接口TableField中定義了數據庫表名的各個具體字段名稱，以及該字段是否忽略（忽略的話就會以數據庫表定義默認值填充，DB非null字段的注解不允許出現把ignore注解設置為true）。update注解是在主鍵在DB重復時，需要更新的字段。

@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.FIELD)public @interface TableField {  /**   * 對應數據庫字段名稱   * @return   */  String fieldName() default "";  /**   * 是否是主鍵   * @return   */  boolean pk() default false;  /**   * 是否忽略該字段   * @return   */  boolean ignore() default false;  /**   * 當數據存在時，是否更新該字段   * @return   */  boolean update() default false;}

第二步，給Bean添加注解

給Bean添加注解（為了簡潔省略了import和set/get方法以及其他屬性），@TableField(fieldName = "company_id")表示companyId字段對應DB表的字段名為"company_id"，其中updateTime屬性的注解含有ignore=true，表示該屬性值會被忽略。另外serialVersionUID屬性由于沒有@TableField注解，在更新DB時也會被忽略。

代碼如下：

@Table(dbName = "company", tableName = "company_candidate")public class CompanyCandidateModel implements Serializable{ private static final long serialVersionUID = -1234554321773322135L; @TableField(fieldName = "company_id") private int companyId; @TableField(fieldName = "user_id") private int userId; //名片id @TableField(fieldName = "card_id") private int cardId; //facebookId @TableField(fieldName = "facebook_id") private long facebookId;  @TableField(fieldName="type", update = true) private int type; @TableField(fieldName = "create_time") private Date createTime; @TableField(fieldName = "update_time", ignore=true) private Date updateTime; // 權重  @TableField(fieldName="weight", update = true) private int weight; // 分值  @TableField(fieldName="score", update = true) private double score;

第三步，讀取注解的反射工具類

讀取第二步Bean類的注解的反射工具類。利用反射getAnnotation(TableField.class)讀取注解信息，為批量SQL的拼接最好準備。

getTableBeanFieldMap()方法里生成一個LinkedHashMap對象，是為了保證生成插入SQL的field順序，之后也能按同樣的順序給參數賦值，避免錯位。getSqlParamFields()方法也類似，是為了給PreparedStatement設置參數用。

代碼如下：

public class ReflectUtil {  /**   * <Class,<表定義Field名,Bean定義Field>>的map緩存   */  private static final Map<Class<?>, Map<string field="">> classTableBeanFieldMap = new HashMap<Class<?>, Map<string field="">>();  // 用來按順序填充SQL參數，其中存儲的Field和classTableBeanFieldMap保存同樣的順序，但數量多出ON DUPLICATE KEY UPDATE部分Field  private static final Map<Class<?>, List<field>> sqlParamFieldsMap = new HashMap<Class<?>, List<field>>();   private ReflectUtil(){};  /**   * 獲取該類上所有@TableField注解，且沒有忽略的字段的Map。   * <br />返回一個有序的LinkedHashMap類型   * <br />其中key為DB表中的字段，value為Bean類里的屬性Field對象   * @param clazz   * @return   */  public static Map<string field=""> getTableBeanFieldMap(Class<?> clazz) {   // 從緩存獲取   Map<string field=""> fieldsMap = classTableBeanFieldMap.get(clazz);   if (fieldsMap == null) {   fieldsMap = new LinkedHashMap<string field="">();      for (Field field : clazz.getDeclaredFields()) {// 獲得所有聲明屬性數組的一個拷貝       TableField annotation = field.getAnnotation(TableField.class);        if (annotation != null && !annotation.ignore() && !"".equals(annotation.fieldName())) {          field.setAccessible(true);// 方便后續獲取私有域的值         fieldsMap.put(annotation.fieldName(), field);        }  }      // 放入緩存      classTableBeanFieldMap.put(clazz, fieldsMap);   }   return fieldsMap;  }  /**   * 獲取該類上所有@TableField注解，且沒有忽略的字段的Map。ON DUPLICATE KEY UPDATE后需要更新的字段追加在list最后，為了填充參數值準備   * <br />返回一個有序的ArrayList類型   * <br />其中key為DB表中的字段，value為Bean類里的屬性Field對象   * @param clazz   * @return   */  public static List<field> getSqlParamFields(Class<?> clazz) {   // 從緩存獲取   List<field> sqlParamFields = sqlParamFieldsMap.get(clazz);   if (sqlParamFields == null) {   // 獲取所有參數字段     Map<string field=""> fieldsMap = getTableBeanFieldMap(clazz);   sqlParamFields = new ArrayList<field>(fieldsMap.size() * 2);     // SQL后段ON DUPLICATE KEY UPDATE需要更新的字段     List<field> updateParamFields = new ArrayList<field>();   Iterator<Entry<string field="">> iter = fieldsMap.entrySet().iterator();   while (iter.hasNext()) {    Entry<string field=""> entry = (Entry<string field="">) iter.next();    Field field = entry.getValue();    // insert語句對應sql參數字段    sqlParamFields.add(field);        // ON DUPLICATE KEY UPDATE后面語句對應sql參數字段        TableField annotation = field.getAnnotation(TableField.class);    if (annotation != null && !annotation.ignore() && annotation.update()) {    updateParamFields.add(field);    }   }   sqlParamFields.addAll(updateParamFields);      // 放入緩存   sqlParamFieldsMap.put(clazz, sqlParamFields);   }   return sqlParamFields;  }  /**   * 獲取表名,對象中使用@Table的tableName來標記對應數據庫的表名，若未標記則自動將類名轉成小寫   *    * @param clazz   * @return   */  public static String getTableName(Class<?> clazz) {    Table table = clazz.getAnnotation(Table.class);    if (table != null && table.tableName() != null && !"".equals(table.tableName())) {      return table.tableName();    }    // 當未配置@Table的tableName，自動將類名轉成小寫    return clazz.getSimpleName().toLowerCase();  }  /**   * 獲取數據庫名,對象中使用@Table的dbName來標記對應數據庫名   * @param clazz   * @return   */  public static String getDBName(Class<?> clazz) {    Table table = clazz.getAnnotation(Table.class);    if (table != null && table.dbName() != null) {      // 注解@Table的dbName      return table.dbName();    }    return "";  }

第四步，生成SQL語句

根據上一步的方法，生成真正執行的SQL語句。

insert into company_candidate(company_id,user_id,card_id,facebook_id,type,create_time,weight,score) VALUES (?,?,?,?,?,?,?,?) ON DUPLICATE KEY UPDATE type=?,weight=?,score=?

代碼如下：

public class SQLUtil {  private static final char COMMA = ',';  private static final char BRACKETS_BEGIN = '(';  private static final char BRACKETS_END = ')';  private static final char QUESTION_MARK = '?';  private static final char EQUAL_SIGN = '=';  private static final String INSERT_BEGIN = "INSERT INTO ";  private static final String INSERT_VALURS = " VALUES ";  private static final String DUPLICATE_UPDATE = " ON DUPLICATE KEY UPDATE ";  // 數據庫表名和對應insertupdateSQL的緩存  private static final Map<string string=""> tableInsertSqlMap = new HashMap<string string="">();  /**   * 獲取插入的sql語句，對象中使用@TableField的fieldName來標記對應數據庫的列名，若未標記則忽略   * 必須標記@TableField(fieldName = "company_id")注解   * @param tableName   * @param fieldsMap   * @return   * @throws Exception   */  public static String getInsertSql(String tableName, Map<string field=""> fieldsMap) throws Exception {   String sql = tableInsertSqlMap.get(tableName);   if (sql == null) {   StringBuilder sbSql = new StringBuilder(300).append(INSERT_BEGIN);   StringBuilder sbValue = new StringBuilder(INSERT_VALURS);   StringBuilder sbUpdate = new StringBuilder(100).append(DUPLICATE_UPDATE);   sbSql.append(tableName);   sbSql.append(BRACKETS_BEGIN);   sbValue.append(BRACKETS_BEGIN);   Iterator<Entry<string field="">> iter = fieldsMap.entrySet().iterator();   while (iter.hasNext()) {    Entry<string field=""> entry = (Entry<string field="">) iter.next();    String tableFieldName = entry.getKey();    Field field = entry.getValue();    sbSql.append(tableFieldName);    sbSql.append(COMMA);    sbValue.append(QUESTION_MARK);    sbValue.append(COMMA);    TableField tableField = field.getAnnotation(TableField.class);    if (tableField != null && tableField.update()) {    sbUpdate.append(tableFieldName);    sbUpdate.append(EQUAL_SIGN);    sbUpdate.append(QUESTION_MARK);    sbUpdate.append(COMMA);    }   }   // 去掉最后的逗號   sbSql.deleteCharAt(sbSql.length() - 1);   sbValue.deleteCharAt(sbValue.length() - 1);   sbSql.append(BRACKETS_END);   sbValue.append(BRACKETS_END);   sbSql.append(sbValue);   if (!sbUpdate.toString().equals(DUPLICATE_UPDATE)) {    sbUpdate.deleteCharAt(sbUpdate.length() - 1);    sbSql.append(sbUpdate);   }   sql = sbSql.toString();   tableInsertSqlMap.put(tableName, sql);   }    return sql;  }

第五步，批量SQL插入實現

從連接池獲取Connection，SQLUtil.getInsertSql()獲取執行的SQL語句，根據sqlParamFields來為PreparedStatement填充參數值。當循環的值集合到達batchNum時就提交一次。

代碼如下：

  /**   * 批量插入，如果主鍵一致則更新。結果返回更新記錄條數<br />   * @param dataList   *      要插入的對象List   * @param batchNum   *      每次批量插入條數   * @return 更新記錄條數   */  public int batchInsertSQL(List<? extends Object> dataList, int batchNum) throws Exception {   if (dataList == null || dataList.isEmpty()) {   return 0;   }    Class<?> clazz = dataList.get(0).getClass();    String tableName = ReflectUtil.getTableName(clazz);    String dbName = ReflectUtil.getDBName(clazz);    Connection connnection = null;    PreparedStatement preparedStatement = null;    // 獲取所有需要更新到DB的屬性域    Map<string field=""> fieldsMap = ReflectUtil.getTableBeanFieldMap(dataList.get(0).getClass());    // 根據需要插入更新的字段生成SQL語句    String sql = SQLUtil.getInsertSql(tableName, fieldsMap);    log.debug("prepare to start batch operation , sql = " + sql + " , dbName = " + dbName);    // 獲取和SQL語句同樣順序的填充參數Fields    List<field> sqlParamFields = ReflectUtil.getSqlParamFields(dataList.get(0).getClass());    // 最終更新結果條數    int result = 0;    int parameterIndex = 1;// SQL填充參數開始位置為1    // 執行錯誤的對象    List<object> errorsRecords = new ArrayList</object><object>(batchNum);//指定數組大小    // 計數器，batchNum提交后內循環累計次數    int innerCount = 0;    try {      connnection = this.getConnection(dbName);      // 設置非自動提交      connnection.setAutoCommit(false);      preparedStatement = connnection.prepareStatement(sql);      // 當前操作的對象      Object object = null;      int totalRecordCount = dataList.size();      for (int current = 0; current < totalRecordCount; current++) {        innerCount++;        object = dataList.get(current);       parameterIndex = 1;// 開始參數位置為1       for(Field field : sqlParamFields) {       // 放入insert語句對應sql參數          preparedStatement.setObject(parameterIndex++, field.get(object));       }       errorsRecords.add(object);        preparedStatement.addBatch();        // 達到批量次數就提交一次        if (innerCount >= batchNum || current >= totalRecordCount - 1) {          // 執行batch操作          preparedStatement.executeBatch();          preparedStatement.clearBatch();          // 提交          connnection.commit();          // 記錄提交成功條數          result += innerCount;          innerCount = 0;          errorsRecords.clear();        }        // 盡早讓GC回收        dataList.set(current, null);      }      return result;    } catch (Exception e) {      // 失敗后處理方法      CallBackImpl.getInstance().exectuer(sql, errorsRecords, e);      BatchDBException be = new BatchDBException("batch run error , dbName = " + dbName + " sql = " + sql, e);      be.initCause(e);      throw be;    } finally {      // 關閉      if (preparedStatement != null) {       preparedStatement.clearBatch();        preparedStatement.close();      }      if (connnection != null)        connnection.close();    }  }

最后，批量工具類使用例子

在mysql下的開發環境下測試，5萬條數據大概13秒。

List<companycandidatemodel> updateDataList = new ArrayList<companycandidatemodel>(50000);// ...為updateDataList填充數據int result = batchJdbcTemplate.batchInsertSQL(updateDataList, 50);

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對VeVb武林網的支持。

注：相關教程知識閱讀請移步到JAVA教程頻道。

上一篇：spring cloud consul使用ip注冊服務的方法示例

下一篇：Java讀取.properties配置文件方法示例