关于java:解放双手MyBatis官方代码生成工具给力

在咱们应用MyBatis的过程中，如果所有实体类和单表CRUD代码都须要手写，那将会是一件相当麻烦的事件。MyBatis官网代码生成器MyBatis Generator能够帮忙咱们解决这个问题，在我的开源我的项目mall中也是应用的这个代码生成器，用习惯了也挺不错的。本文将介绍MyBatis Generator的应用办法及应用技巧，心愿对大家有所帮忙！

SpringBoot实战电商我的项目mall（40k+star）地址：https://github.com/macrozheng/mall

简介

MyBatis Generator（简称MBG）是MyBatis官网提供的代码生成工具。能够通过数据库表间接生成实体类、单表CRUD代码、mapper.xml文件，从而解放咱们的双手！

开始应用

首先咱们通过一个入门示例将MBG用起来，该示例会蕴含根底的CRUD操作。

集成MBG

在pom.xml中增加如下依赖，次要增加了MyBatis、PageHelper、Druid、MBG和MySQL驱动等依赖；

<dependencies>    <!--SpringBoot整合MyBatis-->    <dependency>        <groupId>org.mybatis.spring.boot</groupId>        <artifactId>mybatis-spring-boot-starter</artifactId>        <version>2.1.3</version>    </dependency>    <!--MyBatis分页插件-->    <dependency>        <groupId>com.github.pagehelper</groupId>        <artifactId>pagehelper-spring-boot-starter</artifactId>        <version>1.3.0</version>    </dependency>    <!--集成druid连接池-->    <dependency>        <groupId>com.alibaba</groupId>        <artifactId>druid-spring-boot-starter</artifactId>        <version>1.1.10</version>    </dependency>    <!-- MyBatis 生成器 -->    <dependency>        <groupId>org.mybatis.generator</groupId>        <artifactId>mybatis-generator-core</artifactId>        <version>1.4.0</version>    </dependency>    <!--Mysql数据库驱动-->    <dependency>        <groupId>mysql</groupId>        <artifactId>mysql-connector-java</artifactId>        <version>8.0.15</version>    </dependency></dependencies>

在application.yml中对数据源和MyBatis的mapper.xml文件门路进行配置，这里做个约定，MBG生成的放在resources/com/**/mapper目录下，自定义的放在resources/dao目录下；

# 数据源配置spring:  datasource:    url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai    username: root    password: root# MyBatis mapper.xml门路配置mybatis:  mapper-locations:    - classpath:dao/*.xml    - classpath*:com/**/mapper/*.xml

增加Java配置，用于扫码Mapper接口门路，这里还有个约定，MBG生成的放在mapper包下，自定义的放在dao包下。

/** * MyBatis配置类 * Created by macro on 2019/4/8. */@Configuration@MapperScan({"com.macro.mall.tiny.mbg.mapper","com.macro.mall.tiny.dao"})public class MyBatisConfig {}

应用代码生成器

在应用MBG生成代码前，咱们还须要对其进行一些配置，首先在generator.properties文件中配置好数据库连贯信息；

jdbc.driverClass=com.mysql.cj.jdbc.Driverjdbc.connectionURL=jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghaijdbc.userId=rootjdbc.password=root

而后在generatorConfig.xml文件中对MBG进行配置，配置属性阐明间接参考正文即可；

