mybatis入门实例

简介

MyBatis 是支持普通 SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis 消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Old Java Objects，普通的 Java对象）映射成数据库中的记录。

每个MyBatis应用程序主要都是使用SqlSessionFactory实例的，一个SqlSessionFactory实例可以通过SqlSessionFactoryBuilder获得。SqlSessionFactoryBuilder可以从一个xml配置文件或者一个预定义的配置类的实例获得。

用xml文件构建SqlSessionFactory实例是非常简单的事情。推荐在这个配置中使用类路径资源（classpath resource)，但你可以使用任何Reader实例，包括用文件路径或file://开头的url创建的实例。MyBatis有一个实用类—-Resources，它有很多方法，可以方便地从类路径及其它位置加载资源。

工作过程
(1)加载配置并初始化

触发条件：加载配置文件

处理过程：将SQL的配置信息加载成为一个个MappedStatement对象（包括了传入参数映射配置、执行的SQL语句、结果映射配置），存储在内存中。

(2)接收调用请求

触发条件：调用Mybatis提供的API

传入参数：为SQL的ID和传入参数对象

处理过程：将请求传递给下层的请求处理层进行处理。

(3)处理操作请求

触发条件：API接口层传递请求过来

传入参数：为SQL的ID和传入参数对象

处理过程：

(A)根据SQL的ID查找对应的MappedStatement对象。

(B)根据传入参数对象解析MappedStatement对象，得到最终要执行的SQL和执行传入参数。

(C)获取数据库连接，根据得到的最终SQL语句和执行传入参数到数据库执行，并得到执行结果。

(D)根据MappedStatement对象中的结果映射配置对得到的执行结果进行转换处理，并得到最终的处理结果。

(E)释放连接资源。

(4)返回处理结果将最终的处理结果返回。

实例
开发环境：
mybatis-3.2.7
Eclipse Java EE IDE for Web Developers.
jdk 1.8
实例背景：
对用户表进行增删改查，表设计如下：

当前表中测试数据如下：

1）创建Web Project

2）这里手动加入相关依赖，导入依赖的jar包

和mybatis所依赖的包，在其对应的lib文件夹下

3）新建资源文件夹config，并在该文件夹下创建主配置文件SqlMapConfig.xml、日志配置文件log4j.properties、和用来存放输入（输出）映射的文件的包sqlmap
4）配置log4j.properties，内容如下：

# Root logger option#开发环境设为DEBUG,生产环境设为INFOlog4j.rootLogger=DEBUG, stdout# Direct log messages to stdoutlog4j.appender.stdout=org.apache.log4j.ConsoleAppender#log4j.appender.stdout.Target=System.outlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

5）设计用户实例类：com.peace.domain.User，代码如下：

package com.peace.domain;import java.util.Date;public class User {    private int id;    private String username;    private Date birthday;    private String sex;    private String address;    public int getId() {        return id;    }    public void setId(int id) {        this.id = id;    }    public String getName() {        return username;    }    public void setName(String name) {        this.username = name;    }    public Date getBirthday() {        return birthday;    }    public void setBirthday(Date birthday) {        this.birthday = birthday;    }    public String getSex() {        return sex;    }    public void setSex(String sex) {        this.sex = sex;    }    public String getAddress() {        return address;    }    public void setAddress(String address) {        this.address = address;    }    @Override    public String toString() {        return "User [id=" + id + ", username=" + username + ", birthday=" + birthday + ", sex=" + sex + ", address=" + address                + "]";    }   }

6）编写用户实例增删改查需要使用的输入输出映射文件User.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="user_test">    <!-- 最后通过这个id，将其封装到mappedStatement -->    <select id="getUserById" parameterType="int" resultType="com.peace.domain.User">    <!-- #{}表示一个点位符, parameterType指定传入参数的类型, resultType指定要把单条记录映射成的类型 -->        select * from user where id=#{id}    <!-- 如果传入的参数类型为简单类型则{}中的变量名可任意 -->    </select>    <!-- ${}表示拼接字符串，将传入的值不做任何处理拼接，但可能会出来sql注入问题     ${value}:表示传入的参数 内容，如果传入的是简单类型，变量名只能为value-->    <select id="getUserByName" parameterType="java.lang.String" resultType="com.peace.domain.User">        select * from user where username like '%${value}%'        </select><!--     /**     * mysql自增主键，执行insert提交之前会自动生成一个当前主键     * 通过mysql的函数获取刚插入记录的自增主键：LAST_INSET_ID()     */ -->        <!-- 传入的参数类型为pojo，#{}中的变量名应该为pojo的属性名-->    <insert id="addUser" parameterType="com.peace.domain.User">        <!-- LAST_INSERT_ID()返回刚插入的自增主键值，只适用于自增主键             keyProperty:将查询到的主键值设置到parameterType指定对象对应的属性值去             order:select LAST_INSERT_ID()在insert之后执行-->        <selectKey keyProperty="id" order="AFTER" resultType="int">            select LAST_INSERT_ID()        </selectKey>        insert into user(username, birthday, sex, address) values(#{username},#{birthday},#{sex},#{address})    </insert><!--     /**     * mysql非自增主键返回，使用mysql的uuid()函数生成，需要修改表中的id字段为string类型     * 长度设为35位     * 在insert之前执行select uuid()     */ -->        <insert id="addUser1" parameterType="com.peace.domain.User">        <!-- LAST_INSERT_ID()返回刚插入的自增主键值，只适用于自增主键             keyProperty:将查询到的主键值设置到parameterType指定对象对应的属性值去             order:select LAST_INSERT_ID()在insert之后执行-->        <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">            select uuid()        </selectKey>        insert into user(id, username, birthday, sex, address) values(#{id}, #{username},#{birthday},#{sex},#{address})    </insert>    <update id="updateUser" parameterType="com.peace.domain.User">        update user set username=#{username}, birthday=#{birthday}, sex=#{sex}, address=#{address} where id=#{id}    </update>    <delete id="deleteUser" parameterType="int">        delete from user where id=#{id}    </delete></mapper>

