Spring Boot MyBatis

不想你离开。 提交于 2020-03-11 10:17:57

Spring Boot 整合 Druid

概述

Druid 是阿里巴巴开源平台上的一个项目,整个项目由数据库连接池、插件框架和 SQL 解析器组成。该项目主要是为了扩展 JDBC 的一些限制,可以让程序员实现一些特殊的需求,比如向密钥服务请求凭证、统计 SQL 信息、SQL 性能收集、SQL 注入检查、SQL 翻译等,程序员可以通过定制来实现自己需要的功能。

Druid 是目前最好的数据库连接池,在功能、性能、扩展性方面,都超过其他数据库连接池,包括 DBCP、C3P0、BoneCP、Proxool、JBoss DataSource。Druid 已经在阿里巴巴部署了超过 600 个应用,经过多年生产环境大规模部署的严苛考验。Druid 是阿里巴巴开发的号称为监控而生的数据库连接池!

引入依赖

在 pom.xml 文件中引入 druid-spring-boot-starter 依赖


com.alibaba
druid-spring-boot-starter
1.1.10

1
2
3
4
5
引入数据库连接依赖


mysql
mysql-connector-java
runtime

1
2
3
4
5

配置 application.yml

在 application.yml 中配置数据库连接

spring:
datasource:
druid:
url: jdbc:mysql://ip:port/dbname?useUnicode=true&characterEncoding=utf-8&useSSL=false
username: root
password: 123456
initial-size: 1
min-idle: 1
max-active: 20
test-on-borrow: true
# MySQL 8.x: com.mysql.cj.jdbc.Driver
driver-class-name: com.mysql.jdbc.Driver

PS: 具体使用方法在 测试 MyBatis 操作数据库 章节中进行介绍,本章节仅为准备环节。

Spring Boot 整合 tk.mybatis

概述

tk.mybatis 是在 MyBatis 框架的基础上提供了很多工具,让开发更加高效

引入依赖

在 pom.xml 文件中引入 mapper-spring-boot-starter 依赖,该依赖会自动引入 MyBaits 相关依赖


tk.mybatis
mapper-spring-boot-starter
2.0.2

1
2
3
4
5

配置 application.yml

配置 MyBatis

mybatis:
type-aliases-package: 实体类的存放路径,如:com.funtl.hello.spring.boot.entity
mapper-locations: classpath:mapper/*.xml
1
2
3

创建一个通用的父级接口

主要作用是让 DAO 层的接口继承该接口,以达到使用 tk.mybatis 的目的

package com.funtl.utils;

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

/**

  • 自己的 Mapper
  • 特别注意,该接口不能被扫描到,否则会出错
  • Title: MyMapper

  • Description:

  • @author Lusifer
  • @version 1.0.0
  • @date 2018/5/29 0:57
    */
    public interface MyMapper extends Mapper, MySqlMapper {
    }
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    PS: 具体使用方法在 测试 MyBatis 操作数据库 章节中进行介绍,本章节仅为准备环节。

Spring Boot 整合 PageHelper

概述

PageHelper 是 Mybatis 的分页插件,支持多数据库、多数据源。可以简化数据库的分页查询操作,整合过程也极其简单,只需引入依赖即可。

引入依赖

在 pom.xml 文件中引入 pagehelper-spring-boot-starter 依赖


com.github.pagehelper
pagehelper-spring-boot-starter
1.2.5

1
2
3
4
5
PS: 具体使用方法在 测试 MyBatis 操作数据库 章节中进行介绍,本章节仅为准备环节。

使用 MyBatis 的 Maven 插件生成代码
我们无需手动编写 实体类、DAO、XML 配置文件,只需要使用 MyBatis 提供的一个 Maven 插件就可以自动生成所需的各种文件便能够满足基本的业务需求,如果业务比较复杂只需要修改相关文件即可。

配置插件

在 pom.xml 文件中增加 mybatis-generator-maven-plugin 插件




org.mybatis.generator
mybatis-generator-maven-plugin
1.3.5

${basedir}/src/main/resources/generator/generatorConfig.xml
true
true



mysql
mysql-connector-java
${mysql.version}


tk.mybatis
mapper
3.4.4





1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
configurationFile:自动生成所需的配置文件路径

自动生成的配置