<?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>    <properties resource="generator.properties"/>    <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">        <property name="beginningDelimiter" value="`"/>        <property name="endingDelimiter" value="`"/>        <property name="javaFileEncoding" value="UTF-8"/>        <!--生成mapper.xml时笼罩原文件-->        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />        <!-- 为模型生成序列化办法-->        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>        <!-- 为生成的Java模型创立一个toString办法 -->        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>        <!--能够自定义生成model的代码正文-->        <commentGenerator type="com.macro.mall.tiny.mbg.CommentGenerator">            <!-- 是否去除主动生成的正文 true：是 ： false:否 -->            <property name="suppressAllComments" value="true"/>            <property name="suppressDate" value="true"/>            <property name="addRemarkComments" value="true"/>        </commentGenerator>        <!--配置数据库连贯-->        <jdbcConnection driverClass="${jdbc.driverClass}"                        connectionURL="${jdbc.connectionURL}"                        userId="${jdbc.userId}"                        password="${jdbc.password}">            <!--解决mysql驱动降级到8.0后不生成指定数据库代码的问题-->            <property name="nullCatalogMeansCurrent" value="true" />        </jdbcConnection>        <!--指定生成model的门路-->        <javaModelGenerator targetPackage="com.macro.mall.tiny.mbg.model" targetProject="mall-tiny-generator\src\main\java"/>        <!--指定生成mapper.xml的门路-->        <sqlMapGenerator targetPackage="com.macro.mall.tiny.mbg.mapper" targetProject="mall-tiny-generator\src\main\resources"/>        <!--指定生成mapper接口的的门路-->        <javaClientGenerator type="XMLMAPPER" targetPackage="com.macro.mall.tiny.mbg.mapper"                             targetProject="mall-tiny-generator\src\main\java"/>        <!--生成全副表tableName设为%-->        <table tableName="ums_admin">            <generatedKey column="id" sqlStatement="MySql" identity="true"/>        </table>        <table tableName="ums_role">            <generatedKey column="id" sqlStatement="MySql" identity="true"/>        </table>        <table tableName="ums_admin_role_relation">            <generatedKey column="id" sqlStatement="MySql" identity="true"/>        </table>        <table tableName="ums_resource">            <generatedKey column="id" sqlStatement="MySql" identity="true"/>        </table>        <table tableName="ums_resource_category">            <generatedKey column="id" sqlStatement="MySql" identity="true"/>        </table>    </context></generatorConfiguration>

这里值得一提的是targetRuntime这个属性，设置不同的属性生成的代码和生成代码的应用形式会有所不同，罕用的有MyBatis3和MyBatis3DynamicSql两种，这里应用的是MyBatis3；
如果你想自定义MBG生成的代码的话，能够本人写一个CommentGenerator来继承DefaultCommentGenerator，这里我自定义了实体类代码的生成，增加了Swagger注解的反对；

