MyBatis-generator - 《田云的博客笔记》

配置
生成代码
使用

插件github：https://github.com/itfsw/mybatis-generator-plugin，很多用法请参考这里。

配置

mybatis-generator.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <context id="MySql" defaultModelType="flat">
        <!--搜索：need to change-->
        <!-- 查询单条数据插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.SelectOneByExamplePlugin"/>
        <!-- MySQL分页插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.LimitPlugin">
            <!-- 通过配置startPage影响Example中的page方法开始分页的页码，默认分页从0开始 -->
            <property name="startPage" value="0"/>
        </plugin>
        <!-- Example Criteria 增强插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.ExampleEnhancedPlugin">
            <!-- 是否支持已经过时的andIf方法（推荐使用when代替），默认支持 -->
            <property name="enableAndIf" value="true"/>
        </plugin>
        <!-- Example 目标包修改插件 need to change-->
        <plugin type="com.itfsw.mybatis.generator.plugins.ExampleTargetPlugin">
            <!-- 修改Example类生成到目标包下 -->
            <property name="targetPackage" value="com.alvin.biaozhu.entity.example"/>
        </plugin>
        <!-- 数据Model属性对应Column获取插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.ModelColumnPlugin"/>
        <!-- 数据Model链式构建插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.ModelBuilderPlugin"/>
        <!-- 批量插入插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.BatchInsertPlugin">
            <!--
            开启后可以实现官方插件根据属性是否为空决定是否插入该字段功能
            ！需开启allowMultiQueries=true多条sql提交操作，所以不建议使用！插件默认不开启
            -->
            <property name="allowMultiQueries" value="false"/>
        </plugin>
        <!-- 存在即更新插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.UpsertPlugin">
            <!--
            支持upsertByExample，upsertByExampleSelective操作
            ！需开启allowMultiQueries=true多条sql提交操作，所以不建议使用！插件默认不开启
            -->
            <property name="allowMultiQueries" value="false"/>
            <!--
            开启批量功能，支持batchUpsert,batchUpsertWithBLOBs,batchUpserSelective
            ！这几个方法中无法支持IncrementsPlugin的方法！插件默认不开启
            -->
            <property name="allowBatchUpsert" value="fasle"/>
        </plugin>
        <!-- 增量插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.IncrementPlugin"/>
        <!--<table tableName="tb">-->
        <!--&lt;!&ndash; 配置需要进行增量操作的列名称（英文半角逗号分隔） &ndash;&gt;-->
        <!--<property name="incrementColumns" value="field1,field2"/>-->
        <!--</table>-->
        <!-- 查询结果选择性返回插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.SelectSelectivePlugin"/>
        <!-- Selective选择插入更新增强插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.SelectiveEnhancedPlugin"/>
        <!-- Lombok插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.LombokPlugin">
            <!-- @Data 默认开启,同时插件会对子类自动附加@EqualsAndHashCode(callSuper = true)，@ToString(callSuper = true) -->
            <property name="@Data" value="true"/>
            <!-- @Builder 必须在 Lombok 版本 >= 1.18.2 的情况下开启，对存在继承关系的类自动替换成@SuperBuilder -->
            <property name="@Builder" value="false"/>
            <!-- @NoArgsConstructor 和 @AllArgsConstructor 使用规则和Lombok一致 -->
            <property name="@AllArgsConstructor" value="false"/>
            <property name="@NoArgsConstructor" value="false"/>
            <!-- @Getter、@Setter、@Accessors 等使用规则参见官方文档 -->
            <property name="@Accessors(chain = true)" value="false"/>
            <!-- 临时解决IDEA工具对@SuperBuilder的不支持问题，开启后(默认未开启)插件在遇到@SuperBuilder注解时会调用ModelBuilderPlugin来生成相应的builder代码 -->
            <property name="supportSuperBuilderForIdea" value="false"/>
        </plugin>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- Mapper注解插件 -->
        <plugin type="com.itfsw.mybatis.generator.plugins.MapperAnnotationPlugin">
            <!-- @Mapper 默认开启 -->
            <property name="@Mapper" value="true"/>
            <!-- @Repository 默认关闭，开启后解决IDEA工具@Autowired报错 -->
            <property name="@Repository" value="true"/>
        </plugin>
        <!--<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />-->
        <!--数据库连接配置 need to change-->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://soft.tianyunperfect.cn:3306/biaozhu?nullCatalogMeansCurrent=true"
                userId="dev"
                password="kaimen"/>
        <!--指定自动生成的 POJO置于哪个包下 need to change -->
        <javaModelGenerator targetPackage="com.alvin.biaozhu.entity"
                            targetProject="src/main/java"></javaModelGenerator>
        <!--指定自动生成的 mapper.xml置于哪个包下 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"></sqlMapGenerator>
        <!--指定自动生成的 DAO接口置于哪个包下 need to change-->
        <javaClientGenerator targetPackage="com.alvin.biaozhu.mapper"
                targetProject="src/main/java" type="XMLMAPPER"></javaClientGenerator>
        <!--指定数据表名，可以使用_和%通配符-->
        <table tableName="similar"></table>
    </context>
