Mybatis学习笔记-源自黑马程序员学习视频

JDBC简介

JDBC（Java DataBase Connectivity）是Java和数据库之间的一个桥梁，是一个规范而不是一个实现，能够执行SQL语句。它由一组用Java语言编写的类和接口组成。各种不同类型的数据库都有相应的实现，本文中的代码都是采用MySQL数据库实现的。

JDBC操作流程如下

JDBC操作流程分析

（1）根据AOP的设计思想，将公共的模块剥离出，让程序员更加关注业务代码。对于JDBC的操作流程
只有获取数据和结果转换在实际处理过程中可能是不一致的，其他过程是一致的，因此可以加载驱动、获取连接、释放资源，剥离出来，让程序员更加关注sql本身的功能。
（2）JDBC操作流程是需要将获取的数据手动映射POJO，增加开发量

为了解决这些问题，许多优秀ORM（模型）持久化框架应运而生，典型代表：hibernate和mybatis等，Hibernate和MyBatis的增、删、查、改.对于业务逻辑层来说大同小异，对于映射层而言Hibernate的配置不需要接口和SQL.相反MyBatis是需要的。（目前Hibernate我使用相对较少，所以本文不做介绍）

2. 什么是Mybatis

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集--------------------来自于官网。

3.Mybatis框架

首先配置Mybaits运行环境的xml文件，通过该文件创建Mybaits的会话工厂，通过Mybatis的会话工厂发起对数据库的CRUD操作，会话通过调度器执行数据库的CRUD，最后连接数据库。

3.Mybatis操作传入的参数

3.1 #{} 在数据库查询的时候映射成占位符

3.2 ${}在数据库查询的时候映射成对应的值

4、操作案例

4.1 数据库

CREATE TABLE `user` ( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `name` varchar(64) NOT NULL DEFAULT '', `dept` varchar(254) NOT NULL DEFAULT '', `website` varchar(254) DEFAULT '', `phone` varchar(16) NOT NULL DEFAULT '', PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=latin1;

-- ---------------------------- -- Records of user -- ----------------------------

INSERT INTO `user` VALUES ('1', 'yiibai', 'Tech', 'http://www.yiibai.com', '13800009988');

原链接：https://www.yiibai.com/mybatis/install_configure.html

4.2 项目结构

4.2. 主要功能

4.2.1 pom文件配置

package org.mybatis.example;


import org.apache.ibatis.session.SqlSession;
import org.mybatis.mapper.UserMapper;
import org.mybatis.model.UserDO;
import org.mybatis.utils.SqlSessionUtils;


/**
 * @author : cuantianhou 2019/12/25
 */
public class SimpleDemo {

    public static void main(String[] args) {

        try {
            SqlSession sqlSession = SqlSessionUtils.getSqlSession();
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            UserDO  queryDO = new UserDO();
            queryDO.setId(1);
            queryDO = userMapper.selectByPrimaryKey(queryDO);
            System.out.println(queryDO);
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

4.2.2 SqlsessionUtils

package org.mybatis.utils;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;
import java.util.Objects;

/**
 * @author : cuantianhou 2019/12/25
 */
public class SqlSessionUtils {

    private static final String resource = "mybatis-config.xml";

    private static SqlSessionFactory sqlSessionFactory;
    private static SqlSessionFactory getSqlSessionFactory(){
        if(Objects.isNull(sqlSessionFactory )) {
            InputStream inputStream = null;
            try {
                inputStream = Resources.getResourceAsStream(resource);
                sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return sqlSessionFactory;
    }

    public static SqlSession getSqlSession(){
        return getSqlSessionFactory().openSession();
    }
}

4.2.3 自动生成mybatis中sql语句和mapper文件配置generatorConfig.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>

    <properties url="file:/data/baofoo4/test.properties" />

    <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3">
        <!-- 自动识别数据库关键字，默认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"/>

        <commentGenerator>
            <!-- 是否生成注释代时间戳 true：是： false:否-->
            <property name="suppressDate" value="false"/>
            <!-- 是否去除自动生成的注释 true：是： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--数据库链接地址账号密码-->
        <jdbcConnection
                driverClass="${jdbc.driver}"
                connectionURL="${jdbc.url}"
                userId="${jdbc.username}"
                password="${jdbc.password}">
        </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="true"/>
        </javaTypeResolver>

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

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

            <!-- 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=""/>-->

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

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

            <!-- 可以为所有生成的接口添加一个父接口，但是MBG只负责生成，不负责检查-->
            <!--<property name="rootInterface" value="com.baofu.admin.cm.dal.mapper.BaseMapper"/>-->
        </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="user"
               mapperName="UserMapper"
               domainObjectName="UserDO"
               enableSelectByPrimaryKey="true"
               enableSelectByExample="false"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableUpdateByPrimaryKey="true"
               enableDeleteByExample="false"
               enableDeleteByPrimaryKey="false"
               selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

4.2.4 测试程序

package org.mybatis.example;


import org.apache.ibatis.session.SqlSession;
import org.mybatis.mapper.UserMapper;
import org.mybatis.model.UserDO;
import org.mybatis.utils.SqlSessionUtils;


/**
 * @author : cuantianhou 2019/12/25
 */
public class SimpleDemo {

    public static void main(String[] args) {

        try {
            SqlSession sqlSession = SqlSessionUtils.getSqlSession();
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            UserDO  queryDO = new UserDO();
            queryDO.setId(1);
            queryDO = userMapper.selectByPrimaryKey(queryDO);
            System.out.println(queryDO);
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

4.2.5 测试结果

5、总结

         本文主要是讲解了mybatis出现的原因，mybatis的一般使用方法和mybatis的使用案例，如果本文对大家有所帮助，请点个赞。