Spring JDBC簡介
先來看看一個JDBC的例子。我們可以看到為了執(zhí)行一條SQL語句,我們需要創(chuàng)建連接,創(chuàng)建語句對象,然后執(zhí)行SQL,然后操縱結果集獲取數據。
try(Connection connection = DriverManager.getConnection(URL, USERNAME, PASSWORD)){
List<User> users = new ArrayList<>();
try (Statement statement = connection.createStatement()) {
try (ResultSet rs = statement.executeQuery("SELECT *FROM user")) {
while (rs.next()) {
User user = new User();
user.setId(rs.getInt(1));
user.setUsername(rs.getString(2));
user.setPassword(rs.getString(3));
user.setNickname(rs.getString(4));
user.setBirthday(rs.getDate(5));
users.add(user);
}
}
}
}
其實這些步驟中有很多步驟都是固定的,Spring JDBC框架將這些操作封裝起來, 我們只需要關注業(yè)務邏輯點即可。在Spring JDBC框架中,我們要做的事情如下:
- 定義連接字符串參數。
- 指定SQL語句。
- 聲明參數和參數類型。
- 每次迭代結果集的操作。
Spring會幫我們完成以下事情:
- 打開連接。
- 準備和執(zhí)行SQL語句。
- 在需要的情況下迭代結果集。
- 處理異常。
- 操作事務。
- 關閉結果集、語句和數據庫連接。
使用JdbcTemplate
JdbcTemplate是Jdbc框架最重要的類,提供了較為底層的Jdbc操作。其它幾個類都是在JdbcTemplate基礎上封裝了相關功能。
添加依賴
要在Gradle項目中使用Spring JDBC框架,添加如下一段。由于Spring JDBC的主要類JdbcTemlate需要一個數據源用來初始化,所以還需要一個數據源的實現。
compile group: 'org.springframework', name: 'spring-jdbc', version: '4.3.5.RELEASE'
compile group: 'org.apache.commons', name: 'commons-dbcp2', version: '2.1.1'
如果要使用Spring框架的其他功能,可能還需要添加對應的依賴。
創(chuàng)建Jdbc Template Bean
首先需要創(chuàng)建一個數據源Bean。為了將配置分離,我們先新建一個jdbc.properties文件。
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.username=root
jdbc.password=12345678
然后創(chuàng)建一個Spring配置文件jdbc.xml。這里用到了<context:property-placeholder>節(jié)點來導入其它配置文件。然后用這些屬性創(chuàng)建一個數據源Bean,然后再利用數據源Bean來創(chuàng)建一個JdbcTemplate。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
<bean id="dataSource" class="org.apache.commons.dbcp2.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>
<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
<constructor-arg ref="dataSource"/>
</bean>
<context:property-placeholder location="jdbc.properties"/>
</beans>
JdbcTemplate操作
注冊了JdbcTemplate之后,就可以將它注入到任何地方來使用了。首先它可以使用execute方法,執(zhí)行任何SQL語句。這里創(chuàng)建了一個簡單的MySQL用戶表,只有主鍵和用戶名。
jdbcTemplate.execute("CREATE TABLE user(id INT AUTO_INCREMENT PRIMARY KEY,name VARCHAR(255) UNIQUE)");
它還可以使用update方法執(zhí)行增加、更新和刪除操作。
jdbcTemplate.update("INSERT INTO user(name) VALUES(?)", "yitian");
jdbcTemplate.update("INSERT INTO user(name) VALUES(?)", "zhang2");
jdbcTemplate.update("UPDATE user SET name=? WHERE name=?", "zhang3", "zhang2");
jdbcTemplate.update("DELETE FROM user WHERE name=?", "zhang3");
查詢操作也很簡單,使用queryForObject方法,傳入SQL字符串和結果類型即可。
int count = jdbcTemplate.queryForObject("SELECT count(*) FROM user", Integer.class);
System.out.println("記錄數目是:" + count);
String name = jdbcTemplate.queryForObject("SELECT name FROM user WHERE id=1", String.class);
System.out.println("姓名是:" + name);
如果要查詢整條記錄也可以。Spring提供了一個接口RowMapper,只需要實現該接口的mapRow方法,即可將結果集的一條記錄轉化為一個Java對象,該方法的第二個參數是當前行的行數。下面是一個RowMapper實現。
public class UserRowMapper implements RowMapper<User> {
@Override
public User mapRow(ResultSet rs, int rowNum) throws SQLException {
return new User(rs.getInt(1), rs.getString(2));
}
}
User實體類對應于上面創(chuàng)建表時簡單的用戶表(其他方法已省略)。
public class User {
private int id;
private String name;
}
實現了RowMapper接口之后,我們就可以查詢一條記錄并轉化為Java對象了。
User user = jdbcTemplate.queryForObject("SELECT id,name FROM user WHERE id=?", new UserRowMapper(), 1);
System.out.println(user);
查詢多條記錄也可以,這時候需要使用query方法。
List<User> users = jdbcTemplate.query("SELECT id,name FROM usr", new UserRowMapper());
System.out.println(users);
還有一個通用方法queryForList,返回一個List,每一個元素都是一個Map,在Map中存放著列名和值組成的鍵值對。
List<Map<String, Object>> results = jdbcTemplate.queryForList("SELECT id,name FROM user");
System.out.println(results);
使用NamedParameterJdbcTemplate
前面的JdbcTemplate提供了非常方便的JDBC操作封裝,但是在綁定參數的時候只能采用通配符?方式以順序方式綁定參數。如果SQL語句比較復雜,參數比較多,那么這種方式顯得不太方便。因此Spring提供了一個更加方便的類NamedParameterJdbcTemplate,它可以以命名方式綁定SQL語句參數。NamedParameterJdbcTemplate在內部使用一個JdbcTemplate,你也可以調用getJdbcOperations方法獲取底層的JdbcTemplate對象,然后用前面的方法進行基本操作。
創(chuàng)建NamedParameterJdbcTemplate和JdbcTemplate相同,只需要傳入一個數據源即可。
<bean id="namedParameterJdbcTemplate" class="org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate">
<constructor-arg ref="dataSource"/>
</bean>
NamedParameterJdbcTemplate和JdbcTemplate的大部分操作相同,這里僅介紹綁定命名參數的部分。首先,SQL語句必須使用:參數名稱的形式作為參數。然后,我們創(chuàng)建一個MapSqlParameterSource對象,它的內部使用了一個Map保存的命名參數的名稱和值。然后我們使用它的addValue方法傳遞需要的命名參數的名稱和值,這個方法還可以接受第三個參數指定參數類型,這個類型以java.sql.Types的一些公共字段的形式給出。最后,將MapSqlParameterSource傳遞給相應的方法執(zhí)行即可。
String sql = "SELECT id,name FROM user WHERE name=:name AND id<:user_id";
MapSqlParameterSource namedParameters = new MapSqlParameterSource();
namedParameters.addValue("name", "test");
namedParameters.addValue("user_id", 100, Types.INTEGER);
User user = namedParameterJdbcTemplate.queryForObject(sql, namedParameters, new UserRowMapper());
System.out.println(user);
如果不想創(chuàng)建MapSqlParameterSource對象,還可以直接使用一個Map傳遞命名參數的名稱和值。
Map<String, Object> map = new HashMap<>();
map.put("user_id", 100);
map.put("name", "test");
List<User> users = namedParameterJdbcTemplate.query(sql, map, new UserRowMapper());
System.out.println(users);
上面討論的MapSqlParameterSource實際上實現了SqlParameterSource接口,上面的幾個方法簽名也是接受SqlParameterSource接口。這個接口表示用來傳遞命名參數和值的集合。除了MapSqlParameterSource之外,還有另外一個常用的實現,BeanPropertySqlParameterSource,這個類接受一個Java Bean對象,然后使用Bean的屬性名和值作為命名參數的名稱和值。這一點需要注意。
User bean = new User(100, "test");
SqlParameterSource parameterSource = new BeanPropertySqlParameterSource(bean);
users = namedParameterJdbcTemplate.query(sql, parameterSource, new UserRowMapper());
System.out.println(users);
使用SimpleJdbc類
前面所說的JdbcTemplate封裝了一些功能,讓我們方便的使用JDBC。Spring還提供了幾個更高級、功能更具體的SimpleJdbc類。這些類會讀取JDBC的元數據Metadata,使用起來更加方便。
SimpleJdbcInsert
SimpleJdbcInsert類用來插入數據。簡單的使用方法如下。SimpleJdbcInsert需要一個數據源來創(chuàng)建,withTableName方法指定要插入的表名,usingGeneratedKeyColumns指定設置了主鍵自增的列名。其他使用方法和前面所說的類類似。executeAndReturnKey這個方法很特別,它會將數據插入數據庫并返回該條記錄對應的自增鍵。有時候我們可能希望使用自增主鍵來插入一條數據,由于主鍵是數據庫自動生成的,我們必須再次查詢數據庫才能獲得主鍵。這種情況下使用executeAndReturnKey非常方便。注意這個方法返回的是java.lang.Number類型,可以調用其XXXvalue方法轉換成各種數值。
SimpleJdbcInsert simpleJdbcInsert = new SimpleJdbcInsert(dataSource)
.withTableName("user")
.usingGeneratedKeyColumns("id");
User user = new User();
user.setName("test");
Map<String, Object> params = new HashMap<>();
params.put("names", user.getName());
int id = simpleJdbcInsert.executeAndReturnKey(params).intValue();
System.out.println("simpleJdbcInsert" + user);
SimpleJdbcCall
SimpleJdbcCall類用來調用存儲過程的。使用方法類似。這里就直接給出Spring官方文檔的示例代碼了。
MySQL存儲過程。
CREATE FUNCTION get_actor_name (in_id INTEGER)
RETURNS VARCHAR(200) READS SQL DATA
BEGIN
DECLARE out_name VARCHAR(200);
SELECT concat(first_name, ' ', last_name)
INTO out_name
FROM t_actor where id = in_id;
RETURN out_name;
END;
SimpleJdbcCall調用存儲過程。
public class JdbcActorDao implements ActorDao {
private JdbcTemplate jdbcTemplate;
private SimpleJdbcCall funcGetActorName;
public void setDataSource(DataSource dataSource) {
this.jdbcTemplate = new JdbcTemplate(dataSource);
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
jdbcTemplate.setResultsMapCaseInsensitive(true);
this.funcGetActorName = new SimpleJdbcCall(jdbcTemplate)
.withFunctionName("get_actor_name");
}
public String getActorName(Long id) {
SqlParameterSource in = new MapSqlParameterSource()
.addValue("in_id", id);
String name = funcGetActorName.executeFunction(String.class, in);
return name;
}
// ... additional methods
}
如果要從存儲過程獲取記錄的話,可以這樣。以下是一個MySQL存儲過程。
CREATE PROCEDURE read_all_actors()
BEGIN
SELECT a.id, a.first_name, a.last_name, a.birth_date FROM t_actor a;
END;
相對應的Java代碼。
public class JdbcActorDao implements ActorDao {
private SimpleJdbcCall procReadAllActors;
public void setDataSource(DataSource dataSource) {
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
jdbcTemplate.setResultsMapCaseInsensitive(true);
this.procReadAllActors = new SimpleJdbcCall(jdbcTemplate)
.withProcedureName("read_all_actors")
.returningResultSet("actors",
BeanPropertyRowMapper.newInstance(Actor.class));
}
public List getActorsList() {
Map m = procReadAllActors.execute(new HashMap<String, Object>(0));
return (List) m.get("actors");
}
// ... additional methods
}
將JDBC操作轉化為Java對象
org.springframework.jdbc.object包下提供了一組類,讓我們用更加面向對象的方式來操作數據庫。我們可以將SQL查詢轉化為一組業(yè)務對象,也可以方便的進行查詢、更新和執(zhí)行存儲過程的操作。
MappingSqlQuery
MappingSqlQuery是一個抽象類,繼承自SQLQuery。我們在使用這個類的時候需要創(chuàng)建一個自定義類,繼承自MappingSqlQuery,然后在其構造方法中初始化一個查詢字符串,并在這里設置查詢參數;然后需要實現該類的mapRow方法,將結果集的行轉化為實體類對象。下面是一個例子。構造方法中定義的查詢字符串會被創(chuàng)建為PreparedStatement,因此可以在查詢字符串中使用占位符?。對于每個出現的占位符,我們都必須調用declareParameter方法聲明參數,該方法接受一個SqlParameter對象,該對象需要參數名和類型兩個參數。最后需要調用compile方法編譯和準備查詢。該類是線程安全的,因此可以安全的在多個線程之間共享對象。
public class UserMappingSqlQuery extends MappingSqlQuery<User> {
public UserMappingSqlQuery(DataSource ds) {
super(ds, "SELECT id,name FROM user WHERE id=:id");
super.declareParameter(new SqlParameter("id", Types.INTEGER));
compile();
}
@Override
protected User mapRow(ResultSet rs, int rowNum) throws SQLException {
return new User(rs.getInt(1), rs.getString(2));
}
}
然后我們創(chuàng)建一個對象,調用findObject方法并傳入查詢參數,即可獲得結果對象。
@Test
public void testMappingSqlQuery() {
MappingSqlQuery<User> mappingSqlQuery = new UserMappingSqlQuery(dataSource);
User user = mappingSqlQuery.findObject(1);
logger.debug(user);
}
如果查詢要返回一組記錄并傳遞多個查詢參數。需要調用相應的execute方法。一下是另一個MappingSqlQuery,以及其測試代碼。
public class UsersMappingSqlQuery extends MappingSqlQuery<User> {
public UsersMappingSqlQuery(DataSource ds) {
super(ds, "SELECT id,name FROM user WHERE id<? AND name LIKE ?");
super.declareParameter(new SqlParameter("id", Types.INTEGER));
super.declareParameter(new SqlParameter("name", Types.VARCHAR));
compile();
}
@Override
protected User mapRow(ResultSet rs, int rowNum) throws SQLException {
return new User(rs.getInt(1), rs.getString(2));
}
}
//獲取多個對象
mappingSqlQuery = new UsersMappingSqlQuery(dataSource);
List<User> users = mappingSqlQuery.execute(100, "test");
logger.debug(users);
使用SqlUpdate
這個類的使用方法和SqlQuery類似,但是由于它是一個具體類,因此不需要定義子類即可使用。下面是它的簡單使用方法。為了更新具體的數據(例如一個Java Bean對象),你也可以繼承該類,并提供自己的更新方法,就和上面一樣。
@Test
public void testSqlUpdate() {
SqlUpdate sqlUpdate = new SqlUpdate(dataSource, "INSERT INTO user(name) VALUES(?)");
sqlUpdate.declareParameter(new SqlParameter("name", Types.VARCHAR));
sqlUpdate.compile();
sqlUpdate.update("wang5");
List<User> users = jdbcTemplate.query("SELECT id,name FROM user", new UserRowMapper());
logger.debug(users);
}
使用StoredProcedure
StoredProcedure是關系數據庫中存儲過程概念的抽象類,提供了一組方便的受保護方法。因此在使用該類的時候需要我們創(chuàng)建一個子類,繼承該類。在使用這個類的時候我們需要使用setSql方法設置數據庫中存儲過程的名稱。在傳遞參數的時候,使用SqlParameter傳遞IN參數,使用SqlOutParameter傳遞OUT參數,使用SqlInOutParameter傳遞INOUT參數。
以下是Spring官方文檔的一個例子。
class GetSysdateProcedure extends StoredProcedure {
private static final String SQL = "sysdate";
public GetSysdateProcedure(DataSource dataSource) {
setDataSource(dataSource);
setFunction(true);
setSql(SQL);
declareParameter(new SqlOutParameter("date", Types.DATE));
compile();
}
public Date execute() {
// the 'sysdate' sproc has no input parameters, so an empty Map is supplied...
Map<String, Object> results = execute(new HashMap<String, Object>());
Date sysdate = (Date) results.get("date");
return sysdate;
}
}
其他知識
提供SQL參數信息
一般情況下Spring可以自行決定SQL參數的類型,但是有時候或者說最好由我們提供準確的SQL參數信息。
-
JdbcTemplate的很多查詢和更新方法包含一個額外的參數,一個int數組,該數組應該是java.sql.Types指定的一些常量,表明SQL參數的類型。 - 可以使用
SqlParameterValue來設置參數的值,在創(chuàng)建該對象的時候提供參數的值和類型。 - 如果使用具有命名參數功能的類時,使用
SqlParameterSource類(BeanPropertySqlParameterSource或MapSqlParameterSource)來指定命名參數和其類型。
數據源
我們在學習JDBC的時候,基本上都是從DriverManager類創(chuàng)建一個數據庫連接。在實際環(huán)境中,我們應該使用數據源(DataSource)來創(chuàng)建數據庫連接。數據源將創(chuàng)建數據庫的職責和應用代碼分離,數據源可以交給數據庫管理員來設置,程序員只需要獲取數據源對象,然后開發(fā)相關代碼。
在上面的例子中我們使用的是Apache的commons-dbcp2數據源,Spring自己也實現了幾個數據源方便我們開發(fā)和測試。
DriverManagerDataSource是一個簡單的數據源,每次請求都會返回一個新的數據庫連接。它使用數據庫驅動來創(chuàng)建數據源,就像我們使用DriverManager那樣。這是一個簡單的測試類,可以幫助我們在不借助任何Java EE容器的情況下獲取數據源。但是由于使用commons-dbcp2這樣的成熟數據源也很容易,所以其實我們只需要使用commons-dbcp2即可。
SingleConnectionDataSource也是一個數據源,它包裝了一個單獨的數據庫連接,在每次請求都會返回同一個數據庫連接對象。和DriverManagerDataSource相比它更輕量,因為沒有創(chuàng)建額外數據庫連接的開銷。
初始化數據源
在創(chuàng)建數據源的時候我們可以在Spring配置文件中設置數據源的初始化腳本。
<jdbc:initialize-database data-source="dataSource">
<jdbc:script location="classpath:com/foo/sql/db-schema.sql"/>
<jdbc:script location="classpath:com/foo/sql/db-test-data.sql"/>
</jdbc:initialize-database>
有時候我們希望在初始化數據的時候刪除上一次的測試數據。但是如果數據庫不支持類似DROP TABLE IF EXISTS這樣的語法,那么我們就必須在初始化腳本中添加一些DROP語句。這些刪除語句可能會失?。ㄈ绻麤]有測試數據的情況下執(zhí)行刪除),這時候就可以忽略刪除失敗。當初始化腳本出現錯誤的時候就會拋出異常,但是如果設置了忽略刪除失敗,Spring就會直接忽略這些失敗而不拋出異常。ignore-failures屬性還可以取另外兩個值NONE和ALL,分別表示不忽略失敗和忽略所有失敗。
<jdbc:initialize-database data-source="dataSource" ignore-failures="DROPS">
<jdbc:script location="..."/>
</jdbc:initialize-database>
我們還可以設置初始化腳本的間隔符。
<jdbc:initialize-database data-source="dataSource" separator="@@">
<jdbc:script location="classpath:com/foo/sql/db-schema.sql" separator=";"/>
<jdbc:script location="classpath:com/foo/sql/db-test-data-1.sql"/>
<jdbc:script location="classpath:com/foo/sql/db-test-data-2.sql"/>
</jdbc:initialize-database>
工具類
org.springframework.jdbc.datasource.DataSourceUtils,這是一個方便的工具類,包含了一組和數據源相關的工具方法。
org.springframework.jdbc.support.JdbcUtils類提供了一些方法來操作JDBC,在Spring內部使用,也可以用于自己的JDBC操作。
還有幾個工具類主要由Spring內部使用,這里就不列舉了。
嵌入式數據庫支持
我們在開發(fā)數據庫應用的時候需要安裝某種類型的數據庫,比如MySQL等等。但是這樣就需要額外的項目依賴。這樣一個產品級的數據庫軟件動輒上G,安裝、測試都不方便。這時候我們可以使用嵌入式數據庫進行開發(fā)和測試。嵌入式數據庫具有占用小、啟動快、配置簡單等特點,非常適合開發(fā)測試。而且由于嵌入式數據庫系統占用低,在一些設備上還可以直接作為存儲數據庫使用。例如輕量級嵌入式數據庫Sqlite,就安裝在每個安卓手機中,用于存儲數據。
在Spring中創(chuàng)建一個嵌入式數據庫,在XML中添加如下一段。這樣創(chuàng)建出來的數據庫可以直接作為javax.sql.DataSource類型的Spring Bean使用。最好設置generate-name="true"生成一個唯一名稱。默認情況下創(chuàng)建的是HSQL嵌入式數據庫。當然別忘了添加相應嵌入式數據庫的依賴項。
<jdbc:embedded-database id="dataSource" generate-name="true">
<jdbc:script location="classpath:schema.sql"/>
<jdbc:script location="classpath:test-data.sql"/>
</jdbc:embedded-database>
當然還可以以編程方式創(chuàng)建嵌入式數據庫。下面是上面等價的編程方式。
@Configuration
public class DataSourceConfig {
@Bean
public DataSource dataSource() {
return new EmbeddedDatabaseBuilder()
.generateUniqueName(true)
.setType(H2)
.setScriptEncoding("UTF-8")
.ignoreFailedDrops(true)
.addScript("schema.sql")
.addScripts("user_data.sql", "country_data.sql")
.build();
}
}
除了HSQL,Spring還支持H2和Derby兩種嵌入式數據庫(值得一提的是,現在的JDK分發(fā)包中附帶了一個Java DB數據庫,在安裝了JDK之后可以在JDK安裝目錄中看到db文件夾,這里面存放的其實就是Derby數據庫)。要指定數據庫類型,在上面的XML片段中添加embedded-database屬性并設置HSQL、H2或Derby。如果使用編程方式,在EmbeddedDatabaseBuilder上調用setType(EmbeddedDatabaseType)方法,該方法的參數指定一個枚舉,指定這三種類型。
上面的generate-name="true"或者generateUniqueName(true)挺重要的。如果不指定這個屬性。在多次調用嵌入式數據庫之后,可能會生成多個數據庫實例。為了避免這種情況發(fā)生,需要設置這個屬性。設置之后,如果已經存在了數據庫實例,就會使用這個已存在的實例,而不是設置新的實例。這個屬性是在Spring 4.2中增加的。使用以下幾個方法都可以設置該屬性。
EmbeddedDatabaseFactory.setGenerateUniqueDatabaseName()EmbeddedDatabaseBuilder.generateUniqueName()<jdbc:embedded-database generate-name="true" …? >
參考資料
http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#jdbc
項目代碼在Csdn代碼庫,有興趣的同學可以看看。
最后祝大家新年快樂!