Mybatis(一)

Mybatis简介

MyBatis 是一个可以自定义SQL、存储过程和高级映射的持久层框架。MyBatis 摒除了大部分的JDBC代码、手工设置参数和结果集重获。MyBatis 只使用简单的XML 和注解来配置和映射基本数据类型、Map 接口和POJO 到数据库记录。相对Hibernate和Apache OJB等“一站式”ORM解决方案而言,Mybatis 是一种“半自动化”的ORM实现

Mybatis架构

Mybatis(一)_第1张图片
image.png
  • mybatis配置
    SqlMapConfig.xml,此文件作为mybatis的全局配置文件,配置了mybatis的运行环境等信息。
    mapper.xml文件即sql映射文件,文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载
  • 通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂
  • 由会话工厂创建sqlSession即会话,操作数据库需要通过sqlSession进行
  • mybatis底层自定义了Executor执行器接口操作数据库,Executor接口有两个实现,一个是基本执行器、一个是缓存执行器
  • Mapped Statement也是mybatis一个底层封装对象,它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象,sql的id即是Mapped statement的id
  • Mapped Statement对sql执行输入参数进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中,输入参数映射就是jdbc编程中对preparedStatement设置参数
  • Mapped Statement对sql执行输出结果进行定义,包括HashMap、基本类型、pojo,Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中,输出结果映射过程相当于jdbc编程中对结果的解析处理过程

Mybatis快速入门

下载

mybaits的代码由github.com管理
下载地址:https://github.com/mybatis/mybatis-3/releases

  • mybatis-3.2.7.jar : mybatis的核心包
  • lib文件夹 : mybatis的依赖包所在
  • mybatis-3.2.7.pdf :mybatis使用手册

导包

  • mybatis核心包


    Mybatis(一)_第2张图片
    image.png
  • mybatis依赖包


    Mybatis(一)_第3张图片
    image.png
  • 数据库驱动包


    image.png

配置文件

  • log4j.properties
    mybatis默认使用log4j作为输出日志信息
    创建log4j.properties如下
# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
  • SqlMapConfig.xml
    SqlMapConfig.xml是mybatis核心配置文件,配置文件内容为数据源、事务管理
    创建SqlMapConfig.xml,如下:



    
    
        
            
            
            
            
                
                
                
                
            
        
    
>

出现以下报错Error creating document instance. Cause: org.xml.sax.SAXParseException; lineNumber: 28; columnNumber: 17; 尾随节中不允许有内容,可以从上面看出,在最后>多了一个>,此外空格也一不予许的

  • 新建一个User
package com.cuzz.pojo;

import java.util.Date;

public class User {
    private int id;
    private String username;
    private String sex;
    private Date birthday;
    private String address;
    
    public int getId() {
        return id;
    }
    public void setId(int 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 Date getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
    public String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
    }
    @Override
    public String toString() {
        return "User [id=" + id + ", username=" + username + ", sex=" + sex
                + ", birthday=" + birthday + ", address=" + address + "]";
    }
}
  • sql映射文件
    sqlMap目录下创建sql映射文件User.xml





  • 加载映射文件
    mybatis框架需要加载Mapper.xml映射文件
    将users.xml添加在SqlMapConfig.xml,如下:



    
    
        
            
            
            
            
                
                
                
                
            
        
    
    
     
    
        
    
    

实现根据id查询用户

  • 映射文件
    在user.xml中添加select标签,编写sql:





    
    
    
    

    

测试程序

测试程序步骤:

  • 创建SqlSessionFactoryBuilder对象
  • 加载SqlMapConfig.xml配置文件
  • 创建SqlSessionFactory对象
  • 创建SqlSession对象
  • 执行SqlSession对象执行查询,获取结果User
  • 打印结果
  • 释放资源
package com.cuzz.test;

import java.io.InputStream;

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

public class MybaitsTest {
    private SqlSessionFactory sqlSessionFactory = null;

    @Before
    public void init() throws Exception {
        // 1. 创建SqlSessionFactoryBuilder对象
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

        // 2. 加载SqlMapConfig.xml配置文件
        InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");

        // 3. 创建SqlSessionFactory对象
        this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
    }

    @Test
    public void testQueryUserById() throws Exception {
        // 4. 创建SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 5. 执行SqlSession对象执行查询,获取结果User
        // 第一个参数是User.xml的statement的id,第二个参数是执行sql需要的参数;
        Object user = sqlSession.selectOne("queryUserById", 1);

        // 6. 打印结果
        System.out.println(user);

        // 7. 释放资源
        sqlSession.close();
    }
}

查询结果


Mybatis(一)_第4张图片
image.png

实现根据用户名模糊查询用户

  • 查询sql:
    SELECT * FROM user WHERE username LIKE '%王%'