package com.macro.mall.tiny.mbg;import org.mybatis.generator.api.IntrospectedColumn;import org.mybatis.generator.api.IntrospectedTable;import org.mybatis.generator.api.dom.java.CompilationUnit;import org.mybatis.generator.api.dom.java.Field;import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;import org.mybatis.generator.internal.DefaultCommentGenerator;import org.mybatis.generator.internal.util.StringUtility;import java.util.Properties;/** * 自定义正文生成器 * Created by macro on 2018/4/26. */public class CommentGenerator extends DefaultCommentGenerator {    private boolean addRemarkComments = false;    private static final String EXAMPLE_SUFFIX="Example";    private static final String MAPPER_SUFFIX="Mapper";    private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME="io.swagger.annotations.ApiModelProperty";    /**     * 设置用户配置的参数     */    @Override    public void addConfigurationProperties(Properties properties) {        super.addConfigurationProperties(properties);        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));    }    /**     * 给字段增加正文     */    @Override    public void addFieldComment(Field field, IntrospectedTable introspectedTable,                                IntrospectedColumn introspectedColumn) {        String remarks = introspectedColumn.getRemarks();        //依据参数和备注信息判断是否增加备注信息        if(addRemarkComments&&StringUtility.stringHasValue(remarks)){            //数据库中特殊字符须要本义            if(remarks.contains("\"")){                remarks = remarks.replace("\"","'");            }            //给model的字段增加swagger注解            field.addJavaDocLine("@ApiModelProperty(value = \""+remarks+"\")");        }    }    @Override    public void addJavaFileComment(CompilationUnit compilationUnit) {        super.addJavaFileComment(compilationUnit);        //只在model中增加swagger注解类的导入        String fullyQualifiedName = compilationUnit.getType().getFullyQualifiedName();        if(!fullyQualifiedName.contains(MAPPER_SUFFIX)&&!fullyQualifiedName.contains(EXAMPLE_SUFFIX)){            compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));        }    }}

最初咱们写个Generator类用于生成代码，间接运行main办法即可生成所有代码；

/** * 用于生产MBG的代码 * Created by macro on 2018/4/26. */public class Generator {    public static void main(String[] args) throws Exception {        //MBG 执行过程中的正告信息        List<String> warnings = new ArrayList<String>();        //当生成的代码反复时，笼罩原代码        boolean overwrite = true;        //读取咱们的 MBG 配置文件        InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");        ConfigurationParser cp = new ConfigurationParser(warnings);        Configuration config = cp.parseConfiguration(is);        is.close();        DefaultShellCallback callback = new DefaultShellCallback(overwrite);        //创立 MBG        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);        //执行生成代码        myBatisGenerator.generate(null);        //输入正告信息        for (String warning : warnings) {            System.out.println(warning);        }    }}

所有准备就绪，执行main办法，生成代码构造信息如下。

实现根本的CRUD操作

这里应用的是mall-tiny我的项目中权限治理性能相干表，具体能够参考《还在从零开始搭建我的项目？手撸了款疾速开发脚手架！》。

查看下MBG生成的Mapper接口，发现曾经蕴含了根本的CRUD办法，具体SQL实现也曾经在mapper.xml中生成了，单表CRUD间接调用对应办法即可；

public interface UmsAdminMapper {    long countByExample(UmsAdminExample example);    int deleteByExample(UmsAdminExample example);    int deleteByPrimaryKey(Long id);    int insert(UmsAdmin record);    int insertSelective(UmsAdmin record);    List<UmsAdmin> selectByExample(UmsAdminExample example);    UmsAdmin selectByPrimaryKey(Long id);    int updateByExampleSelective(@Param("record") UmsAdmin record, @Param("example") UmsAdminExample example);    int updateByExample(@Param("record") UmsAdmin record, @Param("example") UmsAdminExample example);    int updateByPrimaryKeySelective(UmsAdmin record);    int updateByPrimaryKey(UmsAdmin record);}

生成代码中有一些Example类，比方UmsAdminExample，咱们能够把它了解为一个条件构建器，用于构建SQL语句中的各种条件；

利用好MBG生成的代码即可实现单表的CRUD操作了，比方上面最常见的操作。

/** * 后盾用户治理Service实现类 * Created by macro on 2020/12/8. */@Servicepublic class UmsAdminServiceImpl implements UmsAdminService {    @Autowired    private UmsAdminMapper adminMapper;    @Autowired    private UmsAdminDao adminDao;    @Override    public void create(UmsAdmin entity) {        adminMapper.insert(entity);    }    @Override    public void update(UmsAdmin entity) {        adminMapper.updateByPrimaryKeySelective(entity);    }    @Override    public void delete(Long id) {        adminMapper.deleteByPrimaryKey(id);    }    @Override    public UmsAdmin select(Long id) {        return adminMapper.selectByPrimaryKey(id);    }    @Override    public List<UmsAdmin> listAll(Integer pageNum, Integer pageSize) {        PageHelper.startPage(pageNum, pageSize);        return adminMapper.selectByExample(new UmsAdminExample());    }}

进阶应用

想要用好MBG，下面的根底操作是不够的，还须要一些进阶的应用技巧。

条件查问

应用Example类构建查问条件能够很不便地实现条件查问。

这里以按用户名和状态查问后盾用户并按创立工夫降序排列为例，SQL实现如下；

SELECT    id,    username,    PASSWORD,    icon,    email,    nick_name,    note,    create_time,    login_time,STATUS FROM    ums_admin WHERE    ( username = 'macro' AND STATUS IN ( 0, 1 ) ) ORDER BY    create_time DESC;

对应的Java代码实现如下。

/** * 后盾用户治理Service实现类 * Created by macro on 2020/12/8. */@Servicepublic class UmsAdminServiceImpl implements UmsAdminService {        @Override    public List<UmsAdmin> list(Integer pageNum, Integer pageSize, String username, List<Integer> statusList) {        PageHelper.startPage(pageNum, pageSize);        UmsAdminExample umsAdminExample = new UmsAdminExample();        UmsAdminExample.Criteria criteria = umsAdminExample.createCriteria();        if(StrUtil.isNotEmpty(username)){            criteria.andUsernameEqualTo(username);        }        criteria.andStatusIn(statusList);        umsAdminExample.setOrderByClause("create_time desc");        return adminMapper.selectByExample(umsAdminExample);    }}

子查问

应用MBG生成的代码并不能实现子查问，须要本人手写SQL实现。

这里以按角色ID查问后盾用户为例，首先定义一个UmsAdminDao接口，这里约定下Dao外面寄存的办法都是自定义SQL实现的办法，首先在Dao接口中增加subList办法；

/** * Created by macro on 2020/12/9. */public interface UmsAdminDao {    List<UmsAdmin> subList(@Param("roleId") Long roleId);}

而后创立一个UmsAdminDao.xml文件，对应UmsAdminDao接口的SQL实现，写好对应的SQL实现，留神应用的resultMap MBG曾经帮咱们生成好了，无需本人手写。

<select id="subList" resultMap="com.macro.mall.tiny.mbg.mapper.UmsAdminMapper.BaseResultMap">    SELECT *    FROM ums_admin    WHERE id IN (SELECT admin_id FROM ums_admin_role_relation WHERE role_id = #{roleId})</select>

Group和Join查问

Group和Join查问也不能应用MBG生成的代码实现。

这里以按角色统计后盾用户数量为例，首先在Dao接口中增加groupList办法；

public interface UmsAdminDao {    List<RoleStatDto> groupList();}

而后在mapper.xml中增加对应的SQL实现，咱们能够通过给查问进去的列起别名，间接把列映射到resultType所定义的对象中去。

<select id="groupList" resultType="com.macro.mall.tiny.domain.RoleStatDto">    SELECT ur.id        AS roleId,           ur.NAME      AS roleName,           count(ua.id) AS count    FROM ums_role ur             LEFT JOIN ums_admin_role_relation uarr ON ur.id = uarr.role_id             LEFT JOIN ums_admin ua ON uarr.admin_id = ua.id    GROUP BY ur.id;</select>

条件删除

条件删除很简略，间接应用Example类结构删除条件即可。

这里以按用户名删除后盾用户为例，SQL实现如下；

DELETE FROM    ums_admin WHERE    username = 'andy';

对应Java中的实现为。

/** * 后盾用户治理Service实现类 * Created by macro on 2020/12/8. */@Servicepublic class UmsAdminServiceImpl implements UmsAdminService {    @Override    public void deleteByUsername(String username) {        UmsAdminExample example = new UmsAdminExample();        example.createCriteria().andUsernameEqualTo(username);        adminMapper.deleteByExample(example);    }}

条件批改

条件删除很简略，间接应用Example类结构批改条件，而后传入批改参数即可。

这里以按指定ID批改后盾用户的状态为例，SQL实现如下；

UPDATE ums_admin SET STATUS = 1 WHERE    id IN ( 1, 2 );

对应Java中的实现为。

/** * 后盾用户治理Service实现类 * Created by macro on 2020/12/8. */@Servicepublic class UmsAdminServiceImpl implements UmsAdminService {    @Override    public void updateByIds(List<Long> ids, Integer status) {        UmsAdmin record = new UmsAdmin();        record.setStatus(status);        UmsAdminExample example = new UmsAdminExample();        example.createCriteria().andIdIn(ids);        adminMapper.updateByExampleSelective(record,example);    }}

一对多查问

一对多查问无奈间接应用MBG生成的代码实现，须要手写SQL实现，并应用resultMap来进行后果集映射。

这里以按ID查问后盾用户信息（蕴含对应角色列表）为例，先在Dao接口中增加selectWithRoleList办法；

/** * Created by macro on 2020/12/9. */public interface UmsAdminDao {    AdminRoleDto selectWithRoleList(@Param("id") Long id);}

而后在mapper.xml中增加对应的SQL实现，这里有个小技巧，能够给角色表查问进去的列取个别名，增加一个role_前缀；

<select id="selectWithRoleList" resultMap="AdminRoleResult">    SELECT ua.*,           ur.id          AS role_id,           ur.NAME        AS role_name,           ur.description AS role_description,           ur.create_time AS role_create_time,           ur.STATUS      AS role_status,           ur.sort        AS role_sort    FROM ums_admin ua             LEFT JOIN ums_admin_role_relation uarr ON ua.id = uarr.admin_id             LEFT JOIN ums_role ur ON uarr.role_id = ur.id    WHERE ua.id = #{id}</select>

而后定义一个叫做AdminRoleResult的ResultMap，通过collection标签间接将以role_结尾的列映射到UmsRole对象中去即可。

<resultMap id="AdminRoleResult" type="com.macro.mall.tiny.domain.AdminRoleDto"           extends="com.macro.mall.tiny.mbg.mapper.UmsAdminMapper.BaseResultMap">    <collection property="roleList" resultMap="com.macro.mall.tiny.mbg.mapper.UmsRoleMapper.BaseResultMap"                columnPrefix="role_">    </collection></resultMap>

一对一查问

一对一查问无奈间接应用MBG生成的代码实现，须要手写SQL实现，并应用resultMap来进行后果集映射。

这里以按ID查问资源信息（包含分类信息）为例，先在Dao接口中增加selectResourceWithCate办法；

/** * Created by macro on 2020/12/9. */public interface UmsAdminDao {    ResourceWithCateDto selectResourceWithCate(@Param("id")Long id);}

而后在mapper.xml中增加对应的SQL实现，能够给分类表查问进去的列取个别名，增加一个cate_前缀；

<select id="selectResourceWithCate" resultMap="ResourceWithCateResult">    SELECT ur.*,           urc.id          AS cate_id,           urc.`name`      AS cate_name,           urc.create_time AS cate_create_time,           urc.sort        AS cate_sort    FROM ums_resource ur             LEFT JOIN ums_resource_category urc ON ur.category_id = urc.id    WHERE ur.id = #{id}</select>

而后定义一个叫做ResourceWithCateResult的ResultMap，通过association标签间接将以cate_结尾的列映射到UmsResourceCategory对象中去即可。

<resultMap id="ResourceWithCateResult" type="com.macro.mall.tiny.domain.ResourceWithCateDto"           extends="com.macro.mall.tiny.mbg.mapper.UmsResourceMapper.BaseResultMap">    <association property="resourceCategory"                 resultMap="com.macro.mall.tiny.mbg.mapper.UmsResourceCategoryMapper.BaseResultMap"                 columnPrefix="cate_">    </association></resultMap>

总结

总的来说MyBatis官网代码生成器MBG还是很弱小的，能够生成一些罕用的单表CRUD办法，缩小了咱们的工作量。然而对于子查问、多表查问和一些简单查问反对有点偏弱，仍然须要在mapper.xml中手写SQL实现。

参考资料

官网文档：https://mybatis.org/generator...

我的项目源码地址

https://github.com/macrozheng...

本文 GitHub https://github.com/macrozheng/mall-learning 曾经收录，欢送大家Star！