簡介： 隻需瞅一眼Google Trends上全球Java界最熱門的兩款SQL映射架構近一年的對比數字，就不難了解其實力分布：在此領域，MyBatis早已占領東亞地區開發者市場，并以絕對優勢穩居中國最搶手Java資料庫通路架構之首。
作者 | 金戟
來源 | 阿裡技術公衆号
隻需瞅一眼Google Trends上全球Java界最熱門的兩款SQL映射架構近一年的對比數字，就不難了解其實力分布：在此領域，MyBatis早已占領東亞地區開發者市場，并以絕對優勢穩居中國最搶手Java資料庫通路架構之首。
MyBatis霸榜的底氣來源于其廣袤的生态以及國内衆多大廠的支援。而在琳琅滿目的MyBatis擴充中，還埋藏着許多“寶藏項目”，來自阿裡技術團隊的Fluent MyBatis便是其中一顆獨特的新星。
一 普拉斯們不香了
從iBatis到MyBatis，再到國内團隊以MyBatis Plus為典型代表的諸多周邊工具，"Batis"系列套餐的發展曆程，幾乎又是一部XML的興衰史。最初的iBatis誕生于2002年，彼時XML在Java乃至整個軟體技術界都還相當盛行，和同時期的許多項目一樣，iBatis硬生生的将一堆堆XML塞進千家萬戶的項目裡。
許多年後，曾今與iBatis并肩過的社群戰友們紛紛淡出了曆史舞台，少數像Spring這樣延續至今的佼佼者，也逐漸摒棄XML，向代碼化配置的方式發展。在這方面，iBatis一直是個保守派，即使在MyBatis接過iBatis的衣缽之後，也隻是”重磅“推出了支援代碼執行SQL的@Select/@Insert/@Update/@Delete注解（以及相應的4種Provider注解），用來抵擋開發者們對XML泛濫的吐槽，這是在2010年中旬，然後就再無動作。直到2016年底，MyBatis的主要貢獻者之一Jeff Butler正式建立MyBatis Dynamic SQL項目，MyBatis終于開始全面擁抱無XML的代碼化SQL建構。
在從MyBatis到MyBatis Dynamic SQL之間長達6年多的空窗期裡，開源社群催生出了許多民間基于MyBatis的無XML代碼方案，其中流行得比較廣泛的是Tk Mybatis、MyBatis Plus這類内置Mapper和自動生成CRUD的擴充庫，一經推出就收獲諸多好評。包括MyBatis Plus裡實際上并不太完備的"條件構造器"功能，也由于當時同類解決方案的匮乏而頗受追捧。與此同時，在MyBatis社群之外，一直在默默發展的JOOQ是一款曆史與MyBatis幾乎同樣悠久的純Java動态SQL執行庫，它的使用者群體不大，卻口碑甚好。如今在任意搜尋引擎上輸入"MyBatis vs JOOQ"，依然能得到幾乎是一邊倒選擇JOOQ的結果，大家給出的理由也非常一緻：簡潔、靈活、無需XML，很"Java"。而在MyBatis陣營裡，若是拿出MyBatis Plus的"條件構造器"與之正面對陣，隻消三個回合，就會被屁滾尿流的打出擂台。隻可惜JOOQ的家底沒有MyBatis那樣殷實，早早走上了商業資料庫支援賣License收費的道路，才讓MyBatis免于在輿論上迎來自己的中年危機。
Fluent MyBatis誕生于2019年底，即使與MyBatis Dynamic SQL相比都是晚輩，然而尚處成長期的它就已透出了青出于藍而勝于藍的味道。
在實作方式上，MyBatis Plus覆寫并替換了部分MyBatis内部類型的方法，整體機制較重，卻也是以能将一些功能細節隐藏到使用者無需關注的内部邏輯裡；與之相反，MyBatis Dynamic SQL的實作機制非常輕量，不僅完全基于MyBatis原生的Provider系列注解開發，而且沒有什麼隐藏邏輯，對使用者的每張表自動生成相應的Entity、DynamicSqlSupport和Mapper三個類，全部放入使用者的源碼目錄裡，是以暴露的細節比較多，代碼侵入性略高。Fluent MyBatis取二者之所長，整體機制與MyBatis Dynamic SQL更接近，同樣基于原生的Provider注解，對使用者的每個表生成Entity類和預設空白的Dao類，不同之處在于它還會通過JVM編譯期代碼增強功能自動生成許多開發者不可更改的标準輔助類，這些代碼無需放入使用者的源碼目錄但能夠在編碼時直接使用，即提供豐富的功能，又保證了使用者代碼的整潔。
在使用方式上，Fluent MyBatis同樣借鑒了前輩們的最優實踐，沒有花裡胡哨的注解和配置，直接複用MyBatis連接配接，所有功能開箱即用。同時由于Fluent MyBatis将所有表字段、條件、操作都以方法調用形式提供，是以獲得了比其他同類項目都更好的IDE文法輔助。舉一個不太複雜的例子：
// 使用Fluent MyBatis構造查詢語句
mapper.listMaps(new StudentScoreQuery()
.select
.schoolTerm()
.subject()
.count.score("count")
.min.score("min_score")
.max.score("max_score")
.avg.score("avg_score")
.end()
.where.schoolTerm().ge(2000)
.and.subject.in(new String[]{"英語", "數學", "國文"})
.and.score().ge(60)
.and.isDeleted().isFalse()
.end()
.groupBy.schoolTerm().subject().end()
.having.count.score.gt(1).end()
.orderBy.schoolTerm().asc().subject().asc().end()
);
MyBatis Dynamic SQL的文法也比較美觀，但字段名和min/max/avg等方法都需要靜态引用，比Fluent MyBatis稍顯遜色。
// 使用MyBatis Dynamic SQL構造查詢語句
mapper.selectMany(
select(
schoolTerm,
subject,
count(score).as("count"),
min(score).as("min_score"),
max(score).as("max_score"),
avg(score).as("avg_score")
).from(studentScore)
.where(schoolTerm, isGreaterThanOrEqualTo(2000))
.and(subject, isIn("英語", "數學", "國文"))
.and(score, isGreaterThanOrEqualTo(60))
.and(isDeleted, isEqualTo(false))
.groupBy(schoolTerm, subject)
.having(count(score), isGreaterThan(1)) //目前其實還不支援having方法
.orderBy(schoolTerm, subject)
.build(isDeleted, isEqualTo(false))
.render(RenderingStrategies.MYBATIS3)
);
JOOQ的曆史比較悠久，寫出來的代碼鋪天蓋地都是常量字段，功能強大但美觀度欠佳。
// 使用JOOQ構造查詢語句
dslContext.select(
STUDENT_SCORE.GENDER_MAN,
STUDENT_SCORE.SCHOOL_TERM,
STUDENT_SCORE.SUBJECT,
count(STUDENT_SCORE.SCORE).as("count"),
min(STUDENT_SCORE.SCORE).as("min_score"),
max(STUDENT_SCORE.SCORE).as("max_score"),
avg(STUDENT_SCORE.SCORE).as("avg_score")
)
.from(STUDENT_SCORE)
.where(
STUDENT_SCORE.SCHOOL_TERM.ge(2000),
STUDENT_SCORE.SUBJECT.in("英語", "數學", "國文"),
STUDENT_SCORE.SCORE.ge(60),
STUDENT_SCORE.IS_DELETED.eq(false)
)
.groupBy(
STUDENT_SCORE.GENDER_MAN,
STUDENT_SCORE.SCHOOL_TERM,
STUDENT_SCORE.SUBJECT
)
.having(count().ge(1))
.orderBy(
STUDENT_SCORE.SCHOOL_TERM.asc(),
STUDENT_SCORE.SUBJECT.asc()
)
.fetch();
MyBatis Plus的條件構造器僅僅封裝了基本的SQL操作，對于字段、條件、别名等都要使用字元串拼接，極易出現由于拼寫失誤引起的SQL異常。
// 使用MyBatis Plus構造查詢語句
mapper.selectMaps(new QueryWrapper<StudentScore>()
.select(
"school_term",
"subject",
"count(score) as count",
"min(score) as min_score",
"max(score) as max_score",
"avg(score) as avg_score"
)
.ge("school_term", 2000)
.in("subject", "英語", "數學", "國文")
.ge("score", 60)
.eq("is_deleted", false)
.groupBy("school_term", "subject")
.having("count(score)>1")
.orderByAsc("school_term", "subject")
);
在Java動态SQL建構的功能完整度方面，目前的排序是MyBatis Plus < MyBatis Dynamic SQL < Fluent MyBatis < JOOQ。
MyBatis Plus條件構造器在功能性上完敗，不僅無法表達JOIN、UNION語句，嵌套查詢之類稍複雜SQL也完全沒招。MyBatis Dynamic SQL支援JOIN和UNION語句，尚未支援嵌套查詢，且缺少HAVING等少量标準SQL文法。Fluent MyBatis支援多表JOIN、UNION、嵌套查詢和幾乎所有标準SQL文法，對于絕大多數場景都妥妥夠用。JOOQ是真正的王者，不僅支援标準SQL文法，連各廠商特有的專有關鍵字和内置方法都沒放過，如MySQL的ON DUPLICATE KEY UPDATE、PostgreSQL的WINDOW、Oracle的CONNECT BY等等。補齊各種SQL文法是一件瑣碎而費力的工作，考慮到SQL文法的總量已經基本不再變化，相信假以時日，各方的差距會逐漸縮小。
除了SQL基本功，特别值得一提的是Fluent MyBatis的獨門絕技：支援動态換表名（FreeQuery/FreeUpdate特性）。在雲效項目的開發過程中，由于需要在各種嵌套查詢之上再根據視圖條件動态選擇聚合計算的次元表，多虧了Fluent MyBatis的動态表名功能，才得以在最大程度保留文法構造便利性的情況下，讓代碼複用成為可能。
相比密密麻麻的XML檔案，Java代碼在易讀性和可維護性方面有着明顯的優勢。在官方和社群的共同推動下，一個全新的、代碼化的MyBatis生态正在冉冉升起。蓦然回首，曾經驕傲的"Plus擴充"們全都不香了。
二 優雅的資料流
初識Fluent MyBatis，最明顯能感受到的特點是它及其便利的IDE文法提示。
基于資料表自動生成的Entity、Mapper、Query、Update等對象，讓所有的資料庫字段和SQL操作都變成了方法，串成平整的流式語句。即使是層層嵌套的查詢，也能表現得錯落有緻：
new StudentQuery()
.where.isDeleted().isFalse()
.and.grade().eq(4)
.and.homeCountyId().in(CountyDivisionQuery.class, q -> q
.selectId()
.where.isDeleted().isFalse()
.and.province().eq("浙江省")
.and.city().eq("杭州市")
.end()
).end();
很容易就能看出，上述語句對應的SQL為：
SELECT * FROM student
WHERE is_deleted = false
AND grade = 4
AND home_county_id IN (
SELECT id FROM county_division
WHERE is_deleted = false
AND province = '浙江省'
AND city = '杭州市'
)
不僅如此，Fluent MyBatis實作的JOIN文法經過幾次調整後，現在的版本也已經十分美觀：
JoinBuilder.from(
new StudentQuery("t1", parameter)
.selectAll()
.where.age().eq(34)
.end()
).join(
new HomeAddressQuery("t2", parameter)
.where.address().like("address")
.end()
).on(
l -> l.where.homeAddressId(),
r -> r.where.id()
).endJoin().build();
其中利用Lambada語句表達JOIN條件的設計即充分符合了Java開發者的習慣，又很好的比對了IDE文法提示的需要，細思極妙。
Fluent MyBatis中的流可以設定條件過濾，例如“僅更新值為非空的字段”：
new StudentUpdate()
.update.name().is(student.getName(), If::notBlank)
.set.phone().is(student.getPhone(), If::notBlank)
.set.email().is(student.getEmail(), If::notBlank)
.set.gender().is(student.getGender(), If::notNull)
.end()
.where.id().eq(student.getId()).end();
上面這段代碼等效于MyBatis中的如下XML内容：
顯然Java的流式代碼可讀性遠高于XML檔案的尖括号套尖括号的層疊結構。
流是可續接的，對于更複雜的分支條件，Fluent MyBatis中能利用譬如下述語句，充分發揮出Java代碼的靈活性：
StudentQuery studentQuery = Refs.Query.student.aliasQuery()
.select.age().end()
.where.age().isNull().end()
.groupBy.age().apply("id").end();
if (config.shouldFilterAge()) {
studentQuery.having.max.age().gt(1L).end();
} else if (config.shouldOrder()) {
studentQuery.orderBy.id().desc().end();
}
這種基于外部變量狀态的判斷，已然超出了MyBatis的XML檔案的能力範圍。
三 三分鐘源碼淺析
Fluent MyBatis的代碼由Fluent Generator和Fluent MyBatis兩個子項目組成。這對組合與MyBatis Generator搭檔MyBatis Dynamic SQL有異曲同工之妙：Fluent Generator通過讀取資料庫裡的表，自動生成Fluent MyBatis所需的Entity和Dao對象；Fluent MyBatis提供編寫SQL語句的函數式DSL。
Fluent Generator子項目的代碼顯得樸實而平鋪直述，程式入口在包結構樹最外層的FileGenerator類型裡，由開發者直接調用該類的build()方法，使用鍊式構造器方式傳入需讀取的表名和存放生成檔案的目錄等配置。Fluent Generator根據這些資訊從資料庫裡讀取出表結構，然後為每張表生成Entity和Dao類型的Java檔案，放置到約定位置，整個邏輯一氣呵成。值得一提的是，Fluent Generator的配置方法是完全代碼化的，相比MyBatis Generator雖支援純代碼化配置，卻在官方示例繼續沿用XML檔案配置輸入的作風更勝一籌。
Fluent Generator生成的Dao類型預設是空的類，它隻是一種推薦的資料查詢層結構，通過繼承各自的BaseDao類型，獲得便捷操作Mapper的能力。
Fluent MyBatis子項目的代碼要稍顯豐盈一些，分為三個子產品：
- fluent-mybatis 包含各種公共基礎類
- fluent-mybatis-test 測試用例
- fluent-mybatis-processor 編譯期代碼生成器
fluent-mybatis子產品定義了與代碼生成相關的注解、資料模型和其他輔助類型，它們大多都是幕後英雄：開發者通常不會直接用到這個包中的類。
fluent-mybatis-test子產品包含豐富的測試用例，在一定程度上彌補了Fluent MyBatis目前階段尚不完備的文檔。平時遇到的許多Fluent MyBatis使用問題，若在文檔上無法找到，那麼翻一翻代碼庫的測試用例，一定會有意外的收獲。
fluent-mybatis-processor子產品的原理與Lombook工具庫類似，但它并不修改原有的類型，而是掃描Entity類型上的注解，然後動态産生新的輔助類。Fluent Generator産出的Entity類就像是潘多拉盒子，蘊含着Fluent MyBatis魔法的秘密。FluentMybatisProcessor類是整場表演的魔術師，它将每個形如XyzEntity的實體類變幻出一系列輔助類，其中比較關鍵的包括：
- XyzBaseDao：繼承BaseDao類型，實作IBaseDao接口，包含獲得Entity相關Mapper、Query、Update類型的方法，是Fluent Generator為使用者生成的空白Dao類的父類。
- XyzMapper：實作IEntityMapper，IRichMapper、IWrapperMapper接口，用于構造Query和Update對象，以及執行IQuery或IUpdate類型的SQL指令。
- XyzQuery：繼承BaseWrapper、BaseQuery類型，實作IWrapper、IQuery接口，用于組裝查詢語句的基本容器。
- XyzUpdate：繼承BaseWrapper、BaseUpdate類型，實作IWrapper、IBaseUpdate接口，用于組裝更新語句的基本容器。
- XyzSqlProvider：繼承BaseSqlProvider類型，用于最終組裝SQL語句。
- 還有XyzMapping、XyzDefaults、XyzFormSetter、XyzEntityHelper：、XyzWrapperHelper等。由fluent-mybatis-processor子產品生成的許多類型都會在編寫業務代碼的時候用到。
一個典型的Fluent MyBatis工作流程是先通過生成的Query或Update類型組裝出執行對象，然後交給Mapper對象下發執行。譬如：
// 構造并執行查詢語句
List<StudentEntity> users = mapper.listEntity(
new StudentQuery() .select.name().score().end()
.where.userName().like("user").end()
.orderBy.id().asc().end()
.limit(20, 10)
);
// 構造并執行更新語句
int effectedRecordCount = mapper.updateBy(
new StudentUpdate()
.set.userName().is("u2")
.set.isDeleted().is(true)
.set.homeAddressId().isNull().end()
.where.isDeleted().eq(false).end()
);
Query和Update類型不僅實作IQuery/IUpdate接口，還實作了IWrapper接口，前者用于組裝對象，後者用于讀取對象内容，這是一處很有心的設計。Mapper類型中的許多方法都能接收IQuery或IUpdate接口類型的對象，再通過方法上的@InsertProvider、@SelectProvider、@UpdateProvider或@DeleteProvider注解把實際請求轉給生成的Provider類型。Provider們從約定的Map參數中取出傳入的IWrapper執行對象，使用MapperSql工具類組裝SQL語句，最後交給MyBatis執行。
在Mapper裡也有一些直接接受Map對象的方法，可以省去用IQuery/IUpdate描述SQL的過程，進行簡單的插入和查詢。傳入的原始Map對象同樣會在Provider裡被讀取出來，用MapperSql組裝SQL語句，再交給MyBatis執行。
Fluent MyBatis的這種基于Provider機制的實作方式不僅能為使用者提供流暢的SQL構造體驗，也能充分複用MyBatis原生的諸多優點，譬如豐富的DB連接配接器、健全的防SQL注入機制等等，進而確定核心邏輯的穩定可靠。
四 再見XML君
追求卓越是技術人的天性，我來自阿裡雲·雲效産品團隊，我們在用Fluent MyBatis。
如果您也早已厭倦MyBatis裡毫無生氣的XML檔案，那麼不妨就和它們做個告别吧。
Let's Fluent，加入飛速流動的隊伍，一起來感受未來的風潮迎面吹來。
原文連結
本文為阿裡雲原創内容，未經允許不得轉載。