結果集分類
單行數據處理:ScalarHandler ArrayHandler MapHandler BeanHandler
多行數據處理:BeanListHandler AbstractListHandler(ArrayListHandler MapListHandler ColumnListHandler)
AbstractKeyedHandler(KeyedHandler BeanMapHandler)
可供擴展的類:BaseResultSetHandler
Dbutils使用結果集的方法有query、insert、insertBatch三個。這些方法都在QueryRunner類中,需要注意的是insert和update方法都能執行 “insert”開頭的sql語句,但是返回值有區別。insert
執行後返回的是表中的插入行生成的主鍵值,update
返回的是受語句影響的行數。所以,如果目標表中有主鍵且需要返回插入行的主鍵值就用 insert 方法,如果表沒有主鍵或者不需要返回主鍵值可使用 update 方法。
準備
先建立測試用數據表[users]:
字段類型,id 爲主鍵:
[id] [int] IDENTITY(1,1) NOT NULL,
[userName] [nchar](20) NOT NULL,
[loginName] [nchar](20) NOT NULL,
[userPassword] [nchar](100) NOT NULL,
[userLevel] [int] NOT NULL,
[userLock] [bit] NOT NULL,
1、ScalarHandler
用於獲取結果集中第一行某列的數據並轉換成 T 表示的實際對象。該類對結果集的處理直接在 handle 方法中進行,不涉及 dbutils 庫的其他類。
String sql = "select * from users";
// ---- query 語句 ----
// ScalarHandler 的參數爲空或null時,返回第一行第一列的數據
int rs = runner.query(sql, new ScalarHandler<Integer>());
System.out.println("ScalarHandler: " + rs); // Print:[ScalarHandler: 1]
// ScalarHandler 的參數可以是列的索引(從1開始)或列名
String rs = runner.query(sql, new ScalarHandler<String>(2));
// 或者 String rs = runner.query(sql, new ScalarHandler<String>("userName"));
System.out.println("ScalarHandler: " + rs); // Print:[ScalarHandler: 測試用戶1]
// ---- insert 語句 ----
// 因爲我使用的是mssql數據庫,QueryRunner的insert獲取插入數據的主鍵其實調用的是select SCOPE_IDENTITY()
// 數據庫執行後返回的類型是numeric,映射到 java 類型就是 java.math.BigDecimal
String inSql = "insert users (userName, loginName, userPassword, userLevel, userLock) values (?, ?, ?, ?, ?)";
BigDecimal insertRs = runner.insert(inSql,new ScalarHandler(), "java程序編寫", "javahello", "sefsfsfwew", "15", false);
System.out.println("ScalarHandler: " + insertRs); // Print:[ScalarHandler: 4]
使用的時候一定要保證提供正確的列索引或列名,並且結果類型也要正確可轉換。
2、ArrayHandler
用於獲取結果集中的第一行數據,並將其封裝到一個數組中,一列值對應一個數組元素。
public Object[] handle(ResultSet rs) throws SQLException {
// convert = new BasicRowProcessor()
// 如果有數據,將調用 BasicRowProcessor 的 toArray(rs) 方法處理
return rs.next() ? this.convert.toArray(rs) : EMPTY_ARRAY;
}
// ---- query 語句 ----
String sql = "select * from users";
Object[] rs = runner.query(sql, new ArrayHandler());
// Print: ArrayHandler: [1, 測試用戶1, test1, jiseflwes, 10, false]
System.out.println("ArrayHandler: " + Arrays.toString(rs));
// ---- insert 語句 ----
String inSql = "insert users_t (userName, loginName, userPassword, userLevel, userLock) values (?, ?, ?, ?, ?)";
Object[] insertRs = runner.insert(inSql,new ArrayHandler(), "java程序編寫", "javahello", "sefsfsfwew", "15", false);
// Print: ArrayHandler: [5]
System.out.println("ArrayHandler: " + Arrays.toString(insertRs));
3、MapHandler
用於獲取結果集中的第一行數據,並將其封裝到一個Map中,Map 中 key 是數據的列別名(as label),如果沒有就是列的實際名稱,Map 中 value 就是列的值,注意代表列的 key 不區分大小寫。
handle 源碼:
public Map<String, Object> handle(ResultSet rs) throws SQLException {
// convert = new BasicRowProcessor()
// 如果有數據,將調用 BasicRowProcessor 的 toMap(rs) 方法處理
return rs.next() ? this.convert.toMap(rs) : null;
}
通過查看 BasicRowProcessor 代碼,可以知道封裝結果集的 Map 其實是一個 LinkedHashMap 對象。
// ---- query 語句 ----
String sql = "select userName, loginName, userPassword as password, userLevel, userLock from users";
Map<String, Object> rs = runner.query(sql, new MapHandler());
// Print: MapHandler: {userName=測試用戶1, loginName=test1, password=jiseflwes, userLevel=10, userLock=false}
System.out.println("MapHandler: " + rs);
// 列名小寫 Print: username: 測試用戶1
System.out.println("username: " + rs.get("username"));
// 列名大寫 Print: USERNAME: 測試用戶1
System.out.println("USERNAME: " + rs.get("USERNAME"));
// 使用了as指定別名,那麼取數據的時候一定要用別名,否則返回null。
// Print: userPassword as password: jiseflwes
System.out.println("userPassword as password: " + rs.get("password"));
// Print: userPassword as password: null
System.out.println("userPassword as password: " + rs.get("userPassword"));
// ---- insert 語句 ----
String inSql = "insert users (userName, loginName, userPassword, userLevel, userLock) values (?, ?, ?, ?, ?)";
Map<String, Object> insertRs = runner.insert(inSql,new MapHandler(), "java程序編寫", "javahello", "sefsfsfwew", "15", false);
// 注意這個鍵(key)是由數據庫驅動定義的。
// Print: MapHandler:{GENERATED_KEYS=6}
System.out.println("MapHandler: " + insertRs);
// 我用的是微軟提供的驅動,所以是GENERATED_KEYS,如果是其他驅動就又不同了(比如jtds驅動key是ID)
// jtds驅動使用 insertRs.get("ID")
// Print: MapHandler: 6
System.out.println("MapHandler: " + insertRs.get("GENERATED_KEYS"));
4、BeanHandler
用於獲取結果集中的第一行數據,並將其封裝到JavaBean對象。整個轉換過程最終會在 BeanProcessor 類中完成。
/**
* Users類
*/
public class Users {
private int id;
private String userName;
private String loginName;
private String userPassword;
private int userLevel;
private boolean userLock;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
// ... 略過其他 getter 和 setter 方法
@Override
public String toString() {
return "Users{" +
"id=" + id +
", userName='" + userName + '\'' +
", loginName='" + loginName + '\'' +
", userPassword='" + userPassword + '\'' +
", userLevel=" + userLevel +
", userLock=" + userLock +
'}';
}
}
執行代碼:
//---- query 語句 ----
String sql = "select * from users";
Users rs = runner.query(sql, new BeanHandler<Users>(Users.class));
// Print: BeanHandler: Users{id=1, userName='測試用戶1', loginName='test1', userPassword='jiseflwes', userLevel=10, userLock=true}
System.out.println("BeanHandler: " + rs);
// Print: BeanHandler: test1
System.out.println("BeanHandler: " + rs.getLoginName());
需要注意的是,默認的情況下要保證表的字段和javabean的屬性一致(字符一致即可,對大小寫不敏感),比如字段是userLock,那麼javabean中屬性必須是userLock這幾個字母(可以是userlock,userLock,userLOCK,不過還是建議按照規範來定義)。
但有個問題,數據表中的字段可能已經定下來了,而且名稱可能不太規範,比如用下劃線(login_name),或者加了一個類型前綴(chrLoginName),如果修改表字段,那麼涉及到的修改地方太多了,其實查看源碼可以知道BeanHandler有兩個構造方法:
// BeanHandler 構造方法
public BeanHandler(Class<T> type) {
this(type, ArrayHandler.ROW_PROCESSOR);
}
public BeanHandler(Class<T> type, RowProcessor convert) {
this.type = type;
this.convert = convert;
}
可以看出其實都是調用的第二個方法。
runner.query(sql, new BeanHandler<Users>(Users.class));
// 等價於
runner.query(sql, new BeanHandler<Users>(Users.class, new BasicRowProcessor()));
// 等價於
runner.query(sql, new BeanHandler<Users>(Users.class, new BasicRowProcessor(new BeanProcessor())));
// 所以關鍵的地方在 new BeanProcessor() 這個具體處理結果的對象
情況一
只涉及到下劃線,表字段名用下劃線間隔(如表users_t字段:[id],[user_name],[login_name],[user_password],[user_level],[user_lock]),現在要封裝到Javabean中Users類(代碼見上),其中屬性使用駝峯命名。可以用dbutils1.6提供的BeanProcessor類的子類GenerousBeanProcessor。
String sql = "select id,user_name,login_name,user_password,user_level,user_lock from users_t";
// 創建一個BeanProcessor對象
// GenerousBeanProcessor 僅僅重寫了父類BeanProcessor的mapColumnsToProperties方法
BeanProcessor bean = new GenerousBeanProcessor();
// 將GenerousBeanProcessor對象傳遞給BasicRowProcessor
RowProcessor processor = new BasicRowProcessor(bean);
// 最後使用GenerousBeanProcessor的mapColumnsToProperties處理表字段到javabean的屬性映射
Users rs = runner.query(sql, new BeanHandler<Users>(Users.class, processor));
// Print: BeanHandler: Users{id=1, userName='測試用戶1', loginName='test1', userPassword='jiseflwes', userLevel=10, userLock=true}
System.out.println("BeanHandler: " + rs);
情況二
完全改變表字段到Javabean屬性的映射(如表users_m字段:[yhmid],[charUsername],[charLoginName],[charPassword],[intLevel],[boolLock])映射到Users類(代碼同上):
// BeanProcessor 有兩個構造方法,可以傳入一個HashMap集合
// HashMap 規定了表字段映射到Javabean的哪個屬性,即key爲字段名稱,value爲對應的javabean屬性
// map.put(表字段名稱, Javabean屬性名稱)
Map<String, String> map = new HashMap<String, String>();
map.put("yhmid", "id");
map.put("charUsername", "userName");
map.put("charLoginName", "loginName");
map.put("charPassword", "userPassword");
map.put("intLevel", "userLevel");
map.put("boolLock", "userLock");
// 用構建好的HashMap建立一個BeanProcessor對象
BeanProcessor bean = new BeanProcessor(map);
RowProcessor processor = new BasicRowProcessor(bean);
Users rs = runner.query(sql, new BeanHandler<Users>(Users.class, processor));
// Print: BeanHandler: Users{id=1, userName='測試用戶1', loginName='test1', userPassword='jiseflwes', userLevel=10, userLock=true}
System.out.println("BeanHandler: " + rs);
5、BeanListHandler
用於將結果集的每一行數據轉換爲Javabean,再將這個Javabean添加到ArrayList中。可以簡單的看着是BeanHandler的高級版,只不過是多了一步,就是將生成的Javabean添加到ArrayList中,其他的處理都和BeanHandler一樣。
String sql = "select * from users";
List<Users> rs = runner.query(sql, new BeanListHandler<Users>(Users.class));
// Print: BeanListHandler: [
// Users{id=1, userName='測試用戶1', loginName='test1', userPassword='jiseflwes', userLevel=10, userLock=true},
// Users{id=1, userName='知道什麼', loginName='hello', userPassword='2556sefsfs', userLevel=10, userLock=true},
// Users{id=1, userName='編程就編程', loginName='cjava', userPassword='sfsfsef254sefs', userLevel=2, userLock=false}]
System.out.println("BeanListHandler: " + rs);
6、AbstractListHandler
AbstractListHandler抽象類已經實現handle方法,該方法其實只是起到一個包裝作用,將處理好的每行數據添加到ArrayList中。每行的數據處理通過調用handleRow方法實現,所有它的3個子類都必須實現這個方法。
// AbstractListHandler 類實現了handle方法
@Override
public List<T> handle(ResultSet rs) throws SQLException {
List<T> rows = new ArrayList<T>();
while (rs.next()) {
rows.add(this.handleRow(rs)); // 每個子類實現自己的handleRow方法
}
return rows;
}
6.1、ArrayListHandler (extends AbstractListHandler<Object[]>)
用於將結果集每行數據轉換爲Object數組(處理過程等同與ArrayHandler),再將該數組添加到ArrayList中。簡單點,就是將每行數據經過ArrayHandler處理後添加到ArrayList中。
String sql = "select * from users";
List rs = runner.query(sql, new ArrayListHandler());
// Print:
// [1, 測試用戶1, test1, jiseflwes, 10, true]
// [2, 知道什麼, hello, 2556sefsfs, 10, true]
// [3, 編程就編程, cjava, sfsfsef254sefs, 2, false]
for(Object user : rs) {
System.out.println(Arrays.toString((Object[])user));
}
6.2 MapListHandler (extends AbstractListHandler<Map<String, Object>>)
用於將結果集每行數據轉換爲Map(處理過程等同與MapHandler),再將Map添加到ArrayList中。簡單點,就是將每行數據經過MapHandler處理後添加到ArrayList中。
String sql = "select * from users";
List rs = runner.query(sql, new MapListHandler());
// Print:
// {1, 測試用戶1, test1, jiseflwes, 10, true}
// {2, 知道什麼, hello, 2556sefsfs, 10, true}
// {3, 編程就編程, cjava, sfsfsef254sefs, 2, false}
for(Object user : rs) {
System.out.println((Map<String, Object>)user);
}
6.3 ColumnListHandler (extends AbstractListHandler)
根據列索引或列名獲取結果集中某列的所有數據,並添加到ArrayList中。可以理解爲ScalarHandler的加強版。
String sql = "select * from users";
List<String> rs = runner.query(sql, new ColumnListHandler<String>(2));
// 等同 List<String> rs = runner.query(sql, new ColumnListHandler<String>("userName"));
// Print:
// 測試用戶1
// 知道什麼
// 編程就編程
for(String user : rs) {
System.out.println(user);
}
7、AbstractKeyedHandler<K, V>
AbstractKeyedHandler是一個抽象類,已經實現了handle方法,其子類必須實現createKey(ResultSet rs)和createRow(ResultSet rs)方法,以便handle()的調用。
/**
* 返回一個HashMap<K, V>
* createKey(rs) 將某列的值作爲HashMap的key
* createRow(rs) 將結果集轉換後作爲HashMap的value
*/
@Override
public Map<K, V> handle(ResultSet rs) throws SQLException {
Map<K, V> result = createMap();
while (rs.next()) {
result.put(createKey(rs), createRow(rs)); // 需要子類自己實現
}
return result;
}
7.1 KeyedHandler (extends AbstractKeyedHandler<K, Map<String, Object>>)
用於獲取所有結果集,將每行結果集轉換爲Map<String, Object>,並指定某列爲key。可以簡單的認爲是一個雙層Map,相當於先對每行數據執行MapHandler,再爲其指定key添加到一個HaspMap中。KeyedHandler 中的是指定的列值的類型。
String sql = "select * from users";
// 在這兒指定主鍵id爲結果key,也可以傳入列名 new KeyedHandler<Integer>("id")
Map<Integer, Map<String, Object>> rs = runner.query(sql, new KeyedHandler<Integer>(1));
// Print: KeyedHandler: {
// 1={id=1, userName=測試用戶1, loginName=test1, userPassword=jiseflwes, userLevel=10, userLock=true},
// 2={id=2, userName=知道什麼, loginName=hello, userPassword=2556sefsfs, userLevel=10, userLock=true},
// 3={id=3, userName=編程就編程, loginName=cjava, userPassword=sfsfsef254sefs, userLevel=2, userLock=false}}
System.out.println("KeyedHandler: " + rs);
// 也可以指定其他列作爲key,但是需要注意如果指定的列值存在重複值,那麼後面的值將覆蓋前面的,最終HashMap中key都是唯一的。
// 如指定列userLevel爲key,最終只有兩個結果,因爲前兩行userLevel值都是10。
Map<Integer, Map<String, Object>> rs = runner.query(sql, new KeyedHandler<Integer>("userLevel"));
// Print: KeyedHandler: {
// 2={id=3, userName=編程就編程, loginName=cjava, userPassword=sfsfsef254sefs, userLevel=2, userLock=false},
// 10={id=2, userName=知道什麼, loginName=hello, userPassword=2556sefsfs, userLevel=10, userLock=true}}
System.out.println("KeyedHandler: " + rs);
7.2 BeanMapHandler<K, V> (extends AbstractKeyedHandler<K, V>)
用於獲取所有結果集,將每行結果集轉換爲Javabean作爲value,並指定某列爲key,封裝到HashMap中。相當於對每行數據的做BeanHandler一樣的處理後,再指定列值爲Key封裝到HashMap中。
String sql = "select * from users";
// new BeanMapHandler<Integer, Users>(Users.class,"id")
Map<Integer, Users> rs = runner.query(sql, new BeanMapHandler<Integer, Users>(Users.class,1));
// Print: BeanMapHandler: {
// 1=Users{id=1, userName='測試用戶1', loginName='test1', userPassword='jiseflwes', userLevel=10, userLock=true},
// 2=Users{id=2, userName='知道什麼', loginName='hello', userPassword='2556sefsfs', userLevel=10, userLock=true},
// 3=Users{id=3, userName='編程就編程', loginName='cjava', userPassword='sfsfsef254sefs', userLevel=2, userLock=false}}
System.out.println("BeanMapHandler: " + rs);
需要注意這個結果轉換類也可以像BeanHandler的情況一和情況二介紹的那樣定義一個processor,但默認情況下這麼做了就會以每行的第一列作爲Key,不能指定其他列爲Key。
// 這種情況下,以每行第一列爲key
Map<Integer, Users> rs = runner.query(sql, new BeanMapHandler<Integer, Users>(Users.class,processor));
8、BaseResultSetHandler
根據文檔介紹,如果上面的結果集處理類都不能滿足你的要求,可以通過繼承這個抽象類定義自己的結果處理類,子類必須實現無參方法handle()。
做個簡單的例子,比如要將指定列值加一個前綴"class-"後添加到ArrayList中:
//------------- 定義類 MeResultHandler.java -------------
/**
* 自定義的結果處理類,對結果集的操作直接調用父類已經封裝好的方法。
* 這兒只是對取到的結果包裝加工。
*/
public class MeResultHandler extends BaseResultSetHandler<List<String>> {
private final int columnIndex;
// 指定要獲取值的列索引
public MeResultHandler(int columnIndex) {
this.columnIndex = columnIndex;
}
// 重寫父類的方法,封裝每行數據
@Override
protected List<String> handle() throws SQLException {
List<String> rows = new ArrayList<String>();
// 因爲父類已經封裝好了對ResultSet各種操作,直接調用父類方法 next()
while(this.next()) {
rows.add(handleRow());
}
return rows;
}
// 自定義的數據處理方法
@SuppressWarnings("unchecked")
private String handleRow() throws SQLException {
// 直接調用父類方法 getObject()
return "class-" + String.valueOf(this.getObject(this.columnIndex));
}
}
//------------- 使用類 -------------
List<String> rs = runner.query(sql, new MeResultHandler(1));
// Print: MeResultHandler: [class-1, class-2, class-3]
System.out.println("MeResultHandler: " + rs);
總的來說,最終的數據處理是在 BasicRowProcessor 的四個方法中進行,涉及到JavaBean的話會通過 BasicRowProcessor 調用 BeanProcessor 的兩個方法。其他的都是對每行數據轉換後的結果的封裝。