fluentmybatis学习一

1. FluentMybatis特性
   
2. FluentMybatis原理
   
3. 创建一个示例的数据库表

DROP TABLE IF EXISTS &＃96;your_table&＃96;;create table &＃96;your_table&＃96;(id bigint auto_increment comment &＃39;主键ID&＃39; primary key,name varchar(30) charset utf8 null comment &＃39;姓名&＃39;,age int null comment &＃39;年龄&＃39;,email varchar(50) charset utf8 null comment &＃39;邮箱&＃39;,gmt_create datetime null comment &＃39;记录创建时间&＃39;,gmt_modified datetime null comment &＃39;记录最后修改时间&＃39;,is_deleted tinyint(2) default 0 null comment &＃39;逻辑删除标识&＃39;
);


4. 初始化 SpringBoot 项目
   spring boot: 基于spring boot开发&＃xff0c;肯定是必须的
   lombok: 省略get, set, toString代码的神器&＃xff0c;个人比较喜欢&＃xff1b;你也可以手动生成get set方法
   mysql-connector-java: 数据库驱动
   fluent-mybatis: fluent-mybatis运行时依赖
   fluent-mybatis-processor: fluent-mybatis编译时依赖
   fluent-mybatis-generator: fluent-mybatis代码生成依赖
   测试依赖的jar包: spring-test, junit
5. List item

spring.datasource.username&＃61;root
spring.datasource.password&＃61;password
spring.datasource.url&＃61;jdbc:mysql://localhost:3306/fluent_mybatis?useSSL&＃61;false&useUnicode&＃61;true&characterEncoding&＃61;utf-8
spring.datasource.driver-class-name&＃61;com.mysql.jdbc.Driver


6. 创建实体类 可以手工创建Entity类&＃xff0c;或者任何手段创建的Entity类&＃xff0c;然后加上下面注解
   在Entity类上加上 &＃64;FluentMybatis注解
   在主键字段加 &＃64;TableId注解
   在一般字段加 &＃64;TableField注解
   这里直接使用fluent mybatis提供的工具类生成代码

public class AppEntityGenerator {static final String url &＃61; "jdbc:mysql://localhost:3306/fluent_mybatis?useSSL&＃61;false&useUnicode&＃61;true&characterEncoding&＃61;utf-8";public static void main(String[] args) {FileGenerator.build(Abc.class);}&＃64;Tables(/** 数据库连接信息 **/url &＃61; url, username &＃61; "root", password &＃61; "password",/** Entity类parent package路径 **/basePack &＃61; "cn.org.fluent.mybatis.springboot.demo",/** Entity代码源目录 **/srcDir &＃61; "spring-boot-demo/src/main/java",/** Dao代码源目录 **/daoDir &＃61; "spring-boot-demo/src/main/java",/** 如果表定义记录创建&＃xff0c;记录修改&＃xff0c;逻辑删除字段 **/gmtCreated &＃61; "gmt_create", gmtModified &＃61; "gmt_modified", logicDeleted &＃61; "is_deleted",/** 需要生成文件的表 **/tables &＃61; &＃64;Table(value &＃61; {"your_table"}))static class Abc {}
}


1. gmt_create, 记录创建时间&＃xff0c;会设置记录插入的默认值&＃xff0c;对应生成Entity字段上的注解 &＃64;TableField(insert&＃61;“now()”)
2. gmt_modified, 记录最后更新时间&＃xff0c;会设置记录插入和更新默认值&＃xff0c;对应生成代码Entity字段上注解 &＃64;TableField(insert&＃61;“now()”, update&＃61;“now()”)
3. is_deleted, 记录逻辑删除标识&＃xff0c;字段类型为Boolean&＃xff0c;且设置记录插入的默认值&＃xff0c;对应注解 &＃64;TableField(insert&＃61;“0”)
4. 执行生成代码main函数, 在工程main/src/java目录下产出 Entity, DaoIntf, DaoImpl文件&＃xff1b; 观察YourEntity的主键 id, gmt_create, gmt_modified, is_deleted这几个字段的注解

&＃64;Data
&＃64;Accessors(chain &＃61; true)
&＃64;FluentMybatis(table &＃61; "your_table")
public class YourEntity implements IEntity{private static final long serialVersionUID &＃61; 1L;&＃64;TableId(value &＃61; "id")private Long id;&＃64;TableField(value &＃61; "gmt_create", insert &＃61; "now()")private Date gmtCreate;&＃64;TableField(value &＃61; "gmt_modified", insert &＃61; "now()", update &＃61; "now()")private Date gmtModified;&＃64;TableField(value &＃61; "is_deleted", insert &＃61; "0")private Boolean isDeleted;&＃64;TableField(value &＃61; "age")private Integer age;&＃64;TableField(value &＃61; "email")private String email;&＃64;TableField(value &＃61; "name")private String name;&＃64;Overridepublic Serializable findPk() {return id;}
}