在 src/main/resources/generator/ 目录下创建 generatorConfig.xml 配置文件:

<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">



<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
    <property name="beginningDelimiter" value="`"/>
    <property name="endingDelimiter" value="`"/>
    
    <!-- 配置 tk.mybatis 插件 -->
    <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
        <property name="mappers" value="com.funtl.utils.MyMapper"/>
    </plugin>

    <!-- 配置数据库连接 -->
    <jdbcConnection
            driverClass="${jdbc.driverClass}"
            connectionURL="${jdbc.connectionURL}"
            userId="${jdbc.username}"
            password="${jdbc.password}">
    </jdbcConnection>

    <!-- 配置实体类存放路径 -->
    <javaModelGenerator targetPackage="com.funtl.hello.spring.boot.entity" targetProject="src/main/java"/>

    <!-- 配置 XML 存放路径 -->
    <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>

    <!-- 配置 DAO 存放路径 -->
    <javaClientGenerator
            targetPackage="com.funtl.hello.spring.boot.mapper"
            targetProject="src/main/java"
            type="XMLMAPPER"/>

    <!-- 配置需要指定生成的数据库和表,% 代表所有表 -->
    <table catalog="myshop" tableName="%">
        <!-- mysql 配置 -->
        <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
    </table>
</context>


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

配置数据源

在 src/main/resources 目录下创建 jdbc.properties 数据源配置:

MySQL 8.x: com.mysql.cj.jdbc.Driver

jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://ip:port/dbname?useUnicode=true&characterEncoding=utf-8&useSSL=false
jdbc.username=root
jdbc.password=123456
1
2
3
4
5

插件自动生成命令

mvn mybatis-generator:generate
1
成功生成控制台打印的消息,如:

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building hello-spring-boot 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- mybatis-generator-maven-plugin:1.3.5:generate (default-cli) @ hello-spring-boot ---
[INFO] Connecting to the Database
[INFO] Introspecting table %
[INFO] Generating Record class for table tb_order
[INFO] Generating Mapper Interface for table tb_order
[INFO] Generating SQL Map for table tb_order
[INFO] Generating Record class for table tb_item_cat
[INFO] Generating Mapper Interface for table tb_item_cat
[INFO] Generating SQL Map for table tb_item_cat
[INFO] Generating Record class for table tb_item_desc
[INFO] Generating Mapper Interface for table tb_item_desc
[INFO] Generating SQL Map for table tb_item_desc
[INFO] Generating Record class for table tb_order_shipping
[INFO] Generating Mapper Interface for table tb_order_shipping
[INFO] Generating SQL Map for table tb_order_shipping
[INFO] Generating Record class for table tb_user
[INFO] Generating Mapper Interface for table tb_user
[INFO] Generating SQL Map for table tb_user
[INFO] Generating Record class for table tb_content
[INFO] Generating Mapper Interface for table tb_content
[INFO] Generating SQL Map for table tb_content
[INFO] Generating Record class for table tb_item_param_item
[INFO] Generating Mapper Interface for table tb_item_param_item
[INFO] Generating SQL Map for table tb_item_param_item
[INFO] Generating Record class for table tb_order_item
[INFO] Generating Mapper Interface for table tb_order_item
[INFO] Generating SQL Map for table tb_order_item
[INFO] Generating Record class for table tb_content_category
[INFO] Generating Mapper Interface for table tb_content_category
[INFO] Generating SQL Map for table tb_content_category
[INFO] Generating Record class for table tb_item
[INFO] Generating Mapper Interface for table tb_item
[INFO] Generating SQL Map for table tb_item
[INFO] Generating Record class for table tb_item_param
[INFO] Generating Mapper Interface for table tb_item_param
[INFO] Generating SQL Map for table tb_item_param
[INFO] Saving file TbOrderMapper.xml
[INFO] Saving file TbItemCatMapper.xml
[INFO] Saving file TbItemDescMapper.xml
[INFO] Saving file TbOrderShippingMapper.xml
[INFO] Saving file TbUserMapper.xml
[INFO] Saving file TbContentMapper.xml
[INFO] Saving file TbItemParamItemMapper.xml
[INFO] Saving file TbOrderItemMapper.xml
[INFO] Saving file TbContentCategoryMapper.xml
[INFO] Saving file TbItemMapper.xml
[INFO] Saving file TbItemParamMapper.xml
[INFO] Saving file TbOrder.java
[INFO] Saving file TbOrderMapper.java
[INFO] Saving file TbItemCat.java
[INFO] Saving file TbItemCatMapper.java
[INFO] Saving file TbItemDesc.java
[INFO] Saving file TbItemDescMapper.java
[INFO] Saving file TbOrderShipping.java
[INFO] Saving file TbOrderShippingMapper.java
[INFO] Saving file TbUser.java
[INFO] Saving file TbUserMapper.java
[INFO] Saving file TbContent.java
[INFO] Saving file TbContentMapper.java
[INFO] Saving file TbItemParamItem.java
[INFO] Saving file TbItemParamItemMapper.java
[INFO] Saving file TbOrderItem.java
[INFO] Saving file TbOrderItemMapper.java
[INFO] Saving file TbContentCategory.java
[INFO] Saving file TbContentCategoryMapper.java
[INFO] Saving file TbItem.java
[INFO] Saving file TbItemMapper.java
[INFO] Saving file TbItemParam.java
[INFO] Saving file TbItemParamMapper.java
[WARNING] Column id, specified as an identity column in table tb_order, does not exist in the table.
[WARNING] Column id, specified as an identity column in table tb_item_desc, does not exist in the table.
[WARNING] Column id, specified as an identity column in table tb_order_shipping, does not exist in the table.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.901 s
[INFO] Finished at: 2018-05-29T01:24:17+08:00
[INFO] Final Memory: 12M/192M
[INFO] ------------------------------------------------------------------------
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

