FluentMybatis實現mybatis動態sql拼裝和fluent api語法

Posted on by

開始第一個例子: Hello World

 新建Java工程，設置maven依賴

新建maven工程，設置項目編譯級別為Java8及以上，引入fluent mybatis依賴包。

<dependencies>
    <!-- 引入fluent-mybatis 運行依賴包, scope為compile -->
    <dependency>
        <groupId>com.github.atool</groupId>
        <artifactId>fluent-mybatis</artifactId>
        <version>1.3.1</version>
    </dependency>
    <!-- 引入fluent-mybatis-processor, scope設置為provider 編譯需要，運行時不需要 -->
    <dependency>
        <groupId>com.github.atool</groupId>
        <artifactId>fluent-mybatis-processor</artifactId>
        <version>1.3.1</version>
    </dependency>
</dependencies>

新建演示用的數據庫結構

create schema fluent_mybatis_tutorial;

create table hello_world
(
    id           bigint unsigned auto_increment primary key,
    say_hello    varchar(100) null,
    your_name    varchar(100) null,
    gmt_create   datetime   DEFAULT NULL COMMENT '創建時間',
    gmt_modified datetime   DEFAULT NULL COMMENT '更新時間',
    is_deleted   tinyint(2) DEFAULT 0 COMMENT '是否邏輯刪除'
) ENGINE = InnoDB
  CHARACTER SET = utf8 comment '簡單演示表';

創建數據庫表對應的Entity類

創建數據庫表對應的Entity類: HelloWorldEntity, 你隻需要簡單的做3個動作:

  • 根據駝峰命名規則命名Entity類和字段
  • HelloWorldEntity繼承IEntity接口類
  • 在HelloWorldEntity類上加註解 @FluentMybatis
@FluentMybatis
public class HelloWorldEntity implements IEntity {
    private Long id;

    private String sayHello;

    private String yourName;

    private Date gmtCreate;

    private Date gmtModified;

    private Boolean isDeleted;
    
    // get, set, toString 方法
}

很簡單吧，在這裡，你即不需要配置任何mybatis xml文件, 也不需要寫任何Mapper接口, 但你已經擁有瞭強大的增刪改查的功能，並且是Fluent API，讓我們寫一個測試來見證一下Fluent Mybatis的魔法力量!

運行測試來見證Fluent Mybatis的神奇

為瞭運行測試, 我們還需要進行JUnit和Spring Test相關配置。

配置spring bean定義

 數據源DataSource配置
mybatis的mapper掃描路徑
mybatis的SqlSessionFactoryBean

@ComponentScan(basePackages = "cn.org.atool.fluent.mybatis.demo1")
@MapperScan("cn.org.atool.fluent.mybatis.demo1.entity.mapper")
@Configuration
public class HelloWorldConfig {
    /**
     * 設置dataSource屬性
     *
     * @return
     */
    @Bean
    public DataSource dataSource() {
        BasicDataSource dataSource = new BasicDataSource();
        dataSource.setDriverClassName("com.mysql.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/fluent_mybatis_tutorial?useUnicode=true&characterEncoding=utf8");
        dataSource.setUsername("root");
        dataSource.setPassword("password");
        return dataSource;
    }

    /**
     * 定義mybatis的SqlSessionFactoryBean
     *
     * @param dataSource
     * @return
     */
    @Bean
    public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource) {
        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        return bean;
    }
}

使用Junit4和Spring-test來執行測試

  • 使用spring-test初始化spring容器
  • 註入HelloWorldEntity對應的Mapper類: HelloWorldMapper, 這個類是fluent mybatis編譯時生成的。
  • 使用HelloWorldMapper進行刪除、插入、查詢、修改操作。
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = HelloWorldConfig.class)
public class HelloWorldTest {
    /**
     * fluent mybatis編譯時生成的Mapper類
     */
    @Autowired
    HelloWorldMapper mapper;

