mybatis入“坑”第一步

一、导入坐标

要想通过maven创建一个简单的mybatis项目，首先需要的是要导入相关的坐标。需要导入的坐标如下：

<dependencies>
	<!--mysql驱动坐标-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.46</version>
    </dependency>
    <!-- mybatis坐标 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <!--单元测试坐标-->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
</dependencies>

创建实体类User和在数据库中插入创建对应的user表。

二、配置mybatis的核心配置文件mybtis-config.xml

创建mybatis-config.xml的配置文件，用于配置连接数据库和注册Mapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="db.properties" />

    <!--数据库连接的环境配置-->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <!--每一个Mapper.xml都需要在mybatis核心配置文件中注册-->
    <mappers>
        <mapper resource="com/wkx/dao/UserMapper.xml"/>
    </mappers>
</configuration>

①properties标签：可以动态配置属性。

可以全部在外部进行配置，如下：

<properties resource="db.properties" />

也可以在通过property标签一部分在外部进行内部配置另一部分在内部进行配置(如下)，增加配置的灵活性。

<properties resource="db.properties">
    <property name="username" value="root"/>
    <property name="password" value="123456"/>
</properties>

②环境配置environments标签：用于配置数据的环境。可配置多个数据库环境，但是SqlSessionFactory只能选择一个去使用。如下：

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="${driver}"/>
            <property name="url" value="${url}"/>
            <property name="username" value="${username}"/>
            <property name="password" value="${password}"/>
        </dataSource>
    </environment>
    <environment id="test">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="${driver}"/>
            <property name="url" value="${url}"/>
            <property name="username" value="${username}"/>
            <property name="password" value="${password}"/>
        </dataSource>
    </environment>
</environments>

可以在不同的环境下切换不同的数据环境，只需要修改environments标签中的default属性对应不同环境下的id属性，比如development和test不同的环境。

③映射器mappers：定义映射的路径，告诉mybatis去哪里找对应的语句。除了上述通过类路径的资源引用方式，也可以通过其它的方式。比如通过包的形式将映射器接口全部注册为映射器，如下：

<mappers>
  <package name="com.wkx.dao"/>
</mappers>

问题：Mapper.xml的配置文件在mybatis核心配置文件注册时找不到对应Mapper.xml，是因为maven读取配置文件时只在resources的文件目录下寻找，所以需要在pom.xml文件中配置过滤器。所以pom.xml中应该添加如下代码：

<!--在build中配置resources,来防止资源导出失败的原因-->
<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>

        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

三、创建Mapper.xml

完成mybatis-config.xml配置文件的创建后，接着需要配置相关的Mapper.xml，进而进行SQL语句的编写。

<mapper namespace="com.wkx.dao.UserMapper">
    <select id="getUser" resultType="com.wkx.pojo.User">
        select * from user
    </select>

    <!--使用User类作为输入类型-->
    <update id="updateUser" parameterType="com.wkx.pojo.User">
        update user set name=#{name},pwd=#{pwd} where id=#{id}
    </update>

    <!--map类型(只需要其中的key对应sql语句中的需要注入的值)-->
    <update id="updateUserMap" parameterType="map">
        update user set name=#{username} where id=#{uid}
    </update>
</mapper>

①namespace命名空间：使用全限定类名对语句进行隔离，以及实现对接口的绑定。

②select、update等标签中的id属性对应的是Mapper接口中的方法名。通过id找到对应的方法需要执行的SQL语句。

③使用的Map集合类型对数据的SQL语句进行操作，只需要将Map集合中key对应SQL语句中的需要注入的值。也就是说SQL注入的值可以不和实体类中属性一致。同时，使用Map集合而不是User类作为传入类型进行传输时不需要将User类中所有数据传输。

四、编写工具类

mybatis的使用需要以SqlSessionFactory为核心，使用SqlSessionFactory去生产SqlSession对象。创建一个工具类去生产SqlSession对象，以后使用mybatis便可以从该工具类中拿出SqlSession。

public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    // 调用该类执行该静态模块中的代码，获取SqlSessionFactory
    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 通过该方法可以生产SqlSession对象
    public SqlSession getSqlSession(){
        SqlSession sqlSession = sqlSessionFactory.openSession();
        return sqlSession;
    }
}

五、测试

接着我们就可以利用mybatisUtils工具类生产的SqlSession对象去调用openSession执行对应的Mapper接口，就可以调用接口中的方法去执行对应的SQL语句。

具体测试类如下：

// 查询所有用户信息
@Test
public void queryUserTest(){
    MybatisUtils mybatisUtils = new MybatisUtils();
    // 调用mybatisUtils中的getSqlSession方法获取SqlSession对象
    SqlSession sqlSession = mybatisUtils.getSqlSession();
    // 执行SqlSession中的getMapper方法，以便后来来执行对应的Mapper接口方法
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    // 执行接口方法，配置完成mybatis会调用的对应的SQL语句执行
    List<User> user = mapper.getUser();
    sqlSession.close();
    System.out.println(user);
}

// 使用Map数据类型对数据进行更新
@Test
public void updateUserMap(){
    MybatisUtils mybatisUtils = new MybatisUtils();
    SqlSession sqlSession = mybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);

    Map<String,Object> map = new HashMap<>();

    map.put("username","王三");
    // map.put("password","2334op");
    map.put("uid","3");

    int count = mapper.updateUserMap(map);

    /*增删改的数据库操作需要提交事务*/
    sqlSession.commit();
    sqlSession.close();
    System.out.println(count);
}

注意：① 增删改的SQL语句操作都需要进行事务的提交。

          ② SqlSession使用完后要记得关闭。