Mybatis学习 - 基本功能

一、什么是mybatis

mybatis是一个优秀的基于java的持久层框架，它内部封装了jdbc，开发这只需要关注sql语句本身，而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程。（jdbc基本配置）

mybatis通过xml或注解的方式，将要执行的各种statement配置起来，并通过java对象和statement中sql的动态参数进行映射，生成最终执行的sql语句。（statement封装）

最后mybatis框架执行sql并将结果映射为java对象并返回。采用orm思想解决了实体和数据库映射的问题，对jdbc进行了封装，屏蔽了jdbc api底层访问细节，使我们不用与jdbc api打交道，就可以完成对数据库的持久化操作。（结果集映射）

二、开发步骤

1. 引入maven坐标
2. 创建数据表
3. 编写实体类
4. 编写映射文件XxxMapper.xml
5. 编写核心文件SqlMapConfig.xml
6. 测试

三、例子

基于jdk11

1. 引入maven坐标

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.7</version>
</dependency>

2. 创建数据表

create database if not exists test character set 'utf8';
use test;

create table user (
    id int auto_increment,
    username varchar(64),
    password varchar(64),
    primary key (id)
);

3. 创建实体类User

根据数据表创建

public class User {    
	private int id;    
	private String username;    
	private String password;
    //省略get个set方法
}

4. 编写UserMapper配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!-- 映射文件DTD约束头 -->
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- mapper 根标签；
     namespace 命名空间，与下面的语句id一起组成查询的标识 -->
<mapper namespace="userMapper">
    <!-- 语句标签，select insert update delete 
         语句id 与上面的命名空间一起组成查询的标识
        resultType 查询结果对应的实体类型
    -->
    <select id="findAll" resultType="mybatis.model.User">
        <!-- 要执行的sql语句 -->
        select id, username, password from user
    </select>
</mapper>

5. 编写mybatis核心文件

文件例子：

<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <environments default="development"> <!-- 指定默认的环境名称 -->
        <environment id="development"> <!-- 指定当前环境的名称 -->
            <transactionManager type="JDBC"/> <!-- 指定事务管理类型是jdbc -->
            <dataSource type="POOLED"> <!-- 指定当前数据源类型是连接池 -->
                <!-- 数据源配置的基本参数 -->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/test?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="mapper/UserMapper.xml"/>
    </mappers>
</configuration>

配置项说明

• 事务管理器：
  （1）JDBC ：这个配置就是直接使用了JDBC的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
  （2）MANAGED：这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将closeConnection属性设置为false来组织它默认的关闭行为。

• 数据源：
  （1）UNPOOLED：这个数据源的实现知识每次被请求时打开和关闭连接
  （2）POOLED：这种数据源的实现利用池的概念，将JDBC连接对象组织起来
  （3）JNDI：这个数据源的实现是为了能在EJB或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个JNDI上下文的引用

• mapper标签
  该标签作用是加载映射，有以下几种方式
  （1）类路径的资源引用

<mapper resource="mapper/UserMapper.xml"/>

（2）使用完全限定资源定位符(URL)

<mapper url="file:///var/mappers/UserMapper.xml"/>

（3）使用映射器接口实现类的完全限定类名

<mapper class="org.mybatis.builder.AuthorMapper"/>

（4）将包内的映射器接口（Mapper）实现全部注册为映射器

<mapper name="org.mybatis.builder"/> <!-- 将该包下所有的Mapper实现类注册 -->

• properties文件
  实际开发中，习惯将数据源的配置信息单独抽取成一个properties文件，该标签可以加载额外配置的properties文件
  -> 在核心配置文件中 增加

  <configuration>
  	<properties resource="jdbc.properties"/>
  	<environments>
  		<environment>
  			<transactional/>
  			<datasource>
  				<property name="xxx" value="${jdbc.properties文件中的key}"/>
  				...
  			</datasource>
  		</environment>
  </configuration>
  

• 其他标签
  

6. 测试

// 加载核心配置文件
InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
// 获得sqlSession工厂对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
// 获取sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 执行sql语句
List<User> list = sqlSession.selectList("userMapper.findAll");
System.out.println(list);
sqlSession.close();

四、Demo们：插入，更新，删除，将结果集映射为map

• UserMapper.xml

<!-- 插入，更新，删除 -->
 <!-- parameterType属性指定要插入的数据类型 -->
 <insert id="add" parameterType="mybatis.model.User">
     <!-- sql语句中使用#{实体属性名}方式引用实体中的属性值 -->
     insert into user values(#{id}, #{username}, #{password})
 </insert>

 <update id="updateById" parameterType="mybatis.model.User">
     update user set username=#{username}, password=#{password} where id=#{id}
 </update>

 <delete id="deleteById" parameterType="java.lang.Integer">
     <!-- sql语句中使用#{任意字符串}方式引用传递的单个参数 -->
     delete from user where id=#{id}
 </delete>

 <select id="queryMap" resultType="java.util.Map">
     select * from user
 </select>

• 代码

// 插入
@Test
public void insert() throws IOException {
    // 加载核心配置文件
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    // 获得sqlSession工厂对象
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    // 获取sqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    User user = new User();
    user.setId(3);
    user.setUsername("tom");
    user.setPassword("123");
    // 执行sql语句 api sqlSession.insert(命名空间.id, 实体对象)
    int affectedRows = sqlSession.insert("userMapper.add", user);
    sqlSession.commit(); // 插入操作涉及数据库数据变化，需要提交事务
    System.out.println(affectedRows);
    sqlSession.close();
}

// 更新
@Test
public void update() throws IOException {
    // 加载核心配置文件
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    // 获得sqlSession工厂对象
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    // 获取sqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    User user = new User();
    user.setId(3);
    user.setUsername("tom");
    user.setPassword("12345");
    // 执行sql语句 api sqlSession.update(命名空间.id, 实体对象)
    int affectedRows = sqlSession.update("userMapper.updateById", user);
    sqlSession.commit(); // 更新操作涉及数据库数据变化，需要提交事务
    System.out.println(affectedRows);
    sqlSession.close();
}

// 删除
@Test
public void delete() throws IOException {
    // 加载核心配置文件
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    // 获得sqlSession工厂对象
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    // 获取sqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    // 执行sql语句 api sqlSession.delete(命名空间.id, Object)
    int affectedRows = sqlSession.delete("userMapper.deleteById", 3);
    sqlSession.commit(); // 插入操作涉及数据库数据变化，需要提交事务
    System.out.println(affectedRows);
    sqlSession.close();
}

// 将结果集映射成map
@Test
public void testQuery() throws IOException {
    // 加载核心配置文件
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    // 获得sqlSession工厂对象
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    // 获取sqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    // 执行sql语句
    List<Map<String, Object>> list = sqlSession.selectList("userMapper.queryMap");
    System.out.println(list); // [{password=12345, id=1, username=jimmy}, {password=123, id=2, username=happy}]
    sqlSession.close();
}