方法一

  • 映射文件
    在User.xml配置文件中添加如下内容:
        
     
    
    SELECT * FROM `user` WHERE username LIKE #{username}
    
  • 5.5.1.2.测试程序
    MybatisTest中添加测试方法如下:
    @Test
    public void testQueryUserByUsername() throws Exception {
        // 4. 创建SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 5. 执行SqlSession对象执行查询,获取结果User
        // 查询多条数据使用selectList方法
        List list = sqlSession.selectList("queryUserByUsername", "%王%");

        // 6. 打印结果
        for (Object user : list) {
            System.out.println(user);
        }

        // 7. 释放资源
        sqlSession.close();
    }
 
 

查询结果


Mybatis(一)_第5张图片
image.png

方法二

  • 映射文件:
    
    
  • 测试
    
    

查询结果


Mybatis(一)_第6张图片
image.png

小结

#{}和${}

  • #{}表示一个占位符号,通过#{}可以实现preparedStatement向占位符中设置值,自动进行java类型和jdbc类型转换。#{}可以有效防止sql注入。 #{}可以接收简单类型值或pojo属性值。 如果parameterType传输单个简单类型值,#{}括号中可以是value或其它名称
  • ${}表示拼接sql串,通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换, ${}可以接收简单类型值或pojo属性值,如果parameterType传输单个简单类型值,${}括号中只能是value

parameterType和resultType

parameterType:指定输入参数类型,mybatis通过ognl从输入对象中获取参数值拼接在sql中。
resultType:指定输出结果类型,mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。如果有多条数据,则分别进行映射,并把对象放到容器List中

selectOne和selectList

  • selectOne查询一条记录,如果使用selectOne查询多条记录则抛出异常
  • selectList可以查询一条或多条记录

