文档章节

Spring Boot项目利用MyBatis Generator进行数据层代码自动生成

CodeSheep
 CodeSheep
发布于 02/14 07:39
字数 1053
阅读 38
收藏 6

Profile


概 述

MyBatis Generator (简称 MBG) 是一个用于 MyBatis和 iBATIS的代码生成器。它可以为 MyBatis的所有版本以及 2.2.0之后的 iBATIS版本自动生成 ORM层代码,典型地包括我们日常需要手写的 POJOmapper xml 以及 mapper 接口等。MyBatis Generator 自动生成的 ORM层代码几乎可以应对大部分 CRUD 数据表操作场景,可谓是一个生产力工具啊!

注: 本文首发于 My Personal Blog:CodeSheep·程序羊,欢迎光临 小站


数据库准备与工程搭建

  • 首先我们准备一个 MySQL数据表 user_info用于下文实验

里面插入了若干条数据:

准备数据表

  • 新建一个Spring Boot 工程

  • 引入 MyBatis Generator 依赖

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.7</version>
    <scope>provided</scope>
</dependency>
  • 引入 MyBatis Generator Maven 插件
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.7</version>

    <configuration>
        <configurationFile>src/main/resources/mybatis-generator.xml</configurationFile>
        <overwrite>true</overwrite>
    </configuration>

    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.12</version>
        </dependency>
    </dependencies>
</plugin>

MyBatis Generator Maven 插件引入以后,我们可以在 Spring Boot工程的 Maven插件工具栏中看到新增的插件选项,类似下图:

MyBatis Generator Maven 插件


准备 MyBatis Generator 配置文件

MyBatis Generator 也需要一个 xml格式的配置文件,该文件的位置配在了上文 引入 MyBatis Generator Maven 插件的 xml配置里,即src/main/resources/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">     

        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://121.196.123.245:3306/demo"
                userId="root"
                password="xxxxxx" />

        <javaModelGenerator targetPackage="cn.codesheep.springbt_mybatis_generator.entity" targetProject="src/main/java"></javaModelGenerator>

        <sqlMapGenerator targetPackage="mapper"  targetProject="src/main/resources"></sqlMapGenerator>

        <javaClientGenerator targetPackage="cn.codesheep.springbt_mybatis_generator.mapper" targetProject="src/main/java" type="XMLMAPPER"></javaClientGenerator>

        <table tableName="user_info">
            <property name="modelOnly" value="false"/>
        </table>

    </context>

</generatorConfiguration>

上面 xml中几个关键的配置简介如下:

  • < jdbcConnection /> 数据库连接配置,至关重要
  • <javaModelGenerator /> 指定自动生成的 POJO置于哪个包下
  • <sqlMapGenerator /> 指定自动生成的 mapper.xml置于哪个包下
  • <javaClientGenerator /> 指定自动生成的 DAO接口置于哪个包下
  • <table /> 指定数据表名,可以使用_和%通配符

更多关于 MyBatis Generator 配置的内容,可以移步 官方文档


运行 MyBatis Generator

直接通过 IDEA的 Maven图形化插件来运行 MyBatis Generator,其自动生成的过程 和 生成的结果如下图所示:

自动生成的过程和结果

很明显,通过 MyBatis Generator,已经很方便的帮我们自动生成了 POJOmapper xml 以及 mapper接口,接下来我们看看自动生成的代码怎么用!


自动生成的代码如何使用

我们发现通过 MyBatis Generator自动生成的代码中带有一个 Example文件,比如上文中的 UserInfoExample,其实 Example文件对于平时快速开发还是有很大好处的,它能节省很多写 sql语句的时间,举几个实际的例子吧:

  • 单条件模糊搜索 + 排序

在我们的例子中,假如我想通过用户名 user_name来在 MySQL数据表 user_info中进行模糊搜索,并对结果进行排序,此时利用UserInfoExample可以方便快速的实现:

@Autowired
private UserInfoMapper userInfoMapper;

public List<UserInfo> searchUserByUserName( String userName ) {

    UserInfoExample userInfoExample = new UserInfoExample();
    userInfoExample.createCriteria().andUserNameLike( '%'+ userName +'%' ); // 设置模糊搜索的条件

    String orderByClause = "user_name DESC";
    userInfoExample.setOrderByClause( orderByClause );  // 设置通过某个字段排序的条件

    return userInfoMapper.selectByExample( userInfoExample );
}
  • 多条件精确搜索

