Mybatis框架学习(1)--框架搭建以及CRUD操作

一、什么是MyBatis

• MyBatis 是一款优秀的持久层框架；

• MyBatis 避免了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作；

• MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录；
• MyBatis原本是apache的一个开源项目ibatis，2010年该项目由apache迁移到google code，并且改名为MyBatis；
• MyBatis官方文档：https://mybatis.org/mybatis-3/zh/index.html

二、MyBatis的特点

• 简单易学：本身就很小且简单。没有任何第三方依赖，最简单安装只要两个jar文件+配置几个sql映射文件易于学习，易于使用，通过文档和源代码，可以比较完全的掌握它的设计思路和实现；
• 灵活：mybatis不会对应用程序或者数据库的现有设计强加任何影响。 sql写在xml里，便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求；
• 解除sql与程序代码的耦合：通过提供DAO层，将业务逻辑和数据访问逻辑分离，使系统的设计更清晰，更易维护，更易单元测试。sql和代码的分离，提高了可维护性；
• 提供映射标签，支持对象与数据库的ORM(对象关系映射)字段关系映射；
• 提供xml标签，支持编写动态sql
• ......

三、MyBatis快速入门

1、思路流程

环境搭建---导入Mybatis的依赖---代码编写---测试

2、代码演示

①搭建实验的数据库和表

CREATE DATABASE ssmbuild;
USE ssmbuild;
DROP TABLE IF EXISTS books;

CREATE TABLE books(
    bookID INT(10) PRIMARY KEY NOT NULL AUTO_INCREMENT COMMENT '书id',
    bookName VARCHAR(100) NOT NULL COMMENT '书名',
    bookCounts INT(10) NOT NULL COMMENT '数量',
    detail VARCHAR(200) NOT NULL COMMENT '描述'
);

INSERT INTO books(bookID,bookName,bookCounts,detail) VALUES
(1,'java',1,'从入门到精通'),
(2,'MySQL',10,'从删库到跑路'),
(3,'Linux',5,'从入门到进门');

②导入Mybatis的相关依赖( pom.xml 文件) -- 可以在GitHub上或者官方文档上查找　　　　　

<dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!--Java 连接MySQL需要驱动包,否则JDBC无法访问数据库-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.32</version>
        </dependency>
    </dependencies>

③编写Mybatisde的核心配置文件 -- 查看Mybatis官方文档

<?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/ssmbuild?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="mapper/BookMapper.xml"/>
    </mappers>

</configuration> 

④编写Mybatis工具类 -- 查看Mybatis官方文档 

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 java.io.IOException;
import java.io.InputStream;

