我很高興宣布Spring Data JDBC存儲庫項目的第一個版本。 這個開放源代碼庫的目的是為基于Spring框架中 JdbcTemplate關系數據庫提供通用，輕量且易于使用的DAO實現，與項目的Spring Data 框架兼容。

設計目標

• 輕巧，快速且開銷低。 只有少數幾個類， 沒有XML，注釋，反射
• 這不是成熟的ORM 。 沒有關系處理，延遲加載，臟檢查，緩存
• 在幾秒鐘內實現CRUD
• 對于JPA過大的小型應用程序
• 在需要簡單性或考慮將來遷移到JPA時使用
• 對數據庫方言差異的最小化支持（例如，透明的結果分頁）

特征

每個DAO為以下內容提供內置支持：

• 通過RowMapper抽象到域對象/從域對象映射
• 生成的和用戶定義的主鍵
• 提取生成的密鑰
• 復合（多列）主鍵
• 不變的領域對象
• 分頁（請求結果子集）
• 按幾列排序（與數據庫無關）
• 對多對一關系的可選支持
• 支持的數據庫（連續測試）：
  • 的MySQL
• 通過SqlGenerator類可以輕松擴展到其他數據庫方言。
• 通過ID輕松檢索記錄

API

與Spring Data PagingAndSortingRepository抽象兼容， 所有這些方法都為您實現 ：

public interface PagingAndSortingRepository<T, ID extends Serializable> extends CrudRepository<T, ID> {T save(T entity);Iterable<T> save(Iterable<? extends T> entities);T findOne(ID id);boolean exists(ID id);Iterable<T> findAll();long count();void delete(ID id);void delete(T entity);void delete(Iterable<? extends T> entities);void deleteAll();Iterable<T> findAll(Sort sort);Page<T> findAll(Pageable pageable); }

還完全支持Pageable和Sort參數，這意味著您可以通過任意屬性免費獲得分頁和排序 。 例如，假設您有userRepository擴展了PagingAndSortingRepository<User, String>接口（由庫為您實現），并且在應用某種排序后，您請求了USERS表的第5頁，每頁10個：

Page<User> page = userRepository.findAll(new PageRequest(5, 10,new Sort(new Order(DESC, "reputation"),new Order(ASC, "user_name"))) );

Spring Data JDBC存儲庫庫會將此調用轉換為（PostgreSQL語法）：

SELECT * FROM USERS ORDER BY reputation DESC, user_name ASC LIMIT 50 OFFSET 10

…甚至（Derby語法）：

SELECT * FROM (SELECT ROW_NUMBER() OVER () AS ROW_NUM, t.*FROM (SELECT *FROM USERSORDER BY reputation DESC, user_name ASC) AS t) AS a WHERE ROW_NUM BETWEEN 51 AND 60

無論使用哪個數據庫，都將獲得Page<User>對象作為回報（您仍然必須自己提供RowMapper<User>才能將其從ResultSet轉換為域對象。如果您還不了解Spring Data項目，則Page<T>是一個很棒的抽象，不僅封裝了List<User> ，而且還提供了元數據，例如記錄總數，我們當前所在的頁面等。

使用理由

• 由于將來您的代碼將僅依賴于Spring Data Commons傘項目中的PagingAndSortingRepository和CrudRepository定義的方法， PagingAndSortingRepository您可以自由地從JdbcRepository實現（從該項目）切換到： JpaRepository ， MongoRepository ， GemfireRepository或GraphRepository 。 它們都實現相同的通用API。 當然，不要指望從JDBC切換到JPA或MongoDB就像切換導入的JAR依賴項一樣簡單-但是至少您可以通過使用相同的DAO API最小化影響。
• 您需要一個快速，簡單的JDBC包裝器庫。 JPA甚至MyBatis都不過分
• 如果需要，您想完全控制生成的SQL
• 您想使用對象，但是不需要延遲加載，關系處理，多級緩存，臟檢查……您需要CRUD等等
• 您想干嗎
• 您已經在使用Spring甚至JdbcTemplate ，但仍然覺得手工工作過多
• 您的數據庫表很少

