Apache Commons DbUtils是一個輕量級的封裝。我將它用在了項目中,在需要使用原生SQL語句的地方(批量操作或者很復雜的SQL語句),調用DbUtils來進行操作。
<!-- 定義數據源Bean-->
<bean id="dataSource"
class="org.apache.commons.dbcp.BasicDataSource"
destroy-method="close">
<property name="driverClassName"
value="${jdbc.driverClassName}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</bean>
<!-- 下面定義了DbUtils的一個模板操作Bean -->
<bean id="dbUtilsTemplate" class="com.company.project.dao.template.DbUtilsTemplate">
<property name="dataSource" ref="dataSource" />
</bean>
package com.company.project.dao.template;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.sql.DataSource;
import org.apache.commons.dbcp.BasicDataSource;
import org.apache.commons.dbutils.QueryRunner;
import org.apache.commons.dbutils.handlers.BeanHandler;
import org.apache.commons.dbutils.handlers.BeanListHandler;
import org.apache.commons.dbutils.handlers.MapHandler;
import org.apache.commons.dbutils.handlers.MapListHandler;
import org.apache.commons.dbutils.handlers.ScalarHandler;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* 調用Apache Commons DBUtil組件的數據庫操作類
* 采用DBCP作為數據源,數據源在Spring中已經配置好
* 本類已經在Spring中配置好,在需要的地方,set注入后即可調用
* <code>
* private DbUtilsTemplate dbUtilsTemplate;
* public void setDbUtilsTemplate(DbUtilsTemplate dbUtilsTemplate) {
* this.dbUtilsTemplate = dbUtilsTemplate;
* }
* </code>
* @author Sunshine
* @version 1.0 2009-07-29
*/
public class DbUtilsTemplate {
private DataSource dataSource;
private QueryRunner queryRunner;
private static final Log LOG = LogFactory.getLog(DbUtilsTemplate.class);
public void setDataSource(BasicDataSource dataSource) {
this.dataSource = dataSource;
}
/**
* 執行sql語句
* @param sql sql語句
* @return 受影響的行數
*/
public int update(String sql) {
return update(sql, null);
}
/**
* 執行sql語句
* <code>
* executeUpdate("update user set username = 'kitty' where username = ?", "hello kitty");
* </code>
* @param sql sql語句
* @param param 參數
* @return 受影響的行數
*/
public int update(String sql, Object param) {
return update(sql, new Object[] { param });
}
/**
* 執行sql語句
* @param sql sql語句
* @param params 參數數組
* @return 受影響的行數
*/
public int update(String sql, Object[] params) {
queryRunner = new QueryRunner(dataSource);
int affectedRows = 0;
try {
if (params == null) {
affectedRows = queryRunner.update(sql);
} else {
affectedRows = queryRunner.update(sql, params);
}
} catch (SQLException e) {
LOG.error("Error occured while attempting to update data", e);
}
return affectedRows;
}
/**
* 執行批量sql語句
* @param sql sql語句
* @param params 二維參數數組
* @return 受影響的行數的數組
*/
public int[] batchUpdate(String sql, Object[][] params) {
queryRunner = new QueryRunner(dataSource);
int[] affectedRows = new int[0];
try {
affectedRows = queryRunner.batch(sql, params);
} catch (SQLException e) {
LOG.error("Error occured while attempting to batch update data", e);
}
return affectedRows;
}
/**
* 執行查詢,將每行的結果保存到一個Map對象中,然后將所有Map對象保存到List中
* @param sql sql語句
* @return 查詢結果
*/
public List<Map<String, Object>> find(String sql) {
return find(sql, null);
}
/**
* 執行查詢,將每行的結果保存到一個Map對象中,然后將所有Map對象保存到List中
* @param sql sql語句
* @param param 參數
* @return 查詢結果
*/
public List<Map<String, Object>> find(String sql, Object param) {
return find(sql, new Object[] {param});
}
/**
* 執行查詢,將每行的結果保存到一個Map對象中,然后將所有Map對象保存到List中
* @param sql sql語句
* @param params 參數數組
* @return 查詢結果
*/
@SuppressWarnings("unchecked")
public List<Map<String, Object>> find(String sql, Object[] params) {
queryRunner = new QueryRunner(dataSource);
List<Map<String, Object>> list = new ArrayList<Map<String,Object>>();
try {
if (params == null) {
list = (List<Map<String, Object>>) queryRunner.query(sql, new MapListHandler());
} else {
list = (List<Map<String, Object>>) queryRunner.query(sql, new MapListHandler(), params);
}
} catch (SQLException e) {
LOG.error("Error occured while attempting to query data", e);
}
return list;
}
/**
* 執行查詢,將每行的結果保存到Bean中,然后將所有Bean保存到List中
* @param entityClass 類名
* @param sql sql語句
* @return 查詢結果
*/
public <T> List<T> find(Class<T> entityClass, String sql) {
return find(entityClass, sql, null);
}
/**
* 執行查詢,將每行的結果保存到Bean中,然后將所有Bean保存到List中
* @param entityClass 類名
* @param sql sql語句
* @param param 參數
* @return 查詢結果
*/
public <T> List<T> find(Class<T> entityClass, String sql, Object param) {
return find(entityClass, sql, new Object[] { param });
}
/**
* 執行查詢,將每行的結果保存到Bean中,然后將所有Bean保存到List中
* @param entityClass 類名
* @param sql sql語句
* @param params 參數數組
* @return 查詢結果
*/
@SuppressWarnings("unchecked")
public <T> List<T> find(Class<T> entityClass, String sql, Object[] params) {
queryRunner = new QueryRunner(dataSource);
List<T> list = new ArrayList<T>();
try {
if (params == null) {
list = (List<T>) queryRunner.query(sql, new BeanListHandler(entityClass));
} else {
list = (List<T>) queryRunner.query(sql, new BeanListHandler(entityClass), params);
}
} catch (SQLException e) {
LOG.error("Error occured while attempting to query data", e);
}
return list;
}
/**
* 查詢出結果集中的第一條記錄,并封裝成對象
* @param entityClass 類名
* @param sql sql語句
* @return 對象
*/
public <T> T findFirst(Class<T> entityClass, String sql) {
return findFirst(entityClass, sql, null);
}
/**
* 查詢出結果集中的第一條記錄,并封裝成對象
* @param entityClass 類名
* @param sql sql語句
* @param param 參數
* @return 對象
*/
public <T> T findFirst(Class<T> entityClass, String sql, Object param) {
return findFirst(entityClass, sql, new Object[] { param });
}
/**
* 查詢出結果集中的第一條記錄,并封裝成對象
* @param entityClass 類名
* @param sql sql語句
* @param params 參數數組
* @return 對象
*/
@SuppressWarnings("unchecked")
public <T> T findFirst(Class<T> entityClass, String sql, Object[] params) {
queryRunner = new QueryRunner(dataSource);
Object object = null;
try {
if (params == null) {
object = queryRunner.query(sql, new BeanHandler(entityClass));
} else {
object = queryRunner.query(sql, new BeanHandler(entityClass), params);
}
} catch (SQLException e) {
LOG.error("Error occured while attempting to query data", e);
}
return (T) object;
}
/**
* 查詢出結果集中的第一條記錄,并封裝成Map對象
* @param sql sql語句
* @return 封裝為Map的對象
*/
public Map<String, Object> findFirst(String sql) {
return findFirst(sql, null);
}
/**
* 查詢出結果集中的第一條記錄,并封裝成Map對象
* @param sql sql語句
* @param param 參數
* @return 封裝為Map的對象
*/
public Map<String, Object> findFirst(String sql, Object param) {
return findFirst(sql, new Object[] { param });
}
/**
* 查詢出結果集中的第一條記錄,并封裝成Map對象
* @param sql sql語句
* @param params 參數數組
* @return 封裝為Map的對象
*/
@SuppressWarnings("unchecked")
public Map<String, Object> findFirst(String sql, Object[] params) {
queryRunner = new QueryRunner(dataSource);
Map<String, Object> map = null;
try {
if (params == null) {
map = (Map<String, Object>) queryRunner.query(sql, new MapHandler());
} else {
map = (Map<String, Object>) queryRunner.query(sql, new MapHandler(), params);
}
} catch (SQLException e) {
LOG.error("Error occured while attempting to query data", e);
}
return map;
}
/**
* 查詢某一條記錄,并將指定列的數據轉換為Object
* @param sql sql語句
* @param columnName 列名
* @return 結果對象
*/
public Object findBy(String sql, String columnName) {
return findBy(sql, columnName, null);
}
/**
* 查詢某一條記錄,并將指定列的數據轉換為Object
* @param sql sql語句
* @param columnName 列名
* @param param 參數
* @return 結果對象
*/
public Object findBy(String sql, String columnName, Object param) {
return findBy(sql, columnName, new Object[] { param });
}
/**
* 查詢某一條記錄,并將指定列的數據轉換為Object
* @param sql sql語句
* @param columnName 列名
* @param params 參數數組
* @return 結果對象
*/
public Object findBy(String sql, String columnName, Object[] params) {
queryRunner = new QueryRunner(dataSource);
Object object = null;
try {
if (params == null) {
object = queryRunner.query(sql, new ScalarHandler(columnName));
} else {
object = queryRunner.query(sql, new ScalarHandler(columnName), params);
}
} catch (SQLException e) {
LOG.error("Error occured while attempting to query data", e);
}
return object;
}
/**
* 查詢某一條記錄,并將指定列的數據轉換為Object
* @param sql sql語句
* @param columnIndex 列索引
* @return 結果對象
*/
public Object findBy(String sql, int columnIndex) {
return findBy(sql, columnIndex, null);
}
/**
* 查詢某一條記錄,并將指定列的數據轉換為Object
* @param sql sql語句
* @param columnIndex 列索引
* @param param 參數
* @return 結果對象
*/
public Object findBy(String sql, int columnIndex, Object param) {
return findBy(sql, columnIndex, new Object[] { param });
}
/**
* 查詢某一條記錄,并將指定列的數據轉換為Object
* @param sql sql語句
* @param columnIndex 列索引
* @param params 參數數組
* @return 結果對象
*/
public Object findBy(String sql, int columnIndex, Object[] params) {
queryRunner = new QueryRunner(dataSource);
Object object = null;
try {
if (params == null) {
object = queryRunner.query(sql, new ScalarHandler(columnIndex));
} else {
object = queryRunner.query(sql, new ScalarHandler(columnIndex), params);
}
} catch (SQLException e) {
LOG.error("Error occured while attempting to query data", e);
}
return object;
}
}