public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;
    static{
        try {
            String resource = "mybatis-config.xml";
            InputStream is = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSession(){
        return sqlSessionFactory.openSession();
    }
}

⑤创建实体类以及Mapper接口

【Book实体类】

public class Book {
    private Integer bookID;
    private String bookName;
    private Integer bookCounts;
    private String detail;

    public Book() {
    }

    public Book(Integer bookID, String bookName, Integer bookCounts, String detail) {
        this.bookID = bookID;
        this.bookName = bookName;
        this.bookCounts = bookCounts;
        this.detail = detail;
    }

    public Integer getBookID() {
        return bookID;
    }

    public void setBookID(Integer bookID) {
        this.bookID = bookID;
    }

    public String getBookName() {
        return bookName;
    }

    public void setBookName(String bookName) {
        this.bookName = bookName;
    }

    public Integer getBookCounts() {
        return bookCounts;
    }

    public void setBookCounts(Integer bookCounts) {
        this.bookCounts = bookCounts;
    }

    public String getDetail() {
        return detail;
    }

    public void setDetail(String detail) {
        this.detail = detail;
    }

    @Override
    public String toString() {
        return "Book{" +
                "bookID=" + bookID +
                ", bookName='" + bookName + '\'' +
                ", bookCounts=" + bookCounts +
                ", detail='" + detail + '\'' +
                '}';
    }
}

【BookMapper接口】

import pojo.Book;
import java.util.List;

public interface BookMapper {

    //查询所有的书籍信息
    List<Book> selectBook();
}

⑥编写Mapper.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="mapper.BookMapper">
    <select id="selectBook" resultType="pojo.Book">
        select * from books
    </select>
</mapper>

【说明】

1、mapper.xml配置文件中的namaspace中的名称必须为对应Mapper接口或Dao接口的全限定类名，必须一致！！！

2、select标签中的id为namespace对应接口中的方法名。

⑦编写测试类

import org.apache.ibatis.session.SqlSession;
import pojo.Book;
import utils.MybatisUtils;

import java.util.List;

public class MyTest {
    public static void main(String[] args) {
        SqlSession session = MybatisUtils.getSession();
        BookMapper mapper = session.getMapper(BookMapper.class);
        List<Book> books = mapper.selectBook();
        for (Book book : books) {
            System.out.println(book);
        }
    }
}

⑧测试结果

3、运行过程中可能出现的问题

①Maven静态资源过滤的问题 

解决方案：在pom.xml配置文件中添加如下代码块：

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

②在核心配置文件中由于映射器Mappers未正确配置而出现错误，常见错误总结如下：

[1]使用 <mapper resource="xxxMapper.xml"/>时，包名之间使用"/"，不要使用"."，接口和其对应的Mapper.xml配置文件的名称可以不相同；

[2]核心配置文件中使用<package name=""></package>或<mapper class=""></mapper>时，包名之间使用"."，接口和其对应的Mapper.xml配置文件必须同包同名。

[tips]

为了避免因为映射器配置错误而出现Exception in thread "main" org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)、org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.io.IOException: Could not find resource mapper.BookDao.xml等异常(xxx.xml包名之间一定使用“/")，我们搭建环境的过程中，接口和其对应的配置文件最好同包同名。

四、Mybatis实现CRUD操作

1、查询操作--select

• select标签时Mybatis中最常用的标签之一，该标签有很多属性可以配置，常见的属性有：
  • id：对应接口中的方法名
  • parameterType：传入SQL语句的参数类型，在该参数中可以使用万能的Map实现参数的传递，百试不爽^_^
  • resultType：SQL语句返回返回值的类型
• 【需求：根据id查询Book】

①在BookMapper中添加对应的方法

 public Books findBookByID(int id); //根据id查询Book 

②在BookMapper.xml配置文件中添加select语句 

<select id="findBookByID" resultType="com.yif.pojo.Books" parameterType="int">
        select * from books where bookID = #{id}
</select> 

③测试类中的测试

public static void main(String[] args) {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        BookDao bookDao = sqlSession.getMapper(BookDao.class);
        Books book = bookDao.findBookByID(1);
        System.out.println(book);
        sqlSession.close();
}

 【说明】

在进行参数传递时，如果我们的实体类或者待查询数据库中表的字段过多时，我们可以考虑使用"万能的Map"，使用规则如下：

1、使用Map传递参数，直接在sql语句中取出map中的key即可，实例如下图所示：

 2、增加操作--insert

①在BookMapper中添加对应的方法

 public int addBook(Books book); 

②在BookMapper.xml配置文件中添加insert语句 

<insert id="addBook" parameterType="com.yif.pojo.Books">
        insert into books values (#{bookID},#{bookName},#{bookCounts},#{detail})
</insert>

③测试类中的测试

public static void main(String[] args) {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        BookDao bookDao = sqlSession.getMapper(BookDao.class);
        bookDao.addBook(new Books(4,"python",10,"入门基础"));
        sqlSession.commit();  //手动提交事务，否则增加的内容提交不到数据库中
        sqlSession.close();
    }

【注意】由于增、删、改操作会修改数据库中的内容，在执行这些操作时，需要提交事务！！！

3、修改Book的信息--update

4、根据id删除表中的某一Book -- delete

5、小结

①所有的增删改操作都需要提交事务；

②接口中所有的普通参数，尽量采用方法名(@Param("newpara")int para)，在sql中通过#{newpara}来获取传递的参数；

③根据业务的需求，可以考虑使用Map来实现参数的传递。

五、Mybatis配置解析

1.核心配置文件

•  Mybatis的核心配置文件一般命名为：mybatis-config.xml；
• MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息；
• 可配置的内容如下

properties（属性）
settings（设置）
typeAliases（类型别名）
typeHandlers（类型处理器）
objectFactory（对象工厂）
plugins（插件）
environments（环境配置）
　　environment（环境变量）
　　transactionManager（事务管理器）
　　dataSource（数据源）
databaseIdProvider（数据库厂商标识）
mappers（映射器）

注意元素节点的顺序，如果顺序不对，会报错！！！
蓝色标注出的配置为常见的配置内容，必须熟悉！！！

2、环境配置--environments

<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/ssmbuild?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>

【说明】

①Mybatis可以配置多个environment，但是在每个SqlSessionFactory实例中只能选择一种环境；例如在上述的配置文件中，除了"development“环境外，还可以配置"test"环境；

②Mybatis默认的事务管理器是JDBC，连接池的类型为POOLED

③关于事务管理器和连接池的类型详情参考Mybatis官方文档。

3、属性--properties

• 我们可以通过properties属性实现对外配配置文件的引用；
• 数据库环境配置中的这些属性可以在外部进行配置并并且进行动态替换，既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置；

我们可以通过使用properties来优化我们的配置文件：

step1:在resources目录下新建一个db.properties的文件

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/ssmbuild?useSSL=true&useUnicode=true&characterEncoding=utf8
username=root
password=root

step2:将db.properties文件导入到propertiespe配置中

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

    <environments default="development">
        <!--环境配置：
        可以配置多个环境，但是在实际开发中只可以指定其中的一个
        通过切换environments标签中的default属性的取值，来选择不同的环境
        -->
        <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="MANAGED"></transactionManager>
            <dataSource type="UNPOOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>

    </environments>

    <mappers>
        <mapper resource="com/yif/mapper/BookMapper.xml"></mapper>
        <!--<package name="com.yif.mapper"></package>-->
        <!--<mapper class="com.yif.mapper.BookMapper"></mapper>-->
    </mappers>

【关于properties的说明】

①可以直接引入外部配置文件；

②可以在properties中添加一些属性配置；

③如果properties中的属性配置与外部配置文件中属性配置不一致时，优先使用外部配置文件的！

4、类型别名--typeAliases（含两种方式）

• 类型别名可为 Java 类型设置一个缩写名字；
• 使用类型别名的目的在于降低冗余的全限定类名书写

<!--
    给实体类起别名
        方式一：使用typeAlias标签给单个实体类取别名
        方式二：使用package标签给某一个包下的所有实体类起别名，别名默认为类名小写
-->
    <typeAliases>
        <typeAlias type="com.yif.pojo.Books" alias="Books"></typeAlias>
    </typeAliases>

5、映射器--mappers

• 定义映射SQL语句的配置文件；
• 既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要来定义 SQL 映射语句了。 但首先，我们需要告诉 MyBatis 到哪里去找到这些语句。 在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。 你可以使用相对于类路径的资源引用，或完全限定资源定位符（包括 file:/// 形式的 URL），或类名和包名等；
• 映射器是Mybatis中最核心的组件之一。

<!-- 使用相对于类路径的资源引用 -->
<mappers>
        <mapper resource="com/yif/mapper/BookMapper.xml"></mapper>4 </mappers>

<!-- 使用映射器接口实现类的完全限定类名 -->
 <mappers>
        <mapper class="com.yif.mapper.BookMapper"></mapper>
 </mappers>

<!-- 将包内的映射器接口实现全部注册为映射器 -->
 <mappers>
        <package name="com.yif.mapper"></mapper>
 </mappers>

这些配置会告诉 MyBatis 去哪里找映射文件，剩下的细节就应该是每个 SQL 映射文件了。

6、其他配置预览

• settings --详情查看Mybatis官方文档
  • 缓存开启关闭--cacheEnabled
  • 日志实现--logImpl
    • 1、LOG4J及其使用步骤
      • step1、在pom.xml中导入log4j的依赖　　　　　　　　　　　　

<dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
</dependency>

• • • • step2、编写log4j的配置文档log4j.properties

#将等级为DEBUG的日志信息输出到console和file这两个目的地，console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file

#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
#日志文件的位置
log4j.appender.file.File=./log/yif.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yyyy-MM-dd}][%c]%m%n

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG

