目錄數(shù)據(jù)準(zhǔn)備代碼生成在 WHERE 條件中使用動(dòng)態(tài)條件在 UPDATE 使用動(dòng)態(tài)更新choose 標(biāo)簽參考

MyBatis 令人喜歡的一大特性就是動(dòng)態(tài) SQL。在使用 JDBC 的過程中， 根據(jù)條件進(jìn)行 SQL 的拼接是很麻煩且很容易出錯(cuò)的,MyBatis雖然提供了動(dòng)態(tài)拼裝的能力，但這些寫xml文件，也確實(shí)折磨開發(fā)。Fluent MyBatis提供了更貼合Java語言特質(zhì)的，對(duì)程序員友好的Fluent拼裝能力。

Fluent MyBatis動(dòng)態(tài)SQL，寫SQL更爽

數(shù)據(jù)準(zhǔn)備

為了后面的演示， 創(chuàng)建了一個(gè) Maven 項(xiàng)目 fluent-mybatis-dynamic, 創(chuàng)建了對(duì)應(yīng)的數(shù)據(jù)庫和表

DROP TABLE IF EXISTS `student`;CREATE TABLE `student`( `id` bigint(21) unsigned NOT NULL AUTO_INCREMENT COMMENT ’編號(hào)’, `name` varchar(20) DEFAULT NULL COMMENT ’姓名’, `phone`varchar(20) DEFAULT NULL COMMENT ’電話’, `email`varchar(50) DEFAULT NULL COMMENT ’郵箱’, `gender` tinyint(2) DEFAULT NULL COMMENT ’性別’, `locked` tinyint(2) DEFAULT NULL COMMENT ’狀態(tài)(0:正常,1:鎖定)’, `gmt_created` datetime DEFAULT CURRENT_TIMESTAMP COMMENT ’存入數(shù)據(jù)庫的時(shí)間’, `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT ’修改的時(shí)間’, `is_deleted` tinyint(2) DEFAULT 0, PRIMARY KEY (`id`)) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci COMMENT =’學(xué)生表’;代碼生成

使用Fluent Mybatis代碼生成器，生成對(duì)應(yīng)的Entity文件

public class Generator { static final String url = 'jdbc:mysql://localhost:3306/fluent_mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8'; /** * 生成代碼的package路徑 */ static final String basePackage = 'cn.org.fluent.mybatis.dynamic'; /** * 使用 test/resource/init.sql文件自動(dòng)初始化測(cè)試數(shù)據(jù)庫 */ @BeforeAll static void runDbScript() {DataSourceCreatorFactory.create('dataSource'); } @Test void test() {FileGenerator.build(Nothing.class); } @Tables(/** 數(shù)據(jù)庫連接信息 **/url = url, username = 'root', password = 'password',/** Entity類parent package路徑 **/basePack = basePackage,/** Entity代碼源目錄 **/srcDir = 'src/main/java',/** 如果表定義記錄創(chuàng)建，記錄修改，邏輯刪除字段 **/gmtCreated = 'gmt_created', gmtModified = 'gmt_modified', logicDeleted = 'is_deleted',/** 需要生成文件的表 ( 表名稱:對(duì)應(yīng)的Entity名稱 ) **/tables = @Table(value = {'student'}) ) public static class Nothing { }}

編譯項(xiàng)目，ok，下面我們開始動(dòng)態(tài)SQL構(gòu)造旅程

在 WHERE 條件中使用動(dòng)態(tài)條件

在mybatis中，if 標(biāo)簽是大家最常使用的。在查詢、刪除、更新的時(shí)候結(jié)合 test 屬性聯(lián)合使用。

示例：根據(jù)輸入的學(xué)生信息進(jìn)行條件檢索

當(dāng)只輸入用戶名時(shí)， 使用用戶名進(jìn)行模糊檢索； 當(dāng)只輸入性別時(shí)， 使用性別進(jìn)行完全匹配 當(dāng)用戶名和性別都存在時(shí)， 用這兩個(gè)條件進(jìn)行查詢匹配查詢

mybatis動(dòng)態(tài) SQL寫法

<select resultMap='BaseResultMap' parameterType='com.homejim.mybatis.entity.Student'> select <include refid='Base_Column_List' /> from student <where><if test='name != null and name !=’’'> and name like concat(’%’, #{name}, ’%’)</if><if test='sex != null'> and sex=#{sex}</if> </where></select>

fluent mybatis動(dòng)態(tài)寫法

@Repositorypublic class StudentDaoImpl extends StudentBaseDao implements StudentDao { /** * 根據(jù)輸入的學(xué)生信息進(jìn)行條件檢索 * 1. 當(dāng)只輸入用戶名時(shí)， 使用用戶名進(jìn)行模糊檢索； * 2. 當(dāng)只輸入性別時(shí)， 使用性別進(jìn)行完全匹配 * 3. 當(dāng)用戶名和性別都存在時(shí)， 用這兩個(gè)條件進(jìn)行查詢匹配的用 * * @param name 姓名,模糊匹配 * @param isMale 性別 * @return */ @Override public List<StudentEntity> selectByNameOrEmail(String name, Boolean isMale) {return super.defaultQuery() .where.name().like(name, If::notBlank) .and.gender().eq(isMale, If::notNull).end() .execute(super::listEntity); }}

FluentMyBatis的實(shí)現(xiàn)方式至少有下面的好處

邏輯就在方法實(shí)現(xiàn)上，不需要額外維護(hù)xml，割裂開來 所有的編碼通過IDE智能提示，沒有字符串魔法值編碼 編譯檢查，拼寫錯(cuò)誤能立即發(fā)現(xiàn)

測(cè)試

@SpringBootTest(classes = AppMain.class)public class StudentDaoImplTest extends Test4J { @Autowired StudentDao studentDao; @DisplayName('只有名字時(shí)的查詢') @Test void selectByNameOrEmail_onlyName() {studentDao.selectByNameOrEmail('明', null);// 驗(yàn)證執(zhí)行的sql語句db.sqlList().wantFirstSql().eq('' +'SELECT id, gmt_created, gmt_modified, is_deleted, email, gender, locked, name, phone ' +'FROM student ' +'WHERE name LIKE ?', StringMode.SameAsSpace);// 驗(yàn)證sql參數(shù)db.sqlList().wantFirstPara().eqReflect(new Object[]{'%明%'}); } @DisplayName('只有性別時(shí)的查詢') @Test void selectByNameOrEmail_onlyGender() {studentDao.selectByNameOrEmail(null, false);// 驗(yàn)證執(zhí)行的sql語句db.sqlList().wantFirstSql().eq('' +'SELECT id, gmt_created, gmt_modified, is_deleted, email, gender, locked, name, phone ' +'FROM student ' +'WHERE gender = ?', StringMode.SameAsSpace);// 驗(yàn)證sql參數(shù)db.sqlList().wantFirstPara().eqReflect(new Object[]{false}); } @DisplayName('姓名和性別同時(shí)存在的查詢') @Test void selectByNameOrEmail_both() {studentDao.selectByNameOrEmail('明', false);// 驗(yàn)證執(zhí)行的sql語句db.sqlList().wantFirstSql().eq('' +'SELECT id, gmt_created, gmt_modified, is_deleted, email, gender, locked, name, phone ' +'FROM student ' +'WHERE name LIKE ? ' +'AND gender = ?', StringMode.SameAsSpace);// 驗(yàn)證sql參數(shù)db.sqlList().wantFirstPara().eqReflect(new Object[]{'%明%', false}); }}在 UPDATE 使用動(dòng)態(tài)更新

只更新有變化的字段， 空值不更新

mybatis xml寫法

<update parameterType='...'> update student <set> <if test='name != null'>`name` = #{name,jdbcType=VARCHAR}, </if> <if test='phone != null'>phone = #{phone,jdbcType=VARCHAR}, </if> <if test='email != null'>email = #{email,jdbcType=VARCHAR}, </if> <if test='gender != null'>gender = #{gender,jdbcType=TINYINT}, </if> <if test='gmtModified != null'>gmt_modified = #{gmtModified,jdbcType=TIMESTAMP}, </if> </set> where id = #{id,jdbcType=INTEGER}</update>

fluent mybatis實(shí)現(xiàn)

@Repositorypublic class StudentDaoImpl extends StudentBaseDao implements StudentDao { /** * 根據(jù)主鍵更新非空屬性 * * @param student * @return */ @Override public int updateByPrimaryKeySelective(StudentEntity student) {return super.defaultUpdater() .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() .execute(super::updateBy); } }

測(cè)試

@SpringBootTest(classes = AppMain.class)public class StudentDaoImplTest extends Test4J { @Autowired StudentDao studentDao; @Test void updateByPrimaryKeySelective() {StudentEntity student = new StudentEntity() .setId(1L) .setName('test') .setPhone('13866668888');studentDao.updateByPrimaryKeySelective(student);// 驗(yàn)證執(zhí)行的sql語句db.sqlList().wantFirstSql().eq('' +'UPDATE student ' +'SET gmt_modified = now(), ' +'name = ?, ' +'phone = ? ' +'WHERE id = ?', StringMode.SameAsSpace);// 驗(yàn)證sql參數(shù)db.sqlList().wantFirstPara().eqReflect(new Object[]{'test', '13866668888', 1L}); }}choose 標(biāo)簽

在mybatis中choose when otherwise 標(biāo)簽可以幫我們實(shí)現(xiàn) if else 的邏輯。

查詢條件，假設(shè) name 具有唯一性， 查詢一個(gè)學(xué)生

當(dāng) id 有值時(shí)， 使用 id 進(jìn)行查詢； 當(dāng) id 沒有值時(shí)， 使用 name 進(jìn)行查詢； 否則返回空

mybatis xml實(shí)現(xiàn)

<select resultMap='BaseResultMap' parameterType='...'> select <include refid='Base_Column_List' /> from student <where><choose> <when test='id != null'> and id=#{id} </when> <when test='name != null and name != ’’'> and name=#{name} </when> <otherwise> and 1=2 </otherwise></choose> </where></select>

fluent mybatis實(shí)現(xiàn)方式

@Repositorypublic class StudentDaoImpl extends StudentBaseDao implements StudentDao { /** * 1. 當(dāng) id 有值時(shí)， 使用 id 進(jìn)行查詢； * 2. 當(dāng) id 沒有值時(shí)， 使用 name 進(jìn)行查詢； * 3. 否則返回空 */ @Override public StudentEntity selectByIdOrName(StudentEntity student) { return super.defaultQuery() .where.id().eq(student.getId(), If::notNull) .and.name().eq(student.getName(), name -> isNull(student.getId()) && notBlank(name)) .and.apply('1=2', () -> isNull(student.getId()) && isBlank(student.getName())) .end() .execute(super::findOne).orElse(null); }}

測(cè)試

@SpringBootTest(classes = AppMain.class)public class StudentDaoImplTest extends Test4J { @Autowired StudentDao studentDao; @DisplayName('有 ID 則根據(jù) ID 獲取') @Test void selectByIdOrName_byId() {StudentEntity student = new StudentEntity();student.setName('小飛機(jī)');student.setId(1L);StudentEntity result = studentDao.selectByIdOrName(student);// 驗(yàn)證執(zhí)行的sql語句db.sqlList().wantFirstSql().eq('' +'SELECT id, gmt_created, gmt_modified, is_deleted, email, gender, locked, name, phone ' +'FROM student ' +'WHERE id = ?', StringMode.SameAsSpace);// 驗(yàn)證sql參數(shù)db.sqlList().wantFirstPara().eqReflect(new Object[]{1L}); } @DisplayName('沒有 ID 則根據(jù) name 獲取') @Test void selectByIdOrName_byName() {StudentEntity student = new StudentEntity();student.setName('小飛機(jī)');student.setId(null);StudentEntity result = studentDao.selectByIdOrName(student);// 驗(yàn)證執(zhí)行的sql語句db.sqlList().wantFirstSql().eq('' +'SELECT id, gmt_created, gmt_modified, is_deleted, email, gender, locked, name, phone ' +'FROM student ' +'WHERE name = ?', StringMode.SameAsSpace);// 驗(yàn)證sql參數(shù)db.sqlList().wantFirstPara().eqReflect(new Object[]{'小飛機(jī)'}); } @DisplayName('沒有 ID 和 name, 返回 null') @Test void selectByIdOrName_null() {StudentEntity student = new StudentEntity();StudentEntity result = studentDao.selectByIdOrName(student);// 驗(yàn)證執(zhí)行的sql語句db.sqlList().wantFirstSql().eq('' +'SELECT id, gmt_created, gmt_modified, is_deleted, email, gender, locked, name, phone ' +'FROM student ' +'WHERE 1=2', StringMode.SameAsSpace);// 驗(yàn)證sql參數(shù)db.sqlList().wantFirstPara().eqReflect(new Object[]{}); }}參考

示例代碼地址Fluent MyBatis地址Fluent MyBatis文檔Test4J框架

到此這篇關(guān)于Fluent MyBatis實(shí)現(xiàn)動(dòng)態(tài)SQL的文章就介紹到這了,更多相關(guān)Fluent MyBatis 動(dòng)態(tài)SQL內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！