    @Test
    public void testHelloWorld() {
        /**
         * 為瞭演示方便，先刪除數據
         */
        mapper.delete(mapper.query()
            .where.id().eq(1L).end());
        /**
         * 插入數據
         */
        HelloWorldEntity entity = new HelloWorldEntity();
        entity.setId(1L);
        entity.setSayHello("hello world");
        entity.setYourName("fluent mybatis");
        entity.setIsDeleted(false);
        mapper.insert(entity);
        /**
         * 查詢 id = 1 的數據
         */
        HelloWorldEntity result1 = mapper.findOne(mapper.query()
            .where.id().eq(1L).end());
        /**
         * 控制臺直接打印出查詢結果
         */
        System.out.println("1. HelloWorldEntity:" + result1.toString());
        /**
         * 更新id = 1的記錄
         */
        mapper.updateBy(mapper.updater()
            .update.sayHello().is("say hello, say hello!")
            .set.yourName().is("fluent mybatis is powerful!").end()
            .where.id().eq(1L).end()
        );
        /**
         * 查詢 id = 1 的數據
         */
        HelloWorldEntity result2 = mapper.findOne(mapper.query()
            .where.sayHello().like("hello")
            .and.isDeleted().eq(false).end()
            .limit(1)
        );
        /**
         * 控制臺直接打印出查詢結果
         */
        System.out.println("2. HelloWorldEntity:" + result2.toString());
    }
}

執行Junit4測試方法，控制臺輸出

1. HelloWorldEntity:HelloWorldEntity{id=1, sayHello=’hello world’, yourName=’fluent mybatis’, gmtCreate=null, gmtModified=null, isDeleted=false}
2. HelloWorldEntity:HelloWorldEntity{id=1, sayHello=’say hello, say hello!’, yourName=’fluent mybatis is powerful!’, gmtCreate=null, gmtModified=null, isDeleted=false}

神奇吧！ 我們再到數據庫中查看一下結果

在這裡插入圖片描述

現在，我們已經通過一個簡單例子演示瞭fluent mybatis的強大功能，
在進一步介紹fluent mybatis更強大功能前，我們揭示一下為啥我們隻寫瞭一個數據表對應的Entity類，
卻擁有瞭一系列增刪改查的數據庫操作方法。

fluent mybatis根據Entity類上@FluentMybatis註解在編譯時，
會在target目錄class目錄下自動編譯生成一系列文件：

在這裡插入圖片描述

核心接口類, 使用時需要瞭解

  • mapper/*Mapper: mybatis的Mapper定義接口, 定義瞭一系列通用的數據操作接口方法。
  • dao/*BaseDao: Dao實現基類, 所有的DaoImpl都繼承各自基類
  • 根據分層編碼的原則，我們不會在Service類中直接使用Mapper類，而是引用Dao類。我們在Dao實現類中根據條件實現具體的數據操作方法。
  • wrapper/*Query: fluent mybatis核心類, 用來進行動態sql的構造, 進行條件查詢。
  • wrapper/*Updater: fluent mybatis核心類, 用來動態構造update語句。
  • entity/*EntityHelper: Entity幫助類, 實現瞭Entity和Map的轉換方法
  • 輔助實現時, 實現fluent mybatis動態sql拼裝和fluent api時內部用到的類，使用時無需瞭解
  • 在使用上，我們主要會接觸到上述5個生成的java類。Fluent Mybatis為瞭實現動態拼接和Fluent API功能，還生成瞭一系列輔助類。
  • helper/*Mapping: 表字段和Entity屬性映射定義類
  • helper/*SqlProviderP: Mapper接口動態sql提供者
  • helper/*WrapperHelper: Query和Updater具體功能實現, 包含幾個實現:select, where, group by, having by, order by, limit

Fluent Mybatis文檔&示例

Fluent Mybatis源碼, github

到此這篇關於FluentMybatis實現mybatis動態sql拼裝和fluent api語法的文章就介紹到這瞭,更多相關FluentMybatis實現mybatis動態sql內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：