MyBatis入門（一）—— 入門案例

一、MyBatis簡介

　　MyBatis是面向sql的持久層框架，他封裝了jdbc訪問數據庫的過程，我們開發，只需專注於sql語句本身的拼裝，其它賦值的過程全部可以交給MyBatis去完成。

　　與Hibernate比較：

1.Hibernate學習門檻不低，要精通門檻更高。門檻高在怎么設計O/R映射，在性能和對象模型之間如何權衡取得平衡，以及怎樣用好Hibernate緩存與數據加載策略方面需要你的經驗和能力都很強才行。國內目前前的情況精通hibernate技術大牛非常少。

2.sql優化方面，Hibernate的查詢會將表中的所有字段查詢出來，這一點會有性能消耗。當然了，Hibernate也可以自己寫SQL來指定需要查詢的字段，但這樣就破壞了Hibernate開發的簡潔性。說得更深入一些，如果有個查詢要關聯多張表，比如5張表，10張表時，而且，我們要取的字段只是其中幾張表的部分字段。這時用hibernate時就會顯得非常力不從心。就算用hibernate的sqlquery，后續的維護工作也會讓人發狂。

二、入門案例

1、數據庫的准備（創表語句）

-- ----------------------------
-- Table structure for `user`
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(32) NOT NULL COMMENT '用戶名稱',
  `birthday` date DEFAULT NULL COMMENT '生日',
  `sex` char(1) DEFAULT NULL COMMENT '性別',
  `address` varchar(256) DEFAULT NULL COMMENT '地址',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=27 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', '王五', null, '2', null);
INSERT INTO `user` VALUES ('10', '張三', '2014-07-10', '1', '北京市');
INSERT INTO `user` VALUES ('16', '張小明', null, '1', '河南鄭州');
INSERT INTO `user` VALUES ('22', '陳小明', null, '1', '河南鄭州');
INSERT INTO `user` VALUES ('24', '張三豐', null, '1', '河南鄭州');
INSERT INTO `user` VALUES ('25', '陳小明', null, '1', '河南鄭州');
INSERT INTO `user` VALUES ('26', '王五', null, null, null);

2、使用idea新建maven-archetype-quickstart項目

3、引入依賴

<dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.45</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.2.7</version>
</dependency>

4、於resources文件夾中創建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事務管理 -->
            <transactionManager type="JDBC" />
            <!-- 數據庫連接池 -->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url"
                          value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
                <property name="username" value="root" />
                <property name="password" value="" />
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <!-- 第一種方式，加載 resource-->
        <mapper resource="User.xml"></mapper>
        <mapper resource="UserMapper.xml"/>

        <!-- 第三種方式，包掃描器要求(推薦使用此方式)：
             1、映射文件與接口同一目錄下
             2、映射文件名必需與接口文件名稱一致
        -->
        <!--<package name="com.cenobitor.mapper"/>-->
    </mappers>
</configuration>

5、創建實體類User

package com.cenobitor.pojo;

import java.util.Date;

public class User {

    private Integer id;
    private String username;// 用戶姓名
    private String sex;// 性別
    private Date birthday;// 生日
    private String address;// 地址
    private String uuid;

    ......
}

6、配置SQL查詢的映射文件（resources目錄）

<?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">
<!-- namespace：命名空間，類似於java包，主要用於隔離sql語句的，后續有重要作用
     #{}：占位符，相當於jdbc的?
     ${}:字符串拼接指令，注意如果入參為普通數據類型時，括號里面只能寫value
 -->