• • • • step3、获取Logger对象　

public class MyTest {

    static Logger logger =  Logger.getLogger(MyTest.class);

    @Test
    public void test(){
        logger.info("infor:进入test方法");
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        BookMapper mapper = sqlSession.getMapper(BookMapper.class);
        Books book = mapper.findBookByID(1);
        System.out.println(book);
    }
}

• • • 2、STDOUT_LOGGING
  • 是否开启驼峰命名自动映射--mapUnderscoreToCamelCase
    • 若开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。　　

六、作用域和生命周期

1、Mybatis的执行流程

 

 

 ①SqlSessionFactoryBuilder的作用在于创建SqlSessionFactory，创建成功后，SqlSessionFactoryBuilder就失去了作用，所以它只能存在于创建SqlSessionFactory的方法中，而不能让其长期存在。故SqlSessionFactoryBuilder实例的最佳作用域是方法作用域（也就是局部方法变量）；

②SqlSessionFactory其作用是创建SqlSession接口对象。由于Mybatis的本质就是java对数据库的操作（SqlSessionFactory可以被认为是一个数据库的连接池），所以SqlSessionFactory的生命周期存在于整个Mybatis的应用之中，即一旦创建SqlSessionFactory，就需要长期保存，直至不再使用Mybatis应用。因此可以认为SqlSessionFactory的生命周期等同于Mybatis的应用周期；

③由于SqlSessionFactory可以被认为是一个数据库的连接池，它占据着数据库的连接资源。如果创建多个SqlSessionFactory，那么就存在多个数据库连接池对象，这样不利于对数据库资源的控制，因此在一般的应用中，我们希望SqlSessionFactory作为一个单例，让其在应用中被共享，所以说SqlSessionFactory的最佳作用域是应用作用域；

④如果说sqlSessionFactory相当于数据库操作中的连接池，那么SqlSession就相当于一个数据库连接（Connection对象），所以它应该存活在一个业务请求中：在处理完整个请求后，应该关闭这条连接，将其归还到sqlSessionFactory，否则数据库资源就很快被耗费完。因此SqlSession的最佳作用域是请求或方法作用域。

 

（未完待续......）