MyBatis | 入门和基础

作者: EclipseO2 | 来源:发表于2018-07-24 10:56 被阅读3次

    花了差不多20天的时间把Spring和SpringMVC差不多入了个门,今天,开始学持久化框架MyBatis,虽然之前也用过,但是没能系统的学过,从今天起,认真学习,认真总结

    一、什么是 MyBatis ?

    官方博客是这么说的:MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

    简单的来说,就是之前将数据库表中的字段与 JavaBean 的属性相映射,同时,Sql 语句可以不用嵌在代码中,而只需要写在 XML 配置文件中

    二、如何使用 Mybatis ?

    2.1 所需架包
    • mybatis-3.4.6.jar
    • mysql-connector-java-5.1.41.jar
    • log4j-1.2.17.jar

    2.2 配置文件
    ①. log4j.properties

    配置 log4j 日志文件

    # Global logging configuration
    # developer-->DEBUG  productor-->INFO or ERROR
    log4j.rootLogger=DEBUG, stdout
    # MyBatis logging configuration...
    log4j.logger.org.mybatis.example.BlogMapper=TRACE
    # Console output...
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
    

    由于 MyBatis 需要依赖 log4j, 因此首先新建一个 log4j.properties 配置文件,日志级别设置为 DEBUG

    ②. mybatis-config.xml

    作为全局配置文件,包含获取数据库连接实例的数据源 DataSource 和决定事务作用域和控制方式的事务管理器 TransactionManager,这些都可以在全局配置文件中设置。

    当然,我们同样可以像之前配置 c3p0 那样,把配置信息以键值对的方式储存在类路径下的配置文件中,这会在后面做演示

    <?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>
        <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://localhost:3306/mybatis?useSSL=false" />
                    <property name="username" value="root" />
                    <property name="password" value="lwh011305" />
                </dataSource>
            </environment>
        </environments>
    
        <mappers>
            <mapper resource="mymapper.xml" />
        </mappers>
    </configuration>
    

    <mapper> 中引用 sql 映射文件,这在后面也会详细讲述

    2.3 编写代码

    首先得有一个 POJO 类,这里我定义的是 Employee.java

    public class Employee {
    
        private Integer id;
        private String lastName;
        private String email;
        private String gender;
    
        public Integer getId() {
            return id;
        }
    
        public void setId(Integer id) {
            this.id = id;
        }
             ...
    }
    

    当然只列举了部分

    ①. 从 XML 中构建 SqlSessionFactory

    这里我参照的是 MyBatis 官方文档给出的代码,我先写一个获取 SqlSessionFactory 对象的类,该类返回的是 SqlSessionFactory 的实例

    private SqlSessionFactory getSqlSessionFactoty() throws IOException {
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        return sqlSessionFactory;
    }
    

    这里使用类路径下的资源文件进行配置,该资源文件是全局配置。

    ②. 从 SqlSessionFactory 中获取 SqlSession

    SqlSession 包含了面向数据库执行 SQL 命令所需的所有方法,包括增、删、改、查等等

    selectOne(String statement, Object parameter)
    statement:sql 唯一标识, 即对应 mymapper.xml 中设置的 id 值
    parameter:执行 sql 要使用的参数,比如 id,name 等等

    @Test
    void test() throws IOException {
        
        //1. 根据 xml 配置文件(全局配置文件)创建一个 SqlSessionFactory
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactoty();
    
        //2. 获取 sqlSession 实例, 能直接执行已经映射的 sql 语句
        SqlSession sqlSession = sqlSessionFactory.openSession();
    
        try {
            Employee employee = sqlSession.selectOne("emp", 3);
            System.out.println(employee);
        } finally {
            sqlSession.close();
        }
        
    }
    

    可以看到,上面的 selectOne 方法的第一个参数已经设定,这是因为我已经配置好了 sql 映射文件 mymapper.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="ee">
        <select id="emp" resultType="edu.just.mybatis.Employee">
            select id, last_name lastName, email, gender from Employee where id = #{id}
        </select>
    </mapper>
    

    介绍一下配置文件的参数(当然,这只是最基本的几个参数,更加详细的介绍会在之后文章)
    namespace:命名空间,这种方式可以随意设置命名空间的值
    id:标识映射文件中的sql,SqlSession 的 selectOne 的第一个参数就是对应的这个 id
    #{id}:从传递过来的参数中获取 id 值,类似于 jdbc 中的 “?”
    resultType:指定输出结果的类型,即查询结果所映射的java对象,这里返回的对象是 Employee

    以下是这段代码的执行流程:

    1. 根据全局配置文件(mybatis-config.xml), 创建一个 SqlSessionFactory 对象, 该配置文件包含数据源的配置信息
    2. sql 映射文件(mymapper.xml), 用来写 sql 语句, 配置了每一个 sql, 以及 sql 的封装规则
    3. 将 sql 映射文件注册在全局配置文件中
    4. 1). 根据全局配置文件得到 SqlSessionFactory
      2).使用 SqlSessionFactory, 获取到 sqlSession 对象, 并使用该对象来执行增删改查操作,一个 sqlSession 就是代表和数据库的一次会话, 用完关闭
      3).使用 sql 的唯一标志(配置文件的 id 属性)来告诉 mybatis 执行哪个 sql. 语句都是保存在 sql 映射文件中的


    但是,官方还给我们提供了另外一种方式,接口式编程。即在接口里面定义对数据库的各种操作方式,然后将接口类名对应到 sql 配置文件的命名空间中(namespace)

    我们先写一个接口类

    public interface EmployeeMapper {
        public Employee getEmployee(Integer id);
    }
    

    把接口类映射到 sql 配置文件的 namespace 中,id 即为接口中的方法名,这里是 getEmployee,resultType 即运行语句返回的对象,这里是 Employee

    <?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="edu.just.mybatis.dao.EmployeeMapper">
        <select id="getEmployee" resultType="edu.just.mybatis.Employee">
            select id, last_name lastName, email, gender from Employee where id = #{id}
        </select>
    </mapper>
    

    接下来写测试代码

    @Test
    void test2() throws IOException {
            
        //1. 获取 sqlSessionFactory 对象
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactoty();
        
        //2. 获取 sqlSession 对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        
        try {
            //3. 获取接口的实现类对象, 会为接口自动创建一个代理对象, 代理对象去执行增、删、改、查
            EmployeeMapper employeeMapper = sqlSession.getMapper(EmployeeMapper.class);
            Employee employee = employeeMapper.getEmployee(1);
            System.out.println(employee);
        } finally {
            sqlSession.close();
        }
    }
    

    流程:

    1. 接口式编程
      原生:Dao ====> DaoImpl
      如今:Mapper ====> xxMapper.xml
    2. SqlSession 代表和数据库的一次会话, 用完必须关闭
    3. SqlSession 和 Connection 一样, 都是非线程安全的, 每次使用都应该去获取新的对象,如 private SqlSession sqlSession 这种共享的对象, 不应该使用
    4. mapper 接口没有实现类, 但是 mybatis 会为这个接口生成一个代理对象(接口与 xml 进行绑定),即 sqlSession.getMapper(EmployeeMapper.class)
    5. 两个重要的配置文件
      mybatis-config.xml: mysql:全局配置文件, 包含数据库连接池信息, 事务管理器信息等
      mymapper.xml: sql:映射文件, 保存了每一个 sql 语句的映射信息. 将 sql 语句抽取出来

    三、参考

    MyBatis 官方文档
    MyBatis学习02 走进MyBatis的世界

    相关文章

      网友评论

        本文标题:MyBatis | 入门和基础

        本文链接:https://www.haomeiwen.com/subject/xsssmftx.html