<mapper namespace="user">
    <!-- id:sql id標識sql語句的唯一標識
             parameterType:入參的數據類型
             resultType:返回結果的數據類型
    -->
    <select id="getUserById" parameterType="int" resultType="com.cenobitor.pojo.User">
        SELECT
          `id`,
          `username`,
          `birthday`,
          `sex`,
          `address`
        FROM `user`
        WHERE id = #{id}
    </select>

    <!-- resultType:如果返回結果是集合時，只需要設置為元素的數據類型就可 -->
    <select id="getUserByName" parameterType="String" resultType="com.cenobitor.pojo.User">
        SELECT
          `id`,
          `username`,
          `birthday`,
          `sex`,
          `address`
        FROM `user`
        WHERE username LIKE '%${value}%'
    </select>
    
    <insert id="insertUser" parameterType="com.cenobitor.pojo.User">
        INSERT INTO USER (`username`,`birthday`,`sex`,`address`)
        VALUES (#{username},#{birthday},#{sex},#{address})
    </insert>

    <!--返回MySql自增主鍵-->
    <!-- useGeneratedKeys:標識插入使用自增id
         keyProperty:與useGeneratedKeys配套使用，用於綁定主鍵接收的pojo屬性
     -->
    <insert id="insertUserKey" parameterType="com.cenobitor.pojo.User"
            useGeneratedKeys="true" keyProperty="id">

        <!-- selectKey:用於配置主鍵返回
                      keyProperty：要綁定的pojo屬性
                      resultType:屬性數據類型
                      order:指定什么時候執行，AFTER之后
                 -->
        <!-- <selectKey keyProperty="id" resultType="int" order="AFTER">
             SELECT LAST_INSERT_ID()
        </selectKey> -->

        INSERT INTO USER (`username`,`birthday`,`sex`,`address`)
        VALUES (#{username},#{birthday},#{sex},#{address})
    </insert>

    <!--返回MySql的uuid返回主鍵-->
    <insert id="insertUserUUID" parameterType="com.cenobitor.pojo.User">

        <!-- selectKey:用於配置主鍵返回
                      keyProperty：要綁定的pojo屬性
                      resultType:屬性數據類型
                      order:指定什么時候執行，AFTER之后
                 -->
        <selectKey keyProperty="uuid" resultType="String" order="BEFORE">
             SELECT UUID()
        </selectKey>

        INSERT INTO USER (`username`,`birthday`,`sex`,`address`,`uuid`)
        VALUES (#{username},#{birthday},#{sex},#{address},#{uuid})
    </insert>
    
    <update id="updateUser" parameterType="com.cenobitor.pojo.User">
        UPDATE USER SET username = #{username} WHERE id = #{id}
    </update>
    
    <delete id="deleteUser" parameterType="com.cenobitor.pojo.User">
        DELETE FROM `user` WHERE `id` = #{id}
    </delete>

</mapper>

7、加載映射文件，在SqlMapConfig.xml配置mappers節點

8、編寫測試類

package com.cenobitor;

import com.cenobitor.Utils.SqlSessionFactoryUtils;
import com.cenobitor.pojo.User;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
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.Date;
import java.util.List;

/**
 * Unit test for simple App.
 */
public class AppTest extends TestCase {
    //根據id查找用戶
    public void testGetUserById() throws IOException {

        //創建SqlSessionFactoryBuilder對象
        SqlSessionFactoryBuilder sfb = new SqlSessionFactoryBuilder();
        //查找配置文件,創建輸入流
        InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        //加載配置文件,創建SqlSessionFactory
        SqlSessionFactory sqlSessionFactory = sfb.build(inputStream);
        //創建SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //執行查詢,參數一:要查詢的statementId,參數二:sql語句入參
        User user = sqlSession.selectOne("user.getUserById", 1);
        //輸入查詢結果
        System.out.println(user);

        //釋放資源
        sqlSession.close();
    }

    //根據用戶名查找用戶列表
    public void testGetUserByName(){
        SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();
        List<User> list = sqlSession.selectList("user.getUserByName", "張");
        for (User user : list) {
            System.out.println(user);
        }

        sqlSession.close();
    }

    //插入用戶
    public void testInsertUser(){
        SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();

        User user = new User();
        user.setUsername("貂蟬");
        user.setSex("0");
        user.setBirthday(new Date());
        user.setAddress("呂布");

        //執行插入語句
        sqlSession.insert("user.insertUser",user);
        //提交事務
        sqlSession.commit();
        //釋放資源
        sqlSession.close();
    }

    //Mysql自增返回
    public void testInsertUserKey(){
        SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();

        User user = new User();
        user.setUsername("楊玉環");
        user.setSex("0");
        user.setBirthday(new Date());
        user.setAddress("李隆基");

        //執行插入語句
        sqlSession.insert("user.insertUserKey", user);
        System.out.println(user);
        //提交事務
        sqlSession.commit();
        //釋放資源
        sqlSession.close();
    }

    //Mysql的uuid返回主鍵
    //注：在使用uuid之前數據庫user表要先加上uuid2字段、user的pojo也要加上相應屬性
    public void testInsertUserUUID(){
        SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();

        User user = new User();
        user.setUsername("孫尚香");
        user.setSex("0");
        user.setBirthday(new Date());
        user.setAddress("劉備");

        //執行插入語句
        sqlSession.insert("user.insertUserUUID", user);
        System.out.println(user);
        //提交事務
        sqlSession.commit();
        //釋放資源
        sqlSession.close();
    }

    //修改用戶
    public void testUpdateUser(){
        SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();

        User user = new User();
        user.setUsername("呂雉");
        user.setId(32);

        //執行插入語句
        sqlSession.update("user.updateUser",user);

        //提交事務
        sqlSession.commit();
        //釋放資源
        sqlSession.close();
    }

    //刪除用戶
    public void testDeleteUser(){
        SqlSessionFactory sqlSessionFactory = SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.delete("user.deleteUser",32);
        sqlSession.commit();
        sqlSession.close();
    }
}

9、抽取SqlSessionFactoryUtils工具類，共享SqlSessionFactory的對象

public class SqlSessionFactoryUtils {
    private SqlSessionFactoryUtils(){}

    private static class SqlSessionFactoryInstance{

        public static SqlSessionFactory sqlSessionFactory;

        static {
            try {
                sqlSessionFactory =  new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("SqlMapConfig.xml"));
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    public static SqlSessionFactory getSqlSessionFactory(){
        return SqlSessionFactoryInstance.sqlSessionFactory;
    }

}

三、MyBatis架構圖

四、MyBatis 動態代理Dao開發 

 1、開發規則

• namespace必須是接口的全路徑名
• 接口的方法名必須與映射文件的sql id 一致
• 接口的輸入參數必須與映射文件的parameterType類型一致
• 接口的返回類型必須與映射文件的resultType類型一致

2、動態代理Dao開發步驟

①創建UserMapper.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="com.cenobitor.mapper.UserMapper">

    <select id="getUserById" parameterType="int" resultType="com.cenobitor.pojo.User">
        SELECT
          `id`,
          `username`,
          `birthday`,
          `sex`,
          `address`
        FROM `user`
        WHERE id = #{id}
    </select>

    <select id="getUserByName" parameterType="String" resultType="com.cenobitor.pojo.User">
        SELECT
          `id`,
          `username`,
          `birthday`,
          `sex`,
          `address`
        FROM `user`
        WHERE username LIKE '%${value}%'
    </select>
    
    <insert id="insertUser" parameterType="com.cenobitor.pojo.User">
        INSERT INTO USER (`username`,`birthday`,`sex`,`address`)
        VALUES (#{username},#{birthday},#{sex},#{address})
    </insert>

</mapper>

②創建UserMapper接口

package com.cenobitor.mapper;

import com.cenobitor.pojo.User;
import java.util.List;

public interface UserMapper {

    /**根據用戶ID查詢用戶信息
     * @param id
     * @return
     */
    User getUserById(Integer id);

    /**
     * 根據用戶名查找用戶列表
     * @param name
     * @return
     */
    List<User> getUserByName(String name);

    /**
     * 添加用戶
     * @param user
     */
    void insertUser(User user);

}

③加載UserMpper.xml

 

④建立測試類

public class UserMapperTest {

    @Test
    public void getUserById() {
        SqlSessionFactory sqlSessionFactory =
                SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = mapper.getUserById(31);
        System.out.println(user);//User{id=31, username='楊玉環', sex='0', birthday=Sat Apr 07 00:00:00 CST 2018, address='李隆基', uuid='null'}
        sqlSession.close();
    }

    @Test
    public void getUserByName() {
        SqlSessionFactory sqlSessionFactory =
                SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = mapper.getUserByName("張");
        for (User user : users) {
            System.out.println(user);
        }
        /*User{id=10, username='張三', sex='1', birthday=Thu Jul 10 00:00:00 CST 2014, address='北京市', uuid='null'}
        User{id=16, username='張小明', sex='1', birthday=null, address='河南鄭州', uuid='null'}
        User{id=24, username='張三豐', sex='1', birthday=null, address='河南鄭州', uuid='null'}*/
        sqlSession.close();
    }

    @Test
    public void insertUser() {
        SqlSessionFactory sqlSessionFactory =
                SqlSessionFactoryUtils.getSqlSessionFactory();
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = new User();
        user.setUsername("lisi");
        user.setSex("1");
        user.setBirthday(new Date());
        user.setAddress("北京");
        mapper.insertUser(user);
        sqlSession.commit();
        sqlSession.close();
    }
}

五、SqlMapConfig.xml配置

1、properties

①屬於核心文件配置

<!-- 加載規則，首先加載標簽內部屬性，再加載外部文件，名稱相同時，會替換相同名稱的內容 -->
    <properties resource="jdbc.properties">
        <property name="jdbc.username" value="root1"/>
        <property name="jdbc.password" value="root"/>
    </properties>

②jdbc.properties

    jdbc.driver=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
    jdbc.username=root
    jdbc.password=root

2、typeAliases

自定義別名

<typeAliases>
        <!-- 單個別名定義 -->
        <!-- <typeAlias type="com.itheima.mybatis.pojo.User" alias="user"/> -->
        <!-- 別名包掃描器(推薦使用此方式)，整個包下的類都被定義別名，別名為類名，不區分大小寫-->
        <package name="com.itheima.mybatis.pojo"/>
</typeAliases>

3、mapper

<mappers>
        <!-- 第一種方式，加載 resource-->
        <mapper resource="mapper/user.xml"/>
        <!-- <mapper resource="mapper/UserMapper.xml"/> -->

        <!-- 第二種方式，class掃描器要求：
             1、映射文件與接口同一目錄下
             2、映射文件名必需與接口文件名稱一致
         -->
        <!-- <mapper class="com.itheima.mybatis.mapper.UserMapper"/> -->

        <!-- 第三種方式，包掃描器要求(推薦使用此方式)：
             1、映射文件與接口同一目錄下
             2、映射文件名必需與接口文件名稱一致
        -->
        <package name="com.itheima.mybatis.mapper"/>
</mappers>

 六、小結

1、#{} 和${}

#{} 表示一個占位符號，通過#{} 可以實現preparedStatement向占位符中設置值，自動進行java類型和jdbc類型轉換。#{} 可以有效防止sql注入。#{}可以接受簡單類型值或pojo屬性值。如果parameterType傳輸單個簡單類型值，#{}括號中可以是value或其他名稱。

${}表示拼接sql串，通過${}可以將parameterType傳入的內容拼接在sql中且不進行jdbc類型轉換，${}可以接受簡單類型值或pojo屬性值，如果parameterType傳輸單個簡單類型值，${}括號中只能是value。

2、parameterType和resultype

parameterType:指定輸入參數類型，mybatis通過ognl從輸入對象中獲取參數值拼接在sql中。

resultType:指定類型的對象。如果有多條數據，則分別進行映射，並把對象放到容器List中。