Mybatis学习总结——入门基础

Posted 2020-08-21 平凡希

一、Mybatis介绍

1.MyBatis是什么？

 　 MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis，实质上Mybatis对ibatis进行一些改进。

　　MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。

　　Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatemnt、CallableStatement）配置起来，并通过java对象和statement中的sql进行映射生成最终执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。

      MyBatis是一个支持普通SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录。

2.Mybatis框架图

(1)、mybatis配置

SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。

mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。

(2)、通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂。

(3)、由会话工厂创建sqlSession即会话，操作数据库需要通过sqlSession进行。

(4)、mybatis底层自定义了Executor执行器接口操作数据库，Executor接口有两个实现，一个是基本执行器、一个是缓存执行器。

(5)、Mapped Statement也是mybatis一个底层封装对象，它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象，sql的id即是Mapped statement的id。

(6)、Mapped Statement对sql执行输入参数进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中，输入参数映射就是jdbc编程中对preparedStatement设置参数。

(7)、Mapped Statement对sql执行输出结果进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中，输出结果映射过程相当于jdbc编程中对结果的解析处理过程。

二、Mybatis入门程序

1.需求：(1).根据用户id（主键）查询用户信息 (2).根据用户名称模糊查询用户信息(3).添加用户 4).删除用户(5).更新用户

2.环境：java环境：JDK1.6，eclipse,mysql5.1

3.工程目录结构

4.SqlMapConfig.xml的配置文件内容

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- 和spring整合后 environments配置将废除-->
    <environments default="development">
        <environment id="development">
        <!-- 使用jdbc事务管理,事务控制由mybatis管理-->
            <transactionManager type="JDBC" />
        <!-- 数据库连接池,由mybatis管理-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://localhost:3306/test?characterEncoding=utf-8" />
                <property name="username" value="root" />
                <property name="password" value="root" />
            </dataSource>
        </environment>
    </environments>
<!-- 加载映射文件 -->
    <mappers>
        <mapper resource="com/mybatis/mapping/User.xml"/>
    </mappers>
</configuration>

5.实体User.java内容

package com.mybatis.entity;

import java.util.Date;

/**
 * @ClassName: User
 * @Description: TODO(用户实体)
 * @author lixiaoxi
 * @date 2015-6-27 下午1:56:02
 * 
 */
public class User {
    // 属性名称和数据库字段名称保持一致
    private Integer id;
    // 姓名
    private String username;
    // 性别
    private String sex;
    // 地址
    private String address;
    // 生日
    private Date birthday;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    @Override
    public String toString() {
        return "User [id=" + id + ", username=" + username + ", sex=" + sex
                + ", address=" + address + ", birthday=" + birthday + "]";
    }

}

6.映射文件User.xml的内容

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 为这个mapper指定一个唯一的namespace，namespace的值习惯上设置成包名+sql映射文件名，这样就能够保证namespace的值是唯一的
例如namespace="com.mybatis.mapping.User"就是com.mybatis.mapping(包名)+User(User.xml文件去除后缀)
 -->
 <!-- namespace命名空间,作用就是对sql进行分类化的管理,理解为sql隔离
    注意:使用mapper代理开发时，namespace有特殊作用
 -->
