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 ('', '王五', null, '', null);
 INSERT INTO `user` VALUES ('', '张三', '2014-07-10', '', '北京市');
 INSERT INTO `user` VALUES ('', '张小明', null, '', '河南郑州');
 INSERT INTO `user` VALUES ('', '陈小明', null, '', '河南郑州');
 INSERT INTO `user` VALUES ('', '张三丰', null, '', '河南郑州');
 INSERT INTO `user` VALUES ('', '陈小明', null, '', '河南郑州');
 INSERT INTO `user` VALUES ('', '王五', 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中。