Sqlla

一套數(shù)據(jù)庫的 ORM 微型庫，提供簡單高效的 API 來操作數(shù)據(jù)庫。

Sqlla 擁有極少的API，使用方式簡單。讓開發(fā)者不需要關(guān)心數(shù)據(jù)庫操作的具體細(xì)節(jié)，只需專注SQL和業(yè)務(wù)邏輯。同時簡單的事務(wù)模型讓開發(fā)過程增益很多。

簡單使用

• 創(chuàng)建實體類，用 @SqllaEntity 標(biāo)識

@SqllaEntity
public class UserBean {

    private String uid;
    private String phone;
    private String name;
    
    // 使用 SqllaColumnAlias 標(biāo)識后的屬性使用 alias 的值來對應(yīng)表中的列
    // 沒有標(biāo)識時直接使用屬性的名字來對應(yīng)
    @SqllaColumnAlias("gender")
    private int sex;
    
    // setter getter here
}

• DAO 接口類

public interface UserDao {

    // 用 @Sql 標(biāo)識
    @Sql("select * from t_user where uid = ?")
    UserBean getUserById(String uid);

    @Sql("select * from t_user desc by lastActiveTS limit ?")
    List<UserBean> topUsers(int limit);

    @Sql("select (count(*) > 0) from t_user where name = ?")
    boolean userExist(String name);

    @Sql("insert into t_user (id, uid, name, phone) values (null, ?, ?, ?)")
    boolean insertUser(String uid, String name, String phone);

    @Sql("delete from t_user where uid = ?")
    boolean deleteUserById(String uid);
}

• 創(chuàng)建 Sqlla 實例

Sqlla.ConnectionPool pool = your implimention;
Sqlla sqlla = new Sqlla.Builder().pool(pool).build();

• 數(shù)據(jù)庫操作 CRUD

UserDao dao = sqlla.createApi(UserDao.class);

// 獲取結(jié)果集中的第一個對象(結(jié)果集的第一行)
UserBean bean = dao.getUserById("uid_10000001");

// 查詢最新的10個用戶
List<UserBean> beanList = dao.topUsers(10);

// 查詢用戶是否存在：對于updateable sql, 返回值可以是int, boolean(>0 for true), void
boolean exists = dao.userExist("李多情");

// 插入用戶到數(shù)據(jù)庫(update count > 0 for true)
boolean inserted = dao.insertUser("uid_10000002", "李明洙", "1324113361*");

// 刪除指定用戶
boolean deleted = dao.deleteUserById("uid_10000003");

DAO接口不需要任何的實現(xiàn)類，是不是使用非常簡單？??

概念

• 實體： 庫中預(yù)置了兩種實體模型
  • @SqllaEntity 標(biāo)識的Pojo實體
  • ViewObject 結(jié)果集視圖實體，代表著結(jié)果集的一行，類似于扁平的 JSONObject
• 轉(zhuǎn)換器： 將結(jié)果集轉(zhuǎn)換成實體的部件，可以自定義
• DAO接口： CRUD 操作集合，每個方法代表一條SQL操作
• 事務(wù)： Transaction<T> 代表一個多條 DAO 方法的事務(wù)

深入使用

Sqlla.Builder 提供 pool() 和 addConverterFactory() 方法。

pool()方法必須設(shè)置一個ConnectionPool實例（test 代碼提供了一個基于c3p0數(shù)據(jù)源的 pool）。

addConverterFactory() 方法設(shè)置 自定義的結(jié)果集轉(zhuǎn)換工廠(實現(xiàn) ResultConverter.Factory 接口)。 內(nèi)部預(yù)置了三種工廠,

• PrimitiveTypeConverterFactory 轉(zhuǎn)換基礎(chǔ)數(shù)據(jù)類型
• SqllaEntityConverterFactory 轉(zhuǎn)換 @SqllaEntity 表示的實體類和其列表(List)
• ViewObjectConverterFactory 轉(zhuǎn)換 ViewObject 結(jié)果集視圖和其列表(List<ViewObject>)

