初识MyBatis

初识MaBatis

​

前言

本文是博主初步学习MyBatis所做的笔记，当中如有错别字、描述不对的地方或着侵权的地方，恳请及时告知，博主亦会虚心接收，及时更正

• 博主主页：知识汲取者
• 博主Gitee仓库：Gitee
• 博主Github仓库：Github

欢迎大家访问支持＜（＾－＾）＞

1、MaBatis概述

• Mabatis是什么？

    MyBatis 是一款优秀的持久层¹框架²（也是一个半自动的ORM，Object Relation Mapping框架），它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Ordinary Java Object,普通的 Java对象)映射成数据库中的记录。

  官网：mybatis – MyBatis 3 | 简介

• Mabatis的优点：

  1）提高代码的可维护性。Mabatis让SQL语句和代码进行了解耦³，SQL语句写在XML文件中想修改SQL语句只需要修改XML文件而不必去修改代码

  2）减少重复代码。与JDBC相比，减少了50%以上的代码量，消除了JDBC 大量冗余的代码，不需要手动开关连接

  3）具有良好的兼容性。因为MyBatis 使用JDBC 来连接数据库，所以只要JDBC 支持的数据库MyBatis 都支持

  4）简单易学。本身就很小且简单，没有任何第三方依赖，最简单安装只要两个jar文件+配置几个SQL映射文件。

  5）灵活轻便。MyBatis不会对应用程序或者数据库的现有设计强加任何影响。 SQL语句写在XML文件里，便于统一管理和优化。通过SQL语句可以满足操作数据库的所有需求。PS：MyBatis还具有强大的动态SQL能力

  ……