1. 生成的Dao文件&＃xff0c;引用到了YourTableBaseDao类&＃xff0c;这个类需要根据Entity类编译生成&＃xff0c;在重新编译前会有编译错误&＃xff0c;所以生成代码后需要重新Rebuild下

&＃64;Repository
public class YourDaoImpl extends YourBaseDao implements YourDao {// 在这里添加你自己的业务逻辑代码
}


1. 启动SpringBoot测试&＃xff0c;验证效果

&＃64;SpringBootTest(classes &＃61; QuickStartApplication.class)
public class FluentMybatisApplicationTest {&＃64;Autowiredprivate YourMapper yourMapper;&＃64;Testvoid contextLoads() {List<YourEntity> list &＃61; yourMapper.listEntity(yourMapper.query());for (YourEntity entity : list) {System.out.println(entity);}}
}


1. EntityMapper提供的insert操作

2. insert->单条插入操作->Mapper方法

public interface YourMapper extends IEntityMapper<YourEntity> {/**1. 插入一条记录2. 3. &＃64;param entity4. &＃64;return*/&＃64;Override&＃64;InsertProvider(type &＃61; YourSqlProvider.class,method &＃61; "insert")&＃64;Options(useGeneratedKeys &＃61; true,keyProperty &＃61; "id",keyColumn &＃61; "id")int insert(YourEntity entity);
}


5. 动态SQL组装

public class YourSqlProvider {public String insert(YourEntity entity) {assertNotNull("entity", entity);MapperSql sql &＃61; new MapperSql();sql.INSERT_INTO("your_table");List<String> columns &＃61; new ArrayList<>();List<String> values &＃61; new ArrayList<>();if (entity.getId() !&＃61; null) {columns.add("id");values.add("#{id}");}columns.add("gmt_create");if (entity.getGmtCreate() !&＃61; null) {values.add("#{gmtCreate}");} else {values.add("now()");}columns.add("gmt_modified");if (entity.getGmtModified() !&＃61; null) {values.add("#{gmtModified}");} else {values.add("now()");}columns.add("is_deleted");if (entity.getIsDeleted() !&＃61; null) {values.add("#{isDeleted}");} else {values.add("0");}if (entity.getAge() !&＃61; null) {columns.add("age");values.add("#{age}");}if (entity.getEmail() !&＃61; null) {columns.add("email");values.add("#{email}");}if (entity.getName() !&＃61; null) {columns.add("name");values.add("#{name}");}sql.INSERT_COLUMNS(columns);sql.VALUES();sql.INSERT_VALUES(values);return sql.toString();}
}


1. 执行insert测试方法, 查看控制台输出log信息

DEBUG - &＃61;&＃61;> Preparing: INSERT INTO your_table(gmt_create, gmt_modified, is_deleted, age, email, name) VALUES (now(), now(), ?, ?, ?, ?)
DEBUG - &＃61;&＃61;> Parameters: false(Boolean), 1(Integer), darui.wu&＃64;163.com(String), Fluent Mybatis(String)
DEBUG - <&＃61;&＃61; Updates: 1
count:1
entity:YourEntity(id&＃61;18, gmtCreate&＃61;null, gmtModified&＃61;null, isDeleted&＃61;false, age&＃61;1, email&＃61;darui.wu&＃64;163.com, name&＃61;Fluent Mybatis)


注意:

1. Entity主键值的自增和回写 根据控制台输出&＃xff0c;可以看到Entity的id属性已经是根据数据库自增主键值回写过的。 自增主键的设置是通过 &＃64;TableId 注解来的&＃xff0c;其属性方法auto()默认值是true。
2. fluent mybatis根据&＃64;TableId注解生成的Mapper类上&＃64;Options注解如下&＃xff1a;

&＃64;Options(useGeneratedKeys &＃61; true,keyProperty &＃61; "id",keyColumn &＃61; "id"
)


3. gmt_created, gmt_modified, is_deleted 默认值插入处理 我们先看一下Entity上这3个字段的&＃64;TableField注解, 他们都定义了一个属性方法insert&＃xff0c;设置了insert的默认值&＃xff08;即程序编码insert时&＃xff0c;如果没有设置该字段&＃xff0c;则使用默认值&＃xff09;

&＃64;TableField(value &＃61; "gmt_create", insert &＃61; "now()")private Date gmtCreate;&＃64;TableField(value &＃61; "gmt_modified", insert &＃61; "now()", update &＃61; "now()")private Date gmtModified;&＃64;TableField(value &＃61; "is_deleted", insert &＃61; "0")private Boolean isDeleted;


4. 在测试例子中&＃xff0c;gmt_created和gmt_modified在初始化Entity时&＃xff0c;没有设置任何值; is_deleted设置了值false。 在构建sql是&＃xff0c;gmt_created, gmt_modified直接使用默认值 “now()”, is_deleted使用预编译变量(?)设置(实际值false)。

INSERT INTO your_table
(gmt_create, gmt_modified, is_deleted, age, email, name)
VALUES
(now(), now(), ?, ?, ?, ?)


