# mybatis基本应用


<!--more-->

# 基本应用
## 一、开发步骤
1. 添加MyBatis的坐标  
```xml
    <!--mybatis坐标-->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.4.5</version>
    </dependency>

    <!--mysql驱动坐标-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.6</version>
        <scope>runtime</scope>
    </dependency>
    <!--单元测试坐标-->
```
2. 创建**数据表  
3. 编写**实体类  
4. 编写映射文件**Mapper.xml  
```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="**Mapper">
        <select id="findAll" resultType="com.***">
            select * from User
        </select>
    </mapper>
```
5. 编写核心文件SqlMapConfig.xml  
```xml
    <!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"/>
                    <dataSource type="POOLED">
                        <property name="driver" value="com.mysql.jdbc.Driver"/>
                        <property name="url" value="jdbc:mysql:///test"/>
                        <property name="username" value="root"/>
                        <property name="password" value="root"/>
                    </dataSource>
                </environment>
            </environments>
            <mappers>
                <mapper resource="com/**/**Mapper.xml"/>
            </mappers>
        </configuration>
```
6. 编写测试类
```java
    //加载核心配置文件
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    //获得sqlSession工厂对象
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    //获得sqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //执行sql语句
    List<User> userList = sqlSession.selectList("userMapper.findAll");
    //打印结果
    System.out.println(userList);
    //释放资源
    sqlSession.close();
```

## 二、配置文件
### 映射文件概述
![mapper.png](https://img.zhaojq.top/20260727184920586.png "mapper.png")
### 核心配置文件
1. 层级关系
- configuration
  - properties 属性
  - settings 设置
  - typeAliases 类型别名
  - typeHandlers 类型处理器
  - objectFactory 对象工厂
  - plugins 插件
  - environments 环境
    - environment 环境变量
      - transactionManager 事务管理器
      - dataSource 数据源
  - databaseIdProvider 数据库厂商标识
  - mappers 映射器
2. 常用配置
- environments
  ![environment.png](https://img.zhaojq.top/20260727184920795.png "environment.png")
  > transactionManager 有两种
  > - JDBC：这个配置就是直接使用了JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域
  > - MANAGED：这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。默认情况下它会关闭连接，然而一些容器并不希望这样，因
    此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为
  > 
  > dataSource 有三种
  > - UNPOOLED：这个数据源的实现只是每次被请求时打开和关闭连
  > - POOLED：这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来
  > - JNDI：这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用
  
- mapper

  > 使用相对于类路径的资源引用，例如：
  >
  > `<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>`
  >
  > 使用完全限定资源定位符（URL），例如：
  >
  > `<mapper url="file:///var/mappers/AuthorMapper.xml"/>`
  >
  > 使用映射器接口实现类的完全限定类名，例如：
  >
  > `<mapper class="org.mybatis.builder.AuthorMapper"/>`
  >
  > 将包内的映射器接口实现全部注册为映射器，例如：
  >
  > `<package name="org.mybatis.builder"/>`

## 三、常用API

### 1. SqlSession工厂构建器SqlSessionFactoryBuilder

常用API：SqlSessionFactory build(InputStream inputStream)

通过加载mybatis的核心文件的输入流的形式构建一个SqlSessionFactory对象

其中， Resources 工具类，这个类在 org.apache.ibatis.io 包中。Resources 类帮助你从类路径下、文

件系统或一个 web URL 中加载资源文件

```java
String resource = "org/mybatis/builder/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(inputStream);
```

### 2. SqlSession工厂对象SqlSessionFactory

- openSession()  默认开启一个事务，但不会自动提交
- openSession(boolean autoCommit) 参数为是否自动提交

### 3. SqlSession会话对象

SqlSession 实例在 MyBatis 中是非常强大的一个类。在这里你会看到所有执行语句、提交或回滚事务

和获取映射器实例的方法

执行语句主要有：

```java
<T> T selectOne(String statement, Object parameter)
<E> List<E> selectList(String statement, Object parameter)
int insert(String statement, Object parameter)
int update(String statement, Object parameter)
int delete(String statement, Object parameter)
```

操作事务方法主要有：

```java
void commit()
void rollback()
```



## 四、Dao层实现

### 1.传统开发方式

```java
//dao接口
public interface UserDao {
	List<User> findAll() throws IOException;
}

//实现
public class UserDaoImpl implements UserDao {
  public List<User> findAll() throws IOException {
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    SqlSessionFactory sqlSessionFactory = new
    SqlSessionFactoryBuilder().build(resourceAsStream);
    SqlSession sqlSession = sqlSessionFactory.openSession();
    List<User> userList = sqlSession.selectList("userMapper.findAll");
    sqlSession.close();
    return userList;
  }
}
//测试
@Test
public void testTraditionDao() throws IOException {
  UserDao userDao = new UserDaoImpl();
  List<User> all = userDao.findAll();
  System.out.println(all);
}
```



### 2.代理开发方式

Mapper 接口开发方法只需要程序员编写Mapper 接口（相当于Dao 接口），由Mybatis 框架根据接口

定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。

规范如下：

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

```java
@Test
public void testProxyDao() throws IOException {
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    SqlSessionFactory sqlSessionFactory = new
    SqlSessionFactoryBuilder().build(resourceAsStream);
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //获得MyBatis框架生成的UserMapper接口的实现类
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    User user = userMapper.findById(1);
    System.out.println(user);
    sqlSession.close();
}
```