<mapper namespace="com.mybatis.mapping.User">
    <!-- 在映射文件中配置很多sql语句 -->
    <!-- 需求：通过Id查询用户表的记录 -->
    <!-- 通过SELECT执行数据库查询 
        id:标识映射文件中的sql，称为statement的id;
            将sql语句封装在mapperStatement的对象中，所以Id称为Statement的id;
        parameterType:指定输入参数的类型,这里指定int型
        #{}:表示一个占位符;
        #{id}:其中Id表示接收输入的参数，参数名称就是Id,如果输入参数是简单类型，#{}中的参数名可以任意，可以是value或者其它名称;
        resultType:指定sql输出结果所映射的java对象类型,select指定resultType表示将单条记录映射成java对象。
    -->
    <select id="findUserById" parameterType="int" resultType="com.mybatis.entity.User">
        select username,DATE_FORMAT(birthday,\'%Y-%m-%d\')birthday,sex,address from t_user where id=#{id}
    </select>
    
    <!-- 根据用户名称模糊查询用户信息,可能返回多条数据
        resultType:指定的就是单条记录所映射的java类型;
        ${}:表示拼接sql字符串，将接收到的参数内容不加任何修饰拼接在sql中.
            使用${}拼接sql，可能会引起sql注入
        ${value}:接收输入参数的内容，如果传入的是简单类型,${}中只能使用value
     -->
    <select id="findUserByName" parameterType="java.lang.String" resultType="com.mybatis.entity.User" >
        select * from t_user where username LIKE \'%${value}%\'
    </select>

     <!-- 查询所有用户 -->
    <select id="getUserList" resultType="com.mybatis.entity.User">
        select username,birthday,sex,address from t_user 
    </select>
    
    <!-- 添加用户 
      parameterType:指定输入的参数类型是pojo(包括用户信息);
      #{}中指定pojo的属性名称，接收到pojo对象的属性值    ,mybatis通过OGNL(类似struts2的OGNL)获取对象的属性值
    -->
    <insert id="insertUser" parameterType="com.mybatis.entity.User">
       <!-- 
              将insert插入的数据的主键返回到User对象中;
           select last_insert_id():得到刚insert进去记录的主键值，只适用于自增主键;
           keyProperty:将查询到的主键值，设置到parameterType指定的对象的那个属性
           order:select last_insert_id()执行顺序，相对于insert语句来说它的执行顺序。
           resultType:指定select last_insert_id()的结果类型;
       -->
       <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
           select last_insert_id()
       </selectKey>
       <!-- 
            使用mysql的uuid()，实现非自增主键的返回。
            执行过程:通过uuid()得到主键，将主键设置到user对象的Id的属性中，其次，在insert执行时，从user对象中取出Id属性值;
          <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
              select uuid()
          </selectKey>
          insert into t_user (id,username,birthday,sex,address) values(#{id},#{username},#{birthday},#{sex},#{address})
       -->
       insert into t_user(username,birthday,sex,address) values(#{username},#{birthday},#{sex},#{address})
    </insert>
    
    <!-- 更新用户 
        需要传入用户的Id和用户的更新信息
        parameterType:指定User对象，包括Id和用户的更新信息,注意：Id是必须存在的
        #{id}:从输入的User对象中获取Id的属性值
    -->
    <update id="updateUser" parameterType="com.mybatis.entity.User">
        update t_user set username=#{username},birthday=#{birthday},sex=#{sex},address=#{address} 
        where id=#{id}
    </update>
    
    <!-- 删除用户 
        根据ID删除用户,需要输入Id值
    -->
    <delete id="deleteUser" parameterType="java.lang.Integer">
        delete from t_user where id=#{id}
    </delete>
</mapper>

7.测试程序MybatisTest.java代码

package com.mybatis.test;

import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;

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 org.junit.Test;

import com.mybatis.entity.User;

public class MybatisTest {
    
    // 根据Id查询用户信息，得到一条记录结果
    @Test
    public void findUserByIdTest(){
        // mybatis的配置文件
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try{
            inputStream = Resources.getResourceAsStream(resource);
             // 1.创建会话工场,传入mybatis的配置文件信息
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            
             // 2.通过工厂得到SqlSession
            sqlSession = sqlSessionFactory.openSession();
            
            // 3.通过sqlSession操作数据库
            // 第一个参数：映射文件中的statement的Id,等于namespace + "." + statement的id;
            // 第二个参数:指定和映射文件中所匹配的parameterType类型的参数;
            // sqlSession.selectOne结果是与映射文件所匹配的resultType类型的对象;
            // selectOne：查询一条结果
            User user = sqlSession.selectOne("com.mybatis.mapping.User.findUserById",1);
            System.out.println(user.toString());
        }catch(IOException e){
            e.printStackTrace();
        }finally{
            if(sqlSession != null){
                sqlSession.close();
            }
            if(inputStream != null){
                try{
                    inputStream.close();
                }catch(IOException e){
                    e.printStackTrace();
                }
            }
        }
    }
    
    // 根据姓名模糊查询用户信息，得到一条或多条记录结果
    @Test
    public void findUserByNameTest(){
        // mybatis的配置文件
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try{
            inputStream = Resources.getResourceAsStream(resource);
             // 1.创建会话工场,传入mybatis的配置文件信息
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            
             // 2.通过工厂得到SqlSession
            sqlSession = sqlSessionFactory.openSession();
            
            // 3.通过sqlSession操作数据库
            // 第一个参数：映射文件中的statement的Id,等于namespace + "." + statement的id;
            // 第二个参数:指定和映射文件中所匹配的parameterType类型的参数;
            // sqlSession.selectList结果是与映射文件所匹配的resultType类型的对象;
            // list中的user和resultType类型一致
            List<User> list = sqlSession.selectList("com.mybatis.mapping.User.findUserByName","小");
            System.out.println(list);
        }catch(IOException e){
            e.printStackTrace();
        }finally{
            if(sqlSession != null){
                sqlSession.close();
            }
            if(inputStream != null){
                try{
                    inputStream.close();
                }catch(IOException e){
                    e.printStackTrace();
                }
            }
        }
    }
    
    // 添加用户
    @Test
    public void insertUserTest(){
        // mybatis的配置文件
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try{
            inputStream = Resources.getResourceAsStream(resource);
             // 1.创建会话工场,传入mybatis的配置文件信息
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            
             // 2.通过工厂得到SqlSession
            sqlSession = sqlSessionFactory.openSession();
            //插入用户的对象
            User user = new User();
            user.setUsername("小红");
            user.setSex("1");
            user.setBirthday(new Date());
            user.setAddress("北京");
            // 3.通过sqlSession操作数据库
            // 第一个参数：映射文件中的statement的Id,等于namespace + "." + statement的id;
            // 第二个参数:指定和映射文件中所匹配的parameterType类型的参数;
            sqlSession.insert("com.mybatis.mapping.User.insertUser",user);
            // 执行提交事务
            sqlSession.commit();
            //项目中经常需要 获取新增的用户的主键
            System.out.println(user.getId());
        }catch(IOException e){
            e.printStackTrace();
        }finally{
            if(sqlSession != null){
                sqlSession.close();
            }
            if(inputStream != null){
                try{
                    inputStream.close();
                }catch(IOException e){
                    e.printStackTrace();
                }
            }
        }
    }
    
    // 根据Id更新用户信息
    @Test
    public void updateUserTest(){
        // mybatis的配置文件
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try{
            inputStream = Resources.getResourceAsStream(resource);
             // 1.创建会话工场,传入mybatis的配置文件信息
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            
             // 2.通过工厂得到SqlSession
            sqlSession = sqlSessionFactory.openSession();
            //更新用户的信息
            User user = new User();
            user.setId(2);
            user.setUsername("小黑");
            user.setSex("2");
            user.setBirthday(new Date());
            user.setAddress("上海");
            // 3.通过sqlSession操作数据库
            // 第一个参数：映射文件中的statement的Id,等于namespace + "." + statement的id;
            // 第二个参数:指定和映射文件中所匹配的parameterType类型的参数;
            sqlSession.update("com.mybatis.mapping.User.updateUser",user);
            // 执行提交事务
            sqlSession.commit();
        }catch(IOException e){
            e.printStackTrace();
        }finally{
            if(sqlSession != null){
                sqlSession.close();
            }
            if(inputStream != null){
                try{
                    inputStream.close();
                }catch(IOException e){
                    e.printStackTrace();
                }
            }
        }
    }
    
    // 根据Id删除用户
    @Test
    public void deleteUserTest(){
        // mybatis的配置文件
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = null;
        SqlSession sqlSession = null;
        try{
            inputStream = Resources.getResourceAsStream(resource);
             // 1.创建会话工场,传入mybatis的配置文件信息
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            
             // 2.通过工厂得到SqlSession
            sqlSession = sqlSessionFactory.openSession();

            // 3.通过sqlSession操作数据库
            // 第一个参数：映射文件中的statement的Id,等于namespace + "." + statement的id;
            // 第二个参数:指定和映射文件中所匹配的parameterType类型的参数;
            //传入Id，删除用户
            sqlSession.delete("com.mybatis.mapping.User.deleteUser",6);
            // 执行提交事务
            sqlSession.commit();
        }catch(IOException e){
            e.printStackTrace();
        }finally{
            if(sqlSession != null){
                sqlSession.close();
            }
            if(inputStream != null){
                try{
                    inputStream.close();
                }catch(IOException e){
                    e.printStackTrace();
                }
            }
        }
        
    }
}

8.数据库所用sql脚本

CREATE TABLE t_user (
  id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
  username VARCHAR(30) NOT NULL COMMENT \'用户名称\',
  birthday DATE DEFAULT NULL COMMENT \'生日\',
  sex CHAR(2) DEFAULT NULL COMMENT \'性别\',
  address VARCHAR(256) DEFAULT NULL COMMENT \'地址\'
);
INSERT INTO t_user (username,birthday,sex,address)
                                VALUES
                   (\'小A\',\'2015-06-27\',\'2\',\'北京\'),
                   (\'小B\',\'2015-06-27\',\'2\',\'北京\'),
                   (\'小C\',\'2015-06-27\',\'1\',\'北京\'),
                   (\'小D\',\'2015-06-27\',\'2\',\'北京\');

三、mybatis和Hibernate的本质区别与应用场景

hibernate：是一个标准ORM框架（对象关系映射），入门门槛较高的，不需要程序写sql，sql语句自动生成了，对sql语句进行优化、修改比较困难的。

应用场景：

     适用与需求变化不多的中小型项目，比如：后台管理系统，erp、orm、oa。

mybatis：专注是sql本身，需要程序员自己编写sql语句，sql修改、优化比较方便。mybatis是一个不完全的ORM框架，虽然程序员自己写sql，mybatis 也可以实现映射（输入映射、输出映射）。

应用场景：

     适用与需求变化较多的项目，比如：互联网项目。

四、小结

1.parameterType和resultType

parameterType:在映射文件中通过parameterType指定输入参数的类型。

resultType:在映射文件中通过resultType指定输出结果的类型

2.#{}和${}

#{}表示一个占位符号，#{}接收输入参数，类型可以是简单类型，pojo、hashmap;

如果接收简单类型，#{}中可以写成value或其它名称;

#{}接收pojo对象值，通过OGNL读取对象中的属性值，通过属性.属性.属性...的方式获取对象属性值。

 

${}表示一个拼接符号，会引用sql注入，所以不建议使用 表示一个拼接符号，会引用sql注入，所以不建议使用{}；

${}接收输入参数，类型可以是简单类型，pojo、hashmap;

如果接收简单类型，${}中只能写成value;

${}接收pojo对象值，通过OGNL读取对象中的属性值，通过属性.属性.属性...的方式获取对象属性值。

3.selectOne()和selectList()

selectOne表示查询出一条记录进行映射。如果使用selectOne可以实现，那么使用selectList也可以实现（list中只有一个对象）。

selectList表示查询出一个列表（多条记录）进行映射。如果使用selectList查询多条记录，不能使用selectOne。如果使用selectOne会报错。