7）配置主配置文件SqlMapConfig.xml，内容如下 ：

<?xml version="1.0" encoding="UTF-8" ?> <!-- DOCTYPE后边的标签名只能取为configuration --><!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">      <!-- 使用jdbc事务管理,事务控制由mybatis管理-->        <transactionManager type="JDBC" />      <!-- 数据库连接池,由mybatis管理-->        <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="1234" />        </dataSource>      </environment>    </environments>    <mappers>        <mapper resource="sqlmap/User.xml"/>    </mappers></configuration>

注：DOCTYPE后边的标签名只能取为configuration
8）编写测试类com.peace.test.UserTest，代码如下：

package com.peace.test;import java.io.IOException;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.Test;import com.peace.domain.User;public class UserTest {    /**     * 根据id查一个用户记录     */    @Test    public void getUserById() throws IOException {        //mybatis配置文件的路径        String resource = "SqlMapConfig.xml";        //获取配置文件流        InputStream inputStream = Resources.getResourceAsStream(resource);        //创建会话工厂，传入mybatis配置文件信息        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);        //通过工厂得到会话        SqlSession session = sqlSessionFactory.openSession();        //通过session操作数据库        User user = session.selectOne("user_test.getUserById", 3);        System.out.println(user);        session.close();    }    /**     * 根据name模糊查一个用户记录     */    @Test    public void getUsersByName() throws IOException {        //mybatis配置文件的路径        String resource = "SqlMapConfig.xml";        //获取配置文件流        InputStream inputStream = Resources.getResourceAsStream(resource);        //创建会话工厂，传入mybatis配置文件信息        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);        //通过工厂得到会话        SqlSession session = sqlSessionFactory.openSession();        //通过session操作数据库        List<User> users = session.selectList("user_test.getUserByName", "o");        for(User u : users) {            System.out.println(u);        }        session.close();    }    /**     * 添加一个用户记录     */    @Test    public void addUser() throws IOException {        //mybatis配置文件的路径        String resource = "SqlMapConfig.xml";        //获取配置文件流        InputStream inputStream = Resources.getResourceAsStream(resource);        //创建会话工厂，传入mybatis配置文件信息        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);        //通过工厂得到会话        SqlSession session = sqlSessionFactory.openSession();        //通过session操作数据库        User user = new User();        user.setBirthday(new Date());        user.setName("ABC");        user.setSex("0");        user.setAddress("address:2222");        session.insert("user_test.addUser", user);        session.commit();        System.out.println(user.getId());        session.close();    }    /**     * 更新用户信息     */    @Test    public void updateUser() throws IOException {        //mybatis配置文件的路径        String resource = "SqlMapConfig.xml";        //获取配置文件流        InputStream inputStream = Resources.getResourceAsStream(resource);        //创建会话工厂，传入mybatis配置文件信息        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);        //通过工厂得到会话        SqlSession session = sqlSessionFactory.openSession();        //通过session操作数据库        User user = new User();        user.setBirthday(new Date());        user.setName("ABC");        user.setSex("1");        user.setId(6);        user.setAddress("address:2223ddsfsdf2");        session.update("user_test.updateUser", user);        session.commit();        session.close();    }    /**     * 删除一个用户信息     */    @Test    public void deleteUser() throws IOException {        //mybatis配置文件的路径        String resource = "SqlMapConfig.xml";        //获取配置文件流        InputStream inputStream = Resources.getResourceAsStream(resource);        //创建会话工厂，传入mybatis配置文件信息        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);        //通过工厂得到会话        SqlSession session = sqlSessionFactory.openSession();        //通过session操作数据库        session.delete("user_test.deleteUser", 6);        session.commit();        session.close();    }}

9）测试结果
getUserById

getUserByName

addUser


updateUser

deleteUser

附——工程代码结构图