在項目中,我們經常遇到這樣的情況,表主鍵值設置為自增長,也就是主鍵值不在應用層產生,而是在新增記錄時,由數據庫產生。當我們新增加一條記錄時,為了唯一定位到該記錄,我們需要獲得該記錄的主鍵值,而這需要在數據庫保存數據后才能從數據庫中返回主鍵值。當我們使用Hibernate作為持久化框架時,新對象在持久化之后,主鍵值會自動綁定到對象上,但是當我們使用JDBC的時候要如何獲得主鍵值。
在JDBC3.0規范中,當新增記錄時,允許將數據庫自動產生的主鍵值綁定到Statement或PreparedStatement中。使用Statement時,可以通過以下方法綁定主鍵值:
int executeUpdate(String sql,int autoGeneratedKeys)
也可以通過Connection創建綁定自增值的PreparedStatement:
PreparedStatement prepareStatement(String sql,int autoGeneratedKeys)
當autoGeneratedKeys參數設置為Statement.RETURN_GENERATED_KEYS值時即可綁定數據庫產生的主鍵值,設置為Statement.NO_GENERATED_KEYS時,不綁定主鍵值。如下代碼所示:
Statement stmt = conn.createStatement(); String sql = "insert into user(username,age) values('tom',22)"; stmt.executeUpdate(sql,Statement.RETURN_GENERATED_KEYS); ResultSet rs = stmt.getGeneratedKeys(); if(rs.next()){ int key = rs.getInt(0); }
Spring利用這一技術,提供了一個可以返回新增記錄對應主鍵值的方法;
int update(PreparedStatementCreator psc,KeyHolder generatedKeyHolder)
org.springframework.jdbc.support.KeyHolder是一個回調接口,Spring使用它保存新增記錄對應的主鍵,該接口的接口方法描述為:
- Number getKey() throws InvalidDataAccessApiUsageException
當僅插入一行記錄時,主鍵不是復合鍵而是數字類型時,通過該方法可以直接返回新的主鍵值。如果是復合主鍵,或者有多個主鍵返回時,該方法拋出InvalidDataAccessApiUsageException。
- Map<String,Object> getKeys() throws InvalidDataAccessApiUsageException
如果是復合主鍵,則列名和列值構成Map中的一個Entry。如果返回的是多個主鍵,則該方法拋出InvalidDataAccessApiUsageException異常。
- List<Map<String ,Object>> getKeyList()
如果返回多個主鍵,即PreparedStatement新增了多條記錄,則每一個主鍵對應一個Map,多個Map構成一個List。
Spring為KeyHolder接口指代了一個通用的實現類GenerateKeyHolder,該類返回新增記錄時的自增長主鍵值。我們可以修改上面的代碼使用Spring jdbc實現:
final String sql = "insert into user(username,age) values('tom',22)"; KeyHolder keyHolder = new GeneratedKeyHolder(); jdbcTemplate.update(new PreparedStatementCreator() { public PreparedStatement createPreparedStatement(Connection arg0) throws SQLException { PreparedStatement ps = conn.prepareStatement(sql); return ps; } }, keyHolder);
System.out.println("新插入數據的主鍵是:" + keyHolder.getKey().intValue());