完整配置案例

<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">


<!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
    一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖
 -->
<property name="autoDelimitKeywords" value="false"/>
<!-- 生成的Java文件的编码 -->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 格式化java代码 -->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代码 -->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

<!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

<!-- 必须要有的,使用这个配置链接数据库
    @TODO:是否可以扩展
    # MySQL 8.x: com.mysql.cj.jdbc.Driver
 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin">
    <!-- 这里面可以设置property属性,每一个property属性都设置到配置的Driver上 -->
</jdbcConnection>

<!-- java类型处理器 
    用于处理DB中的类型到Java中的类型,默认使用JavaTypeResolverDefaultImpl;
    注意一点,默认会先尝试使用Integer,Long,Short等来对应DECIMAL和 NUMERIC数据类型; 
-->
<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
    <!-- 
        true:使用BigDecimal对应DECIMAL和 NUMERIC数据类型
        false:默认,
            scale>0;length>18:使用BigDecimal;
            scale=0;length[10,18]:使用Long;
            scale=0;length[5,9]:使用Integer;
            scale=0;length<5:使用Short;
     -->
    <property name="forceBigDecimals" value="false"/>
</javaTypeResolver>


<!-- java模型创建器,是必须要的元素
    负责:1,key类(见context的defaultModelType);2,java类;3,查询类
    targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制;
    targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,如果目录不存在,MBG不会自动建目录
 -->
<javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java">
    <!--  for MyBatis3/MyBatis3Simple
        自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter;
     -->
    <property name="constructorBased" value="false"/>

    <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
    <property name="enableSubPackages" value="true"/>

    <!-- for MyBatis3 / MyBatis3Simple
        是否创建一个不可变的类,如果为true,
        那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类
     -->
    <property name="immutable" value="false"/>

    <!-- 设置一个根对象,
        如果设置了这个根对象,那么生成的keyClass或者recordClass会继承这个类;在Table的rootClass属性中可以覆盖该选项
        注意:如果在key class或者record class中有root class相同的属性,MBG就不会重新生成这些属性了,包括:
            1,属性名相同,类型相同,有相同的getter/setter方法;
     -->
    <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>

    <!-- 设置是否在getter方法中,对String类型字段调用trim()方法 -->
    <property name="trimStrings" value="true"/>
</javaModelGenerator>


<!-- 生成SQL map的XML文件生成器,
    注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),
        或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置
    targetPackage/targetProject:同javaModelGenerator
 -->
<sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources">
    <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
    <property name="enableSubPackages" value="true"/>
</sqlMapGenerator>