再比如,我们想通过电话号码 phone和用户名 user_name 两个字段来在数据表 user_info中实现精确搜索,则可以如下实现:

public List<UserInfo> multiConditionsSearch( UserInfo userInfo ) {

    UserInfoExample userInfoExample = new UserInfoExample();
    UserInfoExample.Criteria criteria = userInfoExample.createCriteria();

    if( !"".equals(userInfo.getPhone()) )
        criteria.andPhoneEqualTo( userInfo.getPhone() );
    if( !"".equals(userInfo.getUserName()) )
        criteria.andUserNameEqualTo( userInfo.getUserName() );

    return userInfoMapper.selectByExample( userInfoExample );
}

很明显可以看出的是,我们是通过直接编写代码逻辑来取代编写 SQL语句,因此还是十分直观和容易理解的!


后 记

由于能力有限,若有错误或者不当之处,还请大家批评指正,一起学习交流!



© 著作权归作者所有

共有 人打赏支持
CodeSheep

CodeSheep

粉丝 215
博文 73
码字总数 100895
作品 0
南京
程序员
私信 提问
Spring Boot 整合MyBatis

Spring Boot官方提供了Spring Data的支持,但是却没有提供MyBatis的支持。 因为,Spring Data是Spring旗下的子产品,而MyBatis却不是。 本文通过一个小例子来实现Spring Boot 与MyBatis的整合...

_流云_
2017/04/17
0
0
SpringMVC+MyBatis项目总结(一)

环境Spring3.2+Mybatis 3.2.7,JDK 1.6,开发工具Myeclipse 2014 GA Pro,数据库MySQL 5.5(数据采用之前Oracle的,直接用Navicat从Oracle导入到Mysql,然后改了一下数据类型,主键自增) Mappe...

Eviltuzki
2015/06/05
0
2
Spring boot Mybatis 整合(完整版)

个人开源项目 springboot+mybatis+thymeleaf+docker构建的个人站点开源项目(集成了个人主页、个人作品、个人博客) 朋友自制的springboot接口文档组件swagger2 更多干货 SpringBoot系列目录...

舒运
2018/07/09
0
0
mybatis generator 生成检索条件问题

使用mybatis generator生成检索条件,想生成如下sql语句: select * from t_base t where t.aaa <> t.bbb 疑问:我用generator自动生成的Example类中的Criteria,仅能生成对[值]的查询条件,...

sg4567
2018/10/16
97
1
关于mybatis下的继承关系映射

假设我有这样3张表 使用mybatis generator工具的话如何才能实现自动生成这样的继承关系,还是生成后需要自己手动去添加的? 另外,对于数据库设计,这样的抽象式的设计值得推荐吗?另外,mybatis需...

yongzhong
2014/12/02
1K
4

没有更多内容

加载失败,请刷新页面

加载更多

记录replugin使用的一个坑

反复编译插件放入宿主中,一直出现如下错误: android.content.res.Resources$NotFoundException: Resource ID #0x7f050000 type #0x5 is not valid 回滚代码,重启AS还是出错。最终发现将宿...

Gemini-Lin
今天
2
0
Vert.x系列(二)--EventBusImpl源码分析

前言:Vert.x 实现了2种完成不同的eventBus: EventBusImpl(A local event bus implementation)和 它的子类 ClusteredEventBus(An event bus implementation that clusters with other Ve......

冷基
今天
2
0
Perl - 获取文件项目

参考:http://www.runoob.com/perl/perl-directories.html 下面返回JSON格式的文件列表 #!/usr/bin/perluse strict;use warnings;use utf8;use feature ':5.26';require Fi......

wffger
昨天
3
0
vue组件系列3、查询下载

直接源码,虽然样式样式不好看,逻辑也不是最优,但是可以留作纪念。毕竟以后类似的功能只需要优化就可以了,不用每次都重头开始。。。 <template> <div class="pre_upload"> <div ...

轻轻的往前走
昨天
3
0
java浅复制和深复制

之前写了数组的复制,所以这里继续总结一下浅复制和深复制。 浅拷贝:对基本数据类型进行值传递,对引用数据类型进行引用传递般的拷贝。 深拷贝:对基本数据类型进行值传递,对引用数据类型,...

woshixin
昨天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部