实现添加用户

  • 使用sql:
    INSERT INTO user (username,birthday,sex,address) VALUES ('cuzz','2018-04-15','1','武汉')
  • 映射文件
    在User.xml配置文件中添加如下内容:
    
    
        INSERT INTO `user` 
        (username, birthday, sex, address) VALUES
        (#{username}, #{birthday}, #{sex}, #{adress})
    
  • 测试
    @Test
    public void testSaveUser() {
        // 4. 创建SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 5. 执行SqlSession对象执行保存
        // 创建需要保存的User
        User user = new User();
        user.setUsername("cuzz");
        user.setSex("1");
        user.setBirthday(new Date());
        user.setAddress("武汉");

        sqlSession.insert("saveUser", user);
        System.out.println(user);

        // 需要进行事务提交
        sqlSession.commit();

        // 7. 释放资源
        sqlSession.close();
    }

测试结果结果

Mybatis(一)_第7张图片
image.png

如上所示,保存成功,但是id=0,需要解决id返回不正常的问题。

mysql自增主键返回

  • 查询id的sql:
    SELECT LAST_INSERT_ID()
  • 通过修改User.xml映射文件,可以将mysql自增主键返回:
    如下添加selectKey 标签
    
        
        
        
        
        
        
            SELECT LAST_INSERT_ID()
        
        
        INSERT INTO `user` 
        (username, birthday, sex, address) VALUES
        (#{username}, #{birthday}, #{sex}, #{address})
    

LAST_INSERT_ID():是mysql的函数,返回auto_increment自增列新记录id值。

效果图:


Mybatis(一)_第8张图片
image.png

能够返回id了

Mysql使用 uuid实现主键



    
    
    
    
    
    
        SELECT LAST_INSERT_ID()
    
    INSERT INTO `user`
    (username,birthday,sex,address) VALUES
    (#{username},#{birthday},#{sex},#{address})

注意这里使用的order是“BEFORE”

修改用户

  • 使用的sql:
    UPDATE user SET username = 'uzi' WHERE id = 1
  • 映射文件
    在User.xml配置文件中添加如下内容:
    
    
        UPDATE `user` SET
        username = #{username} WHERE id = #{id}
    
  • 测试
    MybatisTest中添加测试方法如下:
    @Test
    public void testUpdateUserById() {
        // 4. 创建SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 5. 执行SqlSession对象执行更新
        // 创建需要更新的User
        User user = new User();
        user.setId(1);
        user.setUsername("uzi");
        user.setSex("1");
        user.setBirthday(new Date());
        user.setAddress("召唤峡谷");

        sqlSession.update("updateUserById", user);

        // 需要进行事务提交
        sqlSession.commit();

        // 7. 释放资源
        sqlSession.close();
    }
}

测试结果


image.png

删除用户

  • 使用的sql
    DELETE FROM user WHERE id = 1
  • 映射文件:
    在User.xml配置文件中添加如下内容:
    
    
        DELETE `user` WHERE
        id=#{id}
    
  • 测试
    MybatisTest中添加测试方法如下:
    @Test
    public void testDeleteUserById() {
        // 4. 创建SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 5. 执行SqlSession对象执行删除
        sqlSession.delete("deleteUserById", 1);

        // 需要进行事务提交
        sqlSession.commit();

        // 7. 释放资源
        sqlSession.close();
    }

测试结果


image.png

Dao开发方法

使用MyBatis开发Dao,通常有两个方法,即原始Dao开发方法和Mapper动态代理开发方法。

SqlSession的使用范围

SqlSession中封装了对数据库的操作,如:查询、插入、更新、删除等。
SqlSession通过SqlSessionFactory创建。
SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。

SqlSessionFactoryBuilder

SqlSessionFactoryBuilder用于创建SqlSessionFacoty,SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了,因为SqlSession是通过SqlSessionFactory创建的。所以可以将SqlSessionFactoryBuilder当成一个工具类使用,最佳使用范围是方法范围即方法体内局部变量。

SqlSessionFactory

SqlSessionFactory是一个接口,接口中定义了openSession的不同重载方法,SqlSessionFactory的最佳使用范围是整个应用运行期间,一旦创建后可以重复使用,通常以单例模式管理SqlSessionFactory。

SqlSession

qlSession是一个面向用户的接口,sqlSession中定义了数据库操作方法。

每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用,它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。

打开一个 SqlSession;使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭。如下:

SqlSession session = sqlSessionFactory.openSession();
try {
     // do work
} finally {
    session.close();
}

需求

使用MyBatis开发DAO实现以下的功能:
根据用户id查询一个用户信息
根据用户名称模糊查询用户信息列表
添加用户信息

原始Dao开发方式

原始Dao开发方法需要程序员编写Dao接口和Dao实现类。

  • 映射文件





    
    
    
    
    
   
    
     
    
    
    
    
    
    
    
        
        
        
        
        
        
            SELECT LAST_INSERT_ID()
        
        
        INSERT INTO `user` 
        (username, birthday, sex, address) VALUES
        (#{username}, #{birthday}, #{sex}, #{address})
    
    
    
    
        UPDATE `user` SET
        username = #{username} WHERE id = #{id}
    
    
    
    
    
        DELETE FROM `user` WHERE
        id=#{id}
    
    

  • Dao接口
package com.cuzz.dao;

import java.util.List;

import com.cuzz.pojo.User;

public interface UserDao {
    // 根据id查询用户
    User queryUserById(int id);

    //  根据用户名模糊查询用户
    List queryUserByUsername(String username);

    // 保存用户
    void saveUser(User user);
}
  • Dao实现类
package com.cuzz.dao;

import java.util.List;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import com.cuzz.pojo.User;

public class UserDaoImpl implements UserDao {
    
    private SqlSessionFactory sqlSessionFactory;
    
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
        super();
        this.sqlSessionFactory = sqlSessionFactory;
    }
    
    @Override
    public User queryUserById(int id) {
        // 创建SqlSession
        SqlSession sqlSession = this.sqlSessionFactory.openSession();
        // 执行逻辑
        User user = sqlSession.selectOne("queryUserById", id);
        // 释放资源
        sqlSession.close();
        
        return user;
    }

    @Override
    public List queryUserByUsername(String username) {
        // 创建SqlSession
        SqlSession sqlSession = this.sqlSessionFactory.openSession();

        // 执行查询逻辑
        List list = sqlSession.selectList("queryUserByUsername", username);
        // 释放资源
        sqlSession.close();
        
        return list;
    }

    @Override
    public void saveUser(User user) {
        // 创建SqlSession
        SqlSession sqlSession = this.sqlSessionFactory.openSession();

        // 执行保存逻辑
        sqlSession.insert("saveUser", user);
        // 提交事务
        sqlSession.commit();
        // 释放资源
        sqlSession.close();
    }
}
  • 测试Dao
    创建一个JUnit的测试类,对UserDao进行测试,测试代码如下:
package com.cuzz.test;

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

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;

import com.cuzz.dao.UserDao;
import com.cuzz.dao.UserDaoImpl;
import com.cuzz.pojo.User;

public class UserDaoTest {
    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void init() throws Exception {
        // 创建SqlSessionFactoryBuilder
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        // 加载SqlMapConfig.xml配置文件
        InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        // 创建SqlsessionFactory
        this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
    }

    @Test
    public void testQueryUserById() {
        // 创建DAO
        UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
        // 执行查询
        User user = userDao.queryUserById(1);
        System.out.println(user);
    }

    @Test
    public void testQueryUserByUsername() {
        // 创建DAO

        UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
        // 执行查询
        List list = userDao.queryUserByUsername("%张%");
        for (User user : list) {
            System.out.println(user);
        }
    }

    @Test
    public void testSaveUser() {
        // 创建DAO
        UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);

        // 创建保存对象
        User user = new User();
        user.setUsername("cuzz");
        user.setBirthday(new Date());
        user.setSex("1");
        user.setAddress("召唤峡谷");
        // 执行保存
        userDao.saveUser(user);
        System.out.println(user);
    }
}

问题

原始Dao开发中存在以下问题:

  • Dao方法体存在重复代码:通过SqlSessionFactory创建SqlSession,调用SqlSession的数据库操作方法
  • 调用sqlSession的数据库操作方法需要指定statement的id,这里存在硬编码,不得于开发维护。

Mapper动态代理方式

开发规范

Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口),由Mybatis框架根据接口定义创建接口的动态代理对象,代理对象的方法体同上边Dao接口实现类方法。

