Mybatis入门：记一个简单的Mybatis程序

一个简单的Mybatis程序

什么是Mybatis?

MyBatis 是一款持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 简化了JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可通过 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

环境准备

• IDEA
• MySQL
• jdk1.8
• Maven

创建Maven项目

1. 在pom.xml中导入项目所需Jar包，为了不用每次都导入包，可在父工程的pom.xml中导入，还需要配置build防止静态资源文件无法导出到生成目录target下；

    <dependencies>
        <!--mysql驱动,用于连接数据库-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.12</version>
        </dependency>
        
        <!--mybatis依赖-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.0</version>
        </dependency>
        
        <!--junit测试依赖-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

<!--    防止静态资源文件导出失败问题-->
<!--    若未配置会报错：Could not find resource com/lsq/dao/UserMapper.xml-->
    <build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

2. 创建POJO类

public class User {
    private int id;
    private String pwd;
    private String name;
    //省略Getter和Setter
}

3. 数据库操作的UserMapper接口

public interface UserMapper {
	//获取所有用户
    List<User> getUserList();
    //通过ID获取单个用户
    User getUserById(int id);
    //添加一个用户对象
    int addUser(User user);
    //更新用户
    int updateUser(User user);
    //根据ID删除用户
    int deleteUser(int id);
}

4. 编写UserMapper.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">
<!--命名空间要与UserMapper对应-->
<mapper namespace="com.lsq.dao.UserMapper">

    <!--id是要实现的方法名-->
    <!--
        属性匹配规则：
        1.数据库查询到的字段会先与实体类字段名进行匹配
        2.若字段名不一致，则会根据类型进行匹配
        3.若存在多个类型一致的字段,则进行默认初始化
        4.若按规则匹配,有且仅有一个字段未匹配，会忽略类型和名称进行匹配
        5.查询返回多个对象用数组接收
    -->
    <select id="getUserList" resultType="com.lsq.pojo.User">
        select * from mybatis.user
    </select>

    <select id="getUserById" parameterType="int" resultType="com.lsq.pojo.User">
        select * from mybatis.user where id=#{id}
    </select>

    <insert id="addUser" parameterType="com.lsq.pojo.User">
        insert into mybatis.user (id,name,pwd) values (#{id},#{name},#{pwd});
    </insert>

    <update id="updateUser" parameterType="com.lsq.pojo.User">
        <!--错误表达式：不能加圆括号,set (pwd=#{pwd},name=#{name})-->
        update mybatis.user set id=#{id},pwd=#{pwd},name=#{name} where id=#{id};
    </update>

    <delete id="deleteUser" parameterType="int">
        delete from mybatis.user where id=#{id}
    </delete>
</mapper>

5. 封装一个工具类获取SqlSessionFactory的实例SqlSession 来操作数据库；

public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        //SqlSessionFactory的实例是通过SqlSessionFactoryBuilder获得。
        //SqlSessionFactoryBuilder则可XML配置文件中来构建出 SqlSessionFactory实例
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
    // SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }

}

6. 在静态资源文件夹resources下Mybatis的核心配置文件mybatis-config.xml；

<!--头部声明用来验证 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>

	<!--environment 包含了事务管理和连接池的配置-->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url"
                          value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;userUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    <!--每一个Mapper.xml都需要在 Mybatis核心配置文件中注册-->
    <!--若没有注册则会报如下错误-->
    <!--Type interface com.lsq.dao.UserMapper is not known to the MapperRegistry.-->
    <!--注意必须是/分割,点号分隔会报错找不到文件-->
    <!--<mapper resource="com.lsq.dao.UserMapper.xml"/>-->
    <mappers>
        <mapper resource="com/lsq/dao/UserMapper.xml"/>
    </mappers>
</configuration>

7. 测试类

public class UserMapperTest {

    @Test
    public void test() {
        //获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);

        //通过ID查询用户
        User user = mapper.getUserById(4);
        System.out.println("通过ID查询用户：");
        System.out.println(user);

        //插入用户
        mapper.addUser(new User(6,"12344","李龙"));

        //更新用户信息
        mapper.updateUser(new User(4,"99999","乐乐"));

        //删除用户
        mapper.deleteUser(4);
        sqlSession.commit();

        //获取全部用户
        System.out.println("获取全部用户：");
        List<User> userList = mapper.getUserList();
        for (User us : userList) {
            System.out.println(us);
        }

        sqlSession.close();
    }
}

注意：增删改需要提交事务sqlSession.commit()才会生效

个人总结

1. UserMapper.xml文件实现了接口UserMapper，而二者是通过UserMapper.xml中的命名空间进行绑定的；

2. SqlSessionFactoryBuilder 通过读取配置文件mybatis-config.xml获得SqlSessionFactory，通过SqlSessionFactory获得SqlSession实例，而SqlSession 提供了在数据库执行 SQL 命令所需的所有方法；

3. SqlSession通过getMapper(UserMapper.class)获得UserMapper实例，相当于new了一个UserMapper实例。