Освободи руки! Официальный инструмент генерации кода MyBatis великолепен!

Spring Boot Java
Освободи руки! Официальный инструмент генерации кода MyBatis великолепен!

Адрес фактического центра электронной коммерции SpringBoot (40k+star):GitHub.com/macro-positive/…

Резюме

В процессе использования MyBatis, если все классы сущностей и однотабличные CRUD-коды нужно писать от руки, это будет довольно хлопотно. В решении этой проблемы нам может помочь официальный генератор кода MyBatis Генератор MyBatis Генератор кода также используется в моем торговом центре проектов с открытым исходным кодом, и к нему неплохо привыкнуть. Эта статья познакомит вас с использованием и навыками использования MyBatis Generator, надеюсь, она будет вам полезна!

Введение

Генератор MyBatis (сокращенно MBG) — это инструмент для генерации кода, официально предоставляемый MyBatis. Классы сущностей, однотабличные CRUD-коды и файлы mapper.xml можно генерировать напрямую через таблицы базы данных, тем самым освобождая наши руки!

начать использовать

Сначала мы используем MBG с вводным примером, который включает в себя основные операции CRUD.

Интегрированный МБГ

  • существует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на источниках данных и MyBatismapper.xmlПуть файла конфигурации, здесь, чтобы быть согласованным, сгенерированным на MBGresources/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.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.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);
        }
    }
}
  • Все готово, выполните основной метод и сгенерируйте информацию о структуре кода следующим образом.

Реализовать основные операции CRUD

используется здесьmall-tinyПодробную информацию о соответствующей таблице функций управления разрешениями в проекте см.«Все еще строите проект с нуля? Строительные леса ручной работы для быстрого развития! 》.

  • Глядя на интерфейс Mapper, сгенерированный MBG, обнаруживается, что основные методы 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);
}
  • В сгенерированном коде есть несколько классов-примеров, таких как UmsAdminExample, мы можем понимать его как построитель условий для построения различных условий в операторах SQL;

  • Используйте код, сгенерированный MBG, для выполнения операции CRUD для одной таблицы, например наиболее распространенные операции ниже.
/**
 * 后台用户管理Service实现类
 * Created by macro on 2020/12/8.
 */
@Service
public 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.
 */
@Service
public 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 самостоятельно.

  • Вот пример запроса фоновых пользователей по идентификатору роли. Во-первых, определите интерфейс UmsAdminDao. Здесь согласовано, что все методы, хранящиеся в Dao, являются методами, реализованными пользовательским SQL. Во-первых, добавьте метод в интерфейс Dao.subListметод;
/**
 * Created by macro on 2020/12/9.
 */
public interface UmsAdminDao {

    List<UmsAdmin> subList(@Param("roleId") Long roleId);
}
  • Затем создайте файл UmsAdminDao.xml, соответствующий реализации SQL интерфейса UmsAdminDao, и напишите соответствующую реализацию SQL.Обратите внимание, что используемая MBG resultMap уже сгенерирована для нас, поэтому нет необходимости писать ее самостоятельно.
<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 также нельзя реализовать с помощью кода, сгенерированного MBG.

  • Вот пример подсчета количества фоновых пользователей по ролям, сначала добавьте в интерфейс DaogroupListметод;
public interface UmsAdminDao {

    List<RoleStatDto> groupList();
}
  • Затем добавьте соответствующую реализацию SQL в mapper.xml, мы можем напрямую сопоставить столбец с объектом, определенным в 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.
 */
@Service
public 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.
 */
@Service
public 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 для сопоставления набора результатов.

  • Вот пример запроса фоновой информации о пользователе (включая соответствующий список ролей) по идентификатору, сначала добавьте его в интерфейс Dao.selectWithRoleListметод;
/**
 * Created by macro on 2020/12/9.
 */
public interface UmsAdminDao {

    AdminRoleDto selectWithRoleList(@Param("id") Long id);
}
  • Затем добавьте соответствующую реализацию SQL в mapper.xml, вот небольшая хитрость, вы можете взять псевдоним для запрашиваемого столбца из таблицы ролей и добавить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Карта результатов, через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 для сопоставления набора результатов.

  • Вот пример запроса информации о ресурсе (включая информацию о классификации) по идентификатору, сначала добавьте его в интерфейс Dao.selectResourceWithCateметод;
/**
 * Created by macro on 2020/12/9.
 */
public interface UmsAdminDao {

    ResourceWithCateDto selectResourceWithCate(@Param("id")Long id);
}
  • Затем добавьте соответствующую реализацию SQL в mapper.xml, вы можете взять псевдоним для запрашиваемого столбца из таблицы классификации и добавить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Карта результатов, через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, уменьшая нашу рабочую нагрузку. Однако поддержка подзапросов, многотабличных запросов и некоторых сложных запросов слабовата, и по-прежнему необходимо писать реализацию SQL в mapper.xml.

использованная литература

Официальная документация:не поставил boost.org/generator/i…

Адрес исходного кода проекта

GitHub.com/macro-positive/…

Эта статьяGitHubGitHub.com/macro-positive/…Записано, приветствую всех на Star!

Категории