Mapper接口开发需要遵循以下规范:

  • Mapper.xml文件中的namespace与mapper接口的类路径相同。
  • Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
  • Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
  • Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

动态代理开发

  • 定义mapper映射文件UserMapper.xml






    
    
    
    
    
   
    
     
    
    
    
    
    
    
    
        
        
        
        
        
        
            SELECT LAST_INSERT_ID()
        
        
        INSERT INTO `user` 
        (username, birthday, sex, address) VALUES
        (#{username}, #{birthday}, #{sex}, #{address})
    
    
    
    
        UPDATE `user` SET
        username = #{username} WHERE id = #{id}
    
    
    
    
        DELETE FROM `user` WHERE
        id=#{id}
    
    

  • UserMapper(接口文件)
package com.cuzz.mapper;

import java.util.List;

import com.cuzz.pojo.User;

public interface UserMapper {
    // 根据id查询用户
    User queryUserById(int id);

    //  根据用户名模糊查询用户
    List queryUserByUsername(String username);

    // 保存用户
    void saveUser(User user);
}
  • 配置文件
    修改SqlMapConfig.xml文件
     
    
        
    
  • 测试
package com.cuzz.test;

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

import com.cuzz.mapper.UserMapper;
import com.cuzz.pojo.User;

public class UserMapperTest {
    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void init() throws Exception {
        // 创建SqlSessionFactoryBuilder
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        // 加载SqlMapConfig.xml配置文件
        InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        // 创建SqlsessionFactory
        this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
    }

    @Test
    public void testQueryUserById() {
        // 获取sqlSession,和spring整合后由spring管理
        SqlSession sqlSession = this.sqlSessionFactory.openSession();

        // 从sqlSession中获取Mapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        // 执行查询方法
        User user = userMapper.queryUserById(1);
        System.out.println(user);

        // 和spring整合后由spring管理
        sqlSession.close();
    }

    @Test
    public void testQueryUserByUsername() {
        // 获取sqlSession,和spring整合后由spring管理
        SqlSession sqlSession = this.sqlSessionFactory.openSession();

        // 从sqlSession中获取Mapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        // 执行查询方法
        List list = userMapper.queryUserByUsername("%张%");
        for (User user : list) {
            System.out.println(user);
        }

        // 和spring整合后由spring管理
        sqlSession.close();
    }

    @Test
    public void testSaveUser() {
        // 获取sqlSession,和spring整合后由spring管理
        SqlSession sqlSession = this.sqlSessionFactory.openSession();

        // 从sqlSession中获取Mapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        // 创建保存对象
        User user = new User();
        user.setUsername("cuzz");
        user.setBirthday(new Date());
        user.setSex("1");
        user.setAddress("召唤峡谷");
        // 执行查询方法
        userMapper.saveUser(user);
        System.out.println(user);


        // 和spring整合后由spring管理
        sqlSession.commit();
        sqlSession.close();
    }
}

小结

  • selectOne和selectList
    动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定,如果返回list则调用selectList方法,如果返回单个对象则调用selectOne方法。

  • namespace
    mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类,使用mapper代理方法时,输入参数可以使用pojo包装对象或map对象,保证dao的通用性。

properties(属性)

  • db.properties配置文件内容如下:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=123456
  • SqlMapConfig.xml引用如下:



    
    
    
    
    
        
            
            
            
            
                
                
                
                
            
        
    
    
     
    
        
    
    

typeAliases(类型别名)

    
        
        
        
        
        
    

mappers(映射器)

Mapper配置的几种方法:


  • 使用相对于类路径的资源(现在的使用方式)
    如:


  • 使用mapper接口类路径
    如:

注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。


  • 注册指定包下的所有mapper接口
    如:
    注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。

你可能感兴趣的:(Mybatis(一))