入門

有關更多示例和工作代碼，請不要忘記檢查項目測試 。

先決條件

Maven坐標：

<dependency><groupId>com.blogspot.nurkiewicz</groupId><artifactId>jdbcrepository</artifactId><version>0.1</version> </dependency>

不幸的是，該項目尚未在Maven中央存儲庫中 。 目前，您可以通過克隆將庫安裝在本地存儲庫中：

$ git clone git://github.com/nurkiewicz/spring-data-jdbc-repository.git $ git checkout 0.1 $ mvn javadoc:jar source:jar install

為了啟動您的項目，必須存在DataSource bean并啟用事務管理。 這是最小的MySQL配置：

@EnableTransactionManagement @Configuration public class MinimalConfig {@Beanpublic PlatformTransactionManager transactionManager() {return new DataSourceTransactionManager(dataSource());}@Beanpublic DataSource dataSource() {MysqlConnectionPoolDataSource ds = new MysqlConnectionPoolDataSource();ds.setUser("user");ds.setPassword("secret");ds.setDatabaseName("db_name");return ds;}}

具有自動生成的密鑰的實體

假設您有一個具有自動生成的密鑰（MySQL語法）的數據庫表：

CREATE TABLE COMMENTS (id INT AUTO_INCREMENT,user_name varchar(256),contents varchar(1000),created_time TIMESTAMP NOT NULL,PRIMARY KEY (id) );

首先，您需要創建到該表的域對象User映射（就像在任何其他ORM中一樣）：