5. 我们再看一下对应的SQLProvider的SQL构造, 我们只看着3个字段的构造

public class YourSqlProvider {public String insert(YourEntity entity) {List<String> columns &＃61; new ArrayList<>();List<String> values &＃61; new ArrayList<>();// 省略 ... ...columns.add("gmt_create");if (entity.getGmtCreate() !&＃61; null) {values.add("#{gmtCreate}");} else {values.add("now()");}columns.add("gmt_modified");if (entity.getGmtModified() !&＃61; null) {values.add("#{gmtModified}");} else {values.add("now()");}columns.add("is_deleted");if (entity.getIsDeleted() !&＃61; null) {values.add("#{isDeleted}");} else {values.add("0");}if (entity.getAge() !&＃61; null) {columns.add("age");values.add("#{age}");}// 省略... ...return sql.toString();}
}


我们看到&＃xff0c;没有 insert属性的字段&＃xff0c;只判断了是否为空; 有insert属性的字段&＃xff0c;如果entity不为空&＃xff0c;则把默认值赋值给sql语句。

insertBatch 批量插入

public class YourSqlProvider {public String insertBatch(Map map) {assertNotEmpty("map", map);MapperSql sql &＃61; new MapperSql();List<YourEntity> entities &＃61; getParas(map, "list");sql.INSERT_INTO("your_table");sql.INSERT_COLUMNS(ALL_ENTITY_FIELDS);sql.VALUES();for (int index &＃61; 0; index < entities.size(); index&＃43;&＃43;) {if (index > 0) {sql.APPEND(", ");}sql.INSERT_VALUES("#{list[" &＃43; index &＃43; "].id}",entities.get(index).getGmtCreate() &＃61;&＃61; null ? "now()" : "#{list[" &＃43; index &＃43; "].gmtCreate}",entities.get(index).getGmtModified() &＃61;&＃61; null ? "now()" : "#{list[" &＃43; index &＃43; "].gmtModified}",entities.get(index).getIsDeleted() &＃61;&＃61; null ? "0" : "#{list[" &＃43; index &＃43; "].isDeleted}","#{list[" &＃43; index &＃43; "].age}","#{list[" &＃43; index &＃43; "].email}","#{list[" &＃43; index &＃43; "].name}");}return sql.toString();}
}


SQL构造语句是通过一个for循环遍历实体列表&＃xff0c;构造出下列SQL语句, 其中对有insert默认值属性处理方式同单条insert一样, 这里就不再重复。

NSERT INTO your_table (&＃39;Entity对应的字段列表&＃39;) VALUES (&＃39;实例1值&＃39;), (&＃39;实例2值&＃39;)


写个测试看看具体效果

&＃64;SpringBootTest(classes &＃61; QuickStartApplication.class)
public class FluentMybatisApplicationTest {&＃64;Autowiredprivate YourMapper yourMapper;void insertBatch(){List<YourEntity> entities &＃61; new ArrayList<>();entities.add(new YourEntity().setName("Fluent Mybatis").setEmail("darui.wu&＃64;163.com"));entities.add(new YourEntity().setName("Fluent Mybatis Demo").setEmail("darui.wu&＃64;163.com"));entities.add(new YourEntity().setName("Test4J").setEmail("darui.wu&＃64;163.com"));int count &＃61; yourMapper.insertBatch(entities);System.out.println("count:" &＃43; count);System.out.println("entity:" &＃43; entities);}
}


执行测试&＃xff0c;查看控制台输出

DEBUG - &＃61;&＃61;> Preparing: INSERT INTO your_table(id, gmt_create, gmt_modified, is_deleted, age, email, name) VALUES (?, now(), now(), 0, ?, ?, ?) , (?, now(), now(), 0, ?, ?, ?) , (?, now(), now(), 0, ?, ?, ?)
DEBUG - &＃61;&＃61;> Parameters: null, null, darui.wu&＃64;163.com(String), Fluent Mybatis(String), null, null, darui.wu&＃64;163.com(String), Fluent Mybatis Demo(String), null, null, darui.wu&＃64;163.com(String), Test4J(String)
DEBUG - <&＃61;&＃61; Updates: 3
count:3
entity:[YourEntity(id&＃61;null, gmtCreate&＃61;null, gmtModified&＃61;null, isDeleted&＃61;null, age&＃61;null, email&＃61;darui.wu&＃64;163.com, name&＃61;Fluent Mybatis), YourEntity(id&＃61;null, gmtCreate&＃61;null, gmtModified&＃61;null, isDeleted&＃61;null, age&＃61;null, email&＃61;darui.wu&＃64;163.com, name&＃61;Fluent Mybatis Demo), YourEntity(id&＃61;null, gmtCreate&＃61;null, gmtModified&＃61;null, isDeleted&＃61;null, age&＃61;null, email&＃61;darui.wu&＃64;163.com, name&＃61;Test4J)]