MyBatis

1. 框架的作用

MyBatis是持久层框架。

在Java实现数据库编程时，主要通过JDBC来实现，而JDBC相关代码在实现过程中流程相对固定，不论哪种数据操作，代码方面差距不大，所以，就出现了各种减化开发的持久层框架，常见的有Hibernate和MyBatis。

使用MyBatis框架时，无需编写JDBC相关代码，只需要为某些抽象方法配置其对应的需要执行的SQL语句即可。

2. 使用MyBatis实现数据访问

2.1. 案例目标：通过MyBatis实现用户注册

假设用户数据有：用户名、密码、年龄、手机号码、电子邮箱，通过使用MyBatis框架，实现向数据库的表中插入用户数据。

2.2. 创建数据库与数据表

创建数据库：

CREATE DATABASE tedu_ums;

使用数据库：

USE tedu_ums;

创建数据表：

CREATE TABLE t_user (
    id INT AUTO_INCREMENT,
    username VARCHAR(20) UNIQUE NOT NULL,
    password VARCHAR(20) NOT NULL,
    age INT,
    phone VARCHAR(20),
    email VARCHAR(20),
    PRIMARY KEY(id)
) DEFAULT CHARSET=UTF8;

2.3. 创建项目

创建项目时必须做的5件事情（添加web.xml，添加Tomcat环境，添加依赖，复制web.xml中的DispatcherServlet和CharacterEncodingFilter的配置，复制spring-mvc.xml）。

完成后，打开spring-mvc.xml，删除与本次项目不相关的配置，例如拦截器的配置等等。

在使用MyBatis时，还需要添加相关依赖！首先，在pom.xml中，将spring-webmvc的依赖复制一份，修改为spring-jdbc：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
    <version>4.3.10.RELEASE</version>
</dependency>

在同一个项目中，如果需要使用多个以spring-作为前缀的依赖，则应该使用相同的版本。

然后，还应该检查是否已经添加mysql-connector-java依赖，用于操作mysql数据库：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.6</version>
</dependency>

继续检查是否已经添加commons-dbcp依赖，用于处理数据库连接池等：

<dependency>
    <groupId>commons-dbcp</groupId>
    <artifactId>commons-dbcp</artifactId>
    <version>1.4</version>
</dependency>

继续检查是否已经添加junit依赖，用于单元测试：

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

然后，添加mybatis依赖：

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

通常，会将mybatis与spring整合起来使用，添加mysql-spring依赖：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>2.0.0</version>
</dependency>

注意：后续代码运行时，如果本应该存在的类/接口却提示ClassNotFoundException，或提示ZipException，则意味着新添加的依赖是下载失败的，需要删除对应的jar文件甚至所在的文件夹，然后重新更新项目。

2.4. 建立连接

在resources下创建db.properties文件，用于配置数据库连接：

url=jdbc:mysql://localhost:3306/tedu_ums?useUnicode=true&characterEncoding=utf-8
driver=com.mysql.jdbc.Driver
username=root
password=root
initialSize=2
maxActive=10

将spring-mvc.xml复制，并粘贴为spring-dao.xml，删除文件中原有的配置，并加载db.properties，将配置的属性注入到BasicDataSource中：

<!-- 读取db.properties中的配置 -->
<util:properties id="db"
    location="classpath:db.properties" />

<!-- 配置数据源 -->
<bean id="dataSource"
    class="org.apache.commons.dbcp.BasicDataSource">
    <property name="url" 
        value="#{db.url}" />
    <property name="driverClassName" 
        value="#{db.driver}" />
    <property name="username" 
        value="#{db.username}" />
    <property name="password" 
        value="#{db.password}" />
    <property name="initialSize" 
        value="#{db.initialSize}" />
    <property name="maxActive" 
        value="#{db.maxActive}" />
</bean>

然后，编写并执行单元测试：

@Test
public void getConnection() throws SQLException {
    // 加载Spring配置文件，获取Spring容器
    AbstractApplicationContext ac
        = new ClassPathXmlApplicationContext(
                "spring-dao.xml");

    // 从Spring容器中获取对象
    BasicDataSource dataSource 
        = ac.getBean("dataSource", BasicDataSource.class);

    // 测试
    Connection conn = dataSource.getConnection();
    System.out.println(conn);

    // 释放资源
    ac.close();
}

2.5. 接口与抽象方法

创建cn.tedu.mybatis.User类，在类中声明与数据表对应的6个属性：

public class User {

    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private String phone;
    private String email;

    // SET/GET/toString

}

每张数据表都应该有一个与之对应的实体类。

创建cn.tedu.mybatis.UserMapper接口，并在接口中声明抽象方法：

Integer addnew(User user);

在使用MyBatis时，如果抽象方法对应需要执行的数据操作是增、删、改，则抽象方法的返回值应该是Integer，表示受影响的行数；抽象方法的名称可以自由定义，符合语法规范并能表达语义即可；抽象方法的参数应该根据执行SQL语句时所需要的参数来决定。

然后，需要在Spring的配置文件中配置MapperScannerConfigurer，用于扫描接口文件：

<!-- MapperScannerConfigurer -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <!-- 指定接口文件所在的根包 -->
    <property name="basePackage"
        value="cn.tedu.mybatis" />
</bean>

2.6. 配置映射

从FTP下载somemapper.zip并解压得到SomeMapper.xml文件。

在resources下创建名为mappers的文件夹，将SomeMapper.xml复制到该文件夹下，并修改文件名为UserMapper.xml。

关于UserMapper.xml的配置：

<!-- namespace：匹配的Java接口 -->
<mapper namespace="cn.tedu.mybatis.UserMapper">

    <!-- 根据将要执行的SQL语句的类型选择节点 -->
    <!-- id：对应的抽象方法的方法名 -->
    <!-- 在SQL语句中的?应该使用#{}来占位 -->
    <!-- 在#{}中的名称是参数User类中的属性名 -->
    <insert id="addnew">
        INSERT INTO t_user (
            username, password,
            age, phone,
            email
        ) VALUES (
            #{username}, #{password},
            #{age}, #{phone},
            #{email}
        )
    </insert>

</mapper>

为了使得MyBatis框架能找到这些XML的映射文件并执行其中的SQL语句，还需要在Spring的配置文件中配置：

<!-- SqlSessionFactoryBean -->
<bean class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- 映射的XML文件的位置 -->
    <property name="mapperLocations"
        value="classpath:mappers/*.xml" />
    <!-- 指定数据源，取值将引用(ref)以上配置的数据源的id -->
    <property name="dataSource"
        ref="dataSource" />
</bean>

至此，开发任务已经完成，可以编写并执行单元测试：

@Test
public void addnew() {
    AbstractApplicationContext ac
        = new ClassPathXmlApplicationContext(
            "spring-dao.xml");

    UserMapper userMapper
        = ac.getBean("userMapper", UserMapper.class);
    System.out.println(userMapper);

    User user = new User();
    user.setUsername("root");
    user.setPassword("1234");
    user.setAge(18);
    user.setPhone("13800138001");
    user.setEmail("root@tedu.cn");
    Integer rows = userMapper.addnew(user);
    System.out.println("rows=" + rows);

    ac.close();
}