<!-- 对于mybatis来说,即生成Mapper接口,注意,如果没有配置该元素,那么默认不会生成Mapper接口 
    targetPackage/targetProject:同javaModelGenerator
    type:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):
        1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式创建(SQL生成在annotation中),不会生成对应的XML;
        2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,但是XML会生成在XML中;
        3,XMLMAPPER:会生成Mapper接口,接口完全依赖XML;
    注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER
-->
<javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java">
    <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
    <property name="enableSubPackages" value="true"/>

    <!-- 可以为所有生成的接口添加一个父接口,但是MBG只负责生成,不负责检查
    <property name="rootInterface" value=""/>
     -->
</javaClientGenerator>

<!-- 选择一个table来生成相关文件,可以有一个或多个table,必须要有table元素
    选择的table会生成一下文件:
    1,SQL map文件
    2,生成一个主键类;
    3,除了BLOB和主键的其他字段的类;
    4,包含BLOB的类;
    5,一个用户生成动态查询的条件类(selectByExample, deleteByExample),可选;
    6,Mapper接口(可选)
    tableName(必要):要生成对象的表名;
    注意:大小写敏感问题。正常情况下,MBG会自动的去识别数据库标识符的大小写敏感度,在一般情况下,MBG会
        根据设置的schema,catalog或tablename去查询数据表,按照下面的流程:
        1,如果schema,catalog或tablename中有空格,那么设置的是什么格式,就精确的使用指定的大小写格式去查询;
        2,否则,如果数据库的标识符使用大写的,那么MBG自动把表名变成大写再查找;
        3,否则,如果数据库的标识符使用小写的,那么MBG自动把表名变成小写再查找;
        4,否则,使用指定的大小写格式查询;
    另外的,如果在创建表的时候,使用的""把数据库对象规定大小写,就算数据库标识符是使用的大写,在这种情况下也会使用给定的大小写来创建表名;
    这个时候,请设置delimitIdentifiers="true"即可保留大小写格式;
    可选:
    1,schema:数据库的schema;
    2,catalog:数据库的catalog;
    3,alias:为数据表设置的别名,如果设置了alias,那么生成的所有的SELECT SQL语句中,列名会变成:alias_actualColumnName
    4,domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面;
    5,enableInsert(默认true):指定是否生成insert语句;
    6,enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get);
    7,enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句;
    8,enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update);
    9,enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete);
    10,enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句;
    11,enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询);
    12,enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性);
    13,modelType:参考context元素的defaultModelType,相当于覆盖;
    14,delimitIdentifiers:参考tableName的解释,注意,默认的delimitIdentifiers是双引号,如果类似MYSQL这样的数据库,使用的是`(反引号,那么还需要设置context的beginningDelimiter和endingDelimiter属性)
    15,delimitAllColumns:设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false,delimitIdentifiers参考context的属性
    注意,table里面很多参数都是对javaModelGenerator,context等元素的默认属性的一个复写;
 -->
<table tableName="userinfo" >

    <!-- 参考 javaModelGenerator 的 constructorBased属性-->
    <property name="constructorBased" value="false"/>

    <!-- 默认为false,如果设置为true,在生成的SQL中,table名字不会加上catalog或schema; -->
    <property name="ignoreQualifiersAtRuntime" value="false"/>

    <!-- 参考 javaModelGenerator 的 immutable 属性 -->
    <property name="immutable" value="false"/>

    <!-- 指定是否只生成domain类,如果设置为true,只生成domain类,如果还配置了sqlMapGenerator,那么在mapper XML文件中,只生成resultMap元素 -->
    <property name="modelOnly" value="false"/>

    <!-- 参考 javaModelGenerator 的 rootClass 属性 
    <property name="rootClass" value=""/>
     -->

    <!-- 参考javaClientGenerator 的  rootInterface 属性
    <property name="rootInterface" value=""/>
    -->

    <!-- 如果设置了runtimeCatalog,那么在生成的SQL中,使用该指定的catalog,而不是table元素上的catalog 
    <property name="runtimeCatalog" value=""/>
    -->

    <!-- 如果设置了runtimeSchema,那么在生成的SQL中,使用该指定的schema,而不是table元素上的schema 
    <property name="runtimeSchema" value=""/>
    -->

    <!-- 如果设置了runtimeTableName,那么在生成的SQL中,使用该指定的tablename,而不是table元素上的tablename 
    <property name="runtimeTableName" value=""/>
    -->

    <!-- 注意,该属性只针对MyBatis3Simple有用;
        如果选择的runtime是MyBatis3Simple,那么会生成一个SelectAll方法,如果指定了selectAllOrderByClause,那么会在该SQL中添加指定的这个order条件;
     -->
    <property name="selectAllOrderByClause" value="age desc,username asc"/>

    <!-- 如果设置为true,生成的model类会直接使用column本身的名字,而不会再使用驼峰命名方法,比如BORN_DATE,生成的属性名字就是BORN_DATE,而不会是bornDate -->
    <property name="useActualColumnNames" value="false"/>


    <!-- generatedKey用于生成生成主键的方法,
        如果设置了该元素,MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素,该元素可选
        column:主键的列名;
        sqlStatement:要生成的selectKey语句,有以下可选项:
            Cloudscape:相当于selectKey的SQL为: VALUES IDENTITY_VAL_LOCAL()
            DB2       :相当于selectKey的SQL为: VALUES IDENTITY_VAL_LOCAL()
            DB2_MF    :相当于selectKey的SQL为:SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
            Derby      :相当于selectKey的SQL为:VALUES IDENTITY_VAL_LOCAL()
            HSQLDB      :相当于selectKey的SQL为:CALL IDENTITY()
            Informix  :相当于selectKey的SQL为:select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
            MySql      :相当于selectKey的SQL为:SELECT LAST_INSERT_ID()
            SqlServer :相当于selectKey的SQL为:SELECT SCOPE_IDENTITY()
            SYBASE      :相当于selectKey的SQL为:SELECT @@IDENTITY
            JDBC      :相当于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性
    <generatedKey column="" sqlStatement=""/>
     -->

    <!-- 
        该元素会在根据表中列名计算对象属性名之前先重命名列名,非常适合用于表中的列都有公用的前缀字符串的时候,
        比如列名为:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等;
        那么就可以设置searchString为"^CUST_",并使用空白替换,那么生成的Customer对象中的属性名称就不是
        custId,custName等,而是先被替换为ID,NAME,EMAIL,然后变成属性:id,name,email;
        注意,MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的,
        如果使用了columnOverride元素,该属性无效;
    <columnRenamingRule searchString="" replaceString=""/>
     -->


     <!-- 用来修改表中某个列的属性,MBG会使用修改后的列来生成domain的属性;
         column:要重新设置的列名;
         注意,一个table元素中可以有多个columnOverride元素哈~
      -->
     <columnOverride column="username">
         <!-- 使用property属性来指定列要生成的属性名称 -->
         <property name="property" value="userName"/>

         <!-- javaType用于指定生成的domain的属性类型,使用类型的全限定名
         <property name="javaType" value=""/>
          -->

         <!-- jdbcType用于指定该列的JDBC类型 
         <property name="jdbcType" value=""/>
          -->

         <!-- typeHandler 用于指定该列使用到的TypeHandler,如果要指定,配置类型处理器的全限定名
             注意,mybatis中,不会生成到mybatis-config.xml中的typeHandler
             只会生成类似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述
         <property name="jdbcType" value=""/>
         -->

         <!-- 参考table元素的delimitAllColumns配置,默认为false
         <property name="delimitedColumnName" value=""/>
          -->
     </columnOverride>

     <!-- ignoreColumn设置一个MGB忽略的列,如果设置了改列,那么在生成的domain中,生成的SQL中,都不会有该列出现 
         column:指定要忽略的列的名字;
         delimitedColumnName:参考table元素的delimitAllColumns配置,默认为false
         注意,一个table元素中可以有多个ignoreColumn元素
     <ignoreColumn column="deptId" delimitedColumnName=""/>
     -->
</table>

测试 MyBatis 操作数据库

本节视频

【视频】微服务框架-SpringBoot-MyBatis-测试

使用 tk.mybatis 操作数据库

经过之前章节一系列的配置之后,我们已经满足了使用 MyBaits 操作数据库的必要条件,下面是使用 tk.mybatis 操作数据库的例子。

我们以测试操作用户表为例(tb_user)

修改入口类

需要使用 @MapperScan 注解来指定 Mapper 接口的路径

PS: 注意这里的 @MapperScan 注解是 tk.mybatis.spring.annotation.MapperScan; 包下的

package com.funtl.hello.spring.boot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import tk.mybatis.spring.annotation.MapperScan;

@SpringBootApplication
@MapperScan(basePackages = "com.funtl.hello.spring.boot.mapper")
public class HelloSpringBootApplication {

public static void main(String[] args) {
    SpringApplication.run(HelloSpringBootApplication.class, args);
}

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

创建测试类

package com.funtl.hello.spring.boot;

import com.funtl.hello.spring.boot.entity.TbUser;
import com.funtl.hello.spring.boot.mapper.TbUserMapper;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Rollback;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.transaction.annotation.Transactional;
import tk.mybatis.mapper.entity.Example;

import java.util.Date;
import java.util.List;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = HelloSpringBootApplication.class)
@Transactional
@Rollback
public class MyBatisTests {

/**
 * 注入数据查询接口
 */
@Autowired
private TbUserMapper tbUserMapper;

/**
 * 测试插入数据
 */
@Test
public void testInsert() {
    // 构造一条测试数据
    TbUser tbUser = new TbUser();
    tbUser.setUsername("Lusifer");
    tbUser.setPassword("123456");
    tbUser.setPhone("15888888888");
    tbUser.setEmail("topsale@vip.qq.com");
    tbUser.setCreated(new Date());
    tbUser.setUpdated(new Date());

    // 插入数据
    tbUserMapper.insert(tbUser);
}

/**
 * 测试删除数据
 */
@Test
public void testDelete() {
    // 构造条件,等同于 DELETE from tb_user WHERE username = 'Lusifer'
    Example example = new Example(TbUser.class);
    example.createCriteria().andEqualTo("username", "Lusifer");

    // 删除数据
    tbUserMapper.deleteByExample(example);
}

/**
 * 测试修改数据
 */
@Test
public void testUpdate() {
    // 构造条件
    Example example = new Example(TbUser.class);
    example.createCriteria().andEqualTo("username", "Lusifer");

    // 构造一条测试数据
    TbUser tbUser = new TbUser();
    tbUser.setUsername("LusiferNew");
    tbUser.setPassword("123456");
    tbUser.setPhone("15888888888");
    tbUser.setEmail("topsale@vip.qq.com");
    tbUser.setCreated(new Date());
    tbUser.setUpdated(new Date());

    // 修改数据
    tbUserMapper.updateByExample(tbUser, example);
}

/**
 * 测试查询集合
 */
@Test
public void testSelect() {
    List<TbUser> tbUsers = tbUserMapper.selectAll();
    for (TbUser tbUser : tbUsers) {
        System.out.println(tbUser.getUsername());
    }
}

/**
 * 测试分页查询
 */
@Test
public void testPage() {
    // PageHelper 使用非常简单,只需要设置页码和每页显示笔数即可
    PageHelper.startPage(0, 2);

    // 设置分页查询条件
    Example example = new Example(TbUser.class);
    PageInfo<TbUser> pageInfo = new PageInfo<>(tbUserMapper.selectByExample(example));

    // 获取查询结果
    List<TbUser> tbUsers = pageInfo.getList();
    for (TbUser tbUser : tbUsers) {
        System.out.println(tbUser.getUsername());
    }
}

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

附:完整的 POM


4.0.0

<groupId>com.funtl</groupId>
<artifactId>hello-spring-boot</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>

<name>hello-spring-boot</name>
<description></description>

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.2.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid-spring-boot-starter</artifactId>
        <version>1.1.10</version>
    </dependency>
    <dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper-spring-boot-starter</artifactId>
        <version>2.0.2</version>
    </dependency>
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper-spring-boot-starter</artifactId>
        <version>1.2.5</version>
    </dependency>

    <dependency>
        <groupId>net.sourceforge.nekohtml</groupId>
        <artifactId>nekohtml</artifactId>
        <version>1.9.22</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <mainClass>com.funtl.hello.spring.boot.HelloSpringBootApplication</mainClass>
            </configuration>
        </plugin>

        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.5</version>
            <configuration>
                <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
                <overwrite>true</overwrite>
                <verbose>true</verbose>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${mysql.version}</version>
                </dependency>
                <dependency>
                    <groupId>tk.mybatis</groupId>
                    <artifactId>mapper</artifactId>
                    <version>3.4.4</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!