• Mabatis的历史

    MyBatis本是apache的一个开源项目iBatis，2010年这个项目由apache software foundation迁移到了[google code](https://baike.baidu.com/item/google code/2346604)，并且改名为MyBatis。2013年11月迁移到Github。iBATIS一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects（DAOs）。

拓展：JavaEE的三层架构

• 表现层：用于展示数据
• 业务层：用于处理业务逻辑
• 持久层：用于将数据保存到数据库

2、MyBatis快速入门

任务：使用MyBatis读取数据库中的User表中的所有数据，并以日志文件的形式打印到控制台上

准备工作：

• Step1：在数据库中创建User表

  create database mybatis;
  use mybatis;
  
  drop table if exists tb_user;
  
  create table tb_user(
  	id int primary key auto_increment,
  	username varchar(20),
  	password varchar(20),
  	gender char(1),
  	addr varchar(30)
  );
  INSERT INTO tb_user VALUES (1, 'zhangsan', '123', '男', '北京');
  INSERT INTO tb_user VALUES (2, '李四', '234', '女', '天津');
  INSERT INTO tb_user VALUES (3, '王五', '11', '男', '西安');
  

• Step2：创建Maven项目模块

  

• Step3：定义POJO⁴（Plain Ordinary Java Object）类

  User类：

  package com.hhxy.pojo;
  
  public class User {
      private Integer id;
      private String username;
      private String password;
      private String gender;
      private String addr;
  
      public User() {
      }
  
      public User(Integer id, String username, String password, String gender, String addr) {
          this.id = id;
          this.username = username;
          this.password = password;
          this.gender = gender;
          this.addr = addr;
      }
  
      public Integer getId() {
          return id;
      }
  
      public void setId(Integer id) {
          this.id = id;
      }
  
      public String getUsername() {
          return username;
      }
  
      public void setUsername(String username) {
          this.username = username;
      }
  
      public String getPassword() {
          return password;
      }
  
      public void setPassword(String password) {
          this.password = password;
      }
  
      public String getGender() {
          return gender;
      }
  
      public void setGender(String gender) {
          this.gender = gender;
      }
  
      public String getAddr() {
          return addr;
      }
  
      public void setAddr(String addr) {
          this.addr = addr;
      }
  
      @Override
      public String toString() {
          return "User{" +
                  "id=" + id +
                  ", username='" + username + '\'' +
                  ", password='" + password + '\'' +
                  ", gender='" + gender + '\'' +
                  ", addr='" + addr + '\'' +
                  '}';
      }
  }
  

正式开始：

编写Maven配置文件
pom.xml

编写MyBatis核心配置文件
mybatis-config.xml

编写SQL映射文件
UserMapper.xml

编写Logback核心配置文件
logback.xml

编写相关Java代码

备注：

1. 编写Maven配置文件，主要是用来导入项目所依赖的jar包
2. 编写MyBatis核心配置文件，主要是实现MaBatis框架的核心功能，包括数据库连接、关联SQL映射文件（暂时先不管，后续深入了解）需要注意：该配置文件的名字一定不能乱改！！！
3. 编写SQL映射文件，该文件中存放Java代码要执行的SQL语句，实现了SQL语句和代码进行了解耦
4. 编写Logback核心配置文件，主要是用于方便查看使用MyBatis框架执行程序后的具体细节

这些配置文件的编写顺序没有要求，但是配置文件的编写肯定是要在编写Java代码前的 (其实这些文件CV一下就行了)

推荐阅读：

1. 一文带你快速上手Maven
2. Logback快速入门

• Step1：编写Maven配置文件

  
  <project xmlns="http://maven.apache.org/POM/4.0.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0modelVersion>
      <groupId>com.hhxygroupId>
      <artifactId>day3_mybatisartifactId>
      <version>1.0-SNAPSHOTversion>
      <properties>
          <maven.compiler.source>8maven.compiler.source>
          <maven.compiler.target>8maven.compiler.target>
      properties>
      
      <dependencies>
          
          <dependency>
              <groupId>org.mybatisgroupId>
              <artifactId>mybatisartifactId>
              <version>3.5.5version>
          dependency>
          
          <dependency>
              <groupId>mysqlgroupId>
              <artifactId>mysql-connector-javaartifactId>
              <version>8.0.27version>
          dependency>
          <dependency>
              <groupId>junitgroupId>
              <artifactId>junitartifactId>
              <version>4.13version>
              <scope>testscope>
          dependency>
          
          
          <dependency>
              <groupId>org.slf4jgroupId>
              <artifactId>slf4j-apiartifactId>
              <version>1.7.20version>
          dependency>
          
          <dependency>
              <groupId>ch.qos.logbackgroupId>
              <artifactId>logback-classicartifactId>
              <version>1.2.3version>
          dependency>
          
          <dependency>
              <groupId>ch.qos.logbackgroupId>
              <artifactId>logback-coreartifactId>
              <version>1.2.3version>
          dependency>
      dependencies>
  project>
  

• Step2：编写MyBatis核心配置文件

  
  
  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.cj.jdbc.Driver"/>
                  <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
                  <property name="username" value="root"/>
                  <property name="password" value="32345678"/>
              dataSource>
          environment>
      environments>
      
      <mappers>
          <mapper resource="UserMapper.xml"/>
      mappers>
  configuration>
  

• Step3：编写SQL映射文件

  
  
  DOCTYPE mapper
          PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
          "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  <mapper namespace="test">
      
      <select id="selectAll" resultType="com.hhxy.pojo.User">
      select * from tb_user;
    select>
  mapper>
  

• Step4：编写Logback核心配置文件

  
  <configuration>
      
      <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
          <encoder>
              <pattern>[%level] %blue(%d{HH:mm:ss.SSS}) %cyan([%thread]) %boldGreen(%logger{15}) - %msg %npattern>
          encoder>
      appender>
  
      <logger name="com.itheima" level="DEBUG" additivity="false">
          <appender-ref ref="Console"/>
      logger>
      
      <root level="DEBUG">
          <appender-ref ref="Console"/>
      root>
  configuration>
  

• Step5：编写相关Java代码

  加载MyBatis核心文件
  获取SqlSessionFactory对象

  获取SqlSession对象

  执行SQL映射文件中SQL语句

  释放资源

  package com.hhxy.test;
  
  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.InputStream;
  import java.util.List;
  
  public class MyBatisDemo {
      public static void main(String[] args) throws Exception {
          //1、定位xml文件，获取SqlSessionFactory对象
          String resource = "./mybatis-config.xml";
          InputStream inputStream = Resources.getResourceAsStream(resource);
          SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
          //2、获取SqlSession对象
          SqlSession sqlSession = sqlSessionFactory.openSession();
          //3、执行SQL语句
          List<Object> users = sqlSession.selectList("test.selectAll");
  
          System.out.println(users);
          //5、释放资源
          sqlSession.close();
      }
  }
  

拓展：IDEA设置数据库连接（用于解决SQL映射文件的警告提示 警告提示后没有关键字提示了，用起来很不方便）

• 当鼠标选中mybatis@localhost时，点击可以直接在IDEA中书写SQL语句，比在Navicat中写SQL更舒服，因为IDEA有更强大的关键字提示
• 当鼠标选中表时，点击可以直接设计表

IDEA真的很( ఠൠఠ )ﾉ

3、Mapper代理

  通过MyBatis快速入门，我们可以知道MyBatis优化了原生JDBC的硬编码问题⁵，但是它的优化不够彻底，当我们使用MyBatis执行SQL语句时，仍然存在硬编码问题，这就需要使用到Mapper代理来进行进一步优化了。

  Mapper代理就是定义一个接口，在接口中定义和SQL映射文件的SQL语句相关联的抽象方法，从而在Java代码中只需要使用该接口对象中的方法就能直接访问SQL映射文件，而不需要再通过文件路径来访问SQL映射文件。

Mapper代理的优点：

1. 提高代码的移植性。Mapper代理进一步优化了原生MyBatis访问SQL映射文件存在的硬编码问题
2. 使用简单。IDEA可以直接补全接口中的方法名，不需要像之前一样要自己手写文件路径

示例：

编写Mapper接口
UserMapper

编写MyBatis所需的配置文件

编写Java代码

注意：

1. Mapper接口最好和相应的SQL映射文件同名，同时要和SQL映射文件在同一目录下

   如果Mapper接口和SQL映射文件同名，可以使用包扫描的方式进化SQL映射文件的加载

2. Mapper接口中的方法名要和SQL映射文件中中SQL语句标签的id属性值同名，并且参数类型和返回值类型要相同

3. SQL映射文件中mapper标签的namespace属性值要和Mapper接口的全类名相同

---

小知识须知：在Maven项目中，按照Maven规范，我们必须将代码（类、接口）和配置文件分开写，但是Mapper接口有需要和SQL映射文件在同一级目录下，就需要利用Maven项目编译的特点，即：当Maven项目被编译后，resources区域的文件和Java代码区域的文件是放在在一个区域进行管理的（可以使用compile命令后，去文件夹中查看验证），这样我们就可以只需要给JMapper接口和其相应的SQL映射文件设置相同的目录结构就可以解决这个问题了。同时需要注意，resources区域是文件目录，不能通过点直接创建目录结构，必须一个一个地进行创建（或者使用/号），而Java代码区域可以直接使用点创建目录结构。

package com.hhxy.test;

import com.hhxy.mapper.UserMapper;
import com.hhxy.pojo.User;
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.InputStream;
import java.util.List;

public class MyBatisDemo {
    public static void main(String[] args) throws Exception {
        //1、定位xml文件，获取SqlSessionFactory对象
        String resource = "./mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        //2、获取SqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        /*---------------------------------Mapper代理核心代码--------------------------------*/
        //3、执行SQL语句
        //3.1 获取UserMapper接口对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        //3.2 获取SQL语句执行后的返回对象
        List<User> users = userMapper.selectAll();
        //这段代码的原生写法：List