</generatorConfiguration>

生成代码

双击即可生成代码

效果：

使用

-----原始用法------
public PageResult<Phone> findByExample(String userId, Date date,int pageNum, int pageSize) {
    PhoneExample phoneExample = new PhoneExample();
    PhoneExample.Criteria criteria = phoneExample.createCriteria();
    /**
     * 多条件
     */
    criteria.andUserIdEqualTo(userId);
    criteria.andPhoneGetTimeGreaterThan(new Date());
    /**
     * 排序
     */
    String orderByClause = "user_name DESC";
    phoneExample.setOrderByClause(orderByClause);
    /**
     * 查询，分页必须卸载查询的前一行
     */
    phoneExample.page(pageNum, pageSize);
    List<Phone> list = phoneMapper.selectByExample(phoneExample);
    return new PageResult<Phone>(list.size(), list);
}

Module的构建

User user = User.builder()
        .id(1L)
        .userName("userName")
        .passwd("passwd")
        .build();

条件的构建

UserExample userExample = UserExample.newAndCreateCriteria()
        .andUserNameEqualTo(userName)
        .when(Math.random() > 1, criteria -> criteria.andIdGreaterThan(1L))
        .when(Math.random() > 1, criteria -> criteria.andIdGreaterThan(1L), criteria -> criteria.andIdGreaterThan(1L))
        .example()
        .orderBy(User.Column.id.desc());

查询单条记录

userMapper.selectOneByExample(UserExample.newAndCreateCriteria().example());

查询多条记录

List<User> users = userMapper.selectByExample(userExample);

修改和插入

# 批量插入
userMapper.batchInsert(Arrays.asList(user));
# 单条插入
userMapper.insert(user);
# 存在即更新,类似于JPA的save
userMapper.upsert(user);
# 有时候我们要对某列设置为null，但是mybatis会判断如果是null则不生成sql，我们要使用Selective
tbMapper.insertSelective(tb, Tb.Column.field1, Tb.Column.field2);
tbMapper.updateByPrimaryKeySelective(tb, Tb.Column.field1, Tb.Column.field2);

增量更新

生成pojo前，需要提前配置好

// 在构建更新对象时，配置了增量支持的字段会增加传入增量枚举的方法
Tb tb = Tb.builder()
        .id(102)
        .field4(new Date())
        .build()
        .increment(Tb.Increment.field1.inc(1)) // 字段1 统计增加1
        .increment(Tb.Increment.field2.dec(2)); // 字段2 统计减去2
// 更新操作，可以是 updateByExample, updateByExampleSelective, updateByPrimaryKey
// , updateByPrimaryKeySelective, upsert, upsertSelective等所有涉及更新的操作
this.tbMapper.updateByPrimaryKey(tb);

查询结果选择性返回

// 查询操作精确返回需要的列
this.tbMapper.selectByExampleSelective(
    new TbExample()
    .createCriteria()
    .andField1GreaterThan(1)
    .example(),
    Tb.Column.field1,
    Tb.Column.field2
);
// 同理还有 selectByPrimaryKeySelective，selectOneByExampleSelective（SelectOneByExamplePlugin插件配合使用）方法
// 当然可以使用excludes
this.tbMapper.selectByExampleSelective(
    new TbExample()
    .createCriteria()
    .andField1GreaterThan(1)
    .example(),
    Tb.Column.excludes(Tb.Column.id, Tb.Column.delFlag)
);

分页

example.page(pageNum,pageSize);  从0页开始