public class Comment implements Persistable<Integer> {private Integer id;private String userName;private String contents;private Date createdTime;@Overridepublic Integer getId() {return id;}@Overridepublic boolean isNew() {return id == null;}//getters/setters/constructors/... }

除了標準的Java樣板之外，您還應該注意實現Persistable<Integer> ，其中Integer是主鍵的類型。 Persistable<T>是一個來自Spring Data項目的接口，這是我們對您的域對象的唯一要求。

最后，我們準備創建CommentRepository DAO：

@Repository public class CommentRepository extends JdbcRepository<Comment, Integer> {public CommentRepository() {super(ROW_MAPPER, ROW_UNMAPPER, "COMMENTS");}public static final RowMapper<Comment> ROW_MAPPER = //see belowprivate static final RowUnmapper<Comment> ROW_UNMAPPER = //see below@Overrideprotected Comment postCreate(Comment entity, Number generatedId) {entity.setId(generatedId.intValue());return entity;} }

首先，我們使用@Repository批注標記DAO bean。 它啟用持久性異常轉換。 通過CLASSPATH掃描也可以發現此類帶注釋的bean。

如您所見，我們擴展了JdbcRepository<Comment, Integer> ，它是該庫的中心類，提供了所有PagingAndSortingRepository方法的實現。 它的構造函數具有三個必需的依賴項： RowMapper ， RowUnmapper和表名。 您也可以提供ID列名，否則使用默認的"id" 。

如果您曾經使用過Spring的JdbcTemplate ，則應該熟悉RowMapper界面。 我們需要以某種方式將ResultSet列提取到一個對象中。 畢竟，我們不想使用原始的JDBC結果。 這很簡單：

public static final RowMapper<Comment> ROW_MAPPER = new RowMapper<Comment>() {@Overridepublic Comment mapRow(ResultSet rs, int rowNum) throws SQLException {return new Comment(rs.getInt("id"),rs.getString("user_name"),rs.getString("contents"),rs.getTimestamp("created_time"));} };

RowUnmapper來自此庫，它本質上與RowMapper相反：接收一個對象并將其轉換為Map 。 庫稍后使用此映射來構造SQL CREATE / UPDATE查詢：

private static final RowUnmapper<Comment> ROW_UNMAPPER = new RowUnmapper<Comment>() {@Overridepublic Map<String, Object> mapColumns(Comment comment) {Map<String, Object> mapping = new LinkedHashMap<String, Object>();mapping.put("id", comment.getId());mapping.put("user_name", comment.getUserName());mapping.put("contents", comment.getContents());mapping.put("created_time", new java.sql.Timestamp(comment.getCreatedTime().getTime()));return mapping;} };

如果您從不更新數據庫表（僅讀取插入在其他位置的一些參考數據），則可以跳過RowUnmapper參數或使用MissingRowUnmapper 。

最后一個難題是postCreate()回調方法，該方法在插入對象后調用。 您可以使用它來檢索生成的主鍵并更新域對象（如果域對象是不可變的，則返回新的主鍵）。 如果不需要它，就不要重寫postCreate() 。 根據此示例，檢查JdbcRepositoryGeneratedKeyTest以獲取有效的代碼。

到目前為止，您可能會覺得與JPA或Hibernate相比，有很多手工工作。 但是，眾所周知，各種JPA實現和其他ORM框架都會引入大量開銷并顯示一些學習曲線。 這個微小的庫有意讓用戶承擔一些責任，以避免復雜的映射，反射，注釋……并非總是需要的所有隱式性。 該項目無意替代成熟穩定的ORM框架。 相反，它試圖填補原始JDBC和ORM之間的利基，其中簡單性和低開銷是關鍵特征。

具有手動分配的密鑰的實體

在此示例中，我們將看到如何處理具有用戶定義的主鍵的實體。 讓我們從數據庫模型開始：

CREATE TABLE USERS (user_name varchar(255),date_of_birth TIMESTAMP NOT NULL,enabled BIT(1) NOT NULL,PRIMARY KEY (user_name) );

…和User域模型：

public class User implements Persistable<String> {private transient boolean persisted;private String userName;private Date dateOfBirth;private boolean enabled;@Overridepublic String getId() {return userName;}@Overridepublic boolean isNew() {return !persisted;}public User withPersisted(boolean persisted) {this.persisted = persisted;return this;}//getters/setters/constructors/...}

注意，添加了特殊的persisted瞬態標志。 來自Spring Data項目的CrudRepository.save()合同要求一個實體知道它是否已經保存（ isNew() ）方法–沒有單獨的create()和update()方法。 對于自動生成的鍵（參見上面的Comment ），實現isNew()很簡單，但是在這種情況下，我們需要一個額外的瞬態字段。 如果您討厭這種解決方法，并且只插入數據而從不更新，則始終可以從isNew()返回true 。

最后是我們的DAO， UserRepository bean：

@Repository public class UserRepository extends JdbcRepository<User, String> {public UserRepository() {super(ROW_MAPPER, ROW_UNMAPPER, "USERS", "user_name");}public static final RowMapper<User> ROW_MAPPER = //...public static final RowUnmapper<User> ROW_UNMAPPER = //...@Overrideprotected User postUpdate(User entity) {return entity.withPersisted(true);}@Overrideprotected User postCreate(User entity, Number generatedId) {return entity.withPersisted(true);} }

"USERS"和"user_name"參數指定表名稱和主鍵列名稱。 我將保留mapper和unmapper的詳細信息（請參閱源代碼 ）。 但是請注意postUpdate()和postCreate()方法。 它們確保一旦對象被持久保存，就設置了persisted標志，以便隨后對save()調用將更新現有實體，而不是嘗試重新插入它。

根據此示例，檢查JdbcRepositoryManualKeyTest以獲得有效的代碼。

復合主鍵

我們還支持復合主鍵（由幾列組成的主鍵）。 以該表為例：

CREATE TABLE BOARDING_PASS (flight_no VARCHAR(8) NOT NULL,seq_no INT NOT NULL,passenger VARCHAR(1000),seat CHAR(3),PRIMARY KEY (flight_no, seq_no) );

我希望您注意到Peristable<T>的主鍵類型：

public class BoardingPass implements Persistable<Object[]> {private transient boolean persisted;private String flightNo;private int seqNo;private String passenger;private String seat;@Overridepublic Object[] getId() {return pk(flightNo, seqNo);}@Overridepublic boolean isNew() {return !persisted;}//getters/setters/constructors/...}

不幸的是，我們不支持將所有ID值封裝在一個對象中的小數值類（就像JPA使用@IdClass ），因此您必須使用Object[]數組。 定義DAO類類似于我們已經看到的內容：

public class BoardingPassRepository extends JdbcRepository<BoardingPass, Object[]> {public BoardingPassRepository() {this("BOARDING_PASS");}public BoardingPassRepository(String tableName) {super(MAPPER, UNMAPPER, new TableDescription(tableName, null, "flight_no", "seq_no"));}public static final RowMapper<BoardingPass> ROW_MAPPER = //...public static final RowUnmapper<BoardingPass> UNMAPPER = //...}

需要注意的兩件事：我們擴展了JdbcRepository<BoardingPass, Object[]>并且按預期提供了兩個ID列名稱： "flight_no", "seq_no" 。 我們通過提供由Object[]包裹的flight_no和seq_no （必須seq_no順序）值來查詢此類DAO：

BoardingPass pass = repository.findOne(new Object[] {"FOO-1022", 42});

毫無疑問，這在實踐中很麻煩，因此我們提供了微小的輔助方法，您可以靜態導入：

import static com.blogspot.nurkiewicz.jdbcrepository.JdbcRepository.pk; //...BoardingPass foundFlight = repository.findOne(pk("FOO-1022", 42));

根據此示例，檢查JdbcRepositoryCompoundPkTest以獲取工作代碼。

交易次數

該庫與事務管理完全正交。 每個存儲庫的每種方法都需要運行事務，具體取決于您進行設置。 通常，您將@Transactional放在服務層上（稱為DAO bean）。 我不建議將@Transactional放在每個DAO bean上 。

快取

Spring Data JDBC存儲庫庫不提供任何緩存抽象或支持。 但是， 在Spring中使用緩存抽象將@Cacheable層添加@Cacheable DAO或服務之上非常簡單。 另請參見： Spring中的@Cacheable開銷 。

會費

..總是歡迎。 不要猶豫， 提交錯誤報告并提出請求 。 現在最大的缺失功能是對MSSQL和Oracle數據庫的支持。 如果有人可以看一下，那就太好了。

測試中

該庫已使用Travis（ ）。 測試套件包括265個測試 （53個不同的測試，每個測試針對5個不同的數據庫運行：MySQL，PostgreSQL，H2，HSQLDB和Derby。

在填寫錯誤報告或提交新功能時，請嘗試包括支持測試用例。 每個拉取請求都會在單獨的分支上自動進行測試。

建造

分叉后， 正式的存儲庫構建就像運行一樣簡單：

$ mvn install

您將在JUnit測試執行過程中注意到大量異常。 這個是正常的。 一些測試是針對僅在Travis CI服務器上可用的MySQL和PostgreSQL運行的。 當這些數據庫服務器不可用時，只需跳過整個測試：
結果：

Tests run: 265, Failures: 0, Errors: 0, Skipped: 106

異常堆棧跟蹤來自根AbstractIntegrationTest 。

設計

庫僅包含少數幾個類，如下圖所示：

JdbcRepository是實現所有PagingAndSortingRepository方法的最重要的類。 每個用戶存儲庫都必須擴展此類。 同樣，每個這樣的存儲庫必須至少實現RowMapper和RowUnmapper （僅當您要修改表數據時）。

SQL生成委托給SqlGenerator 。 PostgreSqlGenerator. 和DerbySqlGenerator用于與標準生成器不DerbySqlGenerator的數據庫。

執照

該項目是在Apache許可的 2.0版下發布的 （與Spring框架相同）。

參考： NoBlogDefFound博客中JCG合作伙伴 Tomasz Nurkiewicz 為程序員提供的概率分布 。

翻譯自: https://www.javacodegeeks.com/2013/01/spring-data-jdbc-generic-dao-implementation-most-lightweight-orm-ever.html

總結

以上是生活随笔為你收集整理的Spring Data JDBC通用DAO实现–迄今为止最轻量的ORM的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。