外部可以自定義針對自己特定類型的轉(zhuǎn)換工廠 (ResultSet --> CustomType)，自定義的轉(zhuǎn)換工廠 return !null 時會攔截系統(tǒng)預(yù)置的轉(zhuǎn)換工廠。

事物支持

當(dāng)前版本對事物進行了簡單的支持，與Spring的配合暫時沒有做過測試。

例子

Boolean ret = sqlla.transact(new Transaction<Boolean>(Isolation.SERIALIZABLE) {
    public Boolean transact() throw Exception {
        UserDao dao = sqlla.createApi(UserDao.class);
        dao.deleteUserById("uid_10000004");
        // 也可以手動rollback() or commit(true)
        dao.deleteUserById("uid_10000005");
        return true;
    }
}, false);  // failed value

上面的代碼執(zhí)行了一個簡單的事務(wù)，事務(wù)中包含兩條刪除語句。如果都成功，則自動 commit；只要有一個失敗，則會rollback。當(dāng)回滾之后，事務(wù)將返回給定的 failed value。在事務(wù)中，也可以手動 rollback() 或者 commit(val)，這兩個操作只能調(diào)用一次，而且會中斷其后面的代碼執(zhí)行，要謹(jǐn)慎使用。

開啟一個事務(wù)有兩種方法:

<T> T sqlla.transact(Transaction<T> transaction);

void sqlla.transact(Transaction0 transaction);

注意： transact方法是一個同步方法，它會立馬調(diào)用transaction, 并返回。

Transaction<T> 是一個抽象類，抽象方法transact用于實現(xiàn)事務(wù)的具體邏輯。最多有三個參數(shù)：isolation，readOnly 和 timeout，分別代表 隔離級別，是否只讀，超時秒數(shù)。Transaction0 是其范型為 Void 的子類。

嵌套事務(wù)

Sqlla 對事務(wù)的嵌套提供了簡單的支持。相比于Spring事務(wù)間的多種傳播機制，Sqlla只提供了 REQUIRES_NEW 的傳播機制：內(nèi)層和外層完全隔離開來，互不影響。

methodA 和 methodB 是兩個事務(wù)方法，他們之間完全隔離，提交和回滾互不影響。

public void methodA() {
    sqlla.transact(new Transaction0() {
        protected void transact0() throws Exception {
            UserDao dao = sqlla.createApi(UserDao.class);
            
            boolean inserted = dao.insertUser("uid_1000007", "王五", "13241133615");
            methodB();  // 事務(wù)B方法
            boolean deleted = dao.deleteUserByName("張三");
        }
    });
}

public void methodB() {
    sqlla.transact(new Transaction0() {
        protected void transact0() throws Exception {
            UserDao dao = sqlla.createApi(UserDao.class);
            boolean inserted = dao.insertUser("uid_1000008", "趙六", "13241133616");
        }
    }
}

如何驗證兩個事務(wù)之間互不影響？

我們先把 mehtodA 中的 deleteUserByName 方法的sql改成一個錯的sql

@Sql("delete from t_user where name = ????????")
boolean deleteUserByName(String name);

現(xiàn)在再調(diào)用 methodA，你會發(fā)現(xiàn) “王五” 這個用戶并未插入到數(shù)據(jù)庫中, “張三” 也沒有被刪除，而 “趙六” 卻實實在在的插入到了數(shù)據(jù)庫中。

注意：假如 methodB 本身并不是一個單獨的事務(wù)方法 (未用 sqlla.transact 開啟)，那么他將使用外層的事務(wù)。所以要不要使用事務(wù)，一定要考慮好，不然可能會有一些意想不到的效果。

Sqlla雖然提供了注解的方式來操作SQL，但是事務(wù)并沒有使用注解的方式， 這和MyBatis一致。實際內(nèi)部實現(xiàn)也和 MyBatis 